slip::const_iterator3d_plane< Container3D > Class Template Reference

This is some iterator to iterate a 3d container into a plane area defined by the subscripts of the 3d container. More...

#include <iterator3d_plane.hpp>

Public Types
typedef std::random_access_iterator2d_tag	iterator_category
typedef Container3D::value_type	value_type
typedef DPoint2d< int >	difference_type
typedef Container3D::pointer	pointer
typedef Container3D::const_pointer	const_pointer
typedef Container3D::const_reference	reference
typedef const_iterator3d_plane	self
typedef Container3D::size_type	size_type

Public Member Functions
reference	operator* () const
	Dereference operator. Returns the element that the current const_iterator3d_plane i point to. More...
const_pointer	operator-> () const
Constructors & Destructors
	const_iterator3d_plane ()
	Constructs a const_iterator3d_plane. More...
	const_iterator3d_plane (Container3D *c, PLANE_ORIENTATION P, const int plane_coordinate, const Box2d< int > &b)
	Constructs a iterator3d_plane. More...
	const_iterator3d_plane (Container3D *c, const Box3d< int > &b)
	Constructs a const_iterator3d_plane. More...
	const_iterator3d_plane (const self &o)
	Constructs a copy of the const_iterator3d_plane o. More...
Assignment operators and methods
self &	operator= (const self &o)
	Assign a const_iterator3d_plane. More...
Forward operators addons
self &	operator++ ()
	Preincrement a const_iterator3d_plane. Iterate to the next location inside the Box3d. More...
self	operator++ (int)
	Postincrement a const_iterator3d_plane. Iterate to the next location inside the Box3d. More...
Bidirectional operators addons
self &	operator-- ()
	Predecrement a const_iterator3d_plane. Iterate to the previous location inside the Box3d. More...
self	operator-- (int)
	Postdecrement a const_iterator3d_plane. Iterate to the previous location inside the Box3d. More...
Subscripts accessors
int	x1 () const
	Access to the first subscript of the current const_iterator3d_plane. More...
int	x2 () const
	Access to the first subscript of the current const_iterator3d_plane. More...
int	xp () const
	Access to the plane subscript of the current const_iterator3d_plane. More...
int	zerodim () const
	Access to the plane axe number of the current const_iterator3d_plane. 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_iterator3d_plane operators addons
self &	operator+= (const difference_type &d)
	const_iterator3d_plane addition. More...
self &	operator-= (const difference_type &d)
	const_iterator3d_plane substraction. More...
self	operator+ (const difference_type &d)
	const_iterator3d_plane addition. More...
self	operator- (const difference_type &d)
	const_iterator3d_plane substraction. More...
reference	operator[] (difference_type d) const
	const_iterator3d_plane element assignment operator. Equivalent to *(k + d). More...
const_pointer *	operator[] (int n) const
	const_iterator3d_plane element assignment operator. Equivalent to *(k + n). More...
difference_type	operator- (const self &i1, const self &i2)
	const_iterator3d_plane difference operator. More...

Detailed Description

template<class Container3D>
class slip::const_iterator3d_plane< Container3D >

This is some iterator to iterate a 3d container into a plane area defined by the subscripts of the 3d container.

Author

Denis Arrivault <arrivault_AT_sic.univ-poitiers.fr>

Version

0.0.1

Date

2008/01/09

Parameters

Container3D

Type of 3d container in the const_iterator3d_plane

Description:

This iterator is an 3d extension of the random_access_iterator. It is compatible with the bidirectional_iterator of the Standard library. It iterate into a plane area defined inside the subscripts range of the 3d container. Those subscripts are defined as follows :

axis and notation conventions

Definition at line 722 of file iterator3d_plane.hpp.

Member Typedef Documentation

template<class Container3D >

typedef Container3D::const_pointer slip::const_iterator3d_plane< Container3D >::const_pointer

Definition at line 759 of file iterator3d_plane.hpp.

template<class Container3D >

typedef DPoint2d<int> slip::const_iterator3d_plane< Container3D >::difference_type

Definition at line 757 of file iterator3d_plane.hpp.

template<class Container3D >

typedef std::random_access_iterator2d_tag slip::const_iterator3d_plane< Container3D >::iterator_category

Definition at line 755 of file iterator3d_plane.hpp.

template<class Container3D >

typedef Container3D::pointer slip::const_iterator3d_plane< Container3D >::pointer

Definition at line 758 of file iterator3d_plane.hpp.

template<class Container3D >

typedef Container3D::const_reference slip::const_iterator3d_plane< Container3D >::reference

Definition at line 760 of file iterator3d_plane.hpp.

template<class Container3D >

typedef const_iterator3d_plane slip::const_iterator3d_plane< Container3D >::self

Definition at line 762 of file iterator3d_plane.hpp.

template<class Container3D >

typedef Container3D::size_type slip::const_iterator3d_plane< Container3D >::size_type

Definition at line 764 of file iterator3d_plane.hpp.

template<class Container3D >

typedef Container3D::value_type slip::const_iterator3d_plane< Container3D >::value_type

Definition at line 756 of file iterator3d_plane.hpp.

Constructor & Destructor Documentation

template<class Container3D >

slip::const_iterator3d_plane< Container3D >::const_iterator3d_plane ( )

inline

Constructs a const_iterator3d_plane.

The box to iterate is in this case the full container

Definition at line 774 of file iterator3d_plane.hpp.

template<class Container3D >

slip::const_iterator3d_plane< Container3D >::const_iterator3d_plane ( Container3D *  c, PLANE_ORIENTATION  P, const int  plane_coordinate, const Box2d< int > &  b  )

inline

Constructs a iterator3d_plane.

Parameters

c	pointer to an existing 3d container
P	number of the zero dimension (the axe that is perpendicular to the plane of b)
plane_coordinate	coordinate of the plane along the zero dimension axe
b	Box2d<int> defining the range of the plane to iterate

Precondition

box subscripts must be inside those of the 3d container

P has to be PLANE_ORIENTATION type or 0,1 or 2

plane_coordinate must be within the range of c

Definition at line 790 of file iterator3d_plane.hpp.

template<class Container3D >

slip::const_iterator3d_plane< Container3D >::const_iterator3d_plane ( Container3D *  c, const Box3d< int > &  b  )

inline

Constructs a const_iterator3d_plane.

Parameters

c	pointer to an existing 3d container
b	Box3d<int> defining the range of plane to iterate

Precondition

box subscripts must be inside those of the 3d container

box must be a plane

Definition at line 804 of file iterator3d_plane.hpp.

template<class Container3D >

slip::const_iterator3d_plane< Container3D >::const_iterator3d_plane ( const self &  o )

inline

Constructs a copy of the const_iterator3d_plane o.

Parameters

o	iterator3d_plane to copy.

Definition at line 838 of file iterator3d_plane.hpp.

Member Function Documentation

template<class Container3D >

reference slip::const_iterator3d_plane< Container3D >::operator* ( ) const

inline

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

Returns

a const const_iterator3d_plane reference.

Definition at line 883 of file iterator3d_plane.hpp.

template<class Container3D >

self slip::const_iterator3d_plane< Container3D >::operator+ ( const difference_type &  d )

inline

const_iterator3d_plane addition.

Parameters

d	difference_type

Returns

a const_iterator3d_plane reference

Precondition

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

Definition at line 1128 of file iterator3d_plane.hpp.

template<class Container3D >

self& slip::const_iterator3d_plane< Container3D >::operator++ ( )

inline

Preincrement a const_iterator3d_plane. Iterate to the next location inside the Box3d.

Definition at line 906 of file iterator3d_plane.hpp.

template<class Container3D >

self slip::const_iterator3d_plane< Container3D >::operator++ ( int  )

inline

Postincrement a const_iterator3d_plane. Iterate to the next location inside the Box3d.

Definition at line 934 of file iterator3d_plane.hpp.

template<class Container3D >

self& slip::const_iterator3d_plane< Container3D >::operator+= ( const difference_type &  d )

inline

const_iterator3d_plane addition.

Parameters

d	difference_type

Returns

a const_iterator3d_plane reference

Precondition

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

Definition at line 1096 of file iterator3d_plane.hpp.

template<class Container3D >

self slip::const_iterator3d_plane< Container3D >::operator- ( const difference_type &  d )

inline

const_iterator3d_plane substraction.

Parameters

d	difference_type

Returns

a const_iterator3d_plane reference

Precondition

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

Definition at line 1144 of file iterator3d_plane.hpp.

template<class Container3D >

self& slip::const_iterator3d_plane< Container3D >::operator-- ( )

inline

Predecrement a const_iterator3d_plane. Iterate to the previous location inside the Box3d.

Definition at line 953 of file iterator3d_plane.hpp.

template<class Container3D >

self slip::const_iterator3d_plane< Container3D >::operator-- ( int  )

inline

Postdecrement a const_iterator3d_plane. Iterate to the previous location inside the Box3d.

Definition at line 982 of file iterator3d_plane.hpp.

template<class Container3D >

self& slip::const_iterator3d_plane< Container3D >::operator-= ( const difference_type &  d )

inline

const_iterator3d_plane substraction.

Parameters

d	difference_type

Returns

a const_iterator3d_plane reference

Precondition

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

Definition at line 1112 of file iterator3d_plane.hpp.

template<class Container3D >

const_pointer slip::const_iterator3d_plane< Container3D >::operator-> ( ) const

inline

Definition at line 890 of file iterator3d_plane.hpp.

template<class Container3D >

self& slip::const_iterator3d_plane< Container3D >::operator= ( const self &  o )

inline

Assign a const_iterator3d_plane.

Assign elements of const_iterator3d_plane in o.

Parameters

o	const_iterator3d_plane to get the values from.

Returns

a const_iterator3d_plane reference.

Definition at line 857 of file iterator3d_plane.hpp.

template<class Container3D >

reference slip::const_iterator3d_plane< Container3D >::operator[] ( difference_type  d ) const

inline

const_iterator3d_plane element assignment operator. Equivalent to *(k + d).

Parameters

d	difference_type.

Returns

a const reference to the 3d container elements

Precondition

(k + d) exists and is dereferenceable.

Definition at line 1174 of file iterator3d_plane.hpp.

template<class Container3D >

const_pointer* slip::const_iterator3d_plane< Container3D >::operator[] ( int  n ) const

inline

const_iterator3d_plane element assignment operator. Equivalent to *(k + n).

Parameters

n

offset.

Returns

a const pointer of pointer to the 3d container elements

Precondition

(k + n) exists and is dereferenceable.

Todo:

add assert

Definition at line 1192 of file iterator3d_plane.hpp.

template<class Container3D >

int slip::const_iterator3d_plane< Container3D >::x1 ( ) const

inline

Access to the first subscript of the current const_iterator3d_plane.

Returns

the first subscript.

Definition at line 1214 of file iterator3d_plane.hpp.

template<class Container3D >

int slip::const_iterator3d_plane< Container3D >::x2 ( ) const

inline

Access to the first subscript of the current const_iterator3d_plane.

Returns

the second subscript.

Definition at line 1224 of file iterator3d_plane.hpp.

template<class Container3D >

int slip::const_iterator3d_plane< Container3D >::xp ( ) const

inline

Access to the plane subscript of the current const_iterator3d_plane.

Returns

the plane subscript.

Definition at line 1234 of file iterator3d_plane.hpp.

template<class Container3D >

int slip::const_iterator3d_plane< Container3D >::zerodim ( ) const

inline

Access to the plane axe number of the current const_iterator3d_plane.

Returns

the plane axe number.

Definition at line 1243 of file iterator3d_plane.hpp.

Friends And Related Function Documentation

template<class Container3D >

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

friend

Inequality operator.

Parameters

i1	first const_iterator3d_plane.
i2	second const_iterator3d_plane.

Returns

true if !(i1 == i2)

Definition at line 1018 of file iterator3d_plane.hpp.

template<class Container3D >

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

friend

const_iterator3d_plane difference operator.

Parameters

i1	first const_iterator3d_plane.
i2	second const_iterator3d_plane.

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 1160 of file iterator3d_plane.hpp.

template<class Container3D >

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

friend

< operator.

Parameters

i1	first iterator3d_plane.
i2	second iterator3d_plane.

Returns

true i1.pos_ < i2_pos

Definition at line 1038 of file iterator3d_plane.hpp.

template<class Container3D >

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

friend

<= operator.

Parameters

i1	first iterator3d_plane.
i2	second iterator3d_plane.

Returns

true if !(i2 < i1)

Definition at line 1064 of file iterator3d_plane.hpp.

template<class Container3D >

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

friend

Equality operator.

Parameters

i1	first const_iterator3d_plane.
i2	second const_iterator3d_plane.

Returns

true if i1 and i2 point to the same element of the 3d container

Definition at line 1003 of file iterator3d_plane.hpp.

template<class Container3D >

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

friend

operator.

Parameters

i1	first iterator3d_plane.
i2	second iterator3d_plane.

Returns

true i2 < i1

Definition at line 1051 of file iterator3d_plane.hpp.

template<class Container3D >

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

friend

>= operator.

Parameters

i1	first iterator3d_plane.
i2	second iterator3d_plane.

Returns

true if !(i1 < i2)

Definition at line 1077 of file iterator3d_plane.hpp.

---

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

• src/Container/iterator3d_plane.hpp