This is some iterator to iterate a 2d container into a Box area defined by the indices of the 2d container. More...

#include <Array2d.hpp>

Public Types
typedef std::random_access_iterator2d_tag	iterator_category

typedef Container2D::value_type	value_type

typedef DPoint2d< int >	difference_type

typedef Container2D::const_pointer	pointer

typedef Container2D::const_reference	reference

typedef const_iterator2d_box	self

typedef Container2D::size_type	size_type

Public Member Functions
reference	operator* () const
	Dereference operator. Returns the element that the current const_iterator2d_box i point to. More...

pointer	operator-> () const

Constructors & Destructors
	const_iterator2d_box ()
	Constructs a const_iterator2d_box. More...

	const_iterator2d_box (Container2D *c, const Box2d< int > &b)
	Constructs a const_iterator2d_box. More...

	const_iterator2d_box (const self &o)
	Constructs a copy of the const_iterator2d_box o. More...

Assignment operators and methods
self &	operator= (const self &o)
	Assign a const_iterator2d_box. More...

Forward operators addons
self &	operator++ ()
	Preincrement a const_iterator2d_box. Iterate to the next location inside the Box2d. More...

self	operator++ (int)
	Postincrement a const_iterator2d_box. Iterate to the next location inside the Box2d. More...

Bidirectional operators addons
self &	operator-- ()
	Predecrement a const_iterator2d_box. Iterate to the previous location inside the Box2d. More...

self	operator-- (int)
	Postdecrement a const_iterator2d_box. Iterate to the previous location inside the Box2d. More...

Indices accessors
int	x1 () const
	Access to the first index of the current const_iterator2d_box. More...

int	i () const
	Access to the first index of the current const_iterator2d_box. More...

int	x2 () const
	Access to the second index of the current const_iterator2d_box. More...

int	j () const
	Access to the second index of the current const_iterator2d_box. More...

Friends
Equality comparable operators
bool	operator== (const self &i1, const self &i2)
	Equality operator. More...

bool	operator!= (const self &i1, const self &i2)
	Inequality operator. More...

Strict Weakly comparable operators
bool	operator< (const self &i1, const self &i2)
	< operator. More...

bool	operator> (const self &i1, const self &i2)
	operator. More...

bool	operator<= (const self &i1, const self &i2)
	<= operator. More...

bool	operator>= (const self &i1, const self &i2)
	>= operator. More...

const_iterator2d_box operators addons
self &	operator+= (const difference_type &d)
	const_iterator2d_box addition. More...

self &	operator-= (const difference_type &d)
	const_iterator2d_box substraction. More...

self	operator+ (const difference_type &d)
	const_iterator2d_box addition. More...

self	operator- (const difference_type &d)
	const_iterator2d_box substraction. More...

reference	operator[] (difference_type d) const
	const_iterator2d_box element assignment operator. Equivalent to *(i + d). More...

Container2D::const_row_iterator	row_begin (size_type row) const
	const_iterator2d_box element assignment operator. More...

Container2D::const_row_iterator	row_end (size_type row) const
	const_iterator2d_box element assignment operator. More...

Container2D::const_reverse_row_iterator	row_rbegin (size_type row) const
	iterator2d_box element assignment operator. More...

Container2D::const_reverse_row_iterator	row_rend (size_type row) const
	iterator2d_box element assignment operator. More...

Container2D::const_col_iterator	col_begin (size_type col) const
	const_iterator2d_box element assignment operator. More...

Container2D::const_col_iterator	col_end (size_type col) const
	const_iterator2d_box element assignment operator. More...

Container2D::const_reverse_col_iterator	col_rbegin (size_type col) const
	iterator2d_box element assignment operator. More...

Container2D::const_reverse_col_iterator	col_rend (size_type col) const
	iterator2d_box element assignment operator. More...

difference_type	operator- (const self &i1, const self &i2)
	const_iterator2d_box difference operator. More...

Detailed Description

template<class T>
class slip::const_iterator2d_box< T >

This is some iterator to iterate a 2d container into a Box area defined by the indices of the 2d container.

Author: Benoit Tremblais <tremblais_AT_sic.univ-poitiers.fr>; Julien Dombre <dombre_AT_sic.univ-poitiers.fr>

Version: 0.0.4

Date: 18/12/2007

Parameters

Container2D Type of 2d container in the const_iterator2d_box

Description:: This iterator is an 2d extension of the random_access_iterator. It is compatible with the bidirectional_iterator of the Standard library. It iterate into a box area defined inside the indices range of the 2d container. Those indices are defined as follows :
(0,0)--------> x2 (or j)

|

|

|

|

\|/

x1 (or i)

(0,0) is the upper left corner of the 2d container.

Definition at line 122 of file Array2d.hpp.

Member Typedef Documentation

template<class T >

typedef DPoint2d<int> slip::const_iterator2d_box< T >::difference_type

Definition at line 772 of file iterator2d_box.hpp.

template<class T >

typedef std::random_access_iterator2d_tag slip::const_iterator2d_box< T >::iterator_category

Definition at line 770 of file iterator2d_box.hpp.

template<class T >

typedef Container2D::const_pointer slip::const_iterator2d_box< T >::pointer

Definition at line 773 of file iterator2d_box.hpp.

template<class T >

typedef Container2D::const_reference slip::const_iterator2d_box< T >::reference

Definition at line 774 of file iterator2d_box.hpp.

template<class T >

typedef const_iterator2d_box slip::const_iterator2d_box< T >::self

Definition at line 776 of file iterator2d_box.hpp.

template<class T >

typedef Container2D::size_type slip::const_iterator2d_box< T >::size_type

Definition at line 778 of file iterator2d_box.hpp.

template<class T >

typedef Container2D::value_type slip::const_iterator2d_box< T >::value_type

Definition at line 771 of file iterator2d_box.hpp.

Constructor & Destructor Documentation

template<class T >

slip::const_iterator2d_box< T >::const_iterator2d_box ( )

inline

Constructs a const_iterator2d_box.

The box to iterate is in this case the full container

Definition at line 788 of file iterator2d_box.hpp.

template<class T >

slip::const_iterator2d_box< T >::const_iterator2d_box	(	Container2D *	c,
		const Box2d< int > &	b
	)

inline

Constructs a const_iterator2d_box.

Parameters

c	pointer to an existing 2d container
b	Box2d<int> defining the range of indices to iterate

Precondition: box indices must be inside those of the 2d container

Definition at line 798 of file iterator2d_box.hpp.

template<class T >

slip::const_iterator2d_box< T >::const_iterator2d_box ( const self & o )

inline

Constructs a copy of the const_iterator2d_box o.

Parameters

o	const_iterator2d_box to copy.

Definition at line 808 of file iterator2d_box.hpp.

Member Function Documentation

template<class T >

Container2D::const_col_iterator slip::const_iterator2d_box< T >::col_begin ( size_type col ) const

inline

const_iterator2d_box element assignment operator.

Parameters

col offset.

Returns: a const col_iterator to the first element of the col col of the box

Todo:: add assert

Definition at line 1233 of file iterator2d_box.hpp.

template<class T >

Container2D::const_col_iterator slip::const_iterator2d_box< T >::col_end ( size_type col ) const

inline

const_iterator2d_box element assignment operator.

Parameters

col offset.

Returns: a const col_iterator to the past-the-end element of the col col of the box

Todo:: add assert

Definition at line 1247 of file iterator2d_box.hpp.

template<class T >

Container2D::const_reverse_col_iterator slip::const_iterator2d_box< T >::col_rbegin ( size_type col ) const

inline

iterator2d_box element assignment operator.

Parameters

col offset.

Returns: a const_reverse_col_iterator to the last element of the column col of the box

Definition at line 1259 of file iterator2d_box.hpp.

template<class T >

Container2D::const_reverse_col_iterator slip::const_iterator2d_box< T >::col_rend ( size_type col ) const

inline

iterator2d_box element assignment operator.

Parameters

col offset.

Returns: a const_reverse_col_iterator to one previous the first element of the column col of the box

Definition at line 1271 of file iterator2d_box.hpp.

template<class T >

int slip::const_iterator2d_box< T >::i ( ) const

inline

Access to the first index of the current const_iterator2d_box.

Returns: the first index.

Definition at line 1298 of file iterator2d_box.hpp.

template<class T >

int slip::const_iterator2d_box< T >::j ( ) const

inline

Access to the second index of the current const_iterator2d_box.

Returns: the second index.

Definition at line 1316 of file iterator2d_box.hpp.

template<class T >

reference slip::const_iterator2d_box< T >::operator* ( ) const

inline

Dereference operator. Returns the element that the current const_iterator2d_box i point to.

Returns: a const const_iterator2d_box reference.

Definition at line 850 of file iterator2d_box.hpp.

template<class T >

self slip::const_iterator2d_box< T >::operator+ ( const difference_type & d )

inline

const_iterator2d_box addition.

Parameters

d	difference_type

Returns: a const_iterator2d_box reference

Precondition: All the iterators between the current iterator i and i + d must be dereferenceable.

Definition at line 1108 of file iterator2d_box.hpp.

template<class T >

self& slip::const_iterator2d_box< T >::operator++ ( )

inline

Preincrement a const_iterator2d_box. Iterate to the next location inside the Box2d.

Definition at line 873 of file iterator2d_box.hpp.

template<class T >

self slip::const_iterator2d_box< T >::operator++ ( int )

inline

Postincrement a const_iterator2d_box. Iterate to the next location inside the Box2d.

Definition at line 904 of file iterator2d_box.hpp.

template<class T >

self& slip::const_iterator2d_box< T >::operator+= ( const difference_type & d )

inline

const_iterator2d_box addition.

Parameters

d	difference_type

Returns: a const_iterator2d_box reference

Precondition: All the iterators between the current iterator i and i + d must be dereferenceable.

Definition at line 1072 of file iterator2d_box.hpp.

template<class T >

self slip::const_iterator2d_box< T >::operator- ( const difference_type & d )

inline

const_iterator2d_box substraction.

Parameters

d	difference_type

Returns: a const_iterator2d_box reference

Precondition: All the iterators between the current iterator i and i - d must be dereferenceable.

Definition at line 1125 of file iterator2d_box.hpp.

template<class T >

self& slip::const_iterator2d_box< T >::operator-- ( )

inline

Predecrement a const_iterator2d_box. Iterate to the previous location inside the Box2d.

Definition at line 922 of file iterator2d_box.hpp.

template<class T >

self slip::const_iterator2d_box< T >::operator-- ( int )

inline

Postdecrement a const_iterator2d_box. Iterate to the previous location inside the Box2d.

Definition at line 954 of file iterator2d_box.hpp.

template<class T >

self& slip::const_iterator2d_box< T >::operator-= ( const difference_type & d )

inline

const_iterator2d_box substraction.

Parameters

d	difference_type

Returns: a const_iterator2d_box reference

Precondition: All the iterators between the current iterator i and i - d must be dereferenceable.

Definition at line 1090 of file iterator2d_box.hpp.

template<class T >

pointer slip::const_iterator2d_box< T >::operator-> ( ) const

inline

Definition at line 857 of file iterator2d_box.hpp.

template<class T >

self& slip::const_iterator2d_box< T >::operator= ( const self & o )

inline

Assign a const_iterator2d_box.

Assign elements of const_iterator2d_box in o.

Parameters

o	const_iterator2d_box to get the values from.

Returns: a const_iterator2d_box reference.

Definition at line 826 of file iterator2d_box.hpp.

template<class T >

reference slip::const_iterator2d_box< T >::operator[] ( difference_type d ) const

inline

const_iterator2d_box element assignment operator. Equivalent to *(i + d).

Parameters

d	difference_type.

Returns: a const reference to the 2d container elements

Precondition: (i + d) exists and is dereferenceable.

Definition at line 1160 of file iterator2d_box.hpp.

template<class T >

Container2D::const_row_iterator slip::const_iterator2d_box< T >::row_begin ( size_type row ) const

inline

const_iterator2d_box element assignment operator.

Parameters

row offset.

Returns: a const_row_iterator to the first element of the row row of the box

Todo:: add assert

Definition at line 1179 of file iterator2d_box.hpp.

template<class T >

Container2D::const_row_iterator slip::const_iterator2d_box< T >::row_end ( size_type row ) const

inline

const_iterator2d_box element assignment operator.

Parameters

row offset.

Returns: a const_row_iterator to the past-the-end element of the row row of the box

Todo:: add assert

Definition at line 1193 of file iterator2d_box.hpp.

template<class T >

Container2D::const_reverse_row_iterator slip::const_iterator2d_box< T >::row_rbegin ( size_type row ) const

inline

iterator2d_box element assignment operator.

Parameters

row offset.

Returns: a const_reverse_row_iterator to the last element of the row row of the box

Definition at line 1206 of file iterator2d_box.hpp.

template<class T >

Container2D::const_reverse_row_iterator slip::const_iterator2d_box< T >::row_rend ( size_type row ) const

inline

iterator2d_box element assignment operator.

Parameters

row offset.

Returns: a const_reverse_row_iterator to one previois the first element of the row row of the box

Definition at line 1220 of file iterator2d_box.hpp.

template<class T >

int slip::const_iterator2d_box< T >::x1 ( ) const

inline

Access to the first index of the current const_iterator2d_box.

Returns: the first index.

Definition at line 1289 of file iterator2d_box.hpp.

template<class T >

int slip::const_iterator2d_box< T >::x2 ( ) const

inline

Access to the second index of the current const_iterator2d_box.

Returns: the second index.

Definition at line 1307 of file iterator2d_box.hpp.

Friends And Related Function Documentation

template<class T >

bool operator!=	(	const self &	i1,
		const self &	i2
	)

friend

Inequality operator.

Parameters

i1	first const_iterator2d_box.
i2	second const_iterator2d_box.

Returns: true if !(i1 == i2)

Definition at line 990 of file iterator2d_box.hpp.

template<class T >

difference_type operator-	(	const self &	i1,
		const self &	i2
	)

friend

const_iterator2d_box difference operator.

Parameters

i1	first const_iterator2d_box.
i2	second const_iterator2d_box.

Returns: a difference_type d such that i1 = i2 + d.

Precondition: Either i1 is reachable from i2, or i2 is reachable from i1.

Definition at line 1143 of file iterator2d_box.hpp.

template<class T >

bool operator<	(	const self &	i1,
		const self &	i2
	)

friend

< operator.

Parameters

i1	first iterator2d_box.
i2	second iterator2d_box.

Returns: true i1.pos_ < i2_pos

Definition at line 1009 of file iterator2d_box.hpp.

template<class T >

bool operator<=	(	const self &	i1,
		const self &	i2
	)

friend

<= operator.

Parameters

i1	first iterator2d_box.
i2	second iterator2d_box.

Returns: true if !(i2 < i1)

Definition at line 1037 of file iterator2d_box.hpp.

template<class T >

bool operator==	(	const self &	i1,
		const self &	i2
	)

friend

Equality operator.

Parameters

i1	first const_iterator2d_box.
i2	second const_iterator2d_box.

Returns: true if i1 and i2 point to the same element of the 2d container

Definition at line 975 of file iterator2d_box.hpp.

template<class T >

bool operator>	(	const self &	i1,
		const self &	i2
	)

friend

operator.

Parameters

i1	first iterator2d_box.
i2	second iterator2d_box.

Returns: true i2 < i1

Definition at line 1023 of file iterator2d_box.hpp.

template<class T >

bool operator>=	(	const self &	i1,
		const self &	i2
	)

friend

>= operator.

Parameters

i1	first iterator2d_box.
i2	second iterator2d_box.

Returns: true if !(i1 < i2)

Definition at line 1051 of file iterator2d_box.hpp.

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

src/Container/Array2d.hpp
src/Container/iterator2d_box.hpp

Public Types

Public Member Functions

Friends

const_iterator2d_box operators addons

Detailed Description

template<class T> class slip::const_iterator2d_box< T >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

template<class T>
class slip::const_iterator2d_box< T >