theplu::yat::utility::Container2DIterator< Container, value, reference > Class Template Reference

Iterator for a Container2D. More...

#include <yat/utility/Container2DIterator.h>

Inheritance diagram for theplu::yat::utility::Container2DIterator< Container, value, reference >:

Public Member Functions
	Container2DIterator (void)
	Default Constructor.
	Container2DIterator (Container &container, size_t row, size_t column)
	Constructor. More...
template<typename C2 , typename V2 , typename R2 >
	Container2DIterator (Container2DIterator< C2, V2, R2 > other, typename boost::enable_if_convertible< C2 *, Container *>::type *=0, typename boost::enable_if_convertible< R2, reference >::type *=0)
Container &	container (void) const
size_t	row (void) const
size_t	column (void) const

Friends
class	boost::iterator_core_access

Detailed Description

template<typename Container, typename value, typename reference = value&>
class theplu::yat::utility::Container2DIterator< Container, value, reference >

Iterator for a Container2D.

The iterator can be used to traverse through a Container2D row by row.

Type Requirements:

• Container must be a Container2D
• value is typically Container::value_type if Container2DIterator is mutable or const Container::value_type otherwise.
• reference, typically value&, must be convertible to value
• Container must have an operator()(size_t, size_t) that returns a type that is convertible to reference.

See also

StrideIterator

Constructor & Destructor Documentation

Container2DIterator() [1/2]

template<typename Container, typename value, typename reference = value&>

theplu::yat::utility::Container2DIterator< Container, value, reference >::Container2DIterator ( Container &  container, size_t  row, size_t  column  )

inline

Constructor.

Parameters

container	iterator points to
row	telling which row iterator points to
column	telling which column iterator points to

Container2DIterator() [2/2]

template<typename Container, typename value, typename reference = value&>

template<typename C2 , typename V2 , typename R2 >

theplu::yat::utility::Container2DIterator< Container, value, reference >::Container2DIterator ( Container2DIterator< C2, V2, R2 >  other, typename boost::enable_if_convertible< C2 *, Container *>::type *  = 0, typename boost::enable_if_convertible< R2, reference >::type *  = 0  )

inline

Conversion constructor allowing conversion between different Container2DIterators. Requires that C2 is convertible to Container.

Since

New in yat 0.20

Member Function Documentation

column()

template<typename Container, typename value, typename reference = value&>

size_t theplu::yat::utility::Container2DIterator< Container, value, reference >::column ( void  ) const

inline

Returns

the column of the element the iterator points to

Since

New in yat 0.20

container()

template<typename Container, typename value, typename reference = value&>

Container& theplu::yat::utility::Container2DIterator< Container, value, reference >::container ( void  ) const

inline

Returns

reference to underlying Container

Since

New in yat 0.20

row()

template<typename Container, typename value, typename reference = value&>

size_t theplu::yat::utility::Container2DIterator< Container, value, reference >::row ( void  ) const

inline

Returns

the row of the element the iterator points to

Since

New in yat 0.20

---

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

• yat/utility/Container2DIterator.h