Public Member Functions
fmatvec::Matrix< Diagonal, 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_)
 Regular Constructor.
Matrix< Diagonal, AT > & resize (int n_)
 Matrix resizing.
Matrix< Diagonal, AT > & resize (int n_, Initialization ini, const AT &a=0)
 Matrix resizing.
 Matrix (int n_, Initialization ini, const AT &a=0)
 Regular Constructor.
 Matrix (const Matrix< Diagonal, AT > &A)
 Copy Constructor.
 ~Matrix ()
 Destructor.
Matrix< Diagonal, AT > & operator<< (const Matrix< Diagonal, AT > &A)
 Copy operator.
Matrix< Diagonal, AT > & operator>> (const Matrix< Diagonal, AT > &A)
 Reference operator.
Matrix< Diagonal, AT > & operator= (const Matrix< Diagonal, 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 * 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, AT > copy () const
 Matrix duplicating.
Matrix< Diagonal, AT > & init (const AT &a)
 Initialization.
 operator std::vector< std::vector< AT > > ()
 Cast to std::vector<std::vector<AT> >.

Detailed Description

template<class AT>
class fmatvec::Matrix< Diagonal, 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, AT >::Matrix ( )
inline

Standard constructor.

Construckts a matrix with no size.

template<class AT >
fmatvec::Matrix< Diagonal, AT >::Matrix ( int  n_)
inline

Regular Constructor.

Constructs a diagonal matrix of size n x n.

Parameters:
n_The number of rows and columns.
Remarks:
The matrix will be initialised to zero by default. This default behavior can be changed by defining FMATVEC_NO_INITIALIZATION.
template<class AT >
fmatvec::Matrix< Diagonal, AT >::Matrix ( int  n_,
Initialization  ini,
const AT &  a = 0 
)
inline

Regular Constructor.

Constructs a diagonal matrix of size n x n. The matrix will be initialized to the value given by a (default 0), if ini is set to INIT. If init is set to NONINIT, the matrix will not be initialized.

Parameters:
n_The number of rows and columns.
iniINIT means initialization, NONINIT means no initialization.
aThe value, the matrix will be initialized with (default 0)
template<class AT >
fmatvec::Matrix< Diagonal, AT >::Matrix ( const Matrix< Diagonal, 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, 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, AT >::cols ( ) const
inline

Number of columns.

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

Matrix duplicating.

The calling matrix returns a deep copy of itself.

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

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

template<class AT >
fmatvec::Matrix< Diagonal, 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, 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, AT >::operator() ( int  i) const
inline

Element operator.

See operator()(int)

template<class AT >
AT& fmatvec::Matrix< Diagonal, 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, AT >::operator() ( ) const
inline

Pointer operator.

See operator()()

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

Pointer operator.

Returns the pointer to the first element.

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

Copy operator.

Copies the diagonal matrix given by A.

Parameters:
AThe matrix to be copied.
Returns:
A reference to the calling matrix.

References resize(), and size().

template<class AT >
Matrix<Diagonal, AT>& fmatvec::Matrix< Diagonal, AT >::operator= ( const Matrix< Diagonal, 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>>()

References fmatvec::operator<<(), and fmatvec::operator>>().

template<class AT >
Matrix< Diagonal, AT > & fmatvec::Matrix< Diagonal, AT >::operator>> ( const Matrix< Diagonal, AT > &  A)

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 >
Matrix<Diagonal, AT>& fmatvec::Matrix< Diagonal, AT >::resize ( int  n_)
inline

Matrix resizing.

Resizes the matrix to size n x n.

Parameters:
n_The number of rows and columns.
Returns:
A reference to the calling matrix.
Remarks:
The matrix will be initialised to zero by default. To change this behavior, define FMATVEC_NO_INITIALIZATION.

References resize().

Referenced by operator<<(), and resize().

template<class AT >
Matrix<Diagonal, AT>& fmatvec::Matrix< Diagonal, AT >::resize ( int  n_,
Initialization  ini,
const AT &  a = 0 
)
inline

Matrix resizing.

Resizes the matrix to size n x n. The matrix will be initialized to the value given by a (default 0), if ini is set to INIT. If init is set to NONINIT, the matrix will not be initialized.

Parameters:
n_The number of rows and columns.
iniINIT means initialization, NONINIT means no initialization.
aThe value, the matrix will be initialized with (default 0)
Returns:
A reference to the calling matrix.

References resize().

template<class AT >
int fmatvec::Matrix< Diagonal, AT >::rows ( ) const
inline

Number of rows.

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

Number of rows and columns.

Returns:
The number of rows and columns of the matrix

Referenced by operator<<().


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