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

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

#include <fixed_var_general_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< General, Fixed< M >, Var, AT > &A)
 Copy Constructor. More...
 
template<class Row , class Col >
 Matrix (const Matrix< General, Row, Col, AT > &A)
 
template<class Type , class Row , class Col >
 Matrix (const Matrix< Type, Row, Col, AT > &A)
 
 Matrix (const char *str)
 String Constructor. More...
 
 ~Matrix ()
 Destructor.
 
Matrix< General, Fixed< M >
, Var, AT > & 
resize ()
 
Matrix< General, Fixed< M >
, Var, AT > & 
resize (int n, Noinit)
 
Matrix< General, Fixed< M >
, Var, AT > & 
resize (int n, Init ini=INIT, const AT &a=0)
 
Matrix< General, Fixed< M >
, Var, AT > & 
resize (int n, Eye ini, const AT &a=1)
 
Matrix< General, Fixed< M >
, Var, AT > & 
operator= (const Matrix< General, Fixed< M >, Var, AT > &A)
 Assignment operator. More...
 
template<class Type , class Row , class Col >
Matrix< General, Fixed< M >
, Var, AT > & 
operator= (const Matrix< Type, Row, Col, AT > &A)
 
template<class Type , class Row , class Col >
Matrix< General, Fixed< M >
, Var, AT > & 
operator<< (const Matrix< Type, Row, Col, AT > &A)
 
AT & operator() (int i, int j)
 Element operator. More...
 
const AT & operator() (int i, int j) const
 Element operator. More...
 
AT & e (int i, int j)
 
const AT & e (int i, int j) const
 Element operator. More...
 
AT & e (int i)
 
const AT & e (int i) const
 Element operator. More...
 
AT * operator() ()
 Pointer operator. More...
 
const AT * operator() () const
 Pointer operator. More...
 
int rows () const
 Number of rows. More...
 
int cols () const
 Number of columns. More...
 
int ldim () const
 Leading dimension. More...
 
const CBLAS_TRANSPOSE blasTrans () const
 Transposed status. More...
 
const CBLAS_ORDER blasOrder () const
 Storage convention. More...
 
const Matrix< General, Var,
Var, AT > 
operator() (const Range< Var, Var > &I, const Range< Var, Var > &J) const
 Submatrix operator. More...
 
template<int M1, int M2>
const Matrix< General, Fixed
< M2-M1+1 >, Var, AT > 
operator() (const Range< Fixed< M1 >, Fixed< M2 > > &I, const Range< Var, Var > &J) const
 
const RowVector< Var, AT > row (int j) const
 
const Vector< Fixed< M >, AT > col (int j) const
 
Matrix< General, Fixed< M >
, Var, AT > & 
init (const AT &a=0)
 Initialization. More...
 
Matrix< General, Fixed< M >
, Var, AT > & 
init (Init, const AT &a=0)
 
Matrix< General, Fixed< M >
, Var, AT > & 
init (Eye, const AT &a=1)
 
Matrix< General, Fixed< M >
, Var, AT > & 
init (Noinit, const AT &a=0)
 
 operator std::vector< std::vector< AT > > ()
 Cast to std::vector<std::vector<AT> >. More...
 
 Matrix (std::vector< std::vector< AT > > m)
 std::vector<std::vector<AT> > Constructor. Constructs and initializes a matrix with a std::vector<std::vector<AT> > object. An assert checks for constant length of each row. More...
 
const Matrix< General, Var,
Fixed< M >, AT > 
T () const
 
template<class Row >
void set (int j, const Vector< Row, AT > &x)
 
template<class Col >
void set (int i, const RowVector< Col, AT > &x)
 
template<class Type , class Row , class Col >
void set (const Range< Var, Var > &I, const Range< Var, Var > &J, const Matrix< Type, Row, Col, AT > &A)
 
template<class Row >
void add (int j, const Vector< Row, AT > &x)
 
template<class Col >
void add (int i, const RowVector< Col, AT > &x)
 
template<class Type , class Row , class Col >
void add (const Range< Var, Var > &I, const Range< Var, Var > &J, const Matrix< Type, Row, Col, AT > &A)
 

Detailed Description

template<int M, class AT>
class fmatvec::Matrix< General, Fixed< M >, Var, AT >

This is a matrix class for general matrices.

Template class Matrix with shape type GeneralFixed and atomic type AT. The storage form is dense. 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<int M, class AT >
fmatvec::Matrix< General, Fixed< M >, Var, AT >::Matrix ( )
inline

Standard constructor.

Constructs a matrix with no size.

template<int M, class AT >
fmatvec::Matrix< General, Fixed< M >, Var, AT >::Matrix ( const Matrix< General, Fixed< M >, Var, 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<int M, class AT >
fmatvec::Matrix< General, Fixed< M >, Var, AT >::Matrix ( const char *  str)

String Constructor.

Constructs and initializes a matrix with a string in a matlab-like notation. The rows are seperated by semicolons, the columns by commas. For example

* Matrix<GeneralFixed,double> A("[3,2;1,2]");
*

constructs the matrix

\[ A=\begin{pmatrix}3 & 2\\ 1 & 2\end{pmatrix} \]

Parameters
strThe string the matrix will be initialized with.
template<int M, class AT >
fmatvec::Matrix< General, Fixed< M >, Var, AT >::Matrix ( std::vector< std::vector< AT > >  m)
inline

std::vector<std::vector<AT> > Constructor. Constructs and initializes a matrix with a std::vector<std::vector<AT> > object. An assert checks for constant length of each row.

Parameters
mThe std::vector<std::vector<AT> > the matrix will be initialized with.

Member Function Documentation

template<int M, class AT >
const CBLAS_ORDER fmatvec::Matrix< General, Fixed< M >, Var, 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<int M, class AT >
const CBLAS_TRANSPOSE fmatvec::Matrix< General, Fixed< M >, Var, AT >::blasTrans ( ) const
inline

Transposed status.

Returns the blas-conform transposed status.

Returns
CblasTrans if the matrix is in transposed form, CblasNoTrans otherwise.
template<int M, class AT >
int fmatvec::Matrix< General, Fixed< M >, Var, AT >::cols ( ) const
inline

Number of columns.

Returns
The number of columns of the matrix.
template<int M, class AT >
const AT& fmatvec::Matrix< General, Fixed< M >, Var, AT >::e ( int  i,
int  j 
) const
inline

Element operator.

See e(int,int)

template<int M, class AT >
const AT& fmatvec::Matrix< General, Fixed< M >, Var, AT >::e ( int  i) const
inline

Element operator.

See e(int,int)

template<int M, class AT >
Matrix< General, Fixed< M >, Var, AT > & fmatvec::Matrix< General, Fixed< M >, Var, AT >::init ( const AT &  a = 0)
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<int M, class AT >
int fmatvec::Matrix< General, Fixed< M >, Var, AT >::ldim ( ) const
inline

Leading dimension.

Returns
The leading dimension of the matrix
template<int M, class AT >
fmatvec::Matrix< General, Fixed< M >, Var, 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<int M, class AT >
AT& fmatvec::Matrix< General, Fixed< M >, Var, 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<int M, class AT >
const AT& fmatvec::Matrix< General, Fixed< M >, Var, AT >::operator() ( int  i,
int  j 
) const
inline

Element operator.

See operator()(int,int)

template<int M, class AT >
AT* fmatvec::Matrix< General, Fixed< M >, Var, AT >::operator() ( )
inline

Pointer operator.

Returns the pointer to the first element.

Returns
The pointer to the first element.
template<int M, class AT >
const AT* fmatvec::Matrix< General, Fixed< M >, Var, AT >::operator() ( ) const
inline

Pointer operator.

See operator()()

template<int M, class AT >
const Matrix< General, Var, Var, AT > fmatvec::Matrix< General, Fixed< M >, Var, AT >::operator() ( const Range< Var, Var > &  I,
const Range< Var, Var > &  J 
) const
inline

Submatrix operator.

Returns a submatrix of the calling matrix. For example

* B = A(Range<Var,Var>(1,2),Range<Var,Var>(2,4));
*

yields

\[ A=\begin{pmatrix} a_{00} & a_{01} & a_{02} & a_{03} & a_{04}\\ a_{10} & a_{11} & a_{12} & a_{13} & a_{14}\\ a_{20} & a_{21} & a_{22} & a_{23} & a_{24}\\ a_{30} & a_{31} & a_{32} & a_{33} & a_{34} \end{pmatrix}\quad \Rightarrow \quad B=\begin{pmatrix} a_{12} & a_{13} & a_{14}\\ a_{22} & a_{23} & a_{24} \end{pmatrix} \]

Attention
The submatrix and the calling matrix will share the same physical memory.
Parameters
IRange<Var,Var> containing the starting and the ending row.
JRange<Var,Var> containing the starting and the ending column.
Returns
A submatrix of the calling matrix.

Submatrix operator.

See operator()(const Range<Var,Var>&, const Range<Var,Var>&)

template<int M, class AT >
Matrix< General, Fixed< M >, Var, AT > & fmatvec::Matrix< General, Fixed< M >, Var, AT >::operator= ( const Matrix< General, Fixed< M >, Var, AT > &  A)
inline

Assignment operator.

Copies the matrix given by A.

Parameters
AThe matrix to be assigned.
Returns
A reference to the calling matrix.
template<int M, class AT >
int fmatvec::Matrix< General, Fixed< M >, Var, AT >::rows ( ) const
inline

Number of rows.

Returns
The number of rows 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