Public Member Functions
fmatvec::Matrix< Symmetric, Ref, Ref, AT > Class Template Reference

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

#include <symmetric_matrix.h>

List of all members.

Public Member Functions

 Matrix ()
 Standard constructor.
 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.
 Matrix (const Matrix< General, Ref, Ref, AT > &A)
 Element operator.
template<class Type , class Row , class Col >
 Matrix (const Matrix< Type, Row, Col, AT > &A)
 Matrix (int n_, AT *ele_)
 Regular Constructor.
 ~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.
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.
Matrix< Symmetric, Ref, Ref, AT > & operator>> (const Matrix< Symmetric, Ref, Ref, AT > &A)
 Reference operator.
AT & operator() (int i, int j)
 Element operator.
const AT & operator() (int i, int j) const
 Element operator.
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.
const AT * operator() () const
 Pointer operator.
int size () const
 Size.
int rows () const
 Number of rows.
int cols () const
 Number of columns.
int ldim () const
 Leading dimension.
const CBLAS_ORDER blasOrder () const
 Storage convention.
const CBLAS_UPLO blasUplo () const
 Symmetry convention.
Matrix< Symmetric, Ref, Ref, AT > copy () const
 Matrix duplicating.
Matrix< Symmetric, Ref, Ref, AT > & init (const AT &a)
 Initialization.
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.
const Matrix< General, Ref,
Ref, AT > 
operator() (const Index &I, const Index &J) const
 Submatrix operator.
Matrix< Symmetric, Ref, Ref, AT > operator() (const Index &I)
 Submatrix operator.
const Matrix< Symmetric, Ref,
Ref, AT > 
operator() (const Index &I) const
 Submatrix operator.
Matrix< General, Ref, Ref, AT > operator() (int i1, int j1, int i2, int j2)
 Submatrix operator.
const Matrix< General, Ref,
Ref, AT > 
operator() (int i1, int j1, int i2, int j2) const
 Submatrix operator.
 operator std::vector< std::vector< AT > > ()
 Cast to std::vector<std::vector<AT> >.

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) [inline, explicit]

Element operator.

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

References fmatvec::Matrix< General, Ref, Ref, AT >::cols(), and fmatvec::Matrix< General, Ref, Ref, AT >::rows().

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.

References fmatvec::Matrix< Type, Row, Col, AT >::cols(), and fmatvec::Matrix< Type, Row, Col, AT >::rows().

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.

References fmatvec::Index::end(), and fmatvec::Index::start().

template<class AT >
const Matrix< General, Ref, Ref, AT > fmatvec::Matrix< Symmetric, Ref, Ref, AT >::operator() ( const Index &  I,
const Index &  J 
) const [inline]
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.

References fmatvec::Index::end(), and fmatvec::Index::start().

template<class AT >
const Matrix< Symmetric, Ref, Ref, AT > fmatvec::Matrix< Symmetric, Ref, Ref, AT >::operator() ( const Index &  I) const [inline]
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.

References fmatvec::Matrix< Type, Row, Col, AT >::operator()().

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]
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.

References fmatvec::Matrix< Type, Row, Col, AT >::cols(), and fmatvec::Matrix< Type, Row, Col, AT >::rows().

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>>()

References size().

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

Referenced by operator=().


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