This is some iterator to iterate a 3d container into two Range defined by the indices and strides of the 3d container. More...

#include <DenseVector3dField3d.hpp>

Public Types
typedef std::random_access_iterator3d_tag	iterator_category

typedef Container3D::value_type	value_type

typedef DPoint3d< int >	difference_type

typedef DPoint2d< int >	diff2d

typedef Container3D::pointer	pointer

typedef Container3D::reference	reference

typedef iterator3d_range	self

typedef Container3D::size_type	size_type

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

pointer	operator-> ()

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

	iterator3d_range (Container3D *c, const slip::Range< int > &r1, const slip::Range< int > &r2, const slip::Range< int > &r3)
	Constructs a iterator3d_range. More...

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

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

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

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

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

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

row and col iterators accessors
Container3D::row_range_iterator	row_begin (size_type slice, size_type row)
	iterator3d_range element assignment operator. More...

Container3D::row_range_iterator	row_end (size_type slice, size_type row)
	iterator3d_range element assignment operator. More...

Container3D::col_range_iterator	col_begin (size_type slice, size_type col)
	iterator3d_range element assignment operator. More...

Container3D::col_range_iterator	col_end (size_type slice, size_type col)
	iterator3d_range element assignment operator. More...

Subscripts accessors
int	x1 () const
	Access to the first subscript of the current iterator3d_range. More...

int	k () const
	Access to the first subscript of the current iterator3d_range. More...

int	x2 () const
	Access to the second subscript of the current iterator3d_range. More...

int	i () const
	Access to the second subscript of the current iterator3d_range. More...

int	x3 () const
	Access to the third subscript of the current iterator3d_range. More...

int	j () const
	Access to the third subscript of the current iterator3d_range. 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...

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

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

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

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

reference	operator[] (difference_type d)
	iterator3d_range element assignment operator. Equivalent to *(k + d) = t. More...

pointer	operator[] (diff2d d)
	iterator3d_range element assignment operator. Equivalent to *(k + d) = t. More...

pointer *	operator[] (int n)
	iterator3d_range element assignment operator. Equivalent to *(k + n) = t. More...

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

Detailed Description

template<typename T>
class slip::iterator3d_range< T >

This is some iterator to iterate a 3d container into two Range defined by the indices and strides of the 3d container.

Author: Denis Arrivault <arrivault_AT_sic.univ-poitiers.fr>

Version: 0.0.1

Date: 2007/12/13

Parameters

Container3D Type of 3d container in the iterator3d_range

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 range area defined inside the indices range of the 3d container. Those indices are defined as follows :
x1 _(or k)

/\

/

/

(0,0,0)--------> x3 (or j)

|

|

|

|

\|/

x2 (or i)

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

Definition at line 113 of file DenseVector3dField3d.hpp.

Member Typedef Documentation

template<typename T >

typedef DPoint2d<int> slip::iterator3d_range< T >::diff2d

Definition at line 128 of file iterator3d_range.hpp.

template<typename T >

typedef DPoint3d<int> slip::iterator3d_range< T >::difference_type

Definition at line 127 of file iterator3d_range.hpp.

template<typename T >

typedef std::random_access_iterator3d_tag slip::iterator3d_range< T >::iterator_category

Definition at line 125 of file iterator3d_range.hpp.

template<typename T >

typedef Container3D::pointer slip::iterator3d_range< T >::pointer

Definition at line 129 of file iterator3d_range.hpp.

template<typename T >

typedef Container3D::reference slip::iterator3d_range< T >::reference

Definition at line 130 of file iterator3d_range.hpp.

template<typename T >

typedef iterator3d_range slip::iterator3d_range< T >::self

Definition at line 132 of file iterator3d_range.hpp.

template<typename T >

typedef Container3D::size_type slip::iterator3d_range< T >::size_type

Definition at line 134 of file iterator3d_range.hpp.

template<typename T >

typedef Container3D::value_type slip::iterator3d_range< T >::value_type

Definition at line 126 of file iterator3d_range.hpp.

Constructor & Destructor Documentation

template<typename T >

slip::iterator3d_range< T >::iterator3d_range ( )

inline

Constructs a iterator3d_range.

The range to iterate is in this case the full container

Todo:: VERIFY

Definition at line 145 of file iterator3d_range.hpp.

template<typename T >

slip::iterator3d_range< T >::iterator3d_range	(	Container3D *	c,
		const slip::Range< int > &	r1,
		const slip::Range< int > &	r2,
		const slip::Range< int > &	r3
	)

inline

Constructs a iterator3d_range.

Parameters

c	pointer to an existing 3d container
r1	Range<int> defining the range of indices of the first axis to iterate
r2	Range<int> defining the range of indices of the second axis to iterate
r3	Range<int> defining the range of indices of the third axis to iterate

Precondition: range indices must be inside those of the 3d container

Definition at line 160 of file iterator3d_range.hpp.

template<typename T >

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

inline

Constructs a copy of the iterator3d_range o.

Parameters

o	iterator3d_range to copy.

Definition at line 174 of file iterator3d_range.hpp.

Member Function Documentation

template<typename T >

Container3D::col_range_iterator slip::iterator3d_range< T >::col_begin	(	size_type	slice,
		size_type	col
	)

inline

iterator3d_range element assignment operator.

Parameters

slice	slice offset.
col	col offset.

Returns: a range_col_iterator to the first element of range at the col col of the range of the slice slice of the range

Todo:: add assert

Definition at line 615 of file iterator3d_range.hpp.

template<typename T >

Container3D::col_range_iterator slip::iterator3d_range< T >::col_end	(	size_type	slice,
		size_type	col
	)

inline

iterator3d_range element assignment operator.

Parameters

slice	slice offset.
col	col offset.

Returns: a range_col_iterator to the past-the-end element of range at the col col of the range of the slice slice of the range

Todo:: add assert

Definition at line 631 of file iterator3d_range.hpp.

template<typename T >

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

inline

Access to the second subscript of the current iterator3d_range.

Returns: the second subscript.

Definition at line 674 of file iterator3d_range.hpp.

template<typename T >

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

inline

Access to the third subscript of the current iterator3d_range.

Returns: the third subscript.

Definition at line 693 of file iterator3d_range.hpp.

template<typename T >

int slip::iterator3d_range< T >::k ( ) const

inline

Access to the first subscript of the current iterator3d_range.

Returns: the first subscript.

Definition at line 656 of file iterator3d_range.hpp.

template<typename T >

reference slip::iterator3d_range< T >::operator* ( )

inline

Dereference assignment operator. Returns the element that the current iterator3d_range i point to.

Returns: a iterator3d_range reference.

Definition at line 217 of file iterator3d_range.hpp.

template<typename T >

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

inline

iterator3d_range addition.

Parameters

d	difference_type

Returns: a iterator3d_range reference

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

Definition at line 481 of file iterator3d_range.hpp.

template<typename T >

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

inline

Preincrement a iterator3d_range. Iterate to the next location inside the Range.

Definition at line 239 of file iterator3d_range.hpp.

template<typename T >

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

inline

Postincrement a iterator3d_range. Iterate to the next location inside the Range3d.

Definition at line 275 of file iterator3d_range.hpp.

template<typename T >

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

inline

iterator3d_range addition.

Parameters

d	difference_type

Returns: a iterator3d_range reference

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

Definition at line 447 of file iterator3d_range.hpp.

template<typename T >

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

inline

iterator3d_range substraction.

Parameters

d	difference_type

Returns: a iterator3d_range reference

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

Definition at line 496 of file iterator3d_range.hpp.

template<typename T >

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

inline

Predecrement a iterator3d_range. Iterate to the previous location inside the Range3d.

Definition at line 294 of file iterator3d_range.hpp.

template<typename T >

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

inline

Postdecrement a iterator3d_range. Iterate to the previous location inside the Range3d.

Definition at line 330 of file iterator3d_range.hpp.

template<typename T >

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

inline

iterator3d_range substraction.

Parameters

d	difference_type

Returns: a iterator3d_range reference

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

Definition at line 464 of file iterator3d_range.hpp.

template<typename T >

pointer slip::iterator3d_range< T >::operator-> ( )

inline

Definition at line 223 of file iterator3d_range.hpp.

template<typename T >

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

inline

Assign a iterator3d_range.

Assign elements of iterator3d_range in o.

Parameters

o	iterator3d_range to get the values from.

Returns: a iterator3d_range reference.

Definition at line 193 of file iterator3d_range.hpp.

template<typename T >

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

inline

iterator3d_range element assignment operator. Equivalent to *(k + d) = t.

Parameters

d	difference_type.

Returns: a reference to the 3d container elements

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

Postcondition: k[d] is a copy of reference.

Definition at line 533 of file iterator3d_range.hpp.

template<typename T >

pointer slip::iterator3d_range< T >::operator[] ( diff2d d )

inline

iterator3d_range element assignment operator. Equivalent to *(k + d) = t.

Parameters

d offset.

Returns: a pointer to the 3d container elements

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

Postcondition: k[d] is a copy of pointer.

Todo:: add assert

Definition at line 550 of file iterator3d_range.hpp.

template<typename T >

pointer* slip::iterator3d_range< T >::operator[] ( int n )

inline

iterator3d_range element assignment operator. Equivalent to *(k + n) = t.

Parameters

n offset.

Returns: a pointer of pointer to the 3d container elements

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

Postcondition: k[d] is a copy of pointer of pointer.

Todo:: add assert

Definition at line 566 of file iterator3d_range.hpp.

template<typename T >

Container3D::row_range_iterator slip::iterator3d_range< T >::row_begin	(	size_type	slice,
		size_type	row
	)

inline

iterator3d_range element assignment operator.

Parameters

slice	slice offset.
row	offset.

Returns: a row_range_iterator to the first element of range at the row row of the range of the slice slice of the range

Todo:: add assert

Definition at line 586 of file iterator3d_range.hpp.

template<typename T >

Container3D::row_range_iterator slip::iterator3d_range< T >::row_end	(	size_type	slice,
		size_type	row
	)

inline

iterator3d_range element assignment operator.

Parameters

slice	slice offset.
row	offset.

Returns: a row_range_iterator to the past-the-end element of range at the row row of the range of the slice slice of the range

Todo:: add assert

Definition at line 601 of file iterator3d_range.hpp.

template<typename T >

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

inline

Access to the first subscript of the current iterator3d_range.

Returns: the first subscript.

Definition at line 647 of file iterator3d_range.hpp.

template<typename T >

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

inline

Access to the second subscript of the current iterator3d_range.

Returns: the second subscript.

Definition at line 665 of file iterator3d_range.hpp.

template<typename T >

int slip::iterator3d_range< T >::x3 ( ) const

inline

Access to the third subscript of the current iterator3d_range.

Returns: the third subscript.

Definition at line 684 of file iterator3d_range.hpp.

Friends And Related Function Documentation

template<typename T >

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

friend

Inequality operator.

Parameters

i1	first iterator3d_range.
i2	second iterator3d_range.

Returns: true if !(i1 == i2)

Definition at line 366 of file iterator3d_range.hpp.

template<typename T >

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

friend

iterator3d_range difference operator.

Parameters

i1	first iterator3d_range.
i2	second iterator3d_range.

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

Precondition: Either i1 is reachable from i2, or i2 is reachable from i1.; Both strides must be equal

Definition at line 512 of file iterator3d_range.hpp.

template<typename T >

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

friend

< operator.

Parameters

i1	first iterator3d_range.
i2	second iterator3d_range.

Returns: true i1.pos_ < i2_pos

Definition at line 385 of file iterator3d_range.hpp.

template<typename T >

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

friend

<= operator.

Parameters

i1	first iterator3d_range.
i2	second iterator3d_range.

Returns: true if !(i2 < i1)

Definition at line 413 of file iterator3d_range.hpp.

template<typename T >

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

friend

Equality operator.

Parameters

i1	first iterator3d_range.
i2	second iterator3d_range.

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

Definition at line 351 of file iterator3d_range.hpp.

template<typename T >

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

friend

operator.

Parameters

i1	first iterator3d_range.
i2	second iterator3d_range.

Returns: true i2 < i1

Definition at line 399 of file iterator3d_range.hpp.

template<typename T >

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

friend

>= operator.

Parameters

i1	first iterator3d_range.
i2	second iterator3d_range.

Returns: true if !(i1 < i2)

Definition at line 427 of file iterator3d_range.hpp.

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

src/Container/DenseVector3dField3d.hpp
src/Container/iterator3d_range.hpp

Public Types

Public Member Functions

Friends

iterator3d_range operators addons

Detailed Description

template<typename T> class slip::iterator3d_range< T >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

template<typename T>
class slip::iterator3d_range< T >