mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE > Struct Template Reference

A random-access const iterator for trasversing all the elements of a matrix, left to right, top to bottom. More...

#include <mrpt/math/matrix_iterators.h>

Public Member Functions
bool	operator< (const CGenericMatrixConstIterator< MATRIXTYPE > &it2) const
bool	operator> (const CGenericMatrixConstIterator< MATRIXTYPE > &it2) const
size_t	getCol () const
size_t	getRow () const
	CGenericMatrixConstIterator ()
	CGenericMatrixConstIterator (const MATRIXTYPE &obj, size_t start_row, size_t start_col)
MATRIXTYPE::const_reference	operator* () const
CGenericMatrixConstIterator < MATRIXTYPE > &	operator++ ()
CGenericMatrixConstIterator < MATRIXTYPE >	operator++ (int)
CGenericMatrixConstIterator < MATRIXTYPE > &	operator-- ()
CGenericMatrixConstIterator < MATRIXTYPE >	operator-- (int)
CGenericMatrixConstIterator < MATRIXTYPE > &	operator+= (typename iterator_base::difference_type off)
CGenericMatrixConstIterator < MATRIXTYPE >	operator+ (typename iterator_base::difference_type off) const
CGenericMatrixConstIterator < MATRIXTYPE > &	operator-= (typename iterator_base::difference_type off)
CGenericMatrixConstIterator < MATRIXTYPE >	operator- (typename iterator_base::difference_type off) const
iterator_base::difference_type	operator- (const CGenericMatrixConstIterator< MATRIXTYPE > &it) const
MATRIXTYPE::const_reference	operator[] (typename iterator_base::difference_type off) const
bool	operator== (const CGenericMatrixConstIterator< MATRIXTYPE > &it) const
bool	operator!= (const CGenericMatrixConstIterator< MATRIXTYPE > &it) const
Private Types
typedef std::iterator < std::random_access_iterator_tag, typename MATRIXTYPE::value_type >	iterator_base
typedef MATRIXTYPE::value_type	T
	The type of the matrix elements.
Private Member Functions
void	check_limits (bool allow_end=false) const
Private Attributes
const MATRIXTYPE *	m_matrix
	A reference to the source of this iterator.
size_t	m_cur_row
size_t	m_cur_col
	The iterator points to this element.

Detailed Description

template<class MATRIXTYPE>
struct mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >

A random-access const iterator for trasversing all the elements of a matrix, left to right, top to bottom.

Only in DEBUG mode, the iterator checks for the limits of the matrix.

Note:: The size of a matrix being accessed through an iterator should NOT be modifed or the iterator will become invalid.; The end() iterator is represented by column=0, row=N_ROWS.; An excelent reference for iterators theory: http://www.cs.helsinki.fi/u/tpkarkka/alglib/k06/lectures/iterators.html

Definition at line 196 of file matrix_iterators.h.

Member Typedef Documentation

template<class MATRIXTYPE>

typedef std::iterator<std::random_access_iterator_tag,typename MATRIXTYPE::value_type> mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::iterator_base [private]

Definition at line 199 of file matrix_iterators.h.

template<class MATRIXTYPE>

typedef MATRIXTYPE::value_type mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::T [private]

The type of the matrix elements.

Definition at line 202 of file matrix_iterators.h.

Constructor & Destructor Documentation

template<class MATRIXTYPE>

mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::CGenericMatrixConstIterator ( ) [inline]

Definition at line 236 of file matrix_iterators.h.

template<class MATRIXTYPE>

mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::CGenericMatrixConstIterator	(	const MATRIXTYPE &	obj,
		size_t	start_row,
		size_t	start_col
	)			`[inline]`

Definition at line 237 of file matrix_iterators.h.

References mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::check_limits().

Member Function Documentation

template<class MATRIXTYPE>

void mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::check_limits ( bool allow_end = false ) const [inline, private]

Definition at line 204 of file matrix_iterators.h.

References ASSERTMSG_, mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::m_cur_col, mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::m_cur_row, mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::m_matrix, and THROW_EXCEPTION.

Referenced by mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::CGenericMatrixConstIterator().

template<class MATRIXTYPE>

size_t mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::getCol ( ) const [inline]

Definition at line 233 of file matrix_iterators.h.

References mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::m_cur_row.

template<class MATRIXTYPE>

size_t mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::getRow ( ) const [inline]

Definition at line 234 of file matrix_iterators.h.

template<class MATRIXTYPE>

bool mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::operator!= ( const CGenericMatrixConstIterator< MATRIXTYPE > & it ) const [inline]

Definition at line 311 of file matrix_iterators.h.

template<class MATRIXTYPE>

MATRIXTYPE::const_reference mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::operator* ( ) const [inline]

Definition at line 242 of file matrix_iterators.h.

template<class MATRIXTYPE>

CGenericMatrixConstIterator<MATRIXTYPE> mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::operator+ ( typename iterator_base::difference_type off ) const [inline]

Definition at line 287 of file matrix_iterators.h.

template<class MATRIXTYPE>

CGenericMatrixConstIterator<MATRIXTYPE> mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::operator++ ( int ) [inline]

Definition at line 251 of file matrix_iterators.h.

template<class MATRIXTYPE>

CGenericMatrixConstIterator<MATRIXTYPE>& mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::operator++ ( ) [inline]

Definition at line 246 of file matrix_iterators.h.

template<class MATRIXTYPE>

CGenericMatrixConstIterator<MATRIXTYPE>& mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::operator+= ( typename iterator_base::difference_type off ) [inline]

Definition at line 270 of file matrix_iterators.h.

References mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::m_cur_col, and mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::m_cur_row.

template<class MATRIXTYPE>

iterator_base::difference_type mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::operator- ( const CGenericMatrixConstIterator< MATRIXTYPE > & it ) const [inline]

Definition at line 300 of file matrix_iterators.h.

template<class MATRIXTYPE>

CGenericMatrixConstIterator<MATRIXTYPE> mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::operator- ( typename iterator_base::difference_type off ) const [inline]

Definition at line 295 of file matrix_iterators.h.

template<class MATRIXTYPE>

CGenericMatrixConstIterator<MATRIXTYPE> mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::operator-- ( int ) [inline]

Definition at line 265 of file matrix_iterators.h.

template<class MATRIXTYPE>

CGenericMatrixConstIterator<MATRIXTYPE>& mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::operator-- ( ) [inline]

Definition at line 256 of file matrix_iterators.h.

References mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::m_cur_col, mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::m_cur_row, and mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::m_matrix.

template<class MATRIXTYPE>

CGenericMatrixConstIterator<MATRIXTYPE>& mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::operator-= ( typename iterator_base::difference_type off ) [inline]

Definition at line 292 of file matrix_iterators.h.

template<class MATRIXTYPE>

bool mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::operator< ( const CGenericMatrixConstIterator< MATRIXTYPE > & it2 ) const [inline]

Definition at line 218 of file matrix_iterators.h.

References mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::m_cur_col, and mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::m_cur_row.

template<class MATRIXTYPE>

bool mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::operator== ( const CGenericMatrixConstIterator< MATRIXTYPE > & it ) const [inline]

Definition at line 308 of file matrix_iterators.h.

template<class MATRIXTYPE>

bool mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::operator> ( const CGenericMatrixConstIterator< MATRIXTYPE > & it2 ) const [inline]

Definition at line 225 of file matrix_iterators.h.

References mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::m_cur_col, and mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::m_cur_row.

template<class MATRIXTYPE>

MATRIXTYPE::const_reference mrpt::math::detail::CGenericMatrixConstIterator< MATRIXTYPE >::operator[] ( typename iterator_base::difference_type off ) const [inline]

Definition at line 303 of file matrix_iterators.h.