#include <matrixIterator.hh>

Inheritance diagram for concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >:

Classes
struct	MatrixType
	Non-constant matrix for non-constant iterator. More...

struct	MatrixType< _Tp_, const _Tp_ &, const _Tp_ * >
	Constant matrix for constant iterator. More...

Public Types
typedef _Matrix_iterator< _Tp, _Tp &, _Tp * >	iterator

typedef _Matrix_iterator< _Tp, const _Tp &, const _Tp * >	const_iterator

typedef std::random_access_iterator_tag	iterator_category

typedef _Tp	value_type

typedef _Ptr	pointer

typedef _Ref	reference

typedef size_t	size_type

typedef ptrdiff_t	difference_type

typedef _Matrix_iterator	_Self

typedef _Matrix_iterator_base< _Tp, _Ref, _Ptr >	_Base

typedef MatrixType< _Tp, _Ref, _Ptr >::type	matrix_type

typedef _Base::return_type	return_type

Public Member Functions
	_Matrix_iterator (matrix_type &m, const unsigned int r=0, const unsigned int c=0)

	_Matrix_iterator ()
	Constructor. Iterator stands at the end of any matrix.

template<class _RefR , class _PtrR >
	_Matrix_iterator (const _Matrix_iterator< _Tp, _RefR, _PtrR > &__x)
	Copy constructor. Also from iterator to constant iterator.

return_type	operator* () const
	Dereferencation.

pointer	operator-> () const

matrix_type *	matrix () const
	Pointer to the matrix, needed for copy constructor.

_Self &	operator= (const iterator &__x)
	Assignment.

_Self &	operator++ ()

_Self	operator++ (int)

_Self &	operator-- ()

_Self	operator-- (int)

_Self &	operator+= (difference_type __n)

_Self	operator+ (difference_type __n) const

_Self &	operator-= (difference_type __n)

_Self	operator- (difference_type __n) const

return_type	operator[] (difference_type __n) const

const unsigned int	nofRows () const
	Number of rows.

const unsigned int	nofCols () const
	Number of columns.

unsigned int	row () const
	Row.

unsigned int	col () const
	Column.

bool	last () const
	Returns true, if iterator is behind the last entry.

Protected Member Functions
virtual std::ostream &	info (std::ostream &os) const
	Returns information in an output stream.

Protected Attributes
const unsigned int	nofRows_
	Number of rows and columns.

const unsigned int	nofCols_

unsigned int	row_
	Current row and column.

unsigned int	col_

bool	last_
	Iterator is behind the last entrance.

Detailed Description

template<class _Tp, class _Ref, class _Ptr>
class concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >

STL iterator for matrices

Author: Kersten Schmidt, 2005

Definition at line 278 of file matrixIterator.hh.

Member Typedef Documentation

◆ _Base

template<class _Tp , class _Ref , class _Ptr >

typedef _Matrix_iterator_base<_Tp, _Ref, _Ptr> concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::_Base

Definition at line 293 of file matrixIterator.hh.

◆ _Self

template<class _Tp , class _Ref , class _Ptr >

typedef _Matrix_iterator concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::_Self

Definition at line 292 of file matrixIterator.hh.

◆ const_iterator

template<class _Tp , class _Ref , class _Ptr >

typedef _Matrix_iterator<_Tp, const _Tp&, const _Tp*> concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::const_iterator

Definition at line 281 of file matrixIterator.hh.

◆ difference_type

template<class _Tp , class _Ref , class _Ptr >

typedef ptrdiff_t concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::difference_type

Definition at line 291 of file matrixIterator.hh.

◆ iterator

template<class _Tp , class _Ref , class _Ptr >

typedef _Matrix_iterator<_Tp, _Tp&, _Tp*> concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::iterator

Definition at line 280 of file matrixIterator.hh.

◆ iterator_category

template<class _Tp , class _Ref , class _Ptr >

typedef std::random_access_iterator_tag concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::iterator_category

Definition at line 286 of file matrixIterator.hh.

◆ matrix_type

template<class _Tp , class _Ref , class _Ptr >

typedef MatrixType<_Tp,_Ref,_Ptr>::type concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::matrix_type

Definition at line 294 of file matrixIterator.hh.

◆ pointer

template<class _Tp , class _Ref , class _Ptr >

typedef _Ptr concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::pointer

Definition at line 288 of file matrixIterator.hh.

◆ reference

template<class _Tp , class _Ref , class _Ptr >

typedef _Ref concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::reference

Definition at line 289 of file matrixIterator.hh.

◆ return_type

template<class _Tp , class _Ref , class _Ptr >

typedef _Base::return_type concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::return_type

Definition at line 295 of file matrixIterator.hh.

◆ size_type

template<class _Tp , class _Ref , class _Ptr >

typedef size_t concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::size_type

Definition at line 290 of file matrixIterator.hh.

◆ value_type

template<class _Tp , class _Ref , class _Ptr >

typedef _Tp concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::value_type

Definition at line 287 of file matrixIterator.hh.

Constructor & Destructor Documentation

◆ _Matrix_iterator() [1/2]

template<class _Tp , class _Ref , class _Ptr >

concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::_Matrix_iterator	(	matrix_type &	m,
		const unsigned int	r = `0`,
		const unsigned int	c = `0`
	)

Constructor

Parameters

m	matrix
r	row
c	column

◆ _Matrix_iterator() [2/2]

template<class _Tp , class _Ref , class _Ptr >

template<class _RefR , class _PtrR >

concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::_Matrix_iterator ( const _Matrix_iterator< _Tp, _RefR, _PtrR > & __x )

inline

Copy constructor. Also from iterator to constant iterator.

Definition at line 308 of file matrixIterator.hh.

Member Function Documentation

◆ col()

template<class _Tp , class _Ref , class _Ptr >

unsigned int concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >::col ( ) const

inlineinherited

Column.

Definition at line 75 of file matrixIterator.hh.

◆ info()

template<class _Tp , class _Ref , class _Ptr >

virtual std::ostream & concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::info ( std::ostream & os ) const

protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >.

◆ last()

template<class _Tp , class _Ref , class _Ptr >

bool concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >::last ( ) const

inlineinherited

Returns true, if iterator is behind the last entry.

Definition at line 77 of file matrixIterator.hh.

◆ matrix()

template<class _Tp , class _Ref , class _Ptr >

matrix_type * concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::matrix ( ) const

inline

Pointer to the matrix, needed for copy constructor.

Definition at line 328 of file matrixIterator.hh.

◆ nofCols()

template<class _Tp , class _Ref , class _Ptr >

const unsigned int concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >::nofCols ( ) const

inlineinherited

Number of columns.

Definition at line 71 of file matrixIterator.hh.

◆ nofRows()

template<class _Tp , class _Ref , class _Ptr >

const unsigned int concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >::nofRows ( ) const

inlineinherited

Number of rows.

Definition at line 69 of file matrixIterator.hh.

◆ operator*()

template<class _Tp , class _Ref , class _Ptr >

return_type concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::operator* ( ) const

inline

Dereferencation.

Definition at line 312 of file matrixIterator.hh.

◆ operator+()

template<class _Tp , class _Ref , class _Ptr >

_Self concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::operator+ ( difference_type __n ) const

inline

Definition at line 394 of file matrixIterator.hh.

◆ operator++() [1/2]

template<class _Tp , class _Ref , class _Ptr >

_Self & concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::operator++ ( )

inline

Definition at line 337 of file matrixIterator.hh.

◆ operator++() [2/2]

template<class _Tp , class _Ref , class _Ptr >

_Self concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::operator++ ( int )

inline

Definition at line 347 of file matrixIterator.hh.

◆ operator+=()

template<class _Tp , class _Ref , class _Ptr >

_Self & concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::operator+= ( difference_type __n )

inline

Definition at line 375 of file matrixIterator.hh.

◆ operator-()

template<class _Tp , class _Ref , class _Ptr >

_Self concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::operator- ( difference_type __n ) const

inline

Definition at line 402 of file matrixIterator.hh.

◆ operator--() [1/2]

template<class _Tp , class _Ref , class _Ptr >

_Self & concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::operator-- ( )

inline

Definition at line 353 of file matrixIterator.hh.

◆ operator--() [2/2]

template<class _Tp , class _Ref , class _Ptr >

_Self concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::operator-- ( int )

inline

Definition at line 369 of file matrixIterator.hh.

◆ operator-=()

template<class _Tp , class _Ref , class _Ptr >

_Self & concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::operator-= ( difference_type __n )

inline

Definition at line 400 of file matrixIterator.hh.

◆ operator->()

template<class _Tp , class _Ref , class _Ptr >

pointer concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::operator-> ( ) const

inline

Returns a pointer to the value, but only valid for non-constant matrices.

This restriction comes, because the index operator of a constant matrix returns a copy and not a constant reference.

Definition at line 322 of file matrixIterator.hh.

◆ operator=()

template<class _Tp , class _Ref , class _Ptr >

_Self & concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::operator= ( const iterator & __x )

inline

Assignment.

Definition at line 331 of file matrixIterator.hh.

◆ operator[]()

template<class _Tp , class _Ref , class _Ptr >

return_type concepts::_Matrix_iterator< _Tp, _Ref, _Ptr >::operator[] ( difference_type __n ) const

inline

Definition at line 407 of file matrixIterator.hh.

◆ row()

template<class _Tp , class _Ref , class _Ptr >

unsigned int concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >::row ( ) const

inlineinherited

Row.

Definition at line 73 of file matrixIterator.hh.

Member Data Documentation

◆ col_

template<class _Tp , class _Ref , class _Ptr >

unsigned int concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >::col_

protectedinherited

Definition at line 93 of file matrixIterator.hh.

◆ last_

template<class _Tp , class _Ref , class _Ptr >

bool concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >::last_

protectedinherited

Iterator is behind the last entrance.

Definition at line 95 of file matrixIterator.hh.

◆ nofCols_

template<class _Tp , class _Ref , class _Ptr >

const unsigned int concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >::nofCols_

protectedinherited

Definition at line 91 of file matrixIterator.hh.

◆ nofRows_

template<class _Tp , class _Ref , class _Ptr >

const unsigned int concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >::nofRows_

protectedinherited

Number of rows and columns.

Definition at line 91 of file matrixIterator.hh.

◆ row_

template<class _Tp , class _Ref , class _Ptr >

unsigned int concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >::row_

protectedinherited

Current row and column.

Definition at line 93 of file matrixIterator.hh.

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

operator/matrixIterator.hh

Class documentation of Concepts

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ _Base

◆ _Self

◆ const_iterator

◆ difference_type

◆ iterator

◆ iterator_category

◆ matrix_type

◆ pointer

◆ reference

◆ return_type

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ _Matrix_iterator() [1/2]

◆ _Matrix_iterator() [2/2]

Member Function Documentation

◆ col()

◆ info()

◆ last()

◆ matrix()

◆ nofCols()

◆ nofRows()

◆ operator*()

◆ operator+()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator-()

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator-=()

◆ operator->()

◆ operator=()

◆ operator[]()

◆ row()

Member Data Documentation

◆ col_

◆ last_

◆ nofCols_

◆ nofRows_

◆ row_