icl::math::DynColVector< T > Struct Template Reference

Extension class for the DynMatrix<T> template, that restricts the the matrix column count to 'one'. More...

#include <DynVector.h>

Inheritance diagram for icl::math::DynColVector< T >:

List of all members.

Public Member Functions
	DynColVector (const typename DynMatrix< T >::DynMatrixColumn &column)
	creates a column vector from given matrix column
	DynColVector ()
	Default empty constructor creates a null-vector.
	DynColVector (unsigned int dim, const T &initValue=0) throw (InvalidMatrixDimensionException)
	Creates a column vector with given dimension (and optional initialValue)
	DynColVector (unsigned int dim, T *data, bool deepCopy=true) throw (InvalidMatrixDimensionException)
	Create a column vector with given data.
	DynColVector (unsigned int dim, const T *data) throw (InvalidMatrixDimensionException)
	Creates column vector with given data pointer and dimsion (const version: deepCopy only)
	DynColVector (const DynMatrix< T > &other) throw (InvalidMatrixDimensionException)
	Default copy constructor (the source matrix column count must be 'one')
DynColVector< T > &	operator= (const DynMatrix< T > &other) throw (InvalidMatrixDimensionException)
	assignment operator (the rvalue's column count must be one)
void	setBounds (unsigned int dim, bool holdContent=false, const T &initializer=0) throw (InvalidMatrixDimensionException)
	adapts the vector dimension
void	setDim (unsigned int dim, bool holdContent=false, const T &initializer=0) throw (InvalidMatrixDimensionException)
	adapts the vector dimension

---

Detailed Description

template<class T>
struct icl::math::DynColVector< T >

Extension class for the DynMatrix<T> template, that restricts the the matrix column count to 'one'.

---

Constructor & Destructor Documentation

template<class T>

icl::math::DynColVector< T >::DynColVector

(

const typename DynMatrix< T >::DynMatrixColumn &

column

)

[inline]

creates a column vector from given matrix column

template<class T>

icl::math::DynColVector< T >::DynColVector

(

)

[inline]

Default empty constructor creates a null-vector.

template<class T>

icl::math::DynColVector< T >::DynColVector	(	unsigned int	dim,
		const T &	initValue = 0
	)		throw (InvalidMatrixDimensionException) [inline]

Creates a column vector with given dimension (and optional initialValue)

template<class T>

icl::math::DynColVector< T >::DynColVector	(	unsigned int	dim,
		T *	data,
		bool	deepCopy = true
	)		throw (InvalidMatrixDimensionException) [inline]

Create a column vector with given data.

Data can be wrapped deeply or shallowly. If the latter is true, given data pointer will not be released in the destructor, i.e. the data ownership is not passed to the DynColumnVector instance

template<class T>

icl::math::DynColVector< T >::DynColVector	(	unsigned int	dim,
		const T *	data
	)		throw (InvalidMatrixDimensionException) [inline]

Creates column vector with given data pointer and dimsion (const version: deepCopy only)

template<class T>

icl::math::DynColVector< T >::DynColVector

(

const DynMatrix< T > &

other

)

throw (InvalidMatrixDimensionException) [inline]

Default copy constructor (the source matrix column count must be 'one')

---

Member Function Documentation

template<class T>

DynColVector<T>& icl::math::DynColVector< T >::operator=

(

const DynMatrix< T > &

other

)

throw (InvalidMatrixDimensionException) [inline]

assignment operator (the rvalue's column count must be one)

Reimplemented from icl::math::DynMatrix< T >.

template<class T>

void icl::math::DynColVector< T >::setBounds	(	unsigned int	dim,
		bool	holdContent = false,
		const T &	initializer = 0
	)		throw (InvalidMatrixDimensionException) [inline]

adapts the vector dimension

overwrites setBounds from the parent matrix class to prevent the vector from being resized to matrix bounds

template<class T>

void icl::math::DynColVector< T >::setDim	(	unsigned int	dim,
		bool	holdContent = false,
		const T &	initializer = 0
	)		throw (InvalidMatrixDimensionException) [inline]

adapts the vector dimension

---

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

• /home/jenkins/workspace/icl-manual-trunk/icl-manual/ICLMath/src/ICLMath/DynVector.h