Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::numeric::ublas::hermitian_matrix< T, TRI, L, A > Class Template Reference

A hermitian matrix of values of type T. More...

#include <hermitian.hpp>

Inheritance diagram for boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >:
Collaboration diagram for boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >:

Classes

class  const_iterator1
 
class  const_iterator2
 
class  iterator1
 
class  iterator2
 

Public Types

typedef A::size_type size_type
 
typedef A::difference_type difference_type
 
typedef T value_type
 
typedef const T const_reference
 
typedef Treference
 
typedef A array_type
 
typedef const matrix_reference
< const self_type
const_closure_type
 
typedef matrix_reference
< self_type
closure_type
 
typedef vector< T, A > vector_temporary_type
 
typedef matrix< T, L, A > matrix_temporary_type
 
typedef packed_tag storage_category
 
typedef L::orientation_category orientation_category
 
typedef reverse_iterator_base1
< const_iterator1
const_reverse_iterator1
 
typedef reverse_iterator_base1
< iterator1
reverse_iterator1
 
typedef reverse_iterator_base2
< const_iterator2
const_reverse_iterator2
 
typedef reverse_iterator_base2
< iterator2
reverse_iterator2
 
typedef hermitian_matrix< T,
TRI, L, A > 
container_type
 
typedef matrix_tag type_category
 
typedef E expression_type
 

Public Member Functions

BOOST_UBLAS_INLINE hermitian_matrix ()
 
BOOST_UBLAS_INLINE hermitian_matrix (size_type size)
 
BOOST_UBLAS_INLINE hermitian_matrix (size_type size1, size_type size2)
 
BOOST_UBLAS_INLINE hermitian_matrix (size_type size, const array_type &data)
 
BOOST_UBLAS_INLINE hermitian_matrix (const hermitian_matrix &m)
 
template<class AE >
BOOST_UBLAS_INLINE hermitian_matrix (const matrix_expression< AE > &ae)
 
BOOST_UBLAS_INLINE size_type size1 () const
 
BOOST_UBLAS_INLINE size_type size2 () const
 
BOOST_UBLAS_INLINE const
array_type
data () const
 
BOOST_UBLAS_INLINE array_typedata ()
 
BOOST_UBLAS_INLINE void resize (size_type size, bool preserve=true)
 
BOOST_UBLAS_INLINE void resize (size_type size1, size_type size2, bool preserve=true)
 
BOOST_UBLAS_INLINE void resize_packed_preserve (size_type size)
 
BOOST_UBLAS_INLINE const_reference operator() (size_type i, size_type j) const
 
BOOST_UBLAS_INLINE true_reference at_element (size_type i, size_type j)
 
BOOST_UBLAS_INLINE reference operator() (size_type i, size_type j)
 
BOOST_UBLAS_INLINE true_reference insert_element (size_type i, size_type j, const_reference t)
 
BOOST_UBLAS_INLINE void erase_element (size_type i, size_type j)
 
BOOST_UBLAS_INLINE void clear ()
 
BOOST_UBLAS_INLINE
hermitian_matrix
operator= (const hermitian_matrix &m)
 
BOOST_UBLAS_INLINE
hermitian_matrix
assign_temporary (hermitian_matrix &m)
 
template<class AE >
BOOST_UBLAS_INLINE
hermitian_matrix
operator= (const matrix_expression< AE > &ae)
 
template<class AE >
BOOST_UBLAS_INLINE
hermitian_matrix
assign (const matrix_expression< AE > &ae)
 
template<class AE >
BOOST_UBLAS_INLINE
hermitian_matrix
operator+= (const matrix_expression< AE > &ae)
 
template<class AE >
BOOST_UBLAS_INLINE
hermitian_matrix
plus_assign (const matrix_expression< AE > &ae)
 
template<class AE >
BOOST_UBLAS_INLINE
hermitian_matrix
operator-= (const matrix_expression< AE > &ae)
 
template<class AE >
BOOST_UBLAS_INLINE
hermitian_matrix
minus_assign (const matrix_expression< AE > &ae)
 
template<class AT >
BOOST_UBLAS_INLINE
hermitian_matrix
operator*= (const AT &at)
 
template<class AT >
BOOST_UBLAS_INLINE
hermitian_matrix
operator/= (const AT &at)
 
BOOST_UBLAS_INLINE void swap (hermitian_matrix &m)
 
BOOST_UBLAS_INLINE const_iterator1 find1 (int, size_type i, size_type j) const
 
BOOST_UBLAS_INLINE iterator1 find1 (int rank, size_type i, size_type j)
 
BOOST_UBLAS_INLINE const_iterator2 find2 (int, size_type i, size_type j) const
 
BOOST_UBLAS_INLINE iterator2 find2 (int rank, size_type i, size_type j)
 
BOOST_UBLAS_INLINE const_iterator1 begin1 () const
 
BOOST_UBLAS_INLINE const_iterator1 cbegin1 () const
 
BOOST_UBLAS_INLINE const_iterator1 end1 () const
 
BOOST_UBLAS_INLINE const_iterator1 cend1 () const
 
BOOST_UBLAS_INLINE iterator1 begin1 ()
 
BOOST_UBLAS_INLINE iterator1 end1 ()
 
BOOST_UBLAS_INLINE const_iterator2 begin2 () const
 
BOOST_UBLAS_INLINE const_iterator2 cbegin2 () const
 
BOOST_UBLAS_INLINE const_iterator2 end2 () const
 
BOOST_UBLAS_INLINE const_iterator2 cend2 () const
 
BOOST_UBLAS_INLINE iterator2 begin2 ()
 
BOOST_UBLAS_INLINE iterator2 end2 ()
 
BOOST_UBLAS_INLINE
const_reverse_iterator1 
rbegin1 () const
 
BOOST_UBLAS_INLINE
const_reverse_iterator1 
crbegin1 () const
 
BOOST_UBLAS_INLINE
const_reverse_iterator1 
rend1 () const
 
BOOST_UBLAS_INLINE
const_reverse_iterator1 
crend1 () const
 
BOOST_UBLAS_INLINE
reverse_iterator1 
rbegin1 ()
 
BOOST_UBLAS_INLINE
reverse_iterator1 
rend1 ()
 
BOOST_UBLAS_INLINE
const_reverse_iterator2 
rbegin2 () const
 
BOOST_UBLAS_INLINE
const_reverse_iterator2 
crbegin2 () const
 
BOOST_UBLAS_INLINE
const_reverse_iterator2 
rend2 () const
 
BOOST_UBLAS_INLINE
const_reverse_iterator2 
crend2 () const
 
BOOST_UBLAS_INLINE
reverse_iterator2 
rbegin2 ()
 
BOOST_UBLAS_INLINE
reverse_iterator2 
rend2 ()
 
BOOST_UBLAS_INLINE const
container_type
operator() () const
 
BOOST_UBLAS_INLINE container_typeoperator() ()
 

Static Public Attributes

static const unsigned complexity
 

Friends

BOOST_UBLAS_INLINE friend void swap (hermitian_matrix &m1, hermitian_matrix &m2)
 

Detailed Description

template<class T, class TRI, class L, class A>
class boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >

A hermitian matrix of values of type T.

For a $(n \times n)$-dimensional matrix and $ 0 \leq i < n, 0 \leq j < n$, every element $m_{i,j}$ is mapped to the $(i.n + j)$-th element of the container for row major orientation or the $(i + j.m)$-th element of the container for column major orientation. And $\forall i,j$, $m_{i,j} = \overline{m_{i,j}}$.

Orientation and storage can also be specified, otherwise a row major and unbounded array are used. It is not required by the storage to initialize elements of the matrix. Moreover, only the given triangular matrix is stored and the storage of hermitian matrices is packed.

See http://en.wikipedia.org/wiki/Hermitian_matrix for more details on hermitian matrices.

Template Parameters
Tthe type of object stored in the matrix (like double, float, complex, etc...)
TRIthe type of triangular matrix is either lower or upper. Default is lower
Lthe storage organization. It is either row_major or column_major. Default is row_major
Athe type of Storage array. Default is .

Member Typedef Documentation

template<class T , class TRI , class L , class A >
typedef A boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::array_type
template<class T , class TRI , class L , class A >
typedef matrix_reference<self_type> boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::closure_type
template<class T , class TRI , class L , class A >
typedef const matrix_reference<const self_type> boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::const_closure_type
template<class T , class TRI , class L , class A >
typedef const T boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::const_reference
template<class T , class TRI , class L , class A >
typedef reverse_iterator_base1<const_iterator1> boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::const_reverse_iterator1
template<class T , class TRI , class L , class A >
typedef reverse_iterator_base2<const_iterator2> boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::const_reverse_iterator2
template<class T , class TRI , class L , class A >
typedef A::difference_type boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::difference_type
template<class E>
typedef E boost::numeric::ublas::matrix_expression< E >::expression_type
inherited
template<class T , class TRI , class L , class A >
typedef matrix<T, L, A> boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::matrix_temporary_type
template<class T , class TRI , class L , class A >
typedef L::orientation_category boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::orientation_category
template<class T , class TRI , class L , class A >
typedef T& boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::reference
template<class T , class TRI , class L , class A >
typedef reverse_iterator_base1<iterator1> boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::reverse_iterator1
template<class T , class TRI , class L , class A >
typedef reverse_iterator_base2<iterator2> boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::reverse_iterator2
template<class T , class TRI , class L , class A >
typedef A::size_type boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::size_type
template<class T , class TRI , class L , class A >
typedef packed_tag boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::storage_category
template<class T , class TRI , class L , class A >
typedef T boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::value_type
template<class T , class TRI , class L , class A >
typedef vector<T, A> boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::vector_temporary_type

Constructor & Destructor Documentation

template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::hermitian_matrix ( )
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::hermitian_matrix ( size_type  size)
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::hermitian_matrix ( size_type  size1,
size_type  size2 
)
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::hermitian_matrix ( size_type  size,
const array_type data 
)
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::hermitian_matrix ( const hermitian_matrix< T, TRI, L, A > &  m)
inline
template<class T , class TRI , class L , class A >
template<class AE >
BOOST_UBLAS_INLINE boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::hermitian_matrix ( const matrix_expression< AE > &  ae)
inline

Member Function Documentation

template<class T , class TRI , class L , class A >
template<class AE >
BOOST_UBLAS_INLINE hermitian_matrix& boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::assign ( const matrix_expression< AE > &  ae)
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE iterator1 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::begin1 ( )
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE iterator2 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::begin2 ( )
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE const_iterator1 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::cbegin1 ( ) const
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE const_iterator2 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::cbegin2 ( ) const
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE const_iterator1 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::cend1 ( ) const
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE const_iterator2 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::cend2 ( ) const
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE void boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::clear ( void  )
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE const_reverse_iterator1 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::crbegin1 ( ) const
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE const_reverse_iterator2 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::crbegin2 ( ) const
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE const_reverse_iterator1 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::crend1 ( ) const
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE const_reverse_iterator2 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::crend2 ( ) const
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE array_type& boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::data ( )
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE iterator1 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::end1 ( )
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE iterator2 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::end2 ( )
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE void boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::erase_element ( size_type  i,
size_type  j 
)
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE iterator1 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::find1 ( int  rank,
size_type  i,
size_type  j 
)
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE iterator2 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::find2 ( int  rank,
size_type  i,
size_type  j 
)
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE true_reference boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::insert_element ( size_type  i,
size_type  j,
const_reference  t 
)
inline
template<class T , class TRI , class L , class A >
template<class AE >
BOOST_UBLAS_INLINE hermitian_matrix& boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::minus_assign ( const matrix_expression< AE > &  ae)
inline
BOOST_UBLAS_INLINE const container_type& boost::numeric::ublas::matrix_container< hermitian_matrix< T, TRI, L, A > >::operator() ( ) const
inlineinherited
BOOST_UBLAS_INLINE container_type& boost::numeric::ublas::matrix_container< hermitian_matrix< T, TRI, L, A > >::operator() ( )
inlineinherited
template<class T , class TRI , class L , class A >
template<class AT >
BOOST_UBLAS_INLINE hermitian_matrix& boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::operator*= ( const AT &  at)
inline
template<class T , class TRI , class L , class A >
template<class AE >
BOOST_UBLAS_INLINE hermitian_matrix& boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::operator+= ( const matrix_expression< AE > &  ae)
inline
template<class T , class TRI , class L , class A >
template<class AE >
BOOST_UBLAS_INLINE hermitian_matrix& boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::operator-= ( const matrix_expression< AE > &  ae)
inline
template<class T , class TRI , class L , class A >
template<class AT >
BOOST_UBLAS_INLINE hermitian_matrix& boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::operator/= ( const AT &  at)
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE hermitian_matrix& boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::operator= ( const hermitian_matrix< T, TRI, L, A > &  m)
inline
template<class T , class TRI , class L , class A >
template<class AE >
BOOST_UBLAS_INLINE hermitian_matrix& boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::operator= ( const matrix_expression< AE > &  ae)
inline
template<class T , class TRI , class L , class A >
template<class AE >
BOOST_UBLAS_INLINE hermitian_matrix& boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::plus_assign ( const matrix_expression< AE > &  ae)
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE const_reverse_iterator1 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::rbegin1 ( ) const
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE reverse_iterator1 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::rbegin1 ( )
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE const_reverse_iterator2 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::rbegin2 ( ) const
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE reverse_iterator2 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::rbegin2 ( )
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE const_reverse_iterator1 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::rend1 ( ) const
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE reverse_iterator1 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::rend1 ( )
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE const_reverse_iterator2 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::rend2 ( ) const
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE reverse_iterator2 boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::rend2 ( )
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE void boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::resize ( size_type  size,
bool  preserve = true 
)
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE void boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::resize ( size_type  size1,
size_type  size2,
bool  preserve = true 
)
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE void boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::resize_packed_preserve ( size_type  size)
inline
template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE void boost::numeric::ublas::hermitian_matrix< T, TRI, L, A >::swap ( hermitian_matrix< T, TRI, L, A > &  m)
inline

Friends And Related Function Documentation

template<class T , class TRI , class L , class A >
BOOST_UBLAS_INLINE friend void swap ( hermitian_matrix< T, TRI, L, A > &  m1,
hermitian_matrix< T, TRI, L, A > &  m2 
)
friend

Member Data Documentation

const unsigned boost::numeric::ublas::matrix_container< hermitian_matrix< T, TRI, L, A > >::complexity
staticinherited

The documentation for this class was generated from the following files: