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

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

#include <diagonal_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 (const Matrix< Diagonal, Ref, Ref, AT > &A)
 Copy Constructor.
 ~Matrix ()
 Destructor.
Matrix< Diagonal, Ref, Ref, AT > & resize ()
Matrix< Diagonal, Ref, Ref, AT > & resize (int n_, Noinit)
Matrix< Diagonal, Ref, Ref, AT > & resize (int n, Init ini=INIT, const AT &a=0)
Matrix< Diagonal, Ref, Ref, AT > & resize (int n, Eye ini, const AT &a=1)
Matrix< Diagonal, Ref, Ref, AT > & operator<< (const Matrix< Diagonal, Ref, Ref, AT > &A)
 Copy operator.
Matrix< Diagonal, Ref, Ref, AT > & operator>> (const Matrix< Diagonal, Ref, Ref, AT > &A)
 Reference operator.
Matrix< Diagonal, Ref, Ref, AT > & operator= (const Matrix< Diagonal, Ref, Ref, AT > &A)
 Assignment operator.
const AT & operator() (int i, int j) const
 Element operator.
const AT & operator() (int i) const
 Element operator.
AT & operator() (int i)
 Element operator.
const AT & e (int i, int j) const
const AT & e (int i) const
AT & e (int i)
const AT * operator() () const
 Pointer operator.
AT * operator() ()
 Pointer operator.
int rows () const
 Number of rows.
int cols () const
 Number of columns.
int size () const
 Number of rows and columns.
const CBLAS_ORDER blasOrder () const
 Storage convention.
Matrix< Diagonal, Ref, Ref, AT > copy () const
 Matrix duplicating.
Matrix< Diagonal, Ref, Ref, AT > & init (const AT &a=0)
 Initialization.
Matrix< Diagonal, Ref, Ref, AT > & init (Init, const AT &a=0)
Matrix< Diagonal, Ref, Ref, AT > & init (Eye, const AT &a=1)
Matrix< Diagonal, Ref, Ref, AT > & init (Noinit, const AT &a=0)
 operator std::vector< std::vector< AT > > ()
 Cast to std::vector<std::vector<AT> >.

Detailed Description

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

This is a matrix class for diagonal matrices.

Template class Matrix of shape type Diagonal. 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< Diagonal, Ref, Ref, AT >::Matrix ( ) [inline]

Standard constructor.

Construckts a matrix with no size.

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

Copy Constructor.

Constructs a reference to the diagonal matrix A.

Attention:
The physical memory of the matrix A will not be copied, only referenced.
Parameters:
AThe matrix that will be referenced.

Member Function Documentation

template<class AT >
const CBLAS_ORDER fmatvec::Matrix< Diagonal, 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 >
int fmatvec::Matrix< Diagonal, Ref, Ref, AT >::cols ( ) const [inline]

Number of columns.

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

Matrix duplicating.

The calling matrix returns a deep copy of itself.

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

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 >::rows().

template<class AT >
fmatvec::Matrix< Diagonal, Ref, Ref, AT >::operator std::vector< std::vector< AT > > ( )

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

Returns:
The std::vector<std::vector<AT> > representation of the matrix
template<class AT >
const AT& fmatvec::Matrix< Diagonal, Ref, Ref, AT >::operator() ( int  i,
int  j 
) const [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< Diagonal, Ref, Ref, AT >::operator() ( int  i) const [inline]

Element operator.

See operator()(int)

template<class AT >
AT& fmatvec::Matrix< Diagonal, Ref, Ref, AT >::operator() ( int  i) [inline]

Element operator.

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

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

Pointer operator.

See operator()()

template<class AT >
AT* fmatvec::Matrix< Diagonal, Ref, Ref, AT >::operator() ( ) [inline]

Pointer operator.

Returns the pointer to the first element.

Returns:
The pointer to the first element.
template<class AT >
Matrix< Diagonal, Ref, Ref, AT > & fmatvec::Matrix< Diagonal, Ref, Ref, AT >::operator<< ( const Matrix< Diagonal, Ref, Ref, AT > &  A) [inline]

Copy operator.

Copies the diagonal matrix given by A.

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

Assignment operator.

Copies the square 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< Diagonal, Ref, Ref, AT > & fmatvec::Matrix< Diagonal, Ref, Ref, AT >::operator>> ( const Matrix< Diagonal, Ref, Ref, AT > &  A) [inline]

Reference operator.

References the diagoanl matrix given by A.

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

Number of rows.

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

Number of rows and columns.

Returns:
The number of rows and columns of the matrix

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