mds::math::CSparseMatrixIterator< M, T > Class Template Reference

Sparse matrix iterator. More...

#include <mdsSparseMatrixIterator.h>

Inheritance diagram for mds::math::CSparseMatrixIterator< M, T >:

List of all members.

Public Types
enum	{ TEMPLATE_PARAMETER_IS_NOT_SPARSE_MATRIX = M::CLASS_SPARSEMATRIX }
	Check that M is a matrix. More...
typedef CSparseMatrixIterator < M, T >	tDerived
	Iterator type.
typedef T	tElement
	Element type.
typedef CIteratorTraits < CSparseMatrixIterator< M, T > >::tItem	tItem
	Value (or item) type.
typedef M	tMatrix
	Matrix type.
Public Member Functions
void	advance ()
	Moves iterator to the next element.
bool	atEnd () const
	Returns true if the iterator points after the end.
tSize	col () const
	CSparseMatrixIterator (tMatrix &Matrix)
	Constructor.
tDerived &	getImpl ()
	Returns reference to the iterator implementation.
const tDerived &	getImpl () const
tSize	getSize () const
	Returns number of non-dominant values in the matrix.
	operator bool () const
	Returns true if the iterator is valid, i.e. not pointing after the end.
tItem &	operator* () const
	Returns reference to the current item.
CIteratorBase &	operator++ ()
CIteratorBase	operator++ (int)
tItem *	operator-> () const
	Returns pointer to the current item.
tSize	row () const
	Returns the current iterator position.
const tElement &	value () const
	Returns the current item.
tElement *	valuePtr () const
	Returns pointer to the current item.
tElement &	valueRef () const
	Returns reference to the current item.
	~CSparseMatrixIterator ()
	Destructor.
Protected Types
typedef tMatrix::InnerIterator	tInnerIterator
	Column iterator.
Protected Attributes
tInnerIterator	m_InnerIt
	Column iterator.
tMatrix &	m_Matrix
	Reference to the matrix.
tSize	m_OutIndex
	Iterator position.

---

Detailed Description

template<class M, typename T>
class mds::math::CSparseMatrixIterator< M, T >

Sparse matrix iterator.

• Semantics of the iterator differ from that of standard matrix iterator because it iterates over non-zero elements only!
• Template parameter M is the matrix type.
• Parameter T is the matrix element type.

---

Member Typedef Documentation

typedef CSparseMatrixIterator< M, T > mds::base::CIteratorBase< CSparseMatrixIterator< M, T > >::tDerived [inherited]

Iterator type.

template<class M , typename T >

typedef T mds::math::CSparseMatrixIterator< M, T >::tElement

Element type.

template<class M , typename T >

typedef tMatrix::InnerIterator mds::math::CSparseMatrixIterator< M, T >::tInnerIterator [protected]

Column iterator.

typedef CIteratorTraits<CSparseMatrixIterator< M, T > >::tItem mds::base::CIteratorBase< CSparseMatrixIterator< M, T > >::tItem [inherited]

Value (or item) type.

template<class M , typename T >

typedef M mds::math::CSparseMatrixIterator< M, T >::tMatrix

Matrix type.

---

Member Enumeration Documentation

template<class M , typename T >

anonymous enum

Check that M is a matrix.

You will see name of this enum somewhere in compiler error message if the type M is not matrix.

Enumerator:

TEMPLATE_PARAMETER_IS_NOT_SPARSE_MATRIX

---

Constructor & Destructor Documentation

template<class M , typename T >

mds::math::CSparseMatrixIterator< M, T >::CSparseMatrixIterator

(

tMatrix &

Matrix

)

Constructor.

template<class M , typename T >

mds::math::CSparseMatrixIterator< M, T >::~CSparseMatrixIterator

(

)

Destructor.

---

Member Function Documentation

template<class M , typename T >

void mds::math::CSparseMatrixIterator< M, T >::advance

(

)

Moves iterator to the next element.

template<class M , typename T >

bool mds::math::CSparseMatrixIterator< M, T >::atEnd

(

)

const

Returns true if the iterator points after the end.

template<class M , typename T >

tSize mds::math::CSparseMatrixIterator< M, T >::col

(

)

const

tDerived& mds::base::CIteratorBase< CSparseMatrixIterator< M, T > >::getImpl

(

)

[inherited]

Returns reference to the iterator implementation.

const tDerived& mds::base::CIteratorBase< CSparseMatrixIterator< M, T > >::getImpl

(

)

const [inherited]

template<class M , typename T >

tSize mds::math::CSparseMatrixIterator< M, T >::getSize

(

)

const

Returns number of non-dominant values in the matrix.

Reimplemented from mds::base::CIteratorBase< CSparseMatrixIterator< M, T > >.

mds::base::CIteratorBase< CSparseMatrixIterator< M, T > >::operator bool

(

)

const [inherited]

Returns true if the iterator is valid, i.e. not pointing after the end.

tItem& mds::base::CIteratorBase< CSparseMatrixIterator< M, T > >::operator*

(

)

const [inherited]

Returns reference to the current item.

CIteratorBase& mds::base::CIteratorBase< CSparseMatrixIterator< M, T > >::operator++

(

)

[inherited]

CIteratorBase mds::base::CIteratorBase< CSparseMatrixIterator< M, T > >::operator++

(

int

)

[inherited]

tItem* mds::base::CIteratorBase< CSparseMatrixIterator< M, T > >::operator->

(

)

const [inherited]

Returns pointer to the current item.

template<class M , typename T >

tSize mds::math::CSparseMatrixIterator< M, T >::row

(

)

const

Returns the current iterator position.

template<class M , typename T >

const tElement& mds::math::CSparseMatrixIterator< M, T >::value

(

)

const

Returns the current item.

Reimplemented from mds::base::CIteratorBase< CSparseMatrixIterator< M, T > >.

template<class M , typename T >

tElement* mds::math::CSparseMatrixIterator< M, T >::valuePtr

(

)

const

Returns pointer to the current item.

Reimplemented from mds::base::CIteratorBase< CSparseMatrixIterator< M, T > >.

template<class M , typename T >

tElement& mds::math::CSparseMatrixIterator< M, T >::valueRef

(

)

const

Returns reference to the current item.

Reimplemented from mds::base::CIteratorBase< CSparseMatrixIterator< M, T > >.

---

Member Data Documentation

template<class M , typename T >

tInnerIterator mds::math::CSparseMatrixIterator< M, T >::m_InnerIt [protected]

Column iterator.

template<class M , typename T >

tMatrix& mds::math::CSparseMatrixIterator< M, T >::m_Matrix [protected]

Reference to the matrix.

template<class M , typename T >

tSize mds::math::CSparseMatrixIterator< M, T >::m_OutIndex [protected]

Iterator position.

---

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

• mdsSparseMatrixIterator.h