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

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

#include <vector.h>

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

Public Member Functions

 Vector ()
 Standard constructor. More...
 
 Vector (int m, Noinit ini)
 
 Vector (int m, Init ini=INIT, const AT &a=0)
 
 Vector (int m, AT *ele)
 Regular Constructor. More...
 
 Vector (const char *str)
 String Constructor. More...
 
 Vector (const Vector< Ref, AT > &x)
 Copy Constructor. More...
 
template<class Row >
 Vector (const Vector< Row, AT > &x)
 
template<class Type , class Row , class Col >
 Vector (const Matrix< Type, Row, Col, AT > &x)
 
Vector< Ref, AT > & resize ()
 
Vector< Ref, AT > & resize (int m, Noinit)
 
Vector< Ref, AT > & resize (int m, Init ini=INIT, const AT &a=0)
 
template<class Row >
Vector< Ref, AT > & operator<< (const Vector< Row, AT > &x)
 Copy operator. More...
 
Vector< Ref, AT > & operator>> (const Vector< Ref, AT > &x)
 Reference operator. More...
 
Vector< Ref, AT > & operator>> (const Matrix< General, Ref, Ref, AT > &A)
 
Vector< Ref, AT > & operator= (const Vector< Ref, AT > &x)
 Assignment operator. More...
 
template<class Row >
Vector< Ref, AT > & operator= (const Vector< 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
 
Vector< Ref, AT > & init (const AT &a=0)
 Initialization. More...
 
Vector< Ref, AT > & init (Init, const AT &a=0)
 
Vector< Ref, AT > & init (Noinit, const AT &a=0)
 
int size () const
 Size. More...
 
int inc () const
 Increment. More...
 
Vector< Ref, AT > copy () const
 Vector duplicating. More...
 
Vector< Ref, AT > operator() (int i1, int i2)
 Subvector operator. More...
 
const Vector< Ref, AT > operator() (int i1, int i2) const
 Subvector operator. More...
 
Vector< Ref, AT > operator() (const Index &I)
 Subvector operator. More...
 
const Vector< Ref, AT > operator() (const Index &I) const
 Subvector operator. More...
 
 operator std::vector< AT > ()
 Cast to std::vector<AT>. More...
 
 Vector (std::vector< AT > v)
 std::vector<AT> Constructor. Constructs and initializes a vector with a std::vector<AT> object. More...
 
RowVector< Ref, AT > T ()
 
const RowVector< 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::Vector< Ref, AT >

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

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

Constructor & Destructor Documentation

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

Standard constructor.

Constructs a vector with no size.

template<class AT >
fmatvec::Vector< Ref, AT >::Vector ( int  m,
AT *  ele 
)
inline

Regular Constructor.

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

Parameters
mThe size.
eleThe physical memory the vector will point to.
template<class AT >
fmatvec::Vector< Ref, AT >::Vector ( 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

* Vector<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::Vector< Ref, AT >::Vector ( const Vector< Ref, AT > &  x)
inline

Copy Constructor.

Constructs a reference to the vector x.

Attention
The physical memory of the vector x will not be copied, only referenced.
Parameters
xThe vector that will be referenced.
template<class AT >
fmatvec::Vector< Ref, AT >::Vector ( std::vector< AT >  v)
inline

std::vector<AT> Constructor. Constructs and initializes a vector with a std::vector<AT> object.

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

Member Function Documentation

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

Vector duplicating.

The calling vector returns a deep copy of itself.

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

Increment.

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

Initialization.

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

Parameters
aValue all elements will be initialized with.
Returns
A reference to the calling vector.
template<class AT >
fmatvec::Vector< Ref, AT >::operator std::vector< AT > ( )
inline

Cast to std::vector<AT>.

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

Element operator.

See operator()(int)

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

Subvector operator.

Returns a subvector of the calling vector.

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

Subvector operator.

See operator()(int,int);

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

Subvector operator.

Returns a subvector of the calling vector.

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

Subvector operator.

See operator()(const Index&)

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

Copy operator.

Copies the vector given by x.

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

Assignment operator.

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

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

Reference operator.

References the vector given by x.

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

Size.

Returns
The size of the vector.

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

Impressum / Disclaimer / Datenschutz Generated by doxygen 1.8.5 Valid HTML