All Classes Namespaces Functions Typedefs Enumerations Pages
Public Member Functions | List of all members
fmatvec::Matrix< Symmetric, Ref, Ref, AT > Class Template Reference

This is a matrix class for symmetric matrices. More...

#include <symmetric_matrix.h>

Public Member Functions

 Matrix ()
 Standard constructor. More...
 
 Matrix (int n_, Noinit)
 
 Matrix (int n_, Init ini=INIT, const AT &a=0)
 
 Matrix (int n_, Eye ini, const AT &a=1)
 
 Matrix (int m_, int n_, Noinit)
 
 Matrix (int m_, int n_, Init ini=INIT, const AT &a=0)
 
 Matrix (int m_, int n_, Eye ini, const AT &a=1)
 
 Matrix (const Matrix< Symmetric, Ref, Ref, AT > &A)
 Copy Constructor. More...
 
 Matrix (const Matrix< General, Ref, Ref, AT > &A)
 Element operator. More...
 
template<class Type , class Row , class Col >
 Matrix (const Matrix< Type, Row, Col, AT > &A)
 
 Matrix (int n_, AT *ele_)
 Regular Constructor. More...
 
 ~Matrix ()
 Destructor.
 
Matrix< Symmetric, Ref, Ref, AT > & resize ()
 
Matrix< Symmetric, Ref, Ref, AT > & resize (int n_, Noinit)
 
Matrix< Symmetric, Ref, Ref, AT > & resize (int n, Init ini=INIT, const AT &a=0)
 
Matrix< Symmetric, Ref, Ref, AT > & resize (int n, Eye ini, const AT &a=1)
 
Matrix< Symmetric, Ref, Ref, AT > & operator= (const Matrix< Symmetric, Ref, Ref, AT > &A)
 Assignment operator. More...
 
template<class Type , class Row , class Col >
Matrix< Symmetric, Ref, Ref, AT > & operator= (const Matrix< Type, Row, Col, AT > &A)
 
template<class Type , class Row , class Col >
Matrix< Symmetric, Ref, Ref, AT > & operator<< (const Matrix< Type, Row, Col, AT > &A)
 Copy operator. More...
 
Matrix< Symmetric, Ref, Ref, AT > & operator>> (const Matrix< Symmetric, Ref, Ref, AT > &A)
 Reference operator. More...
 
AT & operator() (int i, int j)
 Element operator. More...
 
const AT & operator() (int i, int j) const
 Element operator. More...
 
AT & ei (int i, int j)
 
const AT & ei (int i, int j) const
 
AT & ej (int i, int j)
 
const AT & ej (int i, int j) const
 
AT & e (int i, int j)
 
const AT & e (int i, int j) const
 
AT * operator() ()
 Pointer operator. More...
 
const AT * operator() () const
 Pointer operator. More...
 
int size () const
 Size. More...
 
int rows () const
 Number of rows. More...
 
int cols () const
 Number of columns. More...
 
int ldim () const
 Leading dimension. More...
 
const CBLAS_ORDER blasOrder () const
 Storage convention. More...
 
const CBLAS_UPLO blasUplo () const
 Symmetry convention. More...
 
Matrix< Symmetric, Ref, Ref, AT > copy () const
 Matrix duplicating. More...
 
Matrix< Symmetric, Ref, Ref, AT > & init (const AT &a)
 Initialization. More...
 
Matrix< Symmetric, Ref, Ref, AT > & init (Init, const AT &a=0)
 
Matrix< Symmetric, Ref, Ref, AT > & init (Eye, const AT &a=1)
 
Matrix< Symmetric, Ref, Ref, AT > & init (Noinit, const AT &a=0)
 
Matrix< General, Ref, Ref, AT > operator() (const Index &I, const Index &J)
 Submatrix operator. More...
 
const Matrix< General, Ref,
Ref, AT > 
operator() (const Index &I, const Index &J) const
 Submatrix operator. More...
 
Matrix< Symmetric, Ref, Ref, AT > operator() (const Index &I)
 Submatrix operator. More...
 
const Matrix< Symmetric, Ref,
Ref, AT > 
operator() (const Index &I) const
 Submatrix operator. More...
 
Matrix< General, Ref, Ref, AT > operator() (int i1, int j1, int i2, int j2)
 Submatrix operator. More...
 
const Matrix< General, Ref,
Ref, AT > 
operator() (int i1, int j1, int i2, int j2) const
 Submatrix operator. More...
 
 operator std::vector< std::vector< AT > > ()
 Cast to std::vector<std::vector<AT> >. More...
 

Detailed Description

template<class AT>
class fmatvec::Matrix< Symmetric, Ref, Ref, AT >

This is a matrix class for symmetric matrices.

Template class Matrix of shape type Symmetric. The template parameter AT defines the atomic type of the matrix. Valid types are int, float, double, complex<float> and complex<double>

Constructor & Destructor Documentation

template<class AT >
fmatvec::Matrix< Symmetric, Ref, Ref, AT >::Matrix ( )
inline

Standard constructor.

Constructs a matrix with no size.

template<class AT >
fmatvec::Matrix< Symmetric, Ref, Ref, AT >::Matrix ( const Matrix< Symmetric, Ref, Ref, AT > &  A)
inline

Copy Constructor.

Constructs a reference to the matrix A.

Attention
The physical memory of the matrix A will not be copied, only referenced.
Parameters
AThe matrix that will be referenced.
template<class AT >
fmatvec::Matrix< Symmetric, Ref, Ref, AT >::Matrix ( const Matrix< General, Ref, Ref, AT > &  A)
inlineexplicit

Element operator.

See Matrix(const Matrix<Symmetric,Ref,Ref,T>&)

template<class AT >
fmatvec::Matrix< Symmetric, Ref, Ref, AT >::Matrix ( int  n_,
AT *  ele_ 
)
inline

Regular Constructor.

Constructs a symmetric matrix of size n x n with the pyhsical memory given by ele_.

Parameters
n_The number of rows and columns.
ele_The physical memory the matrix will point to.

Member Function Documentation

template<class AT >
const CBLAS_ORDER fmatvec::Matrix< Symmetric, Ref, Ref, AT >::blasOrder ( ) const
inline

Storage convention.

Returns the blas-conform storage convention. The elements are stored in columnmajor form, i.e. the elements are stored columnwise.

Returns
CblasColMajor.
template<class AT >
const CBLAS_UPLO fmatvec::Matrix< Symmetric, Ref, Ref, AT >::blasUplo ( ) const
inline

Symmetry convention.

Returns the blas-conform symmetry convention. The elements are stored in the lower triangular part of the array,

Returns
CblasLower.
template<class AT >
int fmatvec::Matrix< Symmetric, Ref, Ref, AT >::cols ( ) const
inline

Number of columns.

Returns
The number of columns of the matrix
template<class AT >
Matrix< Symmetric, Ref, Ref, AT > fmatvec::Matrix< Symmetric, Ref, Ref, AT >::copy ( ) const
inline

Matrix duplicating.

The calling matrix returns a deep copy of itself.

Returns
The duplicate.
template<class AT >
Matrix< Symmetric, Ref, Ref, AT > & fmatvec::Matrix< Symmetric, Ref, Ref, AT >::init ( const AT &  a)
inline

Initialization.

Initializes all elements of the calling matrix with the value given by a.

Parameters
aValue all elements will be initialized with.
Returns
A reference to the calling matrix.
template<class AT >
int fmatvec::Matrix< Symmetric, Ref, Ref, AT >::ldim ( ) const
inline

Leading dimension.

Returns
The leading dimension of the matrix
template<class AT >
fmatvec::Matrix< Symmetric, Ref, Ref, AT >::operator std::vector< std::vector< AT > > ( )
inline

Cast to std::vector<std::vector<AT> >.

Returns
The std::vector<std::vector<AT> > representation of the matrix
template<class AT >
AT& fmatvec::Matrix< Symmetric, Ref, Ref, AT >::operator() ( int  i,
int  j 
)
inline

Element operator.

Returns a reference to the element in the i-th row and the j-th column.

Parameters
iThe i-th row of the matrix
jThe j-th column of the matrix
Returns
A reference to the element A(i,j).
Remarks
The bounds are checked by default. To change this behavior, define FMATVEC_NO_BOUNDS_CHECK.
See Also
operator()(int,int) const
template<class AT >
const AT& fmatvec::Matrix< Symmetric, Ref, Ref, AT >::operator() ( int  i,
int  j 
) const
inline

Element operator.

See operator()(int,int)

template<class AT >
AT* fmatvec::Matrix< Symmetric, Ref, Ref, AT >::operator() ( )
inline

Pointer operator.

Returns the pointer to the first element.

Returns
The pointer to the first element.
template<class AT >
const AT* fmatvec::Matrix< Symmetric, Ref, Ref, AT >::operator() ( ) const
inline

Pointer operator.

See operator()()

template<class AT >
Matrix< General, Ref, Ref, AT > fmatvec::Matrix< Symmetric, Ref, Ref, AT >::operator() ( const Index I,
const Index J 
)
inline

Submatrix operator.

Returns a submatrix of the calling matrix. To preserve the symmetry of the calling matrix, the submatrix is limited to the lower and the upper triangular part of the matrix.

Attention
The submatrix and the calling matrix will share the same physical memory.
Parameters
IIndex containing the starting and the ending row.
JIndex containing the starting and the ending column.
Returns
A submatrix of the calling matrix.
template<class AT >
const Matrix< General, Ref, Ref, AT > fmatvec::Matrix< Symmetric, Ref, Ref, AT >::operator() ( const Index I,
const Index J 
) const
inline

Submatrix operator.

See operator()(const Index&, const Index&)

template<class AT >
Matrix< Symmetric, Ref, Ref, AT > fmatvec::Matrix< Symmetric, Ref, Ref, AT >::operator() ( const Index I)
inline

Submatrix operator.

Returns a submatrix of the calling matrix. To preserve the symmetry of the calling matrix, the submatrix is limited to the lower and the upper triangular part of the matrix.

Attention
The submatrix and the calling matrix will share the same physical memory.
Parameters
IIndex containing the starting and the ending row and column.
Returns
A submatrix of the calling matrix.
template<class AT >
const Matrix< Symmetric, Ref, Ref, AT > fmatvec::Matrix< Symmetric, Ref, Ref, AT >::operator() ( const Index I) const
inline

Submatrix operator.

See operator()(const Index&)

template<class AT >
Matrix< General, Ref, Ref, AT > fmatvec::Matrix< Symmetric, Ref, Ref, AT >::operator() ( int  i1,
int  j1,
int  i2,
int  j2 
)
inline

Submatrix operator.

Returns a submatrix of the calling matrix.

Attention
The submatrix and the calling matrix will share the same physical memory.
Parameters
i1The starting row.
j1The starting column.
i2The ending row.
j2The ending column.
Returns
A submatrix of the calling matrix.
template<class AT >
const Matrix< General, Ref, Ref, AT > fmatvec::Matrix< Symmetric, Ref, Ref, AT >::operator() ( int  i1,
int  j1,
int  i2,
int  j2 
) const
inline

Submatrix operator.

See operator()(int,int,int,int);

template<class AT >
template<class Type , class Row , class Col >
Matrix< Symmetric, Ref, Ref, AT > & fmatvec::Matrix< Symmetric, Ref, Ref, AT >::operator<< ( const Matrix< Type, Row, Col, AT > &  A)
inline

Copy operator.

Copies the symmetric matrix given by A.

Parameters
AThe matrix to be copied.
Returns
A reference to the calling matrix.
template<class AT >
Matrix< Symmetric, Ref, Ref, AT > & fmatvec::Matrix< Symmetric, Ref, Ref, AT >::operator= ( const Matrix< Symmetric, Ref, Ref, AT > &  A)
inline

Assignment operator.

Copies the symmetric matrix given by A by calling operator<<().

Parameters
AThe matrix to be assigned.
Returns
A reference to the calling matrix.
Remarks
To call operator>>() by default, define FMATVEC_NO_DEEP_ASSIGNMENT
See Also
operator<<(), operator>>()
template<class AT >
Matrix< Symmetric, Ref, Ref, AT > & fmatvec::Matrix< Symmetric, Ref, Ref, AT >::operator>> ( const Matrix< Symmetric, Ref, Ref, AT > &  A)
inline

Reference operator.

References the symmetric matrix given by A.

Parameters
AThe matrix to be referenced.
Returns
A reference to the calling matrix.
template<class AT >
int fmatvec::Matrix< Symmetric, Ref, Ref, AT >::rows ( ) const
inline

Number of rows.

Returns
The number of rows of the matrix
template<class AT >
int fmatvec::Matrix< Symmetric, Ref, Ref, AT >::size ( ) const
inline

Size.

Returns
The number of rows and columns of the matrix

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

Impressum / Disclaimer / Datenschutz Generated by doxygen 1.8.5 Valid HTML