Public Member Functions
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 >

List of all members.

Public Member Functions

 RowVector ()
 Standard constructor.
 RowVector (int n, Noinit ini)
 RowVector (int n, Init ini=INIT, const AT &a=0)
 RowVector (int n, AT *ele)
 Regular Constructor.
 RowVector (const char *str)
 String Constructor.
 RowVector (const Matrix< General, Ref, Ref, AT > &x)
 Copy Constructor.
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.
RowVector< Ref, AT > & operator<< (const RowVector< Ref, AT > &x)
 Copy operator.
RowVector< Ref, AT > & operator>> (const RowVector< Ref, AT > &x)
 Reference operator.
RowVector< Ref, AT > & operator= (const RowVector< Ref, AT > &x)
 Assignment operator.
template<class Row >
RowVector< Ref, AT > & operator= (const RowVector< Row, AT > &x)
AT & operator() (int i)
 Element operator.
const AT & operator() (int i) const
 Element operator.
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.
RowVector< Ref, AT > & init (Init, const AT &a=0)
RowVector< Ref, AT > & init (Noinit, const AT &a=0)
int size () const
 Size.
int inc () const
 Increment.
RowVector< Ref, AT > copy () const
 Rowvector duplicating.
RowVector< Ref, AT > operator() (int i1, int i2)
 Subrowvector operator.
const RowVector< Ref, AT > operator() (int i1, int i2) const
 Subvector operator.
RowVector< Ref, AT > operator() (const Index &I)
 Subrowvector operator.
const RowVector< Ref, AT > operator() (const Index &I) const
 Subrowvector operator.
Vector< Ref, AT > T ()
const Vector< 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) [inline, explicit]
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.

Reimplemented from fmatvec::Matrix< General, Ref, Ref, AT >.

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.

Reimplemented from fmatvec::Matrix< General, Ref, Ref, AT >.

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.

Reimplemented from fmatvec::Matrix< General, Ref, Ref, AT >.

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

Subvector operator.

See operator()(int,int);

Reimplemented from fmatvec::Matrix< General, Ref, Ref, AT >.

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.

Reimplemented from fmatvec::Matrix< General, Ref, Ref, AT >.

References fmatvec::Index::end(), and fmatvec::Index::start().

template<class AT >
const RowVector< Ref, AT > fmatvec::RowVector< Ref, AT >::operator() ( const Index &  I) const [inline]
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.

References size().

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>>()

References size().

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.

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


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