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

This is a rowvector class of general shape in dense storage format. More...

#include <row_vector.h>

Inheritance diagram for fmatvec::RowVector< Ref, AT >:
fmatvec::Matrix< General, Ref, Ref, AT >

Public Member Functions

 RowVector ()
 Standard constructor. More...
 
 RowVector (int n, Noinit ini)
 
 RowVector (int n, Init ini=INIT, const AT &a=0)
 
 RowVector (int n, AT *ele)
 Regular Constructor. More...
 
 RowVector (const char *str)
 String Constructor. More...
 
 RowVector (const Matrix< General, Ref, Ref, AT > &x)
 Copy Constructor. More...
 
RowVector< Ref, AT > & resize ()
 
RowVector< Ref, AT > & resize (int n, Noinit)
 
RowVector< Ref, AT > & resize (int n, Init ini=INIT, const AT &a=0)
 
 RowVector (const RowVector< Ref, AT > &x)
 Copy Constructor. More...
 
RowVector< Ref, AT > & operator<< (const RowVector< Ref, AT > &x)
 Copy operator. More...
 
RowVector< Ref, AT > & operator>> (const RowVector< Ref, AT > &x)
 Reference operator. More...
 
RowVector< Ref, AT > & operator= (const RowVector< Ref, AT > &x)
 Assignment operator. More...
 
template<class Row >
RowVector< Ref, AT > & operator= (const RowVector< Row, AT > &x)
 
AT & operator() (int i)
 Element operator. More...
 
const AT & operator() (int i) const
 Element operator. More...
 
AT & er (int i)
 
const AT & er (int i) const
 
AT & et (int i)
 
const AT & et (int i) const
 
AT & e (int i)
 
const AT & e (int i) const
 
RowVector< Ref, AT > & init (const AT &a)
 Initialization. More...
 
RowVector< Ref, AT > & init (Init, const AT &a=0)
 
RowVector< Ref, AT > & init (Noinit, const AT &a=0)
 
int size () const
 Size. More...
 
int inc () const
 Increment. More...
 
RowVector< Ref, AT > copy () const
 Rowvector duplicating. More...
 
RowVector< Ref, AT > operator() (int i1, int i2)
 Subrowvector operator. More...
 
const RowVector< Ref, AT > operator() (int i1, int i2) const
 Subvector operator. More...
 
RowVector< Ref, AT > operator() (const Index &I)
 Subrowvector operator. More...
 
const RowVector< Ref, AT > operator() (const Index &I) const
 Subrowvector operator. More...
 
Vector< Ref, AT > T ()
 
const Vector< Ref, AT > T () const
 
- Public Member Functions inherited from fmatvec::Matrix< General, Ref, Ref, AT >
 Matrix ()
 Standard constructor. More...
 
 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, Ref, Ref, AT > &A)
 Copy Constructor. More...
 
 Matrix (int m_, int n_, AT *ele_)
 Regular Constructor. More...
 
 Matrix (const char *str)
 String Constructor. More...
 
 ~Matrix ()
 Destructor.
 
template<class Type , class Row , class Col >
 Matrix (const Matrix< Type, Row, Col, AT > &A)
 
Matrix< General, Ref, Ref, AT > & resize ()
 
Matrix< General, Ref, Ref, AT > & resize (int m_, int n_, Noinit)
 
Matrix< General, Ref, Ref, AT > & resize (int m, int n, Init ini=INIT, const AT &a=0)
 
Matrix< General, Ref, Ref, AT > & resize (int m, int n, Eye ini, const AT &a=1)
 
Matrix< General, Ref, Ref, AT > & operator= (const Matrix< General, Ref, Ref, AT > &A)
 Assignment operator. More...
 
template<class Type , class Row , class Col >
Matrix< General, Ref, Ref, AT > & operator= (const Matrix< Type, Row, Col, AT > &A)
 
template<class Type , class Row , class Col >
Matrix< General, Ref, Ref, AT > & operator<< (const Matrix< Type, Row, Col, AT > &A)
 Copy operator. More...
 
Matrix< General, Ref, Ref, AT > & operator>> (const Matrix< General, 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 & er (int i, int j)
 
const AT & er (int i, int j) const
 
AT & et (int i, int j)
 
const AT & et (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 rows () const
 Number of rows. More...
 
int cols () const
 Number of columns. More...
 
int ldim () const
 Leading dimension. More...
 
bool transposed () const
 Transposed status. More...
 
const CBLAS_TRANSPOSE blasTrans () const
 Transposed status. More...
 
const CBLAS_ORDER blasOrder () const
 Storage convention. 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...
 
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...
 
SquareMatrix< Ref, AT > operator() (const Index &I)
 Submatrix operator. More...
 
const SquareMatrix< Ref, AT > operator() (const Index &I) const
 Submatrix operator. More...
 
Vector< Ref, AT > col (int i)
 Column operator. More...
 
const Vector< Ref, AT > col (int i) const
 Column operator. More...
 
RowVector< Ref, AT > row (int i)
 Row operator. More...
 
const RowVector< Ref, AT > row (int i) const
 Row operator. More...
 
Matrix< General, Ref, Ref, AT > copy () const
 Matrix duplicating. More...
 
Matrix< General, Ref, Ref, AT > & init (const AT &a=0)
 Initialization. More...
 
Matrix< General, Ref, Ref, AT > & init (Init, const AT &a=0)
 
Matrix< General, Ref, Ref, AT > & init (Eye, const AT &a=1)
 
Matrix< General, Ref, Ref, AT > & init (Noinit, const AT &a=0)
 
Matrix< General, Ref, Ref, AT > & init0 (const AT &a=0)
 
Matrix< General, Ref, Ref, AT > & init0 (Init, 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...
 
Matrix< General, Ref, Ref, AT > T ()
 
const Matrix< General, Ref,
Ref, AT > 
T () const
 

Detailed Description

template<class AT>
class fmatvec::RowVector< Ref, AT >

This is a rowvector class of general shape in dense storage format.

Template class RowVector of type General,Ref,Ref,id. shape is general and storage form is dense. The template parameter AT defines the atomic type of the rowvector. Valid types are int, float, double, complex<float> and complex<double>

Constructor & Destructor Documentation

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

Standard constructor.

Constructs a rowvector with no size.

template<class AT >
fmatvec::RowVector< Ref, AT >::RowVector ( int  n,
AT *  ele 
)
inline

Regular Constructor.

Constructs a rowvector of size m with the pyhsical memory given by ele_;

Parameters
nThe size.
eleThe physical memory the rowvector will point to.
template<class AT >
fmatvec::RowVector< Ref, AT >::RowVector ( const char *  str)
inline

String Constructor.

Constructs and initializes a vector with a string in a matlab-like notation. The entries are seperated by semicolons. For example

* RowVector<double> x("[3,1,2]");
*

constructs the vector

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

Parameters
strThe string the vector will be initialized with.
template<class AT >
fmatvec::RowVector< Ref, AT >::RowVector ( const Matrix< General, Ref, Ref, AT > &  x)
inlineexplicit

Copy Constructor.

See RowVector(const RowVector<Ref,AT>&)

template<class AT >
fmatvec::RowVector< Ref, AT >::RowVector ( const RowVector< Ref, AT > &  x)
inline

Copy Constructor.

Constructs a reference to the rowvector x.

Attention
The physical memory of the rowvector x will not be copied, only referenced.
Parameters
xThe rowvector that will be referenced.

Member Function Documentation

template<class AT >
RowVector< Ref, AT > fmatvec::RowVector< Ref, AT >::copy ( ) const
inline

Rowvector duplicating.

The calling rowvector returns a deep copy of itself.

Returns
The duplicate of the calling rowvector.
template<class AT >
int fmatvec::RowVector< Ref, AT >::inc ( ) const
inline

Increment.

Todo:
Docu
Returns
The increment.
template<class AT >
RowVector< Ref, AT > & fmatvec::RowVector< Ref, AT >::init ( const AT &  a)
inline

Initialization.

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

Parameters
aValue all elements will be initialized with.
Returns
A reference to the calling rowvector.
template<class AT >
AT& fmatvec::RowVector< Ref, AT >::operator() ( int  i)
inline

Element operator.

Returns a reference to the i-th element.

Parameters
iThe i-th element.
Returns
A reference to the element x(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::RowVector< Ref, AT >::operator() ( int  i) const
inline

Element operator.

See operator()(int)

template<class AT >
RowVector< Ref, AT > fmatvec::RowVector< Ref, AT >::operator() ( int  i1,
int  i2 
)
inline

Subrowvector operator.

Returns a subrowvector of the calling rowvector.

Attention
The subrowvector and the calling rowvector will share the same physical memory.
Parameters
i1The starting element.
i2The ending element.
Returns
A subrowvector of the calling rowvector.
template<class AT >
const RowVector< Ref, AT > fmatvec::RowVector< Ref, AT >::operator() ( int  i1,
int  i2 
) const
inline

Subvector operator.

See operator()(int,int);

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

Subrowvector operator.

Returns a subrowvector of the calling rowvector.

Attention
The subrowvector and the calling rowvector will share the same physical memory.
Parameters
IIndex containing the starting and the ending element.
Returns
A subrowvector of the calling rowvector.
template<class AT >
const RowVector< Ref, AT > fmatvec::RowVector< Ref, AT >::operator() ( const Index I) const
inline

Subrowvector operator.

See operator()(const Index&)

template<class AT >
RowVector< Ref, AT > & fmatvec::RowVector< Ref, AT >::operator<< ( const RowVector< Ref, AT > &  x)
inline

Copy operator.

Copies the rowvector given by x.

Parameters
xThe rowvector to be copied.
Returns
A reference to the calling rowvector.
template<class AT >
RowVector< Ref, AT > & fmatvec::RowVector< Ref, AT >::operator= ( const RowVector< Ref, AT > &  x)
inline

Assignment operator.

Copies the rowvector given by x by calling operator<<().

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

Reference operator.

References the rowvector given by x.

Parameters
xThe rowvector to be referenced.
Returns
A reference to the calling rowvector.
template<class AT >
int fmatvec::RowVector< Ref, AT >::size ( ) const
inline

Size.

Returns
The size of the rowvector.

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

Impressum / Disclaimer / Datenschutz Generated by doxygen 1.8.5 Valid HTML