This is a GenericMultiComponent3d class. This container statisfies the BidirectionnalContainer concepts of the STL. It is also an 3d extension of the RandomAccessContainer concept. That is to say the bracket element access is replaced by the triple bracket element access. Data are stored using a Matrix3d of Block. It is essentially an internal class used to define slip::DenseVector3dField3d. But it can be used to define other 3d Multicomponent structures. More...

#include <GenericMultiComponent3d.hpp>

Inheritance diagram for slip::GenericMultiComponent3d< Block >:

Public Types
typedef Block	value_type

typedef GenericMultiComponent3d< Block >	self

typedef const GenericMultiComponent3d< Block >	const_self

typedef value_type *	pointer

typedef value_type const *	const_pointer

typedef value_type &	reference

typedef value_type const &	const_reference

typedef ptrdiff_t	difference_type

typedef std::size_t	size_type

typedef pointer	iterator

typedef const_pointer	const_iterator

typedef std::reverse_iterator < iterator >	reverse_iterator

typedef std::reverse_iterator < const_iterator >	const_reverse_iterator

typedef slip::stride_iterator < pointer >	slice_iterator

typedef slip::stride_iterator < const_pointer >	const_slice_iterator

typedef pointer	row_iterator

typedef const_pointer	const_row_iterator

typedef slip::stride_iterator < pointer >	col_iterator

typedef slip::stride_iterator < const_pointer >	const_col_iterator

typedef slip::stride_iterator < slice_iterator >	slice_range_iterator

typedef slip::stride_iterator < const_slice_iterator >	const_slice_range_iterator

typedef slip::stride_iterator < pointer >	row_range_iterator

typedef slip::stride_iterator < const_pointer >	const_row_range_iterator

typedef slip::stride_iterator < col_iterator >	col_range_iterator

typedef slip::stride_iterator < const_col_iterator >	const_col_range_iterator

typedef std::reverse_iterator < slice_iterator >	reverse_slice_iterator

typedef std::reverse_iterator < const_slice_iterator >	const_reverse_slice_iterator

typedef std::reverse_iterator < iterator >	reverse_row_iterator

typedef std::reverse_iterator < const_iterator >	const_reverse_row_iterator

typedef std::reverse_iterator < col_iterator >	reverse_col_iterator

typedef std::reverse_iterator < const_col_iterator >	const_reverse_col_iterator

typedef std::reverse_iterator < slice_range_iterator >	reverse_slice_range_iterator

typedef std::reverse_iterator < const_slice_range_iterator >	const_reverse_slice_range_iterator

typedef std::reverse_iterator < row_range_iterator >	reverse_row_range_iterator

typedef std::reverse_iterator < const_row_range_iterator >	const_reverse_row_range_iterator

typedef std::reverse_iterator < col_range_iterator >	reverse_col_range_iterator

typedef std::reverse_iterator < const_col_range_iterator >	const_reverse_col_range_iterator

typedef slip::Array3d< Block > ::iterator2d	iterator2d

typedef slip::Array3d< Block > ::const_iterator2d	const_iterator2d

typedef std::reverse_iterator < iterator2d >	reverse_iterator2d

typedef std::reverse_iterator < const_iterator2d >	const_reverse_iterator2d

typedef slip::Array3d< Block > ::iterator3d	iterator3d

typedef slip::Array3d< Block > ::const_iterator3d	const_iterator3d

typedef slip::Array3d< Block > ::iterator3d_range	iterator3d_range

typedef slip::Array3d< Block > ::const_iterator3d_range	const_iterator3d_range

typedef std::reverse_iterator < iterator3d >	reverse_iterator3d

typedef std::reverse_iterator < const_iterator3d >	const_reverse_iterator3d

typedef std::reverse_iterator < iterator3d_range >	reverse_iterator3d_range

typedef std::reverse_iterator < const_iterator3d_range >	const_reverse_iterator3d_range

typedef Block::value_type	block_value_type

typedef block_value_type *	block_pointer

typedef const block_value_type *	const_block_pointer

typedef block_value_type &	block_reference

typedef const block_value_type	const_block_reference

typedef slip::kstride_iterator < typename Block::pointer, Block::SIZE >	component_iterator

typedef slip::kstride_iterator < typename Block::const_pointer, Block::SIZE >	const_component_iterator

typedef std::reverse_iterator < component_iterator >	reverse_component_iterator

typedef std::reverse_iterator < const_component_iterator >	const_reverse_component_iterator

typedef slip::stride_iterator < block_pointer >	component_slice_iterator

typedef slip::stride_iterator < const_block_pointer >	const_component_slice_iterator

typedef slip::stride_iterator < block_pointer >	component_slice_range_iterator

typedef slip::stride_iterator < const_block_pointer >	const_component_slice_range_iterator

typedef component_iterator	component_row_iterator

typedef const_component_iterator	const_component_row_iterator

typedef slip::stride_iterator < block_pointer >	component_row_range_iterator

typedef slip::stride_iterator < const_block_pointer >	const_component_row_range_iterator

typedef slip::stride_iterator < block_pointer >	component_col_iterator

typedef slip::stride_iterator < const_block_pointer >	const_component_col_iterator

typedef slip::stride_iterator < block_pointer >	component_col_range_iterator

typedef slip::stride_iterator < const_block_pointer >	const_component_col_range_iterator

typedef std::reverse_iterator < component_slice_iterator >	reverse_component_slice_iterator

typedef std::reverse_iterator < const_component_slice_iterator >	const_reverse_component_slice_iterator

typedef std::reverse_iterator < component_slice_range_iterator >	reverse_component_slice_range_iterator

typedef std::reverse_iterator < const_component_slice_range_iterator >	const_reverse_component_slice_range_iterator

typedef std::reverse_iterator < component_row_iterator >	reverse_component_row_iterator

typedef std::reverse_iterator < const_component_row_iterator >	const_reverse_component_row_iterator

typedef std::reverse_iterator < component_row_range_iterator >	reverse_component_row_range_iterator

typedef std::reverse_iterator < const_component_row_range_iterator >	const_reverse_component_row_range_iterator

typedef std::reverse_iterator < component_col_iterator >	reverse_component_col_iterator

typedef std::reverse_iterator < const_component_col_iterator >	const_reverse_component_col_iterator

typedef std::reverse_iterator < component_col_range_iterator >	reverse_component_col_range_iterator

typedef std::reverse_iterator < const_component_col_range_iterator >	const_reverse_component_col_range_iterator

typedef slip::component_iterator3d_box < self, Block::SIZE >	component_iterator3d

typedef std::reverse_iterator < component_iterator3d >	reverse_component_iterator3d

typedef slip::const_component_iterator3d_box < const_self, Block::SIZE >	const_component_iterator3d

typedef std::reverse_iterator < const_component_iterator3d >	const_reverse_component_iterator3d

typedef slip::component_iterator3d_range < self, Block::SIZE >	component_iterator3d_range

typedef std::reverse_iterator < component_iterator3d_range >	reverse_component_iterator3d_range

typedef slip::const_component_iterator3d_range < const_self, Block::SIZE >	const_component_iterator3d_range

typedef std::reverse_iterator < const_component_iterator3d_range >	const_reverse_component_iterator3d_range

typedef iterator3d	default_iterator

typedef const_iterator3d	const_default_iterator

Public Member Functions

void resize (const size_type slices, const size_type rows, const size_type cols, const Block &val=Block())

Resizes a GenericMultiComponent3d. More...

size_type dim1 () const

Returns the number of slices (first dimension size) in the GenericMultiComponent3d. More...

size_type slices () const

Returns the number of slices (first dimension size) in the GenericMultiComponent3d. More...

size_type dim2 () const

Returns the number of rows (second dimension size) in the GenericMultiComponent3d. More...

size_type rows () const

Returns the number of rows (first dimension size) in the GenericMultiComponent3d. More...

size_type dim3 () const

Returns the number of columns (third dimension size) in the GenericMultiComponent3d. More...

size_type columns () const

Returns the number of columns (third dimension size) in the GenericMultiComponent3d. More...

size_type cols () const

Returns the number of columns (third dimension size) in the GenericMultiComponent3d. More...

size_type size () const

Returns the number of elements in the GenericMultiComponent3d. More...

size_type max_size () const

Returns the maximal size (number of elements) in the GenericMultiComponent3d. More...

size_type slice_size () const

Returns the number of elements in a slice of the GenericMultiComponent3d. More...

bool empty () const

Returns true if the GenericMultiComponent3d is empty. (Thus size() == 0) More...

void swap (self &M)

Swaps data with another GenericMultiComponent3d. More...

Block min () const

Returns the min elements of the GenericMultiComponent3d according to the operator <. More...

Block max () const

Returns the max elements of the GenericMultiComponent3d according to the operator <. More...

GenericMultiComponent3d< Block > & apply (Block(*fun)(Block))

Returns the sums of the elements of the GenericMultiComponent3d. More...

GenericMultiComponent3d< Block > & apply (Block(*fun)(const Block &))

Applys the one-parameter C-function fun to each element of the GenericMultiComponent3d. More...

template<typename Block>

GenericMultiComponent3d (const typename GenericMultiComponent3d< Block >::size_type slices, const typename GenericMultiComponent3d< Block >::size_type rows, const typename GenericMultiComponent3d< Block >::size_type cols)

template<typename Block>

GenericMultiComponent3d (const typename GenericMultiComponent3d< Block >::size_type slices, const typename GenericMultiComponent3d< Block >::size_type rows, const typename GenericMultiComponent3d< Block >::size_type cols, typename Block::const_pointer val)

template<typename Block>

GenericMultiComponent3d (const typename GenericMultiComponent3d< Block >::size_type slices, const typename GenericMultiComponent3d< Block >::size_type rows, const typename GenericMultiComponent3d< Block >::size_type cols, const Block &val)

template<typename Block>

GenericMultiComponent3d (const typename GenericMultiComponent3d< Block >::size_type slices, const typename GenericMultiComponent3d< Block >::size_type rows, const typename GenericMultiComponent3d< Block >::size_type cols, const Block *val)

Constructors & Destructors

GenericMultiComponent3d ()

Constructs a GenericMultiComponent3d. More...

GenericMultiComponent3d (const size_type slices, const size_type rows, const size_type cols)

Constructs a GenericMultiComponent3d. More...

GenericMultiComponent3d (const size_type slices, const size_type rows, const size_type cols, const Block &val)

Constructs a GenericMultiComponent3d initialized by the scalar value val. More...

GenericMultiComponent3d (const size_type slices, const size_type rows, const size_type cols, typename Block::const_pointer val)

Constructs a GenericMultiComponent3d initialized by an array val. More...

GenericMultiComponent3d (const size_type slices, const size_type rows, const size_type cols, const Block *val)

Constructs a GenericMultiComponent3d initialized by an array val. More...

template<typename InputIterator >

GenericMultiComponent3d (const size_type slices, const size_type rows, const size_type cols, InputIterator first, InputIterator last)

Contructs a GenericMultiComponent3d from a range. More...

template<typename InputIterator >

GenericMultiComponent3d (const size_type slices, const size_type rows, const size_type cols, std::vector< InputIterator > first_iterators_list, InputIterator last)

Contructs a GenericMultiComponent3d from a 3 ranges. More...

GenericMultiComponent3d (const self &rhs)

Constructs a copy of the GenericMultiComponent3d rhs. More...

virtual ~GenericMultiComponent3d ()

Destructor of the GenericMultiComponent3d. More...

One dimensional global iterators

iterator begin ()

Returns a read/write iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

const_iterator begin () const

Returns a read-only (constant) iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

iterator end ()

Returns a read/write iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

const_iterator end () const

Returns a read-only (constant) iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

reverse_iterator rbegin ()

Returns a read/write reverse iterator that points to the last element in the GenericMultiComponent3d. Iteration is done in reverse element order. More...

const_reverse_iterator rbegin () const

Returns a read-only (constant) reverse iterator that points to the last element in the GenericMultiComponent3d. Iteration is done in reverse element order. More...

reverse_iterator rend ()

Returns a read/write reverse iterator that points to one before the first element in the GenericMultiComponent3d. Iteration is done in reverse element order. More...

const_reverse_iterator rend () const

Returns a read-only (constant) reverse iterator that points to one before the first element in the GenericMultiComponent3d. Iteration is done in reverse element order. More...

One dimensional slice iterators

slice_iterator slice_begin (const size_type row, const size_type col)

Returns a read/write iterator that points to the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number). More...

const_slice_iterator slice_begin (const size_type row, const size_type col) const

Returns a read-only (constant) iterator that points to the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number). More...

slice_iterator slice_end (const size_type row, const size_type col)

Returns a read/write iterator that points to the one past the end element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number). More...

const_slice_iterator slice_end (const size_type row, const size_type col) const

Returns a read-only (constant) iterator that points to the one past the end element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number). More...

reverse_slice_iterator slice_rbegin (const size_type row, const size_type col)

Returns a read/write iterator that points to the last element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number). More...

const_reverse_slice_iterator slice_rbegin (const size_type row, const size_type col) const

Returns a read-only (constant) iterator that points to the last element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number). More...

reverse_slice_iterator slice_rend (const size_type row, const size_type col)

Returns a read/write iterator that points to the one before the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number). More...

const_reverse_slice_iterator slice_rend (const size_type row, const size_type col) const

Returns a read (constant) iterator that points to the one before the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number). More...

One dimensional row iterators

row_iterator row_begin (const size_type slice, const size_type row)

Returns a read/write iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

const_row_iterator row_begin (const size_type slice, const size_type row) const

Returns a read_only iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

row_iterator row_end (const size_type slice, const size_type row)

Returns a read/write iterator that points to the past-the-end element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

const_row_iterator row_end (const size_type slice, const size_type row) const

Returns a read_only iterator that points to the past-the-end element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

reverse_row_iterator row_rbegin (const size_type slice, const size_type row)

Returns a read/write reverse iterator that points to the last element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order. More...

const_reverse_row_iterator row_rbegin (const size_type slice, const size_type row) const

Returns a read_only reverse iterator that points to the last element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order. More...

reverse_row_iterator row_rend (const size_type slice, const size_type row)

Returns a read/write reverse iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order. More...

const_reverse_row_iterator row_rend (const size_type slice, const size_type row) const

Returns a read_only reverse iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order. More...

One dimensional col iterators

col_iterator col_begin (const size_type slice, const size_type col)

Returns a read/write iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...

const_col_iterator col_begin (const size_type slice, const size_type col) const

Returns a read_only iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...

col_iterator col_end (const size_type slice, const size_type col)

Returns a read/write iterator that points to the past-the-end element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...

const_col_iterator col_end (const size_type slice, const size_type col) const

Returns a read_only iterator that points to the past-the-end element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...

reverse_col_iterator col_rbegin (const size_type slice, const size_type col)

Returns a read/write reverse iterator that points to the last element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...

const_reverse_col_iterator col_rbegin (const size_type slice, const size_type col) const

Returns a read_only reverse iterator that points to the last element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...

reverse_col_iterator col_rend (const size_type slice, const size_type col)

Returns a read/write reverse iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...

const_reverse_col_iterator col_rend (const size_type slice, const size_type col) const

Returns a read_only reverse iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...

One dimensional slice range iterators

slice_range_iterator slice_begin (const size_type row, const size_type col, const slip::Range< int > &range)

Returns a read/write iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

slice_range_iterator slice_end (const size_type row, const size_type col, const slip::Range< int > &range)

Returns a read/write iterator that points one past the end element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

const_slice_range_iterator slice_begin (const size_type row, const size_type col, const slip::Range< int > &range) const

Returns a read only (constant) iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

const_slice_range_iterator slice_end (const size_type row, const size_type col, const slip::Range< int > &range) const

Returns a read_only iterator that points one past the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

reverse_slice_range_iterator slice_rbegin (const size_type row, const size_type col, const slip::Range< int > &range)

Returns a read/write iterator that points to the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...

reverse_slice_range_iterator slice_rend (const size_type row, const size_type col, const slip::Range< int > &range)

Returns a read/write iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range. More...

const_reverse_slice_range_iterator slice_rbegin (const size_type row, const size_type col, const slip::Range< int > &range) const

Returns a read only (constant) iterator that points to the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range. More...

const_reverse_slice_range_iterator slice_rend (const size_type row, const size_type col, const slip::Range< int > &range) const

Returns a read_only iterator that points one past the lastto the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range. More...

One dimensional row range iterators

row_range_iterator row_begin (const size_type slice, const size_type row, const slip::Range< int > &range)

Returns a read/write iterator that points to the first element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

row_range_iterator row_end (const size_type slice, const size_type row, const slip::Range< int > &range)

Returns a read/write iterator that points one past the end element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

const_row_range_iterator row_begin (const size_type slice, const size_type row, const slip::Range< int > &range) const

Returns a read-only iterator that points to the first element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

const_row_range_iterator row_end (const size_type slice, const size_type row, const slip::Range< int > &range) const

Returns a read_only iterator that points one past the last element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

reverse_row_range_iterator row_rbegin (const size_type slice, const size_type row, const slip::Range< int > &range)

Returns a read-write iterator that points to the last element of the Range range of the row of a slice row and slice in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...

reverse_row_range_iterator row_rend (const size_type slice, const size_type row, const slip::Range< int > &range)

Returns a read-write iterator that points one before the first element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...

const_reverse_row_range_iterator row_rbegin (const size_type slice, const size_type row, const slip::Range< int > &range) const

Returns a read-only iterator that points to the last element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...

const_reverse_row_range_iterator row_rend (const size_type slice, const size_type row, const slip::Range< int > &range) const

Returns a read-only iterator that points one before the first element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...

One dimensional col range iterators

col_range_iterator col_begin (const size_type slice, const size_type col, const slip::Range< int > &range)

Returns a read-write iterator that points to the first element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

col_range_iterator col_end (const size_type slice, const size_type col, const slip::Range< int > &range)

Returns a read-write iterator that points to the past the end element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

const_col_range_iterator col_begin (const size_type slice, const size_type col, const slip::Range< int > &range) const

Returns a read-only iterator that points to the first element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

const_col_range_iterator col_end (const size_type slice, const size_type col, const slip::Range< int > &range) const

Returns a read-only iterator that points to the past the end element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

reverse_col_range_iterator col_rbegin (const size_type slice, const size_type col, const slip::Range< int > &range)

Returns a read-write iterator that points to the last element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...

reverse_col_range_iterator col_rend (const size_type slice, const size_type col, const slip::Range< int > &range)

Returns a read-write iterator that points to one before the first element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...

const_reverse_col_range_iterator col_rbegin (const size_type slice, const size_type col, const slip::Range< int > &range) const

Returns a read_only iterator that points to the last element of the Range & range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...

const_reverse_col_range_iterator col_rend (const size_type slice, const size_type col, const slip::Range< int > &range) const

Returns a read-only iterator that points to the first element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...

One dimensional global plane iterators

iterator plane_begin (const size_type slice)

Returns a read/write iterator that points to the first element in the in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

const_iterator plane_begin (const size_type slice) const

Returns a read-only (constant) iterator that points to the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

iterator plane_end (const size_type slice)

Returns a read/write iterator that points one past the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

const_iterator plane_end (const size_type slice) const

Returns a read-only (constant) iterator that points one past the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

reverse_iterator plane_rbegin (const size_type slice)

Returns a read/write reverse iterator that points to the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order. More...

const_reverse_iterator plane_rbegin (const size_type slice) const

Returns a read-only (constant) reverse iterator that points to the last element in the slice plane k of the GenericMultiComponent3d. Iteration is done in reverse element order. More...

reverse_iterator plane_rend (const size_type slice)

Returns a read/write reverse iterator that points to one before the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order. More...

const_reverse_iterator plane_rend (const size_type slice) const

Returns a read-only (constant) reverse iterator that points to one before the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order. More...

two dimensionnal plane iterators : Global iterators

iterator2d plane_upper_left (PLANE_ORIENTATION P, const size_type plane_coordinate)

Returns a read/write iterator that points to the first element of the plane in the GenericMultiComponent3d. It points to the upper left element of the plane Iteration is done in ordinary element order. More...

iterator2d plane_bottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate)

Returns a read/write iterator that points to the last element of the plane in the GenericMultiComponent3d. It points to past the end element of the bottom right element of the plane Iteration is done in ordinary element order. More...

const_iterator2d plane_upper_left (PLANE_ORIENTATION P, const size_type plane_coordinate) const

Returns a read/write const iterator that points to the first element of the plane in the GenericMultiComponent3d. It points to the upper left element of the plane Iteration is done in ordinary element order. More...

const_iterator2d plane_bottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate) const

Returns a read/write const iterator that points to the last element of the plane in the GenericMultiComponent3d. It points to past the end element of the bottom right element of the plane Iteration is done in ordinary element order. More...

reverse_iterator2d plane_rupper_left (PLANE_ORIENTATION P, const size_type plane_coordinate)

Returns a read/write reverse_iterator that points to the bottom right element of the plane in the GenericMultiComponent3d. Iteration is done in backward element order. More...

reverse_iterator2d plane_rbottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate)

Returns a read/write reverse_iterator that points to the upper left element of the plane in the GenericMultiComponent3d. Iteration is done in backward element order. More...

const_reverse_iterator2d plane_rupper_left (PLANE_ORIENTATION P, const size_type plane_coordinate) const

Returns a read/write const reverse iterator that points to the bottom right element of the plane in the GenericMultiComponent3d. Iteration is done in backward element order. More...

const_reverse_iterator2d plane_rbottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate) const

Returns a read/write const reverse iterator that points to the upper left element of the plane in the GenericMultiComponent3d. Iteration is done in backward element order. More...

two dimensionnal plane iterators : box iterators

iterator2d plane_upper_left (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b)

Returns a read/write iterator that points to the first element of a box within a plane in the GenericMultiComponent3d. It points to the upper left element of the box Iteration is done in ordinary element order. More...

iterator2d plane_bottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b)

Returns a read/write iterator that points to the last element of a box within a plane in the GenericMultiComponent3d. It points to past the end element of the bottom right element of the plane Iteration is done in ordinary element order. More...

const_iterator2d plane_upper_left (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b) const

Returns a read/write const iterator that points to the first element of a box within a plane in the GenericMultiComponent3d. It points to the upper left element of the plane Iteration is done in ordinary element order. More...

const_iterator2d plane_bottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b) const

Returns a read/write const iterator that points to the last element of a box within a plane in the GenericMultiComponent3d. It points to past the end element of the bottom right element of the plane Iteration is done in ordinary element order. More...

reverse_iterator2d plane_rupper_left (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b)

Returns a read/write reverse iterator that points to the last element of a box within a plane in the GenericMultiComponent3d. It points to the bottom right element of the box Iteration is done in backward element order. More...

reverse_iterator2d plane_rbottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b)

Returns a read/write reverse iterator that points to the first element of a box within a plane in the GenericMultiComponent3d. It points to the upper left element of the plane Iteration is done in backward element order. More...

const_reverse_iterator2d plane_rupper_left (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b) const

Returns a read/write const reverse iterator that points to the last element of a box within a plane in the GenericMultiComponent3d. It points to the bottom right element of the plane Iteration is done in backward element order. More...

const_reverse_iterator2d plane_rbottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b) const

Returns a read/write const reverse iterator that points to the first element of a box within a plane in the GenericMultiComponent3d. It points to the bottom right element of the plane Iteration is done in backward element order. More...

three dimensionnal iterators : Global iterators

iterator3d front_upper_left ()

Returns a read/write iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the GenericMultiComponent3d. More...

iterator3d back_bottom_right ()

Returns a read/write iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the GenericMultiComponent3d. More...

const_iterator3d front_upper_left () const

Returns a read-only iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the GenericMultiComponent3d. More...

const_iterator3d back_bottom_right () const

Returns a read-only iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the GenericMultiComponent3d. More...

reverse_iterator3d rfront_upper_left ()

Returns a read/write reverse iterator3d. It points to the back bottom right element of the GenericMultiComponent3d. Iteration is done within the GenericMultiComponent3d in the reverse order. More...

reverse_iterator3d rback_bottom_right ()

Returns a read/write reverse iterator3d. It points to past the front upper left element of the GenericMultiComponent3d. Iteration is done in the reverse order. More...

const_reverse_iterator3d rfront_upper_left () const

Returns a read only reverse iterator3d that points. It points to the back bottom right element of the GenericMultiComponent3d. Iteration is done within the GenericMultiComponent3d in the reverse order. More...

const_reverse_iterator3d rback_bottom_right () const

Returns a read only reverse iterator3d. It points to past the front upper left element of the GenericMultiComponent3d. Iteration is done in the reverse order. More...

three dimensionnal iterators : Box iterators

iterator3d front_upper_left (const Box3d< int > &box)

Returns a read/write iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the Box3d associated to the GenericMultiComponent3d. More...

iterator3d back_bottom_right (const Box3d< int > &box)

Returns a read/write iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the Box3d associated to the GenericMultiComponent3d. More...

const_iterator3d front_upper_left (const Box3d< int > &box) const

Returns a read only iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the Box3d associated to the GenericMultiComponent3d. More...

const_iterator3d back_bottom_right (const Box3d< int > &box) const

Returns a read only iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the Box3d associated to the GenericMultiComponent3d. More...

reverse_iterator3d rfront_upper_left (const Box3d< int > &box)

Returns a read/write reverse iterator3d. It points to the back bottom right element of the Box3d associated to the GenericMultiComponent3d. Iteration is done in the reverse order. More...

reverse_iterator3d rback_bottom_right (const Box3d< int > &box)

Returns a read/write reverse iterator3d. It points to one before the front upper left element of the Box3d box associated to the GenericMultiComponent3d. More...

const_reverse_iterator3d rfront_upper_left (const Box3d< int > &box) const

Returns a read only reverse iterator3d. It points to the back bottom right element of the Box3d box associated to the GenericMultiComponent3d. Iteration is done in the reverse order. More...

const_reverse_iterator3d rback_bottom_right (const Box3d< int > &box) const

Returns a read-only reverse iterator3d. It points to one before the front upper left element of the Box3d box associated to the GenericMultiComponent3d. More...

three dimensionnal iterators : Range iterators

iterator3d_range front_upper_left (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range)

Returns a read/write iterator3d_range that points to the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...

iterator3d_range back_bottom_right (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range)

Returns a read/write iterator3d_range that points to the past the end back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...

const_iterator3d_range front_upper_left (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range) const

Returns a read-only iterator3d_range that points to the to the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...

const_iterator3d_range back_bottom_right (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range) const

Returns a read-only iterator3d_range that points to the past the end back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...

reverse_iterator3d_range rfront_upper_left (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range)

Returns a read/write reverse_iterator3d_range that points to the past the back bottom right element of the ranges row_range and col_range associated to the GenericMultiComponent3d. Iteration is done in the reverse order. More...

reverse_iterator3d_range rback_bottom_right (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range)

Returns a read/write reverse_iterator3d_range that points to one before the front upper left element of the ranges row_range and col_range associated to the GenericMultiComponent3d. Iteration is done in the reverse order. More...

const_reverse_iterator3d_range rfront_upper_left (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range) const

Returns a read-only reverse_iterator3d_range that points to the past the back bottom right element of the ranges row_range and col_range associated to the GenericMultiComponent3d. Iteration is done in the reverse order. More...

const_reverse_iterator3d_range rback_bottom_right (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range) const

Returns a read-only reverse_iterator3d_range that points to one before the front upper left element of the ranges row_range and col_range associated to the GenericMultiComponent3d.Iteration is done in the reverse order. More...

One dimensional component global iterators

component_iterator begin (const std::size_t component)

Returns a read/write iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

const_component_iterator begin (const std::size_t component) const

Returns a read-only (constant) iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

component_iterator end (const std::size_t component)

Returns a read/write iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

const_component_iterator end (const std::size_t component) const

Returns a read-only (constant) iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

reverse_component_iterator rbegin (const std::size_t component)

Returns a read/write iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

const_reverse_component_iterator rbegin (const std::size_t component) const

Returns a read-only (constant) iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

reverse_component_iterator rend (const std::size_t component)

Returns a read/write iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

const_reverse_component_iterator rend (const std::size_t component) const

Returns a read-only (constant) iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

One dimensional component slice iterators

component_slice_iterator slice_begin (const std::size_t component, const size_type row, const size_type col)

Returns a read/write iterator that points to the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number). More...

const_component_slice_iterator slice_begin (const std::size_t component, const size_type row, const size_type col) const

Returns a read-only (constant) iterator that points to the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number). More...

component_slice_iterator slice_end (const std::size_t component, const size_type row, const size_type col)

Returns a read/write iterator that points to the one past the end element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number). More...

const_component_slice_iterator slice_end (const std::size_t component, const size_type row, const size_type col) const

Returns a read-only (constant) iterator that points to the one past the end element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number). More...

reverse_component_slice_iterator slice_rbegin (const std::size_t component, const size_type row, const size_type col)

Returns a read/write iterator that points to the last element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number). More...

const_reverse_component_slice_iterator slice_rbegin (const std::size_t component, const size_type row, const size_type col) const

Returns a read-only (constant) iterator that points to the last element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number). More...

reverse_component_slice_iterator slice_rend (const std::size_t component, const size_type row, const size_type col)

Returns a read/write iterator that points to the one before the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number). More...

const_reverse_component_slice_iterator slice_rend (const std::size_t component, const size_type row, const size_type col) const

Returns a read (constant) iterator that points to the one before the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number). More...

One dimensional component row iterators

component_row_iterator row_begin (const std::size_t component, const size_type slice, const size_type row)

Returns a read/write iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

const_component_row_iterator row_begin (const std::size_t component, const size_type slice, const size_type row) const

Returns a read_only iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

component_row_iterator row_end (const std::size_t component, const size_type slice, const size_type row)

Returns a read/write iterator that points to the past-the-end element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

const_component_row_iterator row_end (const std::size_t component, const size_type slice, const size_type row) const

Returns a read_only iterator that points to the past-the-end element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

reverse_component_row_iterator row_rbegin (const std::size_t component, const size_type slice, const size_type row)

Returns a read/write reverse iterator that points to the last element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order. More...

const_reverse_component_row_iterator row_rbegin (const std::size_t component, const size_type slice, const size_type row) const

Returns a read_only reverse iterator that points to the last element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order. More...

reverse_component_row_iterator row_rend (const std::size_t component, const size_type slice, const size_type row)

Returns a read/write reverse iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order. More...

const_reverse_component_row_iterator row_rend (const std::size_t component, const size_type slice, const size_type row) const

Returns a read_only reverse iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order. More...

One dimensional component col iterators

component_col_iterator col_begin (const std::size_t component, const size_type slice, const size_type col)

Returns a read/write iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...

const_component_col_iterator col_begin (const std::size_t component, const size_type slice, const size_type col) const

Returns a read_only iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...

component_col_iterator col_end (const std::size_t component, const size_type slice, const size_type col)

Returns a read/write iterator that points to the past-the-end element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...

const_component_col_iterator col_end (const std::size_t component, const size_type slice, const size_type col) const

Returns a read_only iterator that points to the past-the-end element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...

reverse_component_col_iterator col_rbegin (const std::size_t component, const size_type slice, const size_type col)

Returns a read/write reverse iterator that points to the last element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...

const_reverse_component_col_iterator col_rbegin (const std::size_t component, const size_type slice, const size_type col) const

Returns a read_only reverse iterator that points to the last element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...

reverse_component_col_iterator col_rend (const std::size_t component, const size_type slice, const size_type col)

Returns a read/write reverse iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...

const_reverse_component_col_iterator col_rend (const std::size_t component, const size_type slice, const size_type col) const

Returns a read_only reverse iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns. More...

One dimensional component slice range iterators

component_slice_range_iterator slice_begin (const std::size_t component, const size_type row, const size_type col, const slip::Range< int > &range)

Returns a read/write iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

component_slice_range_iterator slice_end (const std::size_t component, const size_type row, const size_type col, const slip::Range< int > &range)

Returns a read/write iterator that points one past the end element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

const_component_slice_range_iterator slice_begin (const std::size_t component, const size_type row, const size_type col, const slip::Range< int > &range) const

Returns a read only (constant) iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

const_component_slice_range_iterator slice_end (const std::size_t component, const size_type row, const size_type col, const slip::Range< int > &range) const

Returns a read_only iterator that points one past the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

reverse_component_slice_range_iterator slice_rbegin (const std::size_t component, const size_type row, const size_type col, const slip::Range< int > &range)

Returns a read/write iterator that points to the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...

reverse_component_slice_range_iterator slice_rend (const std::size_t component, const size_type row, const size_type col, const slip::Range< int > &range)

Returns a read/write iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range. More...

const_reverse_component_slice_range_iterator slice_rbegin (const std::size_t component, const size_type row, const size_type col, const slip::Range< int > &range) const

Returns a read only (constant) iterator that points to the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range. More...

const_reverse_component_slice_range_iterator slice_rend (const std::size_t component, const size_type row, const size_type col, const slip::Range< int > &range) const

Returns a read_only iterator that points one past the lastto the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range. More...

One dimensional component row range iterators

component_row_range_iterator row_begin (const std::size_t component, const size_type slice, const size_type row, const slip::Range< int > &range)

Returns a read/write iterator that points to the first element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

component_row_range_iterator row_end (const std::size_t component, const size_type slice, const size_type row, const slip::Range< int > &range)

Returns a read/write iterator that points one past the end element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

const_component_row_range_iterator row_begin (const std::size_t component, const size_type slice, const size_type row, const slip::Range< int > &range) const

Returns a read-only iterator that points to the first element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

const_component_row_range_iterator row_end (const std::size_t component, const size_type slice, const size_type row, const slip::Range< int > &range) const

Returns a read_only iterator that points one past the last element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

reverse_component_row_range_iterator row_rbegin (const std::size_t component, const size_type slice, const size_type row, const slip::Range< int > &range)

Returns a read-write iterator that points to the last element of the Range range of the row of a slice row and slice in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...

reverse_component_row_range_iterator row_rend (const std::size_t component, const size_type slice, const size_type row, const slip::Range< int > &range)

Returns a read-write iterator that points one before the first element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...

const_reverse_component_row_range_iterator row_rbegin (const std::size_t component, const size_type slice, const size_type row, const slip::Range< int > &range) const

Returns a read-only iterator that points to the last element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...

const_reverse_component_row_range_iterator row_rend (const std::size_t component, const size_type slice, const size_type row, const slip::Range< int > &range) const

Returns a read-only iterator that points one before the first element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...

One dimensional component col range iterators

component_col_range_iterator col_begin (const std::size_t component, const size_type slice, const size_type col, const slip::Range< int > &range)

Returns a read-write iterator that points to the first element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

component_col_range_iterator col_end (const std::size_t component, const size_type slice, const size_type col, const slip::Range< int > &range)

Returns a read-write iterator that points to the past the end element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

const_component_col_range_iterator col_begin (const std::size_t component, const size_type slice, const size_type col, const slip::Range< int > &range) const

Returns a read-only iterator that points to the first element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

const_component_col_range_iterator col_end (const std::size_t component, const size_type slice, const size_type col, const slip::Range< int > &range) const

Returns a read-only iterator that points to the past the end element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range. More...

reverse_component_col_range_iterator col_rbegin (const std::size_t component, const size_type slice, const size_type col, const slip::Range< int > &range)

Returns a read-write iterator that points to the last element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...

reverse_component_col_range_iterator col_rend (const std::size_t component, const size_type slice, const size_type col, const slip::Range< int > &range)

Returns a read-write iterator that points to one before the first element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...

const_reverse_component_col_range_iterator col_rbegin (const std::size_t component, const size_type slice, const size_type col, const slip::Range< int > &range) const

Returns a read_only iterator that points to the last element of the Range & range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...

const_reverse_component_col_range_iterator col_rend (const std::size_t component, const size_type slice, const size_type col, const slip::Range< int > &range) const

Returns a read-only iterator that points to the first element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range. More...

One dimensional component global plane iterators

component_iterator plane_begin (const std::size_t component, const size_type slice)

Returns a read/write iterator that points to the first element in the in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

const_component_iterator plane_begin (const std::size_t component, const size_type slice) const

Returns a read-only (constant) iterator that points to the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

component_iterator plane_end (const std::size_t component, const size_type slice)

Returns a read/write iterator that points one past the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

const_component_iterator plane_end (const std::size_t component, const size_type slice) const

Returns a read-only (constant) iterator that points one past the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order. More...

reverse_component_iterator plane_rbegin (const std::size_t component, const size_type slice)

Returns a read/write reverse iterator that points to the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order. More...

const_reverse_component_iterator plane_rbegin (const std::size_t component, const size_type slice) const

Returns a read-only (constant) reverse iterator that points to the last element in the slice plane k of the GenericMultiComponent3d. Iteration is done in reverse element order. More...

reverse_component_iterator plane_rend (const std::size_t component, const size_type slice)

Returns a read/write reverse iterator that points to one before the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order. More...

const_reverse_component_iterator plane_rend (const std::size_t component, const size_type slice) const

Returns a read-only (constant) reverse iterator that points to one before the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order. More...

Three dimensionnal component iterators : Global component iterators

component_iterator3d front_upper_left (const std::size_t component)

Returns a read/write component_iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the GenericMultiComponent3d. More...

component_iterator3d back_bottom_right (const std::size_t component)

Returns a read/write component_iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the GenericMultiComponent3d. More...

const_component_iterator3d front_upper_left (const std::size_t component) const

Returns a read only const_component_iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the GenericMultiComponent3d. More...

const_component_iterator3d back_bottom_right (const std::size_t component) const

Returns a read only const_component_iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the GenericMultiComponent3d. More...

reverse_component_iterator3d rfront_upper_left (const std::size_t component)

Returns a read/write reverse component iterator3d. It points to the back bottom right element of the GenericMultiComponent3d. Iteration is done within the GenericMultiComponent3d in the reverse order. More...

reverse_component_iterator3d rback_bottom_right (const std::size_t component)

Returns a read/write reverse component iterator3d. It points to past the front upper left element of the GenericMultiComponent3d. Iteration is done in the reverse order. More...

const_reverse_component_iterator3d rfront_upper_left (const std::size_t component) const

Returns a read only reverse component iterator3d that points. It points to the back bottom right element of the GenericMultiComponent3d. Iteration is done within the GenericMultiComponent3d in the reverse order. More...

const_reverse_component_iterator3d rback_bottom_right (const std::size_t component) const

Returns a read only reverse component iterator3d. It points to past the front upper left element of the GenericMultiComponent3d. Iteration is done in the reverse order. More...

component_iterator3d front_upper_left (const std::size_t component, const Box3d< int > &box)

Returns a read/write component iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the Box3d associated to the GenericMultiComponent3d. More...

component_iterator3d back_bottom_right (const std::size_t component, const Box3d< int > &box)

Returns a read/write component iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the Box3d associated to the GenericMultiComponent3d. More...

const_component_iterator3d front_upper_left (const std::size_t component, const Box3d< int > &box) const

Returns a read only component iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the Box3d associated to the GenericMultiComponent3d. More...

const_component_iterator3d back_bottom_right (const std::size_t component, const Box3d< int > &box) const

Returns a read only component iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the Box3d associated to the GenericMultiComponent3d. More...

reverse_component_iterator3d rfront_upper_left (const std::size_t component, const Box3d< int > &box)

Returns a read/write reverse component iterator3d. It points to the back bottom right element of the Box3d associated to the GenericMultiComponent3d. Iteration is done in the reverse order. More...

reverse_component_iterator3d rback_bottom_right (const std::size_t component, const Box3d< int > &box)

Returns a read/write reverse component iterator3d. It points to one before the front upper left element of the Box3d box associated to the GenericMultiComponent3d. More...

const_reverse_component_iterator3d rfront_upper_left (const std::size_t component, const Box3d< int > &box) const

Returns a read only reverse component iterator3d. It points to the back bottom right element of the Box3d box associated to the GenericMultiComponent3d. Iteration is done in the reverse order. More...

const_reverse_component_iterator3d rback_bottom_right (const std::size_t component, const Box3d< int > &box) const

Returns a read-only reverse component iterator3d. It points to one before the front upper left element of the Box3d box associated to the GenericMultiComponent3d. More...

component_iterator3d_range front_upper_left (const std::size_t component, const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range)

Returns a read/write component_iterator3d_range that points to the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...

component_iterator3d_range back_bottom_right (const std::size_t component, const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range)

Returns a read/write component_iterator3d_range that points to the past the end back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...

const_component_iterator3d_range front_upper_left (const std::size_t component, const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range) const

Returns a read/write component_const_iterator3d_range that points to the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...

const_component_iterator3d_range back_bottom_right (const std::size_t component, const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range) const

Returns a read/write const_component iterator3d_range that points to the past the end back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...

reverse_component_iterator3d_range rfront_upper_left (const std::size_t component, const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range)

Returns a read/write reverse_component_iterator3d_range. It points to the back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...

reverse_component_iterator3d_range rback_bottom_right (const std::size_t component, const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range)

Returns a read/write reverse_component_iterator3d_range. It points to one before the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...

const_reverse_component_iterator3d_range rfront_upper_left (const std::size_t component, const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range) const

Returns a read/write reverse_const_component_iterator3d_range. It points to the back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...

const_reverse_component_iterator3d_range rback_bottom_right (const std::size_t component, const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range) const

Returns a read/write reverse_const_component_iterator3d_range. It points to one before the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d. More...

Assignment operators and methods

self & operator= (const self &rhs)

Assign a GenericMultiComponent3d. More...

self & operator= (const Block &val)

Affects all the element of the GenericMultiComponent3d by val. More...

self & operator= (const typename Block::value_type &val)

Affects all the element of the GenericMultiComponent3d by val. More...

void fill (const Block &value)

Fills the container range [begin(),begin()+size()) with copies of value. More...

void fill (const typename Block::pointer value)

Fills the container range [begin(),begin()+size()) with a copy of the value array. More...

void fill (const Block *value)

Fills the container range [begin(),begin()+size()) with a copy of the value array. More...

template<typename InputIterator >

void fill (InputIterator first, InputIterator last)

Fills the container range [begin(),begin()+size()) with a copy of the range [first,last) More...

template<typename InputIterator >

void fill (std::vector< InputIterator > first_iterators_list, InputIterator last)

Fills the container range [begin(),begin()+size()) with a copy of the range [first,last) More...

template<typename InputIterator >

void fill (std::size_t component, InputIterator first, InputIterator last)

Fills the container range [begin(),begin()+size()) with a copy of the range [first,last) More...

Element access operators

Less than comparison operator (GenericMultiComponent3d ordering relation)

Parameters

x	A GenericMultiComponent3d
y	A GenericMultiComponent3d of the same type of x

Returns: true iff x is lexicographically less than y

Precondition: x.size() == y.size()

More than comparison operator

Parameters

x	A GenericMultiComponent3d
y	A GenericMultiComponent3d of the same type of x

Returns: true iff y > x

Precondition: x.size() == y.size()

Less than equal comparison operator

Parameters

x	A GenericMultiComponent3d
y	A GenericMultiComponent3d of the same type of x

Returns: true iff !(y > x)

Precondition: x.size() == y.size()

More than equal comparison operator

Parameters

x	A GenericMultiComponent3d
y	A GenericMultiComponent3d of the same type of x

Returns: true iff !(x < y)

Precondition: x.size() == y.size()

pointer * operator[] (const size_type k)

Subscript access to the slice datas contained in the GenericMultiComponent3d. More...

const_pointer const * operator[] (const size_type k) const

Subscript access to the slice datas contained in the GenericMultiComponent3d. More...

reference operator() (const size_type k, const size_type i, const size_type j)

Subscript access to the data contained in the GenericMultiComponent3d. More...

const_reference operator() (const size_type k, const size_type i, const size_type j) const

Subscript access to the data contained in the GenericMultiComponent3d. More...

Static Public Attributes
static const std::size_t	DIM = 3

static const std::size_t	COMPONENTS = Block::SIZE

Friends
class	boost::serialization::access

i/o operators
std::ostream &	operator<< (std::ostream &out, const self &a)
	Write the GenericMultiComponent3d to the ouput stream. More...

Comparison operators
bool	operator== (const GenericMultiComponent3d< Block > &x, const GenericMultiComponent3d< Block > &y)
	GenericMultiComponent3d equality comparison. More...

bool	operator!= (const GenericMultiComponent3d< Block > &x, const GenericMultiComponent3d< Block > &y)
	GenericMultiComponent3d inequality comparison. More...

Detailed Description

template<typename Block>
class slip::GenericMultiComponent3d< Block >

This is a GenericMultiComponent3d class. This container statisfies the BidirectionnalContainer concepts of the STL. It is also an 3d extension of the RandomAccessContainer concept. That is to say the bracket element access is replaced by the triple bracket element access. Data are stored using a Matrix3d of Block. It is essentially an internal class used to define slip::DenseVector3dField3d. But it can be used to define other 3d Multicomponent structures.

Author: Benoit Tremblais <tremblais_AT_sic.univ-poitiers.fr>

Version: 0.0.4

Date: 2014/03/25

Since: 1.0.0

Parameters

Block Type of object in the GenericMultiComponent3d Must be a static block

Axis conventions:: axis and notation conventions

Definition at line 121 of file GenericMultiComponent3d.hpp.

Member Typedef Documentation

template<typename Block>

typedef block_value_type* slip::GenericMultiComponent3d< Block >::block_pointer

Definition at line 256 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef block_value_type& slip::GenericMultiComponent3d< Block >::block_reference

Definition at line 258 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef Block::value_type slip::GenericMultiComponent3d< Block >::block_value_type

Definition at line 255 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::stride_iterator<pointer> slip::GenericMultiComponent3d< Block >::col_iterator

Definition at line 207 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::stride_iterator<col_iterator> slip::GenericMultiComponent3d< Block >::col_range_iterator

Definition at line 213 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::stride_iterator<block_pointer> slip::GenericMultiComponent3d< Block >::component_col_iterator

Definition at line 276 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::stride_iterator<block_pointer> slip::GenericMultiComponent3d< Block >::component_col_range_iterator

Definition at line 278 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::kstride_iterator<typename Block::pointer,Block::SIZE> slip::GenericMultiComponent3d< Block >::component_iterator

Definition at line 260 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::component_iterator3d_box<self,Block::SIZE> slip::GenericMultiComponent3d< Block >::component_iterator3d

Definition at line 296 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::component_iterator3d_range<self,Block::SIZE> slip::GenericMultiComponent3d< Block >::component_iterator3d_range

Definition at line 301 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef component_iterator slip::GenericMultiComponent3d< Block >::component_row_iterator

Definition at line 272 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::stride_iterator<block_pointer> slip::GenericMultiComponent3d< Block >::component_row_range_iterator

Definition at line 274 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::stride_iterator<block_pointer> slip::GenericMultiComponent3d< Block >::component_slice_iterator

Definition at line 268 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::stride_iterator<block_pointer> slip::GenericMultiComponent3d< Block >::component_slice_range_iterator

Definition at line 270 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef const block_value_type* slip::GenericMultiComponent3d< Block >::const_block_pointer

Definition at line 257 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef const block_value_type slip::GenericMultiComponent3d< Block >::const_block_reference

Definition at line 259 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::stride_iterator<const_pointer> slip::GenericMultiComponent3d< Block >::const_col_iterator

Definition at line 208 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::stride_iterator<const_col_iterator> slip::GenericMultiComponent3d< Block >::const_col_range_iterator

Definition at line 214 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::stride_iterator<const_block_pointer> slip::GenericMultiComponent3d< Block >::const_component_col_iterator

Definition at line 277 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::stride_iterator<const_block_pointer> slip::GenericMultiComponent3d< Block >::const_component_col_range_iterator

Definition at line 279 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::kstride_iterator<typename Block::const_pointer,Block::SIZE> slip::GenericMultiComponent3d< Block >::const_component_iterator

Definition at line 261 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::const_component_iterator3d_box<const_self,Block::SIZE> slip::GenericMultiComponent3d< Block >::const_component_iterator3d

Definition at line 298 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::const_component_iterator3d_range<const_self,Block::SIZE> slip::GenericMultiComponent3d< Block >::const_component_iterator3d_range

Definition at line 303 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef const_component_iterator slip::GenericMultiComponent3d< Block >::const_component_row_iterator

Definition at line 273 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::stride_iterator<const_block_pointer> slip::GenericMultiComponent3d< Block >::const_component_row_range_iterator

Definition at line 275 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::stride_iterator<const_block_pointer> slip::GenericMultiComponent3d< Block >::const_component_slice_iterator

Definition at line 269 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::stride_iterator<const_block_pointer> slip::GenericMultiComponent3d< Block >::const_component_slice_range_iterator

Definition at line 271 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef const_iterator3d slip::GenericMultiComponent3d< Block >::const_default_iterator

Definition at line 309 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef const_pointer slip::GenericMultiComponent3d< Block >::const_iterator

Definition at line 196 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::Array3d<Block>::const_iterator2d slip::GenericMultiComponent3d< Block >::const_iterator2d

Definition at line 239 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::Array3d<Block>::const_iterator3d slip::GenericMultiComponent3d< Block >::const_iterator3d

Definition at line 245 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::Array3d<Block>::const_iterator3d_range slip::GenericMultiComponent3d< Block >::const_iterator3d_range

Definition at line 247 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef value_type const* slip::GenericMultiComponent3d< Block >::const_pointer

Definition at line 188 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef value_type const& slip::GenericMultiComponent3d< Block >::const_reference

Definition at line 190 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_col_iterator> slip::GenericMultiComponent3d< Block >::const_reverse_col_iterator

Definition at line 221 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_col_range_iterator> slip::GenericMultiComponent3d< Block >::const_reverse_col_range_iterator

Definition at line 227 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_component_col_iterator> slip::GenericMultiComponent3d< Block >::const_reverse_component_col_iterator

Definition at line 290 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_component_col_range_iterator> slip::GenericMultiComponent3d< Block >::const_reverse_component_col_range_iterator

Definition at line 292 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_component_iterator> slip::GenericMultiComponent3d< Block >::const_reverse_component_iterator

Definition at line 264 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_component_iterator3d> slip::GenericMultiComponent3d< Block >::const_reverse_component_iterator3d

Definition at line 299 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_component_iterator3d_range> slip::GenericMultiComponent3d< Block >::const_reverse_component_iterator3d_range

Definition at line 304 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_component_row_iterator> slip::GenericMultiComponent3d< Block >::const_reverse_component_row_iterator

Definition at line 286 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_component_row_range_iterator> slip::GenericMultiComponent3d< Block >::const_reverse_component_row_range_iterator

Definition at line 288 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_component_slice_iterator> slip::GenericMultiComponent3d< Block >::const_reverse_component_slice_iterator

Definition at line 282 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_component_slice_range_iterator> slip::GenericMultiComponent3d< Block >::const_reverse_component_slice_range_iterator

Definition at line 284 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_iterator> slip::GenericMultiComponent3d< Block >::const_reverse_iterator

Definition at line 199 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_iterator2d> slip::GenericMultiComponent3d< Block >::const_reverse_iterator2d

Definition at line 241 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_iterator3d> slip::GenericMultiComponent3d< Block >::const_reverse_iterator3d

Definition at line 250 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_iterator3d_range> slip::GenericMultiComponent3d< Block >::const_reverse_iterator3d_range

Definition at line 252 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_iterator> slip::GenericMultiComponent3d< Block >::const_reverse_row_iterator

Definition at line 219 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_row_range_iterator> slip::GenericMultiComponent3d< Block >::const_reverse_row_range_iterator

Definition at line 225 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_slice_iterator> slip::GenericMultiComponent3d< Block >::const_reverse_slice_iterator

Definition at line 217 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_slice_range_iterator> slip::GenericMultiComponent3d< Block >::const_reverse_slice_range_iterator

Definition at line 223 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef const_pointer slip::GenericMultiComponent3d< Block >::const_row_iterator

Definition at line 206 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::stride_iterator<const_pointer> slip::GenericMultiComponent3d< Block >::const_row_range_iterator

Definition at line 212 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef const GenericMultiComponent3d<Block> slip::GenericMultiComponent3d< Block >::const_self

Definition at line 186 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::stride_iterator<const_pointer> slip::GenericMultiComponent3d< Block >::const_slice_iterator

Definition at line 204 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::stride_iterator<const_slice_iterator> slip::GenericMultiComponent3d< Block >::const_slice_range_iterator

Definition at line 210 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef iterator3d slip::GenericMultiComponent3d< Block >::default_iterator

Definition at line 308 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef ptrdiff_t slip::GenericMultiComponent3d< Block >::difference_type

Definition at line 192 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef pointer slip::GenericMultiComponent3d< Block >::iterator

Definition at line 195 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::Array3d<Block>::iterator2d slip::GenericMultiComponent3d< Block >::iterator2d

Definition at line 238 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::Array3d<Block>::iterator3d slip::GenericMultiComponent3d< Block >::iterator3d

Definition at line 244 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::Array3d<Block>::iterator3d_range slip::GenericMultiComponent3d< Block >::iterator3d_range

Definition at line 246 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef value_type* slip::GenericMultiComponent3d< Block >::pointer

Definition at line 187 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef value_type& slip::GenericMultiComponent3d< Block >::reference

Definition at line 189 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<col_iterator> slip::GenericMultiComponent3d< Block >::reverse_col_iterator

Definition at line 220 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<col_range_iterator> slip::GenericMultiComponent3d< Block >::reverse_col_range_iterator

Definition at line 226 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<component_col_iterator> slip::GenericMultiComponent3d< Block >::reverse_component_col_iterator

Definition at line 289 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<component_col_range_iterator> slip::GenericMultiComponent3d< Block >::reverse_component_col_range_iterator

Definition at line 291 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<component_iterator> slip::GenericMultiComponent3d< Block >::reverse_component_iterator

Definition at line 263 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<component_iterator3d> slip::GenericMultiComponent3d< Block >::reverse_component_iterator3d

Definition at line 297 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<component_iterator3d_range> slip::GenericMultiComponent3d< Block >::reverse_component_iterator3d_range

Definition at line 302 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<component_row_iterator> slip::GenericMultiComponent3d< Block >::reverse_component_row_iterator

Definition at line 285 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<component_row_range_iterator> slip::GenericMultiComponent3d< Block >::reverse_component_row_range_iterator

Definition at line 287 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<component_slice_iterator> slip::GenericMultiComponent3d< Block >::reverse_component_slice_iterator

Definition at line 281 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<component_slice_range_iterator> slip::GenericMultiComponent3d< Block >::reverse_component_slice_range_iterator

Definition at line 283 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<iterator> slip::GenericMultiComponent3d< Block >::reverse_iterator

Definition at line 198 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<iterator2d> slip::GenericMultiComponent3d< Block >::reverse_iterator2d

Definition at line 240 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<iterator3d> slip::GenericMultiComponent3d< Block >::reverse_iterator3d

Definition at line 249 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<iterator3d_range> slip::GenericMultiComponent3d< Block >::reverse_iterator3d_range

Definition at line 251 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<iterator> slip::GenericMultiComponent3d< Block >::reverse_row_iterator

Definition at line 218 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<row_range_iterator> slip::GenericMultiComponent3d< Block >::reverse_row_range_iterator

Definition at line 224 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<slice_iterator> slip::GenericMultiComponent3d< Block >::reverse_slice_iterator

Definition at line 216 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::reverse_iterator<slice_range_iterator> slip::GenericMultiComponent3d< Block >::reverse_slice_range_iterator

Definition at line 222 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef pointer slip::GenericMultiComponent3d< Block >::row_iterator

Definition at line 205 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::stride_iterator<pointer> slip::GenericMultiComponent3d< Block >::row_range_iterator

Definition at line 211 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef GenericMultiComponent3d<Block> slip::GenericMultiComponent3d< Block >::self

Definition at line 185 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef std::size_t slip::GenericMultiComponent3d< Block >::size_type

Definition at line 193 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::stride_iterator<pointer> slip::GenericMultiComponent3d< Block >::slice_iterator

Definition at line 203 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef slip::stride_iterator<slice_iterator> slip::GenericMultiComponent3d< Block >::slice_range_iterator

Definition at line 209 of file GenericMultiComponent3d.hpp.

template<typename Block>

typedef Block slip::GenericMultiComponent3d< Block >::value_type

Definition at line 184 of file GenericMultiComponent3d.hpp.

Constructor & Destructor Documentation

template<typename Block >

slip::GenericMultiComponent3d< Block >::GenericMultiComponent3d ( )

inline

Constructs a GenericMultiComponent3d.

Definition at line 5289 of file GenericMultiComponent3d.hpp.

template<typename Block>

slip::GenericMultiComponent3d< Block >::GenericMultiComponent3d	(	const size_type	slices,
		const size_type	rows,
		const size_type	cols
	)

Constructs a GenericMultiComponent3d.

Parameters

slices	first dimension of the GenericMultiComponent3d
rows	second dimension of the GenericMultiComponent3d
cols	third dimension of the GenericMultiComponent3d

template<typename Block>

slip::GenericMultiComponent3d< Block >::GenericMultiComponent3d	(	const size_type	slices,
		const size_type	rows,
		const size_type	cols,
		const Block &	val
	)

Constructs a GenericMultiComponent3d initialized by the scalar value val.

Parameters

slices	first dimension of the GenericMultiComponent3d
rows	second dimension of the GenericMultiComponent3d
cols	third dimension of the GenericMultiComponent3d
val	initialization value of the elements

template<typename Block>

slip::GenericMultiComponent3d< Block >::GenericMultiComponent3d	(	const size_type	slices,
		const size_type	rows,
		const size_type	cols,
		typename Block::const_pointer	val
	)

Constructs a GenericMultiComponent3d initialized by an array val.

Parameters

slices	first dimension of the GenericMultiComponent3d
rows	second dimension of the GenericMultiComponent3d
cols	third dimension of the GenericMultiComponent3d
val	initialization linear array value of the elements

template<typename Block>

slip::GenericMultiComponent3d< Block >::GenericMultiComponent3d	(	const size_type	slices,
		const size_type	rows,
		const size_type	cols,
		const Block *	val
	)

Constructs a GenericMultiComponent3d initialized by an array val.

Parameters

slices	first dimension of the GenericMultiComponent3d
rows	second dimension of the GenericMultiComponent3d
cols	third dimension of the GenericMultiComponent3d
val	initialization array value of the elements

template<typename Block>

template<typename InputIterator >

slip::GenericMultiComponent3d< Block >::GenericMultiComponent3d	(	const size_type	slices,
		const size_type	rows,
		const size_type	cols,
		InputIterator	first,
		InputIterator	last
	)

inline

Contructs a GenericMultiComponent3d from a range.

Parameters

slices	first dimension of the GenericMultiComponent3d
rows	second dimension of the GenericMultiComponent3d
cols	third dimension of the GenericMultiComponent3d
first	An input iterator.
last	An input iterator.

Create a GenericMultiComponent3d consisting of copies of the elements from [first,last).

Definition at line 385 of file GenericMultiComponent3d.hpp.

template<typename Block>

template<typename InputIterator >

slip::GenericMultiComponent3d< Block >::GenericMultiComponent3d	(	const size_type	slices,
		const size_type	rows,
		const size_type	cols,
		std::vector< InputIterator >	first_iterators_list,
		InputIterator	last
	)

inline

Contructs a GenericMultiComponent3d from a 3 ranges.

Parameters

slices	first dimension of the GenericMultiComponent3d
rows	second dimension of the GenericMultiComponent3d
cols	third dimension of the GenericMultiComponent3d
first_iterators_list	A std::vector of the first input iterators.
last	An input iterator.

Create a GenericMultiComponent3d consisting of copies of the elements from [first_iterators_list[0],last), [first_iterators_list[1],first_iterators_list[1] + (last - first_iterators_list[0]), ...

Definition at line 409 of file GenericMultiComponent3d.hpp.

template<typename Block>

slip::GenericMultiComponent3d< Block >::GenericMultiComponent3d ( const self & rhs )

inline

Constructs a copy of the GenericMultiComponent3d rhs.

Definition at line 5341 of file GenericMultiComponent3d.hpp.

template<typename Block >

slip::GenericMultiComponent3d< Block >::~GenericMultiComponent3d ( )

inlinevirtual

Destructor of the GenericMultiComponent3d.

Definition at line 5347 of file GenericMultiComponent3d.hpp.

template<typename Block>

slip::GenericMultiComponent3d< Block >::GenericMultiComponent3d	(	const typename GenericMultiComponent3d< Block >::size_type	slices,
		const typename GenericMultiComponent3d< Block >::size_type	rows,
		const typename GenericMultiComponent3d< Block >::size_type	cols
	)

inline

Definition at line 5295 of file GenericMultiComponent3d.hpp.

template<typename Block>

slip::GenericMultiComponent3d< Block >::GenericMultiComponent3d	(	const typename GenericMultiComponent3d< Block >::size_type	slices,
		const typename GenericMultiComponent3d< Block >::size_type	rows,
		const typename GenericMultiComponent3d< Block >::size_type	cols,
		typename Block::const_pointer	val
	)

inline

Definition at line 5303 of file GenericMultiComponent3d.hpp.

template<typename Block>

slip::GenericMultiComponent3d< Block >::GenericMultiComponent3d	(	const typename GenericMultiComponent3d< Block >::size_type	slices,
		const typename GenericMultiComponent3d< Block >::size_type	rows,
		const typename GenericMultiComponent3d< Block >::size_type	cols,
		const Block &	val
	)

inline

Definition at line 5323 of file GenericMultiComponent3d.hpp.

template<typename Block>

slip::GenericMultiComponent3d< Block >::GenericMultiComponent3d	(	const typename GenericMultiComponent3d< Block >::size_type	slices,
		const typename GenericMultiComponent3d< Block >::size_type	rows,
		const typename GenericMultiComponent3d< Block >::size_type	cols,
		const Block *	val
	)

inline

Definition at line 5332 of file GenericMultiComponent3d.hpp.

Member Function Documentation

template<typename Block>

GenericMultiComponent3d< Block > & slip::GenericMultiComponent3d< Block >::apply ( Block(*)(Block) fun )

inline

Returns the sums of the elements of the GenericMultiComponent3d.

Precondition: size() != 0

Applys the one-parameter C-function fun to each element of the GenericMultiComponent3d

Parameters

fun	The one-parameter C function

Returns: the resulting GenericMultiComponent3d

Definition at line 7672 of file GenericMultiComponent3d.hpp.

template<typename Block>

GenericMultiComponent3d< Block > & slip::GenericMultiComponent3d< Block >::apply ( Block(*)(const Block &) fun )

inline

Applys the one-parameter C-function fun to each element of the GenericMultiComponent3d.

Parameters

fun	The one-const-parameter C function

Returns: the resulting GenericMultiComponent3d

Definition at line 7680 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::iterator3d slip::GenericMultiComponent3d< Block >::back_bottom_right ( )

inline

Returns a read/write iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the GenericMultiComponent3d.

Returns: begin iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > M(3,4,5);

//Print M

std::copy(M.front_upper_left(),M.back_bottom_right(),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6520 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_iterator3d slip::GenericMultiComponent3d< Block >::back_bottom_right ( ) const

inline

Returns a read-only iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the GenericMultiComponent3d.

Returns: begin const iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > const M(3,4,5);

//Print M

std::copy(M.front_upper_left(),M.back_bottom_right(),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6527 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::iterator3d slip::GenericMultiComponent3d< Block >::back_bottom_right ( const Box3d< int > & box )

inline

Returns a read/write iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the Box3d associated to the GenericMultiComponent3d.

Parameters

box	a Box3d defining the range of indices to iterate within the GenericMultiComponent3d.

Returns: end iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Precondition: The box indices must be inside the range of the GenericMultiComponent3d ones.

Example: slip::GenericMultiComponent3d<slip::color<double> > M(3,4,5);

slip::Box3d<int> b(1,1,1,2,2,3);

//Print M within a box

std::copy(M.front_upper_left(b),M.back_bottom_right(b),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6588 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_iterator3d slip::GenericMultiComponent3d< Block >::back_bottom_right ( const Box3d< int > & box ) const

inline

Returns a read only iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the Box3d associated to the GenericMultiComponent3d.

Parameters

box	a Box3d defining the range of indices to iterate within the GenericMultiComponent3d.

Returns: end const iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Precondition: The box indices must be inside the range of the GenericMultiComponent3d ones.

Example: slip::GenericMultiComponent3d<slip::color<double> > const M(3,4,5);

slip::Box3d<int> b(1,1,1,2,2,3);

//Print M within a box

std::copy(M.front_upper_left(b),M.back_bottom_right(b),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6596 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::iterator3d_range slip::GenericMultiComponent3d< Block >::back_bottom_right	(	const Range< int > &	slice_range,
		const Range< int > &	row_range,
		const Range< int > &	col_range
	)

inline

Returns a read/write iterator3d_range that points to the past the end back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters

slice_range	The range of the slices.
row_range	The range of the rows.
col_range	The range of the columns.

Precondition: slice_range, row_range and col_range must be valid.; The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.

Returns: iterator3d_range value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > M(3,4,5);

slip::Range<int> sr(0,2,2);

slip::Range<int> rr(0,3,2);

slip::Range<int> cr(0,4,2);

//Print M within a range

std::copy(M.front_upper_left(sr,rr,cr),M.back_bottom_right(sr,rr,cr),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6651 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_iterator3d_range slip::GenericMultiComponent3d< Block >::back_bottom_right	(	const Range< int > &	slice_range,
		const Range< int > &	row_range,
		const Range< int > &	col_range
	)		const

inline

Returns a read-only iterator3d_range that points to the past the end back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters

slice_range	The range of the slices.
row_range	The range of the rows.
col_range	The range of the columns.

Precondition: slice_range, row_range and col_range must be valid.; The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.

Returns: const_iterator3d_range value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > const M(3,4,5);

slip::Range<int> sr(0,2,2);

slip::Range<int> rr(0,3,2);

slip::Range<int> cr(0,4,2);

//Print M within a range

std::copy(M.front_upper_left(sr,rr,cr),M.back_bottom_right(sr,rr,cr),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6674 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::component_iterator3d slip::GenericMultiComponent3d< Block >::back_bottom_right ( const std::size_t component )

inline

Returns a read/write component_iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the GenericMultiComponent3d.

Parameters

component The component number.

Returns: begin iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::Vector3d<double> > A1(8,8,4);

slip::GenericMultiComponent3d<slip::Vector3d<double> > A2(8,8,4);

//copy the first component of the elements of A1 in A2

std::copy(A1.front_upper_left(0),A1.back_bottom_right(0),A2.front_upper_left(0));

Definition at line 7320 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_component_iterator3d slip::GenericMultiComponent3d< Block >::back_bottom_right ( const std::size_t component ) const

inline

Returns a read only const_component_iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the GenericMultiComponent3d.

Parameters

component The component number.

Returns: begin iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 7339 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::component_iterator3d slip::GenericMultiComponent3d< Block >::back_bottom_right	(	const std::size_t	component,
		const Box3d< int > &	box
	)

inline

Returns a read/write component iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the Box3d associated to the GenericMultiComponent3d.

Parameters

component	The component number.
box	a Box3d defining the range of indices to iterate within the GenericMultiComponent3d.

Returns: end iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Precondition: The box indices must be inside the range of the GenericMultiComponent3d ones.

Definition at line 7395 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_component_iterator3d slip::GenericMultiComponent3d< Block >::back_bottom_right	(	const std::size_t	component,
		const Box3d< int > &	box
	)		const

inline

Returns a read only component iterator3d that points to the past the end element of the GenericMultiComponent3d. It points to past the end element of the back bottom right element of the Box3d associated to the GenericMultiComponent3d.

Parameters

component	The component number.
box	a Box3d defining the range of indices to iterate within the GenericMultiComponent3d.

Returns: end const iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Precondition: The box indices must be inside the range of the GenericMultiComponent3d ones.

Definition at line 7413 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::component_iterator3d_range slip::GenericMultiComponent3d< Block >::back_bottom_right	(	const std::size_t	component,
		const Range< int > &	slice_range,
		const Range< int > &	row_range,
		const Range< int > &	col_range
	)

inline

Returns a read/write component_iterator3d_range that points to the past the end back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters

component	The component number.
slice_range	The range of the slices.
row_range	The range of the rows.
col_range	The range of the columns.

Precondition: slice_range, row_range and col_range must be valid.; The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.

Returns: iterator3d_range value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 7477 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_component_iterator3d_range slip::GenericMultiComponent3d< Block >::back_bottom_right	(	const std::size_t	component,
		const Range< int > &	slice_range,
		const Range< int > &	row_range,
		const Range< int > &	col_range
	)		const

inline

Returns a read/write const_component iterator3d_range that points to the past the end back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters

component	The component number.
slice_range	The range of the slices.
row_range	The range of the rows.
col_range	The range of the columns.

Precondition: slice_range, row_range and col_range must be valid.; The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.

Returns: iterator3d_range value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 7498 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::iterator slip::GenericMultiComponent3d< Block >::begin ( )

inline

Returns a read/write iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Returns: begin iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > A1(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > A2(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > S(10,9,5);

//copy A1 in S

std::copy(A1.begin(),A1.end(),S.begin());

Definition at line 5404 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_iterator slip::GenericMultiComponent3d< Block >::begin ( ) const

inline

Returns a read-only (constant) iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Returns: const begin iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const A1(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > const A2(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > S(10,9,5);

//copy A1 in S

std::copy(A1.begin(),A1.end(),S.begin());

//copy A1 in S

std::copy(A1.begin(),A1.end(),S.begin());

Definition at line 5420 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::component_iterator slip::GenericMultiComponent3d< Block >::begin ( const std::size_t component )

inline

Returns a read/write iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

component The component number.

Returns: begin component_iterator value

Definition at line 6734 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_component_iterator slip::GenericMultiComponent3d< Block >::begin ( const std::size_t component ) const

inline

Returns a read-only (constant) iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

component The component number.

Returns: const begin component_iterator value

Definition at line 6750 of file GenericMultiComponent3d.hpp.

template<typename Block>

col_iterator slip::GenericMultiComponent3d< Block >::col_begin	(	const size_type	slice,
		const size_type	col
	)

Returns a read/write iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters

slice	The index of the slice.
col	The index of the column

Returns: begin col_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

const_col_iterator slip::GenericMultiComponent3d< Block >::col_begin	(	const size_type	slice,
		const size_type	col
	)		const

Returns a read_only iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters

slice	The index of the slice.
col	The index of the column

Returns: begin const_col_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

col_range_iterator slip::GenericMultiComponent3d< Block >::col_begin	(	const size_type	slice,
		const size_type	col,
		const slip::Range< int > &	range
	)

Returns a read-write iterator that points to the first element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

slice	The index of the slice.
col	The index of the column to iterate.
range	Range of the column to iterate

Returns: begin col_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: col must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.

Example:: slip::GenericMultiComponent3d<slip::color<double> > A1(8,8,8);

slip::GenericMultiComponent3d<slip::color<double> > A2(4,8,5);

slip::Range<int> range(0,A1.dim2()-1,2);

//copy the the elements of the column 0 of the slice 0 of A1 iterated according to the

//range in the column 1 of the slice 1 of A2

std::copy(A1.col_begin(0,0,range),A1.col_end(0,0,range),A2.col_begin(1,1));

template<typename Block>

const_col_range_iterator slip::GenericMultiComponent3d< Block >::col_begin	(	const size_type	slice,
		const size_type	col,
		const slip::Range< int > &	range
	)		const

Returns a read-only iterator that points to the first element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

slice	The index of the slice.
col	The index of the column to iterate.
range	Range of the column to iterate.

Returns: begin const_col_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: col must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const A1(8,8,8);

slip::GenericMultiComponent3d<slip::color<double> > A2(4,8,5);

slip::Range<int> range(0,A1.dim2()-1,2);

//copy the the elements of the column 0 of the slice 0 of A1 iterated according to the

//range in the column 1 of the slice 1 of A2

std::copy(A1.col_begin(0,0,range),A1.col_end(0,0,range),A2.col_begin(1,1));

template<typename Block>

component_col_iterator slip::GenericMultiComponent3d< Block >::col_begin	(	const std::size_t	component,
		const size_type	slice,
		const size_type	col
	)

Returns a read/write iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters

component	The component number.
slice	The index of the slice.
col	The index of the column

Returns: begin col_iterator value

template<typename Block>

const_component_col_iterator slip::GenericMultiComponent3d< Block >::col_begin	(	const std::size_t	component,
		const size_type	slice,
		const size_type	col
	)		const

Returns a read_only iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters

component	The component number.
slice	The index of the slice.
col	The index of the column

Returns: begin const_col_iterator value

template<typename Block>

component_col_range_iterator slip::GenericMultiComponent3d< Block >::col_begin	(	const std::size_t	component,
		const size_type	slice,
		const size_type	col,
		const slip::Range< int > &	range
	)

Returns a read-write iterator that points to the first element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

component	The component number.
slice	The index of the slice.
col	The index of the column to iterate.
range	Range of the column to iterate

Returns: begin col_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: col must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.
slip::Array3d<double> A1(8,8,8);

slip::Array3d<double> A2(4,8,5);

slip::Range<int> range(0,A1.dim1()-1,2);

//copy the the elements of the column 0 of A1 iterated according to the

//range in the column 1 of A2

std::copy(A1.col_begin(0,range),A1.col_end(0,range),A2.col_begin(1));

template<typename Block>

const_component_col_range_iterator slip::GenericMultiComponent3d< Block >::col_begin	(	const std::size_t	component,
		const size_type	slice,
		const size_type	col,
		const slip::Range< int > &	range
	)		const

Returns a read-only iterator that points to the first element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

component	The component number.
slice	The index of the slice.
col	The index of the column to iterate.
range	Range of the column to iterate.

Returns: begin const_col_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: col must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.
slip::Array3d<double> A1(8,8,8);

slip::Array3d<double> A2(4,8,5);

slip::Range<int> range(0,A1.dim1()-1,2);

//copy the the elements of the column 0 of A1 iterated according to the

//range in the column 1 of A2

std::copy(A1.col_begin(0,range),A1.col_end(0,range),A2.col_begin(1));

template<typename Block>

col_iterator slip::GenericMultiComponent3d< Block >::col_end	(	const size_type	slice,
		const size_type	col
	)

Returns a read/write iterator that points to the past-the-end element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters

slice	The index of the slice.
col	The index of the column

Returns: end col_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

const_col_iterator slip::GenericMultiComponent3d< Block >::col_end	(	const size_type	slice,
		const size_type	col
	)		const

Returns a read_only iterator that points to the past-the-end element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters

slice	The index of the slice.
col	The index of the column

Returns: end const_col_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

col_range_iterator slip::GenericMultiComponent3d< Block >::col_end	(	const size_type	slice,
		const size_type	col,
		const slip::Range< int > &	range
	)

Returns a read-write iterator that points to the past the end element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

slice	The index of the slice.
col	The index of the column to iterate.
range	Range of the column to iterate.

Returns: begin col_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: col must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.

Example:: slip::GenericMultiComponent3d<slip::color<double> > A1(8,8,8);

slip::GenericMultiComponent3d<slip::color<double> > A2(4,8,5);

slip::Range<int> range(0,A1.dim2()-1,2);

//copy the the elements of the column 0 of the slice 0 of A1 iterated according to the

//range in the column 1 of the slice 1 of A2

std::copy(A1.col_begin(0,0,range),A1.col_end(0,0,range),A2.col_begin(1,1));

template<typename Block>

const_col_range_iterator slip::GenericMultiComponent3d< Block >::col_end	(	const size_type	slice,
		const size_type	col,
		const slip::Range< int > &	range
	)		const

Returns a read-only iterator that points to the past the end element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

slice	The index of the slice.
col	The index of the column to iterate.
range	Range of the column to iterate

Returns: begin const_col_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: col must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const A1(8,8,8);

slip::GenericMultiComponent3d<slip::color<double> > A2(4,8,5);

slip::Range<int> range(0,A1.dim2()-1,2);

//copy the the elements of the column 0 of the slice 0 of A1 iterated according to the

//range in the column 1 of the slice 1 of A2

std::copy(A1.col_begin(0,0,range),A1.col_end(0,0,range),A2.col_begin(1,1));

template<typename Block>

component_col_iterator slip::GenericMultiComponent3d< Block >::col_end	(	const std::size_t	component,
		const size_type	slice,
		const size_type	col
	)

Returns a read/write iterator that points to the past-the-end element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters

component	The component number.
slice	The index of the slice.
col	The index of the column

Returns: end col_iterator value

template<typename Block>

const_component_col_iterator slip::GenericMultiComponent3d< Block >::col_end	(	const std::size_t	component,
		const size_type	slice,
		const size_type	col
	)		const

Returns a read_only iterator that points to the past-the-end element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters

component	The component number.
slice	The index of the slice.
col	The index of the column

Returns: end const_col_iterator value

template<typename Block>

component_col_range_iterator slip::GenericMultiComponent3d< Block >::col_end	(	const std::size_t	component,
		const size_type	slice,
		const size_type	col,
		const slip::Range< int > &	range
	)

Returns a read-write iterator that points to the past the end element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

component	The component number.
slice	The index of the slice.
col	The index of the column to iterate.
range	Range of the column to iterate.

Returns: begin col_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: col must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.
slip::Array3d<double> A1(8,8,8);

slip::Array3d<double> A2(4,8,5);

slip::Range<int> range(0,A1.dim1()-1,2);

//copy the the elements of the column 0 of A1 iterated according to the

//range in the column 1 of A2

std::copy(A1.col_begin(0,range),A1.col_end(0,range),A2.col_begin(1));

template<typename Block>

const_component_col_range_iterator slip::GenericMultiComponent3d< Block >::col_end	(	const std::size_t	component,
		const size_type	slice,
		const size_type	col,
		const slip::Range< int > &	range
	)		const

Returns a read-only iterator that points to the past the end element of the Range range of the col col in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

component	The component number.
slice	The index of the slice.
col	The index of the column to iterate.
range	Range of the column to iterate.

Returns: begin const_col_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: col must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.
slip::Array3d<double> A1(8,8,8);

slip::Array3d<double> A2(4,8,5);

slip::Range<int> range(0,A1.dim1()-1,2);

//copy the the elements of the column 0 of A1 iterated according to the

//range in the column 1 of A2

std::copy(A1.col_begin(0,range),A1.col_end(0,range),A2.col_begin(1));

template<typename Block>

reverse_col_iterator slip::GenericMultiComponent3d< Block >::col_rbegin	(	const size_type	slice,
		const size_type	col
	)

Returns a read/write reverse iterator that points to the last element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters

slice	The index of the slice.
col	The index of the column

Returns: begin reverse_col_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

const_reverse_col_iterator slip::GenericMultiComponent3d< Block >::col_rbegin	(	const size_type	slice,
		const size_type	col
	)		const

Returns a read_only reverse iterator that points to the last element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters

slice	The index of the slice.
col	The index of the column

Returns: begin const_reverse_col_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

reverse_col_range_iterator slip::GenericMultiComponent3d< Block >::col_rbegin	(	const size_type	slice,
		const size_type	col,
		const slip::Range< int > &	range
	)

Returns a read-write iterator that points to the last element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters

slice	The index of the slice.
col	The index of the column to iterate.
range	Range of the column to iterate.

Returns: begin reverse_col_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: col must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.

template<typename Block>

const_reverse_col_range_iterator slip::GenericMultiComponent3d< Block >::col_rbegin	(	const size_type	slice,
		const size_type	col,
		const slip::Range< int > &	range
	)		const

Returns a read_only iterator that points to the last element of the Range & range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters

slice	The index of the slice.
col	The index of the column to iterate.
range	Range of the column to iterate.

Returns: begin const_reverse_col_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: col must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.

template<typename Block>

reverse_component_col_iterator slip::GenericMultiComponent3d< Block >::col_rbegin	(	const std::size_t	component,
		const size_type	slice,
		const size_type	col
	)

Returns a read/write reverse iterator that points to the last element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters

component	The component number.
slice	The index of the slice.
col	The index of the column

Returns: begin reverse_col_iterator value

template<typename Block>

const_reverse_component_col_iterator slip::GenericMultiComponent3d< Block >::col_rbegin	(	const std::size_t	component,
		const size_type	slice,
		const size_type	col
	)		const

Returns a read_only reverse iterator that points to the last element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters

component	The component number.
slice	The index of the slice.
col	The index of the column

Returns: begin const_reverse_col_iterator value

template<typename Block>

reverse_component_col_range_iterator slip::GenericMultiComponent3d< Block >::col_rbegin	(	const std::size_t	component,
		const size_type	slice,
		const size_type	col,
		const slip::Range< int > &	range
	)

Returns a read-write iterator that points to the last element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters

component	The component number.
slice	The index of the slice.
col	The index of the column to iterate.
range	Range of the column to iterate.

Returns: begin reverse_col_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: col must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.

template<typename Block>

const_reverse_component_col_range_iterator slip::GenericMultiComponent3d< Block >::col_rbegin	(	const std::size_t	component,
		const size_type	slice,
		const size_type	col,
		const slip::Range< int > &	range
	)		const

Returns a read_only iterator that points to the last element of the Range & range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters

component	The component number.
slice	The index of the slice.
col	The index of the column to iterate.
range	Range of the column to iterate.

Returns: begin const_reverse_col_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: col must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.

template<typename Block>

reverse_col_iterator slip::GenericMultiComponent3d< Block >::col_rend	(	const size_type	slice,
		const size_type	col
	)

Returns a read/write reverse iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters

slice	The index of the slice.
col	The index of the column

Returns: end reverse_col_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

const_reverse_col_iterator slip::GenericMultiComponent3d< Block >::col_rend	(	const size_type	slice,
		const size_type	col
	)		const

Returns a read_only reverse iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters

slice	The index of the slice.
col	The index of the column

Returns: end const_reverse_col_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

reverse_col_range_iterator slip::GenericMultiComponent3d< Block >::col_rend	(	const size_type	slice,
		const size_type	col,
		const slip::Range< int > &	range
	)

Returns a read-write iterator that points to one before the first element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters

slice	The index of the slice.
col	The index of the column to iterate.
range	Range of the column to iterate.

Returns: reverse_col_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: col must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.

template<typename Block>

const_reverse_col_range_iterator slip::GenericMultiComponent3d< Block >::col_rend	(	const size_type	slice,
		const size_type	col,
		const slip::Range< int > &	range
	)		const

Returns a read-only iterator that points to the first element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters

slice	The index of the slice.
col	The index of the column to iterate.
range	Range of the column to iterate.

Returns: const_reverse_col_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: col must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.

template<typename Block>

reverse_component_col_iterator slip::GenericMultiComponent3d< Block >::col_rend	(	const std::size_t	component,
		const size_type	slice,
		const size_type	col
	)

Returns a read/write reverse iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters

component	The component number.
slice	The index of the slice.
col	The index of the column

Returns: end reverse_col_iterator value

template<typename Block>

const_reverse_component_col_iterator slip::GenericMultiComponent3d< Block >::col_rend	(	const std::size_t	component,
		const size_type	slice,
		const size_type	col
	)		const

Returns a read_only reverse iterator that points to the first element of the column column of the slice slice in the GenericMultiComponent3d. Iteration is done modulo the number of columns.

Parameters

component	The component number.
slice	The index of the slice.
col	The index of the column

Returns: end const_reverse_col_iterator value

template<typename Block>

reverse_component_col_range_iterator slip::GenericMultiComponent3d< Block >::col_rend	(	const std::size_t	component,
		const size_type	slice,
		const size_type	col,
		const slip::Range< int > &	range
	)

Returns a read-write iterator that points to one before the first element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters

component	The component number.
slice	The index of the slice.
col	The index of the column to iterate.
range	Range of the column to iterate.

Returns: reverse_col_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: col must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.

template<typename Block>

const_reverse_component_col_range_iterator slip::GenericMultiComponent3d< Block >::col_rend	(	const std::size_t	component,
		const size_type	slice,
		const size_type	col,
		const slip::Range< int > &	range
	)		const

Returns a read-only iterator that points to the first element of the Range range of the col of a slice col in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters

component	The component number.
slice	The index of the slice.
col	The index of the column to iterate.
range	Range of the column to iterate.

Returns: const_reverse_col_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: col must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.

template<typename Block >

GenericMultiComponent3d< Block >::size_type slip::GenericMultiComponent3d< Block >::cols ( ) const

inline

Returns the number of columns (third dimension size) in the GenericMultiComponent3d.

Definition at line 7619 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::size_type slip::GenericMultiComponent3d< Block >::columns ( ) const

inline

Returns the number of columns (third dimension size) in the GenericMultiComponent3d.

Definition at line 7615 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::size_type slip::GenericMultiComponent3d< Block >::dim1 ( ) const

inline

Returns the number of slices (first dimension size) in the GenericMultiComponent3d.

Definition at line 7595 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::size_type slip::GenericMultiComponent3d< Block >::dim2 ( ) const

inline

Returns the number of rows (second dimension size) in the GenericMultiComponent3d.

Definition at line 7607 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::size_type slip::GenericMultiComponent3d< Block >::dim3 ( ) const

inline

Returns the number of columns (third dimension size) in the GenericMultiComponent3d.

Definition at line 7611 of file GenericMultiComponent3d.hpp.

template<typename Block >

bool slip::GenericMultiComponent3d< Block >::empty ( ) const

inline

Returns true if the GenericMultiComponent3d is empty. (Thus size() == 0)

Definition at line 7635 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::iterator slip::GenericMultiComponent3d< Block >::end ( )

inline

Returns a read/write iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Returns: end iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > A1(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > A2(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > S(10,9,5);

//copy A1 in S

std::copy(A1.begin(),A1.end(),S.begin());

Definition at line 5412 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_iterator slip::GenericMultiComponent3d< Block >::end ( ) const

inline

Returns a read-only (constant) iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Returns: const end iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const A1(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > const A2(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > S(10,9,5);

Definition at line 5429 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::component_iterator slip::GenericMultiComponent3d< Block >::end ( const std::size_t component )

inline

Returns a read/write iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

component The component number.

Returns: end component_iterator value

Definition at line 6742 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_component_iterator slip::GenericMultiComponent3d< Block >::end ( const std::size_t component ) const

inline

Returns a read-only (constant) iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

component The component number.

Returns: const end component_iterator value

Definition at line 6758 of file GenericMultiComponent3d.hpp.

template<typename Block>

void slip::GenericMultiComponent3d< Block >::fill ( const Block & value )

inline

Fills the container range [begin(),begin()+size()) with copies of value.

Parameters

value A reference-to-const of arbitrary type.

Definition at line 4929 of file GenericMultiComponent3d.hpp.

template<typename Block>

void slip::GenericMultiComponent3d< Block >::fill ( const typename Block::pointer value )

inline

Fills the container range [begin(),begin()+size()) with a copy of the value array.

Parameters

value A pointer of arbitrary type.

Definition at line 4940 of file GenericMultiComponent3d.hpp.

template<typename Block>

void slip::GenericMultiComponent3d< Block >::fill ( const Block * value )

inline

Fills the container range [begin(),begin()+size()) with a copy of the value array.

Parameters

value A pointer of arbitrary type.

Definition at line 4951 of file GenericMultiComponent3d.hpp.

template<typename Block>

template<typename InputIterator >

void slip::GenericMultiComponent3d< Block >::fill	(	InputIterator	first,
		InputIterator	last
	)

inline

Fills the container range [begin(),begin()+size()) with a copy of the range [first,last)

Parameters

first	An input iterator.
last	An input iterator.

Definition at line 4965 of file GenericMultiComponent3d.hpp.

template<typename Block>

template<typename InputIterator >

void slip::GenericMultiComponent3d< Block >::fill	(	std::vector< InputIterator >	first_iterators_list,
		InputIterator	last
	)

inline

Fills the container range [begin(),begin()+size()) with a copy of the range [first,last)

Parameters

first_iterators_list	An input iterator list.
last	An input iterator.

Definition at line 4980 of file GenericMultiComponent3d.hpp.

template<typename Block>

template<typename InputIterator >

void slip::GenericMultiComponent3d< Block >::fill	(	std::size_t	component,
		InputIterator	first,
		InputIterator	last
	)

inline

Fills the container range [begin(),begin()+size()) with a copy of the range [first,last)

Parameters

component	The component number.
first	An input iterator.
last	An input iterator.

Definition at line 5012 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::iterator3d slip::GenericMultiComponent3d< Block >::front_upper_left ( )

inline

Returns a read/write iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the GenericMultiComponent3d.

Returns: begin iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > M(3,4,5);

//Print M

std::copy(M.front_upper_left(),M.back_bottom_right(),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6505 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_iterator3d slip::GenericMultiComponent3d< Block >::front_upper_left ( ) const

inline

Returns a read-only iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the GenericMultiComponent3d.

Returns: begin const iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > const M(3,4,5);

//Print M

std::copy(M.front_upper_left(),M.back_bottom_right(),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6512 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::iterator3d slip::GenericMultiComponent3d< Block >::front_upper_left ( const Box3d< int > & box )

inline

Returns a read/write iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the Box3d associated to the GenericMultiComponent3d.

Parameters

box	A Box3d defining the range of indices to iterate within the GenericMultiComponent3d.

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Returns: end iterator3d value

Precondition: The box indices must be inside the range of the GenericMultiComponent3d ones.

Example: slip::GenericMultiComponent3d<slip::color<double> > M(3,4,5);

slip::Box3d<int> b(1,1,1,2,2,3);

//Print M within a box

std::copy(M.front_upper_left(b),M.back_bottom_right(b),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6571 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_iterator3d slip::GenericMultiComponent3d< Block >::front_upper_left ( const Box3d< int > & box ) const

inline

Returns a read only iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the Box3d associated to the GenericMultiComponent3d.

Parameters

box	a Box3d defining the range of indices to iterate within the GenericMultiComponent3d.

Returns: end const iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Precondition: The box indices must be inside the range of the GenericMultiComponent3d ones.

Example: slip::GenericMultiComponent3d<slip::color<double> > const M(3,4,5);

slip::Box3d<int> b(1,1,1,2,2,3);

//Print M within a box

std::copy(M.front_upper_left(b),M.back_bottom_right(b),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6578 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::iterator3d_range slip::GenericMultiComponent3d< Block >::front_upper_left	(	const Range< int > &	slice_range,
		const Range< int > &	row_range,
		const Range< int > &	col_range
	)

inline

Returns a read/write iterator3d_range that points to the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters

slice_range	The range of the slices.
row_range	The range of the rows.
col_range	The range of the columns.

Precondition: slice_range, row_range and col_range must be valid.; The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.

Returns: iterator3d_range value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > M(3,4,5);

slip::Range<int> sr(0,2,2);

slip::Range<int> rr(0,3,2);

slip::Range<int> cr(0,4,2);

//Print M within a range

std::copy(M.front_upper_left(sr,rr,cr),M.back_bottom_right(sr,rr,cr),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6641 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_iterator3d_range slip::GenericMultiComponent3d< Block >::front_upper_left	(	const Range< int > &	slice_range,
		const Range< int > &	row_range,
		const Range< int > &	col_range
	)		const

inline

Returns a read-only iterator3d_range that points to the to the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters

slice_range	The range of the slices.
row_range	The range of the rows.
col_range	The range of the columns.

Precondition: slice_range, row_range and col_range must be valid.; The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.

Returns: const_iterator3d_range value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > const M(3,4,5);

slip::Range<int> sr(0,2,2);

slip::Range<int> rr(0,3,2);

slip::Range<int> cr(0,4,2);

//Print M within a range

std::copy(M.front_upper_left(sr,rr,cr),M.back_bottom_right(sr,rr,cr),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6662 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::component_iterator3d slip::GenericMultiComponent3d< Block >::front_upper_left ( const std::size_t component )

inline

Returns a read/write component_iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the GenericMultiComponent3d.

Parameters

component The component number.

Returns: begin iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.
slip::GenericMultiComponent3d<slip::Vector3d<double> > A1(8,8,4);

slip::GenericMultiComponent3d<slip::Vector3d<double> > A2(8,8,4);

//copy the first component of the elements of A1 in A2

std::copy(A1.front_upper_left(0),A1.back_bottom_right(0),A2.front_upper_left(0));

Definition at line 7311 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_component_iterator3d slip::GenericMultiComponent3d< Block >::front_upper_left ( const std::size_t component ) const

inline

Returns a read only const_component_iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the GenericMultiComponent3d.

Parameters

component The component number.

Returns: begin iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 7330 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::component_iterator3d slip::GenericMultiComponent3d< Block >::front_upper_left	(	const std::size_t	component,
		const Box3d< int > &	box
	)

inline

Returns a read/write component iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the Box3d associated to the GenericMultiComponent3d.

Parameters

component	The component number.
box	A Box3d defining the range of indices to iterate within the GenericMultiComponent3d.

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Returns: end iterator3d value

Precondition: The box indices must be inside the range of the GenericMultiComponent3d ones.

Definition at line 7387 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_component_iterator3d slip::GenericMultiComponent3d< Block >::front_upper_left	(	const std::size_t	component,
		const Box3d< int > &	box
	)		const

inline

Returns a read only component iterator3d that points to the first element of the GenericMultiComponent3d. It points to the front upper left element of the Box3d associated to the GenericMultiComponent3d.

Parameters

component	The component number.
box	a Box3d defining the range of indices to iterate within the GenericMultiComponent3d.

Returns: end const iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Precondition: The box indices must be inside the range of the GenericMultiComponent3d ones.

Definition at line 7405 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::component_iterator3d_range slip::GenericMultiComponent3d< Block >::front_upper_left	(	const std::size_t	component,
		const Range< int > &	slice_range,
		const Range< int > &	row_range,
		const Range< int > &	col_range
	)

inline

Returns a read/write component_iterator3d_range that points to the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters

component	The component number.
slice_range	The range of the slices.
row_range	The range of the rows.
col_range	The range of the columns.

Precondition: slice_range, row_range and col_range must be valid.; The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.

Returns: iterator3d_range value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 7467 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_component_iterator3d_range slip::GenericMultiComponent3d< Block >::front_upper_left	(	const std::size_t	component,
		const Range< int > &	slice_range,
		const Range< int > &	row_range,
		const Range< int > &	col_range
	)		const

inline

Returns a read/write component_const_iterator3d_range that points to the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters

component	The component number.
slice_range	The range of the slices.
row_range	The range of the rows.
col_range	The range of the columns.

Precondition: slice_range, row_range and col_range must be valid.; The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.

Returns: iterator3d_range value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 7488 of file GenericMultiComponent3d.hpp.

template<typename Block >

Block slip::GenericMultiComponent3d< Block >::max ( ) const

inline

Returns the max elements of the GenericMultiComponent3d according to the operator <.

Precondition: size() != 0

Definition at line 7659 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::size_type slip::GenericMultiComponent3d< Block >::max_size ( ) const

inline

Returns the maximal size (number of elements) in the GenericMultiComponent3d.

Definition at line 7627 of file GenericMultiComponent3d.hpp.

template<typename Block >

Block slip::GenericMultiComponent3d< Block >::min ( ) const

inline

Returns the min elements of the GenericMultiComponent3d according to the operator <.

Precondition: size() != 0

Definition at line 7646 of file GenericMultiComponent3d.hpp.

template<typename Block>

reference slip::GenericMultiComponent3d< Block >::operator()	(	const size_type	k,
		const size_type	i,
		const size_type	j
	)

Subscript access to the data contained in the GenericMultiComponent3d.

Parameters

k	The index of the slice for which the data should be accessed.
i	The index of the row for which the data should be accessed.
j	The index of the column for which the data should be accessed.

Returns: Read/Write reference to data.

Precondition: k < slices(); i < rows(); j < cols() This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

template<typename Block>

const_reference slip::GenericMultiComponent3d< Block >::operator()	(	const size_type	k,
		const size_type	i,
		const size_type	j
	)		const

Subscript access to the data contained in the GenericMultiComponent3d.

Parameters

k	The index of the slice for which the data should be accessed.
i	The index of the row for which the data should be accessed.
j	The index of the column for which the data should be accessed.

Returns: Read_only (constant) reference to data.

Precondition: k < slices(); i < rows(); j < cols() This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

template<typename Block >

GenericMultiComponent3d< Block > & slip::GenericMultiComponent3d< Block >::operator= ( const self & rhs )

inline

Assign a GenericMultiComponent3d.

Assign elements of GenericMultiComponent3d in rhs

Parameters

rhs	GenericMultiComponent3d to get the values from.

Returns

Definition at line 5354 of file GenericMultiComponent3d.hpp.

template<typename Block>

GenericMultiComponent3d< Block > & slip::GenericMultiComponent3d< Block >::operator= ( const Block & val )

inline

Affects all the element of the GenericMultiComponent3d by val.

Parameters

val	affectation value

Returns: reference to corresponding GenericMultiComponent3d

Definition at line 5365 of file GenericMultiComponent3d.hpp.

template<typename Block>

GenericMultiComponent3d< Block > & slip::GenericMultiComponent3d< Block >::operator= ( const typename Block::value_type & val )

inline

Affects all the element of the GenericMultiComponent3d by val.

Parameters

val	affectation value

Returns: reference to corresponding GenericMultiComponent3d

Definition at line 5373 of file GenericMultiComponent3d.hpp.

template<typename Block>

pointer* slip::GenericMultiComponent3d< Block >::operator[] ( const size_type k )

Subscript access to the slice datas contained in the GenericMultiComponent3d.

Parameters

k	The index of the slice for which data should be accessed.

Returns: Read/write pointer to the slice data.

Precondition: k < slices()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

template<typename Block>

const_pointer const* slip::GenericMultiComponent3d< Block >::operator[] ( const size_type k ) const

Subscript access to the slice datas contained in the GenericMultiComponent3d.

Parameters

k	The index of the slice for which data should be accessed.

Returns: Read-only (constant) pointer* to the slice data.

Precondition: k < slices()

This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

template<typename Block>

iterator slip::GenericMultiComponent3d< Block >::plane_begin ( const size_type slice )

Returns a read/write iterator that points to the first element in the in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

slice the slice coordinate of the plane

Returns: begin iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > A1(2,3,2);

slip::GenericMultiComponent3d<slip::color<double> > A2(2,3,2);

//copy the first plane (in slice direction) of A1 in A2

std::copy(A1.plane_begin(0),A1.plane_end(0),A2.plane_begin(0));

template<typename Block>

const_iterator slip::GenericMultiComponent3d< Block >::plane_begin ( const size_type slice ) const

Returns a read-only (constant) iterator that points to the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

slice the slice coordinate of the plane

Returns: const begin iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const A1(2,3,2);

slip::GenericMultiComponent3d<slip::color<double> > A2(2,3,2);

//copy the first plane (in slice direction) of A1 in A2

std::copy(A1.plane_begin(0),A1.plane_end(0),A2.plane_begin(0));

template<typename Block>

component_iterator slip::GenericMultiComponent3d< Block >::plane_begin	(	const std::size_t	component,
		const size_type	slice
	)

Returns a read/write iterator that points to the first element in the in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

component	The component number.
slice	the slice coordinate of the plane

Returns: begin component iterator value

template<typename Block>

const_component_iterator slip::GenericMultiComponent3d< Block >::plane_begin	(	const std::size_t	component,
		const size_type	slice
	)		const

Returns a read-only (constant) iterator that points to the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

component	The component number.
slice	the slice coordinate of the plane

Returns: const begin component iterator value

template<typename Block>

iterator2d slip::GenericMultiComponent3d< Block >::plane_bottom_right	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate
	)

Returns a read/write iterator that points to the last element of the plane in the GenericMultiComponent3d. It points to past the end element of the bottom right element of the plane Iteration is done in ordinary element order.

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate

Returns: begin iterator2d value

Precondition: P must be 0,1 or 2

Remarks: This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > M(3,4,5);

//Print the 2nd plane of M in the KI_PLANE direction

std::copy(M.plane_upper_left(slip::KI_PLANE,2),M.plane_bottom_right(

slip::KI_PLANE,2),std::ostream_iterator<slip::color<double> >(std::cout," "));

template<typename Block>

const_iterator2d slip::GenericMultiComponent3d< Block >::plane_bottom_right	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate
	)		const

Returns a read/write const iterator that points to the last element of the plane in the GenericMultiComponent3d. It points to past the end element of the bottom right element of the plane Iteration is done in ordinary element order.

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate

Returns: begin const_iterator2d value

Precondition: P must be 0,1 or 2

Remarks: This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const M(3,4,5);

//Print the 2nd plane of M in the KI_PLANE direction

std::copy(M.plane_upper_left(slip::KI_PLANE,2),M.plane_bottom_right(

slip::KI_PLANE,2),std::ostream_iterator<slip::color<double> >(std::cout," "));

template<typename Block>

iterator2d slip::GenericMultiComponent3d< Block >::plane_bottom_right	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate,
		const Box2d< int > &	b
	)

Returns a read/write iterator that points to the last element of a box within a plane in the GenericMultiComponent3d. It points to past the end element of the bottom right element of the plane Iteration is done in ordinary element order.

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate
b	The box within the plane

Returns: begin iterator2d value

Precondition: P must be 0,1 or 2; b must be within the plane

Remarks: This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > M(3,4,5);

slip::Box2d<int> b(1,1,3,3);

//Print the 2nd plane of M in the KI_PLANE direction within a box

std::copy(M.plane_upper_left(slip::KI_PLANE,2,b),M.plane_bottom_right(

slip::KI_PLANE,2,b),std::ostream_iterator<slip::color<double> >(std::cout," "));

template<typename Block>

const_iterator2d slip::GenericMultiComponent3d< Block >::plane_bottom_right	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate,
		const Box2d< int > &	b
	)		const

Returns a read/write const iterator that points to the last element of a box within a plane in the GenericMultiComponent3d. It points to past the end element of the bottom right element of the plane Iteration is done in ordinary element order.

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate
b	The box within the plane

Returns: begin const_iterator2d value

Precondition: P must be 0,1 or 2; b must be within the plane

Remarks: This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > const M(3,4,5);

slip::Box2d<int> b(1,1,3,3);

//Print the 2nd plane of M in the KI_PLANE direction within a box

std::copy(M.plane_upper_left(slip::KI_PLANE,2,b),M.plane_bottom_right(

slip::KI_PLANE,2,b),std::ostream_iterator<slip::color<double> >(std::cout," "));

template<typename Block>

iterator slip::GenericMultiComponent3d< Block >::plane_end ( const size_type slice )

Returns a read/write iterator that points one past the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

slice the slice coordinate of the plane

Returns: end iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > A1(2,3,2);

slip::GenericMultiComponent3d<slip::color<double> > A2(2,3,2);

//copy the first plane (in slice direction) of A1 in A2

std::copy(A1.plane_begin(0),A1.plane_end(0),A2.plane_begin(0));

template<typename Block>

const_iterator slip::GenericMultiComponent3d< Block >::plane_end ( const size_type slice ) const

Returns a read-only (constant) iterator that points one past the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

slice the slice coordinate of the plane

Returns: const end iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const A1(2,3,2);

slip::GenericMultiComponent3d<slip::color<double> > A2(2,3,2);

//copy the first plane (in slice direction) of A1 in A2

std::copy(A1.plane_begin(0),A1.plane_end(0),A2.plane_begin(0));

template<typename Block>

component_iterator slip::GenericMultiComponent3d< Block >::plane_end	(	const std::size_t	component,
		const size_type	slice
	)

Returns a read/write iterator that points one past the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

component	The component number.
slice	the slice coordinate of the plane

Returns: end component iterator value

template<typename Block>

const_component_iterator slip::GenericMultiComponent3d< Block >::plane_end	(	const std::size_t	component,
		const size_type	slice
	)		const

Returns a read-only (constant) iterator that points one past the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

component	The component number.
slice	the slice coordinate of the plane

Returns: const end component iterator value

template<typename Block>

reverse_iterator slip::GenericMultiComponent3d< Block >::plane_rbegin ( const size_type slice )

Returns a read/write reverse iterator that points to the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters

slice the slice coordinate of the plane

Returns: reverse begin iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > A1(2,3,2);

slip::GenericMultiComponent3d<slip::color<double> > A2(2,3,2);

//copy the first plane (in slice direction) of A1 in A2 in reverse order

std::copy(A1.plane_rbegin(0),A1.plane_rend(0),A2.plane_begin(0));

template<typename Block>

const_reverse_iterator slip::GenericMultiComponent3d< Block >::plane_rbegin ( const size_type slice ) const

Returns a read-only (constant) reverse iterator that points to the last element in the slice plane k of the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters

slice the slice coordinate of the plane

Returns: const reverse begin iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const A1(2,3,2);

slip::GenericMultiComponent3d<slip::color<double> > A2(2,3,2);

//copy the first plane (in slice direction) of A1 in A2 in reverse order

std::copy(A1.plane_rbegin(0),A1.plane_rend(0),A2.plane_begin(0));

template<typename Block>

reverse_component_iterator slip::GenericMultiComponent3d< Block >::plane_rbegin	(	const std::size_t	component,
		const size_type	slice
	)

Returns a read/write reverse iterator that points to the last element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters

component	The component number.
slice	the slice coordinate of the plane

Returns: reverse begin component iterator value

template<typename Block>

const_reverse_component_iterator slip::GenericMultiComponent3d< Block >::plane_rbegin	(	const std::size_t	component,
		const size_type	slice
	)		const

Returns a read-only (constant) reverse iterator that points to the last element in the slice plane k of the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters

component	The component number.
slice	the slice coordinate of the plane

Returns: const reverse begin component iterator value

template<typename Block>

reverse_iterator2d slip::GenericMultiComponent3d< Block >::plane_rbottom_right	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate
	)

Returns a read/write reverse_iterator that points to the upper left element of the plane in the GenericMultiComponent3d. Iteration is done in backward element order.

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate

Returns: begin iterator2d value

Precondition: P must be 0,1 or 2

Remarks: This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > M(3,4,5);

//Print the 2nd plane of M in the KI_PLANE direction in reverse order

std::copy(M.plane_rupper_left(slip::KI_PLANE,2),M.plane_rbottom_right(

slip::KI_PLANE,2),std::ostream_iterator<slip::color<double> >(std::cout," "));

template<typename Block>

const_reverse_iterator2d slip::GenericMultiComponent3d< Block >::plane_rbottom_right	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate
	)		const

Returns a read/write const reverse iterator that points to the upper left element of the plane in the GenericMultiComponent3d. Iteration is done in backward element order.

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate

Returns: begin const_iterator2d value

Precondition: P must be 0,1 or 2

Remarks: This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const M(3,4,5);

//Print the 2nd plane of M in the KI_PLANE direction in reverse order

std::copy(M.plane_rupper_left(slip::KI_PLANE,2),M.plane_rbottom_right(

slip::KI_PLANE,2),std::ostream_iterator<slip::color<double> >(std::cout," "));

template<typename Block>

reverse_iterator2d slip::GenericMultiComponent3d< Block >::plane_rbottom_right	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate,
		const Box2d< int > &	b
	)

Returns a read/write reverse iterator that points to the first element of a box within a plane in the GenericMultiComponent3d. It points to the upper left element of the plane Iteration is done in backward element order.

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate
b	The box within the plane

Returns: begin reverse_iterator2d value

Precondition: P must be 0,1 or 2; b must be within the plane

Remarks: This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > M(3,4,5);

slip::Box2d<int> b(1,1,3,3);

//Print the 2nd plane of M in the KI_PLANE direction within a box in reverse order

std::copy(M.plane_rupper_left(slip::KI_PLANE,2,b),M.plane_rbottom_right(

slip::KI_PLANE,2,b),std::ostream_iterator<slip::color<double> >(std::cout," "));

template<typename Block>

const_reverse_iterator2d slip::GenericMultiComponent3d< Block >::plane_rbottom_right	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate,
		const Box2d< int > &	b
	)		const

Returns a read/write const reverse iterator that points to the first element of a box within a plane in the GenericMultiComponent3d. It points to the bottom right element of the plane Iteration is done in backward element order.

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate
b	The box within the plane

Returns: begin const_reverse_iterator2d value

Precondition: P must be 0,1 or 2; b must be within the plane

Remarks: This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > const M(3,4,5);

slip::Box2d<int> b(1,1,3,3);

//Print the 2nd plane of M in the KI_PLANE direction within a box in reverse order

std::copy(M.plane_rupper_left(slip::KI_PLANE,2,b),M.plane_rbottom_right(

slip::KI_PLANE,2,b),std::ostream_iterator<slip::color<double> >(std::cout," "));

template<typename Block>

reverse_iterator slip::GenericMultiComponent3d< Block >::plane_rend ( const size_type slice )

Returns a read/write reverse iterator that points to one before the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters

slice the slice coordinate of the plane

Returns: reverse end iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > A1(2,3,2);

slip::GenericMultiComponent3d<slip::color<double> > A2(2,3,2);

//copy the first plane (in slice direction) of A1 in A2 in reverse order

std::copy(A1.plane_rbegin(0),A1.plane_rend(0),A2.plane_begin(0));

template<typename Block>

const_reverse_iterator slip::GenericMultiComponent3d< Block >::plane_rend ( const size_type slice ) const

Returns a read-only (constant) reverse iterator that points to one before the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters

slice the slice coordinate of the plane

Returns: const reverse end iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const A1(2,3,2);

slip::GenericMultiComponent3d<slip::color<double> > A2(2,3,2);

//copy the first plane (in slice direction) of A1 in A2 in reverse order

std::copy(A1.plane_rbegin(0),A1.plane_rend(0),A2.plane_begin(0));

template<typename Block>

reverse_component_iterator slip::GenericMultiComponent3d< Block >::plane_rend	(	const std::size_t	component,
		const size_type	slice
	)

Returns a read/write reverse iterator that points to one before the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters

component	The component number.
slice	the slice coordinate of the plane

Returns: reverse end component iterator value

template<typename Block>

const_reverse_component_iterator slip::GenericMultiComponent3d< Block >::plane_rend	(	const std::size_t	component,
		const size_type	slice
	)		const

Returns a read-only (constant) reverse iterator that points to one before the first element in the slice plane of the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters

component	The component number.
slice	the slice coordinate of the plane

Returns: const reverse end component iterator value

template<typename Block>

reverse_iterator2d slip::GenericMultiComponent3d< Block >::plane_rupper_left	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate
	)

Returns a read/write reverse_iterator that points to the bottom right element of the plane in the GenericMultiComponent3d. Iteration is done in backward element order.

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate

Returns: begin iterator2d value

Precondition: P must be 0,1 or 2

Remarks: This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > M(3,4,5);

//Print the 2nd plane of M in the KI_PLANE direction in reverse order

std::copy(M.plane_rupper_left(slip::KI_PLANE,2),M.plane_rbottom_right(

slip::KI_PLANE,2),std::ostream_iterator<slip::color<double> >(std::cout," "));

template<typename Block>

const_reverse_iterator2d slip::GenericMultiComponent3d< Block >::plane_rupper_left	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate
	)		const

Returns a read/write const reverse iterator that points to the bottom right element of the plane in the GenericMultiComponent3d. Iteration is done in backward element order.

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate

Returns: begin const_iterator2d value

Precondition: P must be 0,1 or 2

Remarks: This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const M(3,4,5);

//Print the 2nd plane of M in the KI_PLANE direction in reverse order

std::copy(M.plane_rupper_left(slip::KI_PLANE,2),M.plane_rbottom_right(

slip::KI_PLANE,2),std::ostream_iterator<slip::color<double> >(std::cout," "));

template<typename Block>

reverse_iterator2d slip::GenericMultiComponent3d< Block >::plane_rupper_left	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate,
		const Box2d< int > &	b
	)

Returns a read/write reverse iterator that points to the last element of a box within a plane in the GenericMultiComponent3d. It points to the bottom right element of the box Iteration is done in backward element order.

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate
b	The box within the plane

Returns: begin reverse_iterator2d value

Precondition: P must be 0,1 or 2; b must be within the plane

Remarks: This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > M(3,4,5);

slip::Box2d<int> b(1,1,3,3);

//Print the 2nd plane of M in the KI_PLANE direction within a box in reverse order

std::copy(M.plane_rupper_left(slip::KI_PLANE,2,b),M.plane_rbottom_right(

slip::KI_PLANE,2,b),std::ostream_iterator<slip::color<double> >(std::cout," "));

template<typename Block>

const_reverse_iterator2d slip::GenericMultiComponent3d< Block >::plane_rupper_left	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate,
		const Box2d< int > &	b
	)		const

Returns a read/write const reverse iterator that points to the last element of a box within a plane in the GenericMultiComponent3d. It points to the bottom right element of the plane Iteration is done in backward element order.

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate
b	The box within the plane

Returns: begin const_reverse_iterator2d value

Precondition: P must be 0,1 or 2; b must be within the plane

Remarks: This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > const M(3,4,5);

slip::Box2d<int> b(1,1,3,3);

//Print the 2nd plane of M in the KI_PLANE direction within a box in reverse order

std::copy(M.plane_rupper_left(slip::KI_PLANE,2,b),M.plane_rbottom_right(

slip::KI_PLANE,2,b),std::ostream_iterator<slip::color<double> >(std::cout," "));

template<typename Block>

iterator2d slip::GenericMultiComponent3d< Block >::plane_upper_left	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate
	)

Returns a read/write iterator that points to the first element of the plane in the GenericMultiComponent3d. It points to the upper left element of the plane Iteration is done in ordinary element order.

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate

Returns: begin iterator2d value

Precondition: P must be 0,1 or 2

Remarks: This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > M(3,4,5);

//Print the 2nd plane of M in the KI_PLANE direction

std::copy(M.plane_upper_left(slip::KI_PLANE,2),M.plane_bottom_right(

slip::KI_PLANE,2),std::ostream_iterator<slip::color<double> >(std::cout," "));

template<typename Block>

const_iterator2d slip::GenericMultiComponent3d< Block >::plane_upper_left	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate
	)		const

Returns a read/write const iterator that points to the first element of the plane in the GenericMultiComponent3d. It points to the upper left element of the plane Iteration is done in ordinary element order.

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate

Returns: begin const_iterator2d value

Precondition: P must be 0,1 or 2

Remarks: This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const M(3,4,5);

//Print the 2nd plane of M in the KI_PLANE direction

std::copy(M.plane_upper_left(slip::KI_PLANE,2),M.plane_bottom_right(

slip::KI_PLANE,2),std::ostream_iterator<slip::color<double> >(std::cout," "));

template<typename Block>

iterator2d slip::GenericMultiComponent3d< Block >::plane_upper_left	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate,
		const Box2d< int > &	b
	)

Returns a read/write iterator that points to the first element of a box within a plane in the GenericMultiComponent3d. It points to the upper left element of the box Iteration is done in ordinary element order.

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate
b	The box within the plane

Returns: begin iterator2d value

Precondition: P must be 0,1 or 2; b must be within the plane

Remarks: This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > M(3,4,5);

slip::Box2d<int> b(1,1,3,3);

//Print the 2nd plane of M in the KI_PLANE direction within a box

std::copy(M.plane_upper_left(slip::KI_PLANE,2,b),M.plane_bottom_right(

slip::KI_PLANE,2,b),std::ostream_iterator<slip::color<double> >(std::cout," "));

template<typename Block>

const_iterator2d slip::GenericMultiComponent3d< Block >::plane_upper_left	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate,
		const Box2d< int > &	b
	)		const

Returns a read/write const iterator that points to the first element of a box within a plane in the GenericMultiComponent3d. It points to the upper left element of the plane Iteration is done in ordinary element order.

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate
b	The box within the plane

Returns: begin const_iterator2d value

Precondition: P must be 0,1 or 2; b must be within the plane

Remarks: This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > const M(3,4,5);

slip::Box2d<int> b(1,1,3,3);

//Print the 2nd plane of M in the KI_PLANE direction within a box

std::copy(M.plane_upper_left(slip::KI_PLANE,2,b),M.plane_bottom_right(

slip::KI_PLANE,2,b),std::ostream_iterator<slip::color<double> >(std::cout," "));

template<typename Block >

GenericMultiComponent3d< Block >::reverse_iterator3d slip::GenericMultiComponent3d< Block >::rback_bottom_right ( )

inline

Returns a read/write reverse iterator3d. It points to past the front upper left element of the GenericMultiComponent3d. Iteration is done in the reverse order.

Returns: reverse iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > M(3,4,5);

//Print M in reverse order

std::copy(M.rfront_upper_left(),M.rback_bottom_right(),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6536 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_reverse_iterator3d slip::GenericMultiComponent3d< Block >::rback_bottom_right ( ) const

inline

Returns a read only reverse iterator3d. It points to past the front upper left element of the GenericMultiComponent3d. Iteration is done in the reverse order.

Returns: const reverse iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > const M(3,4,5);

//Print M in reverse order

std::copy(M.rfront_upper_left(),M.rback_bottom_right(),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6544 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::reverse_iterator3d slip::GenericMultiComponent3d< Block >::rback_bottom_right ( const Box3d< int > & box )

inline

Returns a read/write reverse iterator3d. It points to one before the front upper left element of the Box3d box associated to the GenericMultiComponent3d.

Parameters

box	A Box3d defining the range of indices to iterate within the GenericMultiComponent3d.

Precondition: The box indices must be inside the range of the GenericMultiComponent3d ones.

Returns: reverse iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > M(3,4,5);

slip::Box3d<int> b(1,1,1,2,2,3);

//Print M within a box in reverse order

std::copy(M.rfront_upper_left(b),M.rback_bottom_right(b),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6605 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_reverse_iterator3d slip::GenericMultiComponent3d< Block >::rback_bottom_right ( const Box3d< int > & box ) const

inline

Returns a read-only reverse iterator3d. It points to one before the front upper left element of the Box3d box associated to the GenericMultiComponent3d.

Parameters

box	A Box3d defining the range of indices to iterate within the GenericMultiComponent3d.

Precondition: The box indices must be inside the range of the GenericMultiComponent3d ones.

Returns: const reverse iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > const M(3,4,5);

slip::Box3d<int> b(1,1,1,2,2,3);

//Print M within a box in reverse order

std::copy(M.rfront_upper_left(b),M.rback_bottom_right(b),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6613 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::reverse_iterator3d_range slip::GenericMultiComponent3d< Block >::rback_bottom_right	(	const Range< int > &	slice_range,
		const Range< int > &	row_range,
		const Range< int > &	col_range
	)

inline

Returns a read/write reverse_iterator3d_range that points to one before the front upper left element of the ranges row_range and col_range associated to the GenericMultiComponent3d. Iteration is done in the reverse order.

Parameters

slice_range	The range of the slices.
row_range	The range of the rows.
col_range	The range of the columns.

Precondition: slice_range, row_range and col_range must be valid.; The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.

Returns: reverse_iterator3d_range value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > M(3,4,5);

slip::Range<int> sr(0,2,2);

slip::Range<int> rr(0,3,2);

slip::Range<int> cr(0,4,2);

//Print M within a range in reverse order

std::copy(M.rfront_upper_left(sr,rr,cr),M.rback_bottom_right(sr,rr,cr),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6706 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_reverse_iterator3d_range slip::GenericMultiComponent3d< Block >::rback_bottom_right	(	const Range< int > &	slice_range,
		const Range< int > &	row_range,
		const Range< int > &	col_range
	)		const

inline

Returns a read-only reverse_iterator3d_range that points to one before the front upper left element of the ranges row_range and col_range associated to the GenericMultiComponent3d.Iteration is done in the reverse order.

Parameters

slice_range	The range of the slices.
row_range	The range of the rows.
col_range	The range of the columns.

Precondition: slice_range, row_range and col_range must be valid.; The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.

Returns: const_reverse_iterator3d_range value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > const M(3,4,5);

slip::Range<int> sr(0,2,2);

slip::Range<int> rr(0,3,2);

slip::Range<int> cr(0,4,2);

//Print M within a range in reverse order

std::copy(M.rfront_upper_left(sr,rr,cr),M.rback_bottom_right(sr,rr,cr),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6716 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::reverse_component_iterator3d slip::GenericMultiComponent3d< Block >::rback_bottom_right ( const std::size_t component )

inline

Returns a read/write reverse component iterator3d. It points to past the front upper left element of the GenericMultiComponent3d. Iteration is done in the reverse order.

Parameters

component The component number.

Returns: reverse component iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 7360 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_reverse_component_iterator3d slip::GenericMultiComponent3d< Block >::rback_bottom_right ( const std::size_t component ) const

inline

Returns a read only reverse component iterator3d. It points to past the front upper left element of the GenericMultiComponent3d. Iteration is done in the reverse order.

Parameters

component The component number.

Returns: const reverse component iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 7377 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::reverse_component_iterator3d slip::GenericMultiComponent3d< Block >::rback_bottom_right	(	const std::size_t	component,
		const Box3d< int > &	box
	)

inline

Returns a read/write reverse component iterator3d. It points to one before the front upper left element of the Box3d box associated to the GenericMultiComponent3d.

Parameters

component	The component number.
box	A Box3d defining the range of indices to iterate within the GenericMultiComponent3d.

Precondition: The box indices must be inside the range of the GenericMultiComponent3d ones.

Returns: reverse iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 7423 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_reverse_component_iterator3d slip::GenericMultiComponent3d< Block >::rback_bottom_right	(	const std::size_t	component,
		const Box3d< int > &	box
	)		const

inline

Returns a read-only reverse component iterator3d. It points to one before the front upper left element of the Box3d box associated to the GenericMultiComponent3d.

Parameters

component	The component number.
box	A Box3d defining the range of indices to iterate within the GenericMultiComponent3d.

Precondition: The box indices must be inside the range of the GenericMultiComponent3d ones.

Returns: const reverse iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 7444 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::reverse_component_iterator3d_range slip::GenericMultiComponent3d< Block >::rback_bottom_right	(	const std::size_t	component,
		const Range< int > &	slice_range,
		const Range< int > &	row_range,
		const Range< int > &	col_range
	)

inline

Returns a read/write reverse_component_iterator3d_range. It points to one before the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters

component	The component number.
slice_range	The range of the slices.
row_range	The range of the rows.
col_range	The range of the columns.

Precondition: slice_range, row_range and col_range must be valid.; The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.

Returns: reverse iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 7520 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_reverse_component_iterator3d_range slip::GenericMultiComponent3d< Block >::rback_bottom_right	(	const std::size_t	component,
		const Range< int > &	slice_range,
		const Range< int > &	row_range,
		const Range< int > &	col_range
	)		const

inline

Returns a read/write reverse_const_component_iterator3d_range. It points to one before the front upper left element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters

component	The component number.
slice_range	The range of the slices.
row_range	The range of the rows.
col_range	The range of the columns.

Precondition: slice_range, row_range and col_range must be valid.; The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.

Returns: reverse iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 7541 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::reverse_iterator slip::GenericMultiComponent3d< Block >::rbegin ( )

inline

Returns a read/write reverse iterator that points to the last element in the GenericMultiComponent3d. Iteration is done in reverse element order.

Returns: reverse begin iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > A1(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > A2(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > S(10,9,5);

//copy A1 in S

std::copy(A1.begin(),A1.end(),S.begin());

Definition at line 5439 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_reverse_iterator slip::GenericMultiComponent3d< Block >::rbegin ( ) const

inline

Returns a read-only (constant) reverse iterator that points to the last element in the GenericMultiComponent3d. Iteration is done in reverse element order.

Returns: const reverse begin iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const A1(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > const A2(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > S(10,9,5);

//copy A1 in S

std::copy(A1.begin(),A1.end(),S.begin());

Definition at line 5455 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::reverse_component_iterator slip::GenericMultiComponent3d< Block >::rbegin ( const std::size_t component )

inline

Returns a read/write iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

component The component number.

Returns: begin reverse_component_iterator value

Definition at line 6767 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_reverse_component_iterator slip::GenericMultiComponent3d< Block >::rbegin ( const std::size_t component ) const

inline

Returns a read-only (constant) iterator that points to the first element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

component The component number.

Returns: const begin reverse_component_iterator value

Definition at line 6783 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::reverse_iterator slip::GenericMultiComponent3d< Block >::rend ( )

inline

Returns a read/write reverse iterator that points to one before the first element in the GenericMultiComponent3d. Iteration is done in reverse element order.

Returns: reverse end iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > A1(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > A2(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > S(10,9,5);

//copy A1 in S

std::copy(A1.begin(),A1.end(),S.begin());

Definition at line 5447 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_reverse_iterator slip::GenericMultiComponent3d< Block >::rend ( ) const

inline

Returns a read-only (constant) reverse iterator that points to one before the first element in the GenericMultiComponent3d. Iteration is done in reverse element order.

Returns: const reverse end iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const A1(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > const A2(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > S(10,9,5);

//copy A1 in S

std::copy(A1.begin(),A1.end(),S.begin());

Definition at line 5463 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::reverse_component_iterator slip::GenericMultiComponent3d< Block >::rend ( const std::size_t component )

inline

Returns a read/write iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

component The component number.

Returns: end reverse_component_iterator value

Definition at line 6775 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_reverse_component_iterator slip::GenericMultiComponent3d< Block >::rend ( const std::size_t component ) const

inline

Returns a read-only (constant) iterator that points one past the last element in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

component The component number.

Returns: const end reverse_component_iterator value

Definition at line 6791 of file GenericMultiComponent3d.hpp.

template<typename Block>

void slip::GenericMultiComponent3d< Block >::resize	(	const size_type	slices,
		const size_type	rows,
		const size_type	cols,
		const Block &	val = `Block()`
	)

inline

Resizes a GenericMultiComponent3d.

Parameters

slices	first dimension of the GenericMultiComponent3d
rows	second dimension of the GenericMultiComponent3d
cols	third dimension of the GenericMultiComponent3d
val	new value for all the elements

Definition at line 5381 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::reverse_iterator3d slip::GenericMultiComponent3d< Block >::rfront_upper_left ( )

inline

Returns a read/write reverse iterator3d. It points to the back bottom right element of the GenericMultiComponent3d. Iteration is done within the GenericMultiComponent3d in the reverse order.

Returns: reverse_iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > M(3,4,5);

//Print M in reverse order

std::copy(M.rfront_upper_left(),M.rback_bottom_right(),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6553 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_reverse_iterator3d slip::GenericMultiComponent3d< Block >::rfront_upper_left ( ) const

inline

Returns a read only reverse iterator3d that points. It points to the back bottom right element of the GenericMultiComponent3d. Iteration is done within the GenericMultiComponent3d in the reverse order.

Returns: const_reverse_iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > const M(3,4,5);

//Print M in reverse order

std::copy(M.rfront_upper_left(),M.rback_bottom_right(),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6561 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::reverse_iterator3d slip::GenericMultiComponent3d< Block >::rfront_upper_left ( const Box3d< int > & box )

inline

Returns a read/write reverse iterator3d. It points to the back bottom right element of the Box3d associated to the GenericMultiComponent3d. Iteration is done in the reverse order.

Parameters

box	a Box3d defining the range of indices to iterate within the GenericMultiComponent3d.

Precondition: The box indices must be inside the range of the GenericMultiComponent3d ones.

Returns: reverse iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > M(3,4,5);

slip::Box3d<int> b(1,1,1,2,2,3);

//Print M within a box in reverse order

std::copy(M.rfront_upper_left(b),M.rback_bottom_right(b),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6622 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_reverse_iterator3d slip::GenericMultiComponent3d< Block >::rfront_upper_left ( const Box3d< int > & box ) const

inline

Returns a read only reverse iterator3d. It points to the back bottom right element of the Box3d box associated to the GenericMultiComponent3d. Iteration is done in the reverse order.

Parameters

box	A Box3d defining the range of indices to iterate within the GenericMultiComponent3d.

Precondition: The box indices must be inside the range of the GenericMultiComponent3d ones.

Returns: const reverse iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > const M(3,4,5);

slip::Box3d<int> b(1,1,1,2,2,3);

//Print M within a box in reverse order

std::copy(M.rfront_upper_left(b),M.rback_bottom_right(b),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6630 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::reverse_iterator3d_range slip::GenericMultiComponent3d< Block >::rfront_upper_left	(	const Range< int > &	slice_range,
		const Range< int > &	row_range,
		const Range< int > &	col_range
	)

inline

Returns a read/write reverse_iterator3d_range that points to the past the back bottom right element of the ranges row_range and col_range associated to the GenericMultiComponent3d. Iteration is done in the reverse order.

Parameters

slice_range	The range of the slices.
row_range	The range of the rows.
col_range	The range of the columns.

Precondition: slice_range, row_range and col_range must be valid.; The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.

Returns: reverse_iterator3d_range value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > M(3,4,5);

slip::Range<int> sr(0,2,2);

slip::Range<int> rr(0,3,2);

slip::Range<int> cr(0,4,2);

//Print M within a range in reverse order

std::copy(M.rfront_upper_left(sr,rr,cr),M.rback_bottom_right(sr,rr,cr),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6685 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_reverse_iterator3d_range slip::GenericMultiComponent3d< Block >::rfront_upper_left	(	const Range< int > &	slice_range,
		const Range< int > &	row_range,
		const Range< int > &	col_range
	)		const

inline

Returns a read-only reverse_iterator3d_range that points to the past the back bottom right element of the ranges row_range and col_range associated to the GenericMultiComponent3d. Iteration is done in the reverse order.

Parameters

slice_range	The range of the slices.
row_range	The range of the rows.
col_range	The range of the columns.

Precondition: slice_range, row_range and col_range must be valid.; The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.

Returns: const_reverse_iterator3d_range value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Example: slip::GenericMultiComponent3d<slip::color<double> > const M(3,4,5);

slip::Range<int> sr(0,2,2);

slip::Range<int> rr(0,3,2);

slip::Range<int> cr(0,4,2);

//Print M within a range in reverse order

std::copy(M.rfront_upper_left(sr,rr,cr),M.rback_bottom_right(sr,rr,cr),

std::ostream_iterator<slip::color<double> >(std::cout," "));

Definition at line 6695 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::reverse_component_iterator3d slip::GenericMultiComponent3d< Block >::rfront_upper_left ( const std::size_t component )

inline

Returns a read/write reverse component iterator3d. It points to the back bottom right element of the GenericMultiComponent3d. Iteration is done within the GenericMultiComponent3d in the reverse order.

Parameters

component The component number.

Returns: reverse_component_iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 7350 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_reverse_component_iterator3d slip::GenericMultiComponent3d< Block >::rfront_upper_left ( const std::size_t component ) const

inline

Returns a read only reverse component iterator3d that points. It points to the back bottom right element of the GenericMultiComponent3d. Iteration is done within the GenericMultiComponent3d in the reverse order.

Parameters

component The component number.

Returns: const_reverse_component_iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 7368 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::reverse_component_iterator3d slip::GenericMultiComponent3d< Block >::rfront_upper_left	(	const std::size_t	component,
		const Box3d< int > &	box
	)

inline

Returns a read/write reverse component iterator3d. It points to the back bottom right element of the Box3d associated to the GenericMultiComponent3d. Iteration is done in the reverse order.

Parameters

component	The component number.
box	a Box3d defining the range of indices to iterate within the GenericMultiComponent3d.

Precondition: The box indices must be inside the range of the GenericMultiComponent3d ones.

Returns: reverse iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 7433 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_reverse_component_iterator3d slip::GenericMultiComponent3d< Block >::rfront_upper_left	(	const std::size_t	component,
		const Box3d< int > &	box
	)		const

inline

Returns a read only reverse component iterator3d. It points to the back bottom right element of the Box3d box associated to the GenericMultiComponent3d. Iteration is done in the reverse order.

Parameters

component	The component number.
box	A Box3d defining the range of indices to iterate within the GenericMultiComponent3d.

Precondition: The box indices must be inside the range of the GenericMultiComponent3d ones.

Returns: const reverse iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 7454 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::reverse_component_iterator3d_range slip::GenericMultiComponent3d< Block >::rfront_upper_left	(	const std::size_t	component,
		const Range< int > &	slice_range,
		const Range< int > &	row_range,
		const Range< int > &	col_range
	)

inline

Returns a read/write reverse_component_iterator3d_range. It points to the back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters

component	The component number.
slice_range	The range of the slices.
row_range	The range of the rows.
col_range	The range of the columns.

Precondition: slice_range, row_range and col_range must be valid.; The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.

Returns: reverse iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 7509 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::const_reverse_component_iterator3d_range slip::GenericMultiComponent3d< Block >::rfront_upper_left	(	const std::size_t	component,
		const Range< int > &	slice_range,
		const Range< int > &	row_range,
		const Range< int > &	col_range
	)		const

inline

Returns a read/write reverse_const_component_iterator3d_range. It points to the back bottom right element of the ranges slice_range, row_range and col_range associated to the GenericMultiComponent3d.

Parameters

component	The component number.
slice_range	The range of the slices.
row_range	The range of the rows.
col_range	The range of the columns.

Precondition: slice_range, row_range and col_range must be valid.; The ranges indices must be inside the ranges of the GenericMultiComponent3d ones.

Returns: reverse iterator3d value

Remarks: This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 7530 of file GenericMultiComponent3d.hpp.

template<typename Block>

row_iterator slip::GenericMultiComponent3d< Block >::row_begin	(	const size_type	slice,
		const size_type	row
	)

Returns a read/write iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

slice	The index of the slice.
row	The index of the row.

Returns: begin row_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

const_row_iterator slip::GenericMultiComponent3d< Block >::row_begin	(	const size_type	slice,
		const size_type	row
	)		const

Returns a read_only iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

slice	The index of the slice.
row	The index of the row.

Returns: begin const_row_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

row_range_iterator slip::GenericMultiComponent3d< Block >::row_begin	(	const size_type	slice,
		const size_type	row,
		const slip::Range< int > &	range
	)

Returns a read/write iterator that points to the first element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

slice	The index of the slice.
row	The index of the row to iterate.
range	Range of the row to iterate.

Returns: begin row_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: row must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.
slip::GenericMultiComponent3d<slip::color<double> > A1(8,8,8);

slip::GenericMultiComponent3d<slip::color<double> > A2(8,4,5);

slip::Range<int> range(0,A1.dim3()-1,2);

//copy the the elements of the row 0 of the slice 0 of A1 iterated according to the

//range in the row 1 of the slice 1 of A2

std::copy(A1.row_begin(0,0,range),A1.row_end(0,0,range),A2.row_begin(1,1));

template<typename Block>

const_row_range_iterator slip::GenericMultiComponent3d< Block >::row_begin	(	const size_type	slice,
		const size_type	row,
		const slip::Range< int > &	range
	)		const

Returns a read-only iterator that points to the first element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

slice	The index of the slice.
row	The index of the row to iterate.
range	Range of the row to iterate.

Returns: begin const_row_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: row must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.
slip::GenericMultiComponent3d<slip::color<double> > const A1(8,8,8);

slip::GenericMultiComponent3d<slip::color<double> > A2(8,4,5);

slip::Range<int> range(0,A1.dim3()-1,2);

//copy the the elements of the row 0 of the slice 0 of A1 iterated according to the

//range in the row 1 of the slice 1 of A2

std::copy(A1.row_begin(0,0,range),A1.row_end(0,0,range),A2.row_begin(1,1));

template<typename Block>

component_row_iterator slip::GenericMultiComponent3d< Block >::row_begin	(	const std::size_t	component,
		const size_type	slice,
		const size_type	row
	)

Returns a read/write iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

component	The component number.
slice	The index of the slice.
row	The index of the row.

Returns: begin row_iterator value

template<typename Block>

const_component_row_iterator slip::GenericMultiComponent3d< Block >::row_begin	(	const std::size_t	component,
		const size_type	slice,
		const size_type	row
	)		const

Returns a read_only iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

component	The component number.
slice	The index of the slice.
row	The index of the row.

Returns: begin const_row_iterator value

template<typename Block>

component_row_range_iterator slip::GenericMultiComponent3d< Block >::row_begin	(	const std::size_t	component,
		const size_type	slice,
		const size_type	row,
		const slip::Range< int > &	range
	)

Returns a read/write iterator that points to the first element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

component	The component number.
slice	The index of the slice.
row	The index of the row to iterate.
range	Range of the row to iterate.

Returns: begin row_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: row must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.
slip::Array3d<double> A1(8,8,8);

slip::Array3d<double> A2(8,4,5);

slip::Range<int> range(0,A1.dim2()-1,2);

//copy the the elements of the row 0 of A1 iterated according to the

//range in the row 1 of A2

std::copy(A1.row_begin(0,range),A1.row_end(0,range),A2.row_begin(1));

template<typename Block>

const_component_row_range_iterator slip::GenericMultiComponent3d< Block >::row_begin	(	const std::size_t	component,
		const size_type	slice,
		const size_type	row,
		const slip::Range< int > &	range
	)		const

Returns a read-only iterator that points to the first element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

component	The component number.
slice	The index of the slice.
row	The index of the row to iterate.
range	Range of the row to iterate.

Returns: begin const_row_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: row must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.
slip::Array3d<double> A1(8,8,8);

slip::Array3d<double> A2(8,4,5);

slip::Range<int> range(0,A1.dim2()-1,2);

//copy the the elements of the row 0 of A1 iterated according to the

//range in the row 1 of A2

std::copy(A1.row_begin(0,range),A1.row_end(0,range),A2.row_begin(1));

template<typename Block>

row_iterator slip::GenericMultiComponent3d< Block >::row_end	(	const size_type	slice,
		const size_type	row
	)

Returns a read/write iterator that points to the past-the-end element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

slice	The index of the slice.
row	The index of the row.

Returns: end row_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

const_row_iterator slip::GenericMultiComponent3d< Block >::row_end	(	const size_type	slice,
		const size_type	row
	)		const

Returns a read_only iterator that points to the past-the-end element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

slice	The index of the slice.
row	The index of the row.

Returns: end const_row_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

row_range_iterator slip::GenericMultiComponent3d< Block >::row_end	(	const size_type	slice,
		const size_type	row,
		const slip::Range< int > &	range
	)

Returns a read/write iterator that points one past the end element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

slice	The index of the slice.
row	The index of the row to iterate.
range	Range of the row to iterate.

Returns: end row_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: row must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.
slip::GenericMultiComponent3d<slip::color<double> > A1(8,8,8);

slip::GenericMultiComponent3d<slip::color<double> > A2(8,4,5);

slip::Range<int> range(0,A1.dim3()-1,2);

//copy the the elements of the row 0 of the slice 0 of A1 iterated according to the

//range in the row 1 of the slice 1 of A2

std::copy(A1.row_begin(0,0,range),A1.row_end(0,0,range),A2.row_begin(1,1));

template<typename Block>

const_row_range_iterator slip::GenericMultiComponent3d< Block >::row_end	(	const size_type	slice,
		const size_type	row,
		const slip::Range< int > &	range
	)		const

Returns a read_only iterator that points one past the last element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

slice	The index of the slice.
row	Row to iterate.
range	Range of the row to iterate

Returns: begin const_row_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: row must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.
slip::GenericMultiComponent3d<slip::color<double> > const A1(8,8,8);

slip::GenericMultiComponent3d<slip::color<double> > A2(8,4,5);

slip::Range<int> range(0,A1.dim3()-1,2);

//copy the the elements of the row 0 of the slice 0 of A1 iterated according to the

//range in the row 1 of the slice 1 of A2

std::copy(A1.row_begin(0,0,range),A1.row_end(0,0,range),A2.row_begin(1,1));

template<typename Block>

component_row_iterator slip::GenericMultiComponent3d< Block >::row_end	(	const std::size_t	component,
		const size_type	slice,
		const size_type	row
	)

Returns a read/write iterator that points to the past-the-end element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

component	The component number.
slice	The index of the slice.
row	The index of the row.

Returns: end row_iterator value

template<typename Block>

const_component_row_iterator slip::GenericMultiComponent3d< Block >::row_end	(	const std::size_t	component,
		const size_type	slice,
		const size_type	row
	)		const

Returns a read_only iterator that points to the past-the-end element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in ordinary element order.

Parameters

component	The component number.
slice	The index of the slice.
row	The index of the row.
component	The component number.

Returns: end const_row_iterator value

template<typename Block>

component_row_range_iterator slip::GenericMultiComponent3d< Block >::row_end	(	const std::size_t	component,
		const size_type	slice,
		const size_type	row,
		const slip::Range< int > &	range
	)

Returns a read/write iterator that points one past the end element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

component	The component number.
slice	The index of the slice.
row	The index of the row to iterate.
range	Range of the row to iterate.

Returns: end row_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: row must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.
slip::Array3d<double> A1(8,8,8);

slip::Array3d<double> A2(8,4,5);

slip::Range<int> range(0,A1.dim2()-1,2);

//copy the the elements of the row 0 of A1 iterated according to the

//range in the row 1 of A2

std::copy(A1.row_begin(0,range),A1.row_end(0,range),A2.row_begin(1));

template<typename Block>

const_component_row_range_iterator slip::GenericMultiComponent3d< Block >::row_end	(	const std::size_t	component,
		const size_type	slice,
		const size_type	row,
		const slip::Range< int > &	range
	)		const

Returns a read_only iterator that points one past the last element of the Range range of the row row in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

component	The component number.
slice	The index of the slice.
row	Row to iterate.
range	Range of the row to iterate

Returns: begin const_row_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: row must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.
slip::Array3d<double> A1(8,8,8);

slip::Array3d<double> A2(8,4,5);

slip::Range<int> range(0,A1.dim2()-1,2);

//copy the the elements of the row 0 of A1 iterated according to the

//range in the row 1 of A2

std::copy(A1.row_begin(0,range),A1.row_end(0,range),A2.row_begin(1));

template<typename Block>

reverse_row_iterator slip::GenericMultiComponent3d< Block >::row_rbegin	(	const size_type	slice,
		const size_type	row
	)

Returns a read/write reverse iterator that points to the last element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters

slice	The index of the slice.
row	The index of the row.

Returns: begin reverse_row_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

const_reverse_row_iterator slip::GenericMultiComponent3d< Block >::row_rbegin	(	const size_type	slice,
		const size_type	row
	)		const

Returns a read_only reverse iterator that points to the last element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters

slice	The index of the slice.
row	The index of the row.

Returns: begin const_reverse_row_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

reverse_row_range_iterator slip::GenericMultiComponent3d< Block >::row_rbegin	(	const size_type	slice,
		const size_type	row,
		const slip::Range< int > &	range
	)

Returns a read-write iterator that points to the last element of the Range range of the row of a slice row and slice in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters

slice	The index of the slice.
row	The index of the row to iterate.
range	Range of the row to iterate.

Returns: reverse_row_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: row must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.

template<typename Block>

const_reverse_row_range_iterator slip::GenericMultiComponent3d< Block >::row_rbegin	(	const size_type	slice,
		const size_type	row,
		const slip::Range< int > &	range
	)		const

Returns a read-only iterator that points to the last element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters

slice	The index of the slice.
row	The index of the row to iterate.
range	Range of the row to iterate

Returns: begin const_reverse_row_range_iterator value

Precondition: row must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.

template<typename Block>

reverse_component_row_iterator slip::GenericMultiComponent3d< Block >::row_rbegin	(	const std::size_t	component,
		const size_type	slice,
		const size_type	row
	)

Returns a read/write reverse iterator that points to the last element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters

component	The component number.
slice	The index of the slice.
row	The index of the row.

Returns: begin reverse_row_iterator value

template<typename Block>

const_reverse_component_row_iterator slip::GenericMultiComponent3d< Block >::row_rbegin	(	const std::size_t	component,
		const size_type	slice,
		const size_type	row
	)		const

Returns a read_only reverse iterator that points to the last element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters

component	The component number.
slice	The index of the slice.
row	The index of the row.

Returns: begin const_reverse_row_iterator value

template<typename Block>

reverse_component_row_range_iterator slip::GenericMultiComponent3d< Block >::row_rbegin	(	const std::size_t	component,
		const size_type	slice,
		const size_type	row,
		const slip::Range< int > &	range
	)

Returns a read-write iterator that points to the last element of the Range range of the row of a slice row and slice in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters

component	The component number.
slice	The index of the slice.
row	The index of the row to iterate.
range	Range of the row to iterate.

Returns: reverse_row_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: row must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.

template<typename Block>

const_reverse_component_row_range_iterator slip::GenericMultiComponent3d< Block >::row_rbegin	(	const std::size_t	component,
		const size_type	slice,
		const size_type	row,
		const slip::Range< int > &	range
	)		const

Returns a read-only iterator that points to the last element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters

component	The component number.
slice	The index of the slice.
row	The index of the row to iterate.
range	Range of the row to iterate

Returns: begin const_reverse_row_range_iterator value

Precondition: row must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.

template<typename Block>

reverse_row_iterator slip::GenericMultiComponent3d< Block >::row_rend	(	const size_type	slice,
		const size_type	row
	)

Returns a read/write reverse iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters

slice	The index of the slice.
row	The index of the row.

Returns: end reverse_row_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

const_reverse_row_iterator slip::GenericMultiComponent3d< Block >::row_rend	(	const size_type	slice,
		const size_type	row
	)		const

Returns a read_only reverse iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters

slice	The index of the slice.
row	The index of the row.

Returns: end const_reverse_row_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

reverse_row_range_iterator slip::GenericMultiComponent3d< Block >::row_rend	(	const size_type	slice,
		const size_type	row,
		const slip::Range< int > &	range
	)

Returns a read-write iterator that points one before the first element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters

slice	The index of the slice.
row	The index of the row to iterate.
range	Range of the row to iterate.

Returns: reverse_row_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: row must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.

template<typename Block>

const_reverse_row_range_iterator slip::GenericMultiComponent3d< Block >::row_rend	(	const size_type	slice,
		const size_type	row,
		const slip::Range< int > &	range
	)		const

Returns a read-only iterator that points one before the first element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters

slice	The index of the slice.
row	The index of the row to iterate.
range	Range of the row to iterate

Returns: const_reverse_row_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: row must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.

template<typename Block>

reverse_component_row_iterator slip::GenericMultiComponent3d< Block >::row_rend	(	const std::size_t	component,
		const size_type	slice,
		const size_type	row
	)

Returns a read/write reverse iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters

component	The component number.
slice	The index of the slice.
row	The index of the row.

Returns: end reverse_row_iterator value

template<typename Block>

const_reverse_component_row_iterator slip::GenericMultiComponent3d< Block >::row_rend	(	const std::size_t	component,
		const size_type	slice,
		const size_type	row
	)		const

Returns a read_only reverse iterator that points to the first element of the row row of the slice slice in the GenericMultiComponent3d. Iteration is done in reverse element order.

Parameters

component	The component number.
slice	The index of the slice.
row	The index of the row.

Returns: end const_reverse_row_iterator value

template<typename Block>

reverse_component_row_range_iterator slip::GenericMultiComponent3d< Block >::row_rend	(	const std::size_t	component,
		const size_type	slice,
		const size_type	row,
		const slip::Range< int > &	range
	)

Returns a read-write iterator that points one before the first element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters

component	The component number.
slice	The index of the slice.
row	The index of the row to iterate.
range	Range of the row to iterate.

Returns: reverse_row_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: row must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.

template<typename Block>

const_reverse_component_row_range_iterator slip::GenericMultiComponent3d< Block >::row_rend	(	const std::size_t	component,
		const size_type	slice,
		const size_type	row,
		const slip::Range< int > &	range
	)		const

Returns a read-only iterator that points one before the first element of the Range range of the row of a slice row in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters

component	The component number.
slice	The index of the slice.
row	The index of the row to iterate.
range	Range of the row to iterate

Returns: const_reverse_row_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: row must be compatible with the range of the GenericMultiComponent3d.; The range must be inside the whole range of the GenericMultiComponent3d.

template<typename Block >

GenericMultiComponent3d< Block >::size_type slip::GenericMultiComponent3d< Block >::rows ( ) const

inline

Returns the number of rows (first dimension size) in the GenericMultiComponent3d.

Definition at line 7603 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::size_type slip::GenericMultiComponent3d< Block >::size ( ) const

inline

Returns the number of elements in the GenericMultiComponent3d.

Definition at line 7623 of file GenericMultiComponent3d.hpp.

template<typename Block>

slice_iterator slip::GenericMultiComponent3d< Block >::slice_begin	(	const size_type	row,
		const size_type	col
	)

Returns a read/write iterator that points to the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number).

Parameters

row	row coordinate of the line
col	col coordinate of the line

Returns: slice_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > A1(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > A2(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > S(10,9,5);

//copy A1 in S

std::copy(A1.begin(),A1.end(),S.begin());

template<typename Block>

const_slice_iterator slip::GenericMultiComponent3d< Block >::slice_begin	(	const size_type	row,
		const size_type	col
	)		const

Returns a read-only (constant) iterator that points to the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number).

Parameters

row	row coordinate of the line
col	col coordinate of the line

Returns: const_slice_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const A1(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > const A2(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > S(10,9,5);

//copy A1 in S

std::copy(A1.begin(),A1.end(),S.begin());

template<typename Block>

slice_range_iterator slip::GenericMultiComponent3d< Block >::slice_begin	(	const size_type	row,
		const size_type	col,
		const slip::Range< int > &	range
	)

Returns a read/write iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns: begin slice_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: the range must be compatible with the slice dimensions; The range must be inside the whole range of the GenericMultiComponent3d.

Example:: slip::GenericMultiComponent3d<slip::color<double> > A1(8,8,8);

slip::GenericMultiComponent3d<slip::color<double> > A2(4,8,8);

slip::Range<int> range(0,A1.dim1()-1,2);

//copy the the elements of the line (0,0) of A1 iterated according to the

//range in the line (1,1) of A2

std::copy(A1.slice_begin(0,0,range),A1.slice_end(0,0,range),A2.slice_begin(1,1));

template<typename Block>

const_slice_range_iterator slip::GenericMultiComponent3d< Block >::slice_begin	(	const size_type	row,
		const size_type	col,
		const slip::Range< int > &	range
	)		const

Returns a read only (constant) iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns: begin const_slice_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: the range must be compatible with the slice dimensions; The range must be inside the whole range of the GenericMultiComponent3d.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const A1(8,8,8);

slip::GenericMultiComponent3d<slip::color<double> > const A2(4,8,8);

slip::Range<int> range(0,A1.dim1()-1,2);

//copy the the elements of the line (0,0) of A1 iterated according to the

//range in the line (1,1) of A2

std::copy(A1.slice_begin(0,0,range),A1.slice_end(0,0,range),A2.slice_begin(1,1));

template<typename Block>

component_slice_iterator slip::GenericMultiComponent3d< Block >::slice_begin	(	const std::size_t	component,
		const size_type	row,
		const size_type	col
	)

Returns a read/write iterator that points to the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number).

Parameters

component	The component number.
row	row coordinate of the line
col	col coordinate of the line

Returns: slice_iterator value

template<typename Block>

const_component_slice_iterator slip::GenericMultiComponent3d< Block >::slice_begin	(	const std::size_t	component,
		const size_type	row,
		const size_type	col
	)		const

Returns a read-only (constant) iterator that points to the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number).

Parameters

component	The component number.
row	row coordinate of the line
col	col coordinate of the line

Returns: const_slice_iterator value

template<typename Block>

component_slice_range_iterator slip::GenericMultiComponent3d< Block >::slice_begin	(	const std::size_t	component,
		const size_type	row,
		const size_type	col,
		const slip::Range< int > &	range
	)

Returns a read/write iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

component	The component number.
row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns: begin slice_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: the range must be compatible with the slice dimensions; The range must be inside the whole range of the GenericMultiComponent3d.
slip::Array3d<double> A1(8,8,8);

slip::Array3d<double> A2(4,8,8);

slip::Range<int> range(0,A1.dim1()-1,2);

//copy the the elements of the line (0,0) of A1 iterated according to the

//range in the line (1,1) of A2

std::copy(A1.slice_begin(0,0,range),A1.slice_end(0,0,range),A2.slice_begin(1,1));

template<typename Block>

const_component_slice_range_iterator slip::GenericMultiComponent3d< Block >::slice_begin	(	const std::size_t	component,
		const size_type	row,
		const size_type	col,
		const slip::Range< int > &	range
	)		const

Returns a read only (constant) iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

component	The component number.
row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns: begin const_slice_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: the range must be compatible with the slice dimensions; The range must be inside the whole range of the GenericMultiComponent3d.
slip::Array3d<double> const A1(M); //M is an already existing %GenericMultiComponent3d

slip::Range<int> range(0,A1.dim1()-1,2);

//display the elements of the line (0,0) of A1 iterated according to the range

std::copy(A1.slice_begin(0,0,range),A1.slice_end(0,0,range),std::ostream_iterator<double>(std::cout," "));

template<typename Block>

slice_iterator slip::GenericMultiComponent3d< Block >::slice_end	(	const size_type	row,
		const size_type	col
	)

Returns a read/write iterator that points to the one past the end element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number).

Parameters

row	row coordinate of the line
col	col coordinate of the line

Returns: slice_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > A1(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > A2(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > S(10,9,5);

//copy A1 in S

std::copy(A1.begin(),A1.end(),S.begin());

template<typename Block>

const_slice_iterator slip::GenericMultiComponent3d< Block >::slice_end	(	const size_type	row,
		const size_type	col
	)		const

Returns a read-only (constant) iterator that points to the one past the end element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number).

Parameters

row	row coordinate of the line
col	col coordinate of the line

Returns: const_slice_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const A1(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > const A2(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > S(10,9,5);

//copy A1 in S

std::copy(A1.begin(),A1.end(),S.begin());

template<typename Block>

slice_range_iterator slip::GenericMultiComponent3d< Block >::slice_end	(	const size_type	row,
		const size_type	col,
		const slip::Range< int > &	range
	)

Returns a read/write iterator that points one past the end element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns: end slice_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: the range must be compatible with the slice dimensions; The range must be inside the whole range of the GenericMultiComponent3d.

Example:: slip::GenericMultiComponent3d<slip::color<double> > A1(8,8,8);

slip::GenericMultiComponent3d<slip::color<double> > A2(4,8,8);

slip::Range<int> range(0,A1.dim1()-1,2);

//copy the the elements of the line (0,0) of A1 iterated according to the

//range in the line (1,1) of A2

std::copy(A1.slice_begin(0,0,range),A1.slice_end(0,0,range),A2.slice_begin(1,1));

template<typename Block>

const_slice_range_iterator slip::GenericMultiComponent3d< Block >::slice_end	(	const size_type	row,
		const size_type	col,
		const slip::Range< int > &	range
	)		const

Returns a read_only iterator that points one past the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns: end const_slice_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: the range must be compatible with the slice dimensions; The range must be inside the whole range of the GenericMultiComponent3d.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const A1(8,8,8);

slip::GenericMultiComponent3d<slip::color<double> > const A2(4,8,8);

slip::Range<int> range(0,A1.dim1()-1,2);

//copy the the elements of the line (0,0) of A1 iterated according to the

//range in the line (1,1) of A2

std::copy(A1.slice_begin(0,0,range),A1.slice_end(0,0,range),A2.slice_begin(1,1));

template<typename Block>

component_slice_iterator slip::GenericMultiComponent3d< Block >::slice_end	(	const std::size_t	component,
		const size_type	row,
		const size_type	col
	)

Returns a read/write iterator that points to the one past the end element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number).

Parameters

component	The component number.
row	row coordinate of the line
col	col coordinate of the line

Returns: slice_iterator value

template<typename Block>

const_component_slice_iterator slip::GenericMultiComponent3d< Block >::slice_end	(	const std::size_t	component,
		const size_type	row,
		const size_type	col
	)		const

Returns a read-only (constant) iterator that points to the one past the end element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order (increasing slice number).

Parameters

component	The component number.
row	row coordinate of the line
col	col coordinate of the line

Returns: const_slice_iterator value

template<typename Block>

component_slice_range_iterator slip::GenericMultiComponent3d< Block >::slice_end	(	const std::size_t	component,
		const size_type	row,
		const size_type	col,
		const slip::Range< int > &	range
	)

Returns a read/write iterator that points one past the end element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

component	The component number.
row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns: end slice_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: the range must be compatible with the slice dimensions; The range must be inside the whole range of the GenericMultiComponent3d.
slip::Array3d<double> A1(8,8,8);

slip::Array3d<double> A2(4,8,8);

slip::Range<int> range(0,A1.dim1()-1,2);

//copy the the elements of the line (0,0) of A1 iterated according to the

//range in the line (1,1) of A2

std::copy(A1.slice_range_begin(0,0,range),A1.slice_range_end(0,0,range),A2.slice_begin(1,1));

template<typename Block>

const_component_slice_range_iterator slip::GenericMultiComponent3d< Block >::slice_end	(	const std::size_t	component,
		const size_type	row,
		const size_type	col,
		const slip::Range< int > &	range
	)		const

Returns a read_only iterator that points one past the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in ordinary element order according to the Range.

Parameters

component	The component number.
row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns: end const_slice_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: the range must be compatible with the slice dimensions; The range must be inside the whole range of the GenericMultiComponent3d.
slip::Array3d<double> const A1(M); //M is an already existing %GenericMultiComponent3d

slip::Range<int> range(0,A1.dim1()-1,2);

//display the elements of the line (0,0) of A1 iterated according to the range

std::copy(A1.slice_begin(0,0,range),A1.slice_end(0,0,range),std::ostream_iterator<double>(std::cout," "));

template<typename Block>

reverse_slice_iterator slip::GenericMultiComponent3d< Block >::slice_rbegin	(	const size_type	row,
		const size_type	col
	)

Returns a read/write iterator that points to the last element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number).

Parameters

row	row coordinate of the line
col	col coordinate of the line

Returns: reverse_slice_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > A1(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > A2(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > S(10,9,5);

//copy A1 in S

std::copy(A1.rbegin(),A1.rend(),S.rbegin());

template<typename Block>

const_reverse_slice_iterator slip::GenericMultiComponent3d< Block >::slice_rbegin	(	const size_type	row,
		const size_type	col
	)		const

Returns a read-only (constant) iterator that points to the last element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number).

Parameters

row	row coordinate of the line
col	col coordinate of the line

Returns: const_reverse_slice_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const A1(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > const A2(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > S(10,9,5);

//copy A1 in S

std::copy(A1.rbegin(),A1.rend(),S.rbegin());

template<typename Block>

reverse_slice_range_iterator slip::GenericMultiComponent3d< Block >::slice_rbegin	(	const size_type	row,
		const size_type	col,
		const slip::Range< int > &	range
	)

Returns a read/write iterator that points to the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters

row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns: begin reverse_slice_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: the range must be compatible with the slice dimensions; The range must be inside the whole range of the GenericMultiComponent3d.

Example:: slip::GenericMultiComponent3d<slip::color<double> > A1(8,8,8);

slip::GenericMultiComponent3d<slip::color<double> > A2(4,8,8);

slip::Range<int> range(0,A1.dim1()-1,2);

//copy the the elements of the line (0,0) of A1 iterated according to the

//range in the line (1,1) of A2

std::copy(A1.slice_rbegin(0,0,range),A1.slice_rend(0,0,range),A2.slice_rbegin(1,1));

template<typename Block>

const_reverse_slice_range_iterator slip::GenericMultiComponent3d< Block >::slice_rbegin	(	const size_type	row,
		const size_type	col,
		const slip::Range< int > &	range
	)		const

Returns a read only (constant) iterator that points to the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range.

Parameters

row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns: begin const_reverse_slice_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: the range must be compatible with the slice dimensions; The range must be inside the whole range of the GenericMultiComponent3d.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const A1(8,8,8);

slip::GenericMultiComponent3d<slip::color<double> > const A2(4,8,8);

slip::Range<int> range(0,A1.dim1()-1,2);

//copy the the elements of the line (0,0) of A1 iterated according to the

//range in the line (1,1) of A2

std::copy(A1.slice_rbegin(0,0,range),A1.slice_rend(0,0,range),A2.slice_rbegin(1,1));

template<typename Block>

reverse_component_slice_iterator slip::GenericMultiComponent3d< Block >::slice_rbegin	(	const std::size_t	component,
		const size_type	row,
		const size_type	col
	)

Returns a read/write iterator that points to the last element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number).

Parameters

component	The component number.
row	row coordinate of the line
col	col coordinate of the line

Returns: reverse_slice_iterator value

template<typename Block>

const_reverse_component_slice_iterator slip::GenericMultiComponent3d< Block >::slice_rbegin	(	const std::size_t	component,
		const size_type	row,
		const size_type	col
	)		const

Returns a read-only (constant) iterator that points to the last element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number).

Parameters

component	The component number.
row	row coordinate of the line
col	col coordinate of the line

Returns: const_reverse_slice_iterator value

template<typename Block>

reverse_component_slice_range_iterator slip::GenericMultiComponent3d< Block >::slice_rbegin	(	const std::size_t	component,
		const size_type	row,
		const size_type	col,
		const slip::Range< int > &	range
	)

Returns a read/write iterator that points to the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in the reverse element order according to the Range.

Parameters

component	The component number.
row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns: begin reverse_slice_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: the range must be compatible with the slice dimensions; The range must be inside the whole range of the GenericMultiComponent3d.

template<typename Block>

const_reverse_component_slice_range_iterator slip::GenericMultiComponent3d< Block >::slice_rbegin	(	const std::size_t	component,
		const size_type	row,
		const size_type	col,
		const slip::Range< int > &	range
	)		const

Returns a read only (constant) iterator that points to the last element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range.

Parameters

component	The component number.
row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns: begin const_reverse_slice_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: the range must be compatible with the slice dimensions; The range must be inside the whole range of the GenericMultiComponent3d.

template<typename Block>

reverse_slice_iterator slip::GenericMultiComponent3d< Block >::slice_rend	(	const size_type	row,
		const size_type	col
	)

Returns a read/write iterator that points to the one before the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number).

Parameters

row	row coordinate of the line
col	col coordinate of the line

Returns: reverse_slice_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > A1(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > A2(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > S(10,9,5);

//copy A1 in S

std::copy(A1.rbegin(),A1.rend(),S.rbegin());

template<typename Block>

const_reverse_slice_iterator slip::GenericMultiComponent3d< Block >::slice_rend	(	const size_type	row,
		const size_type	col
	)		const

Returns a read (constant) iterator that points to the one before the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number).

Parameters

row	row coordinate of the line
col	col coordinate of the line

Returns: const_reverse_slice_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const A1(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > const A2(10,9,5);

slip::GenericMultiComponent3d<slip::color<double> > S(10,9,5);

//copy A1 in S

std::copy(A1.rbegin(),A1.rend(),S.rbegin());

template<typename Block>

reverse_slice_range_iterator slip::GenericMultiComponent3d< Block >::slice_rend	(	const size_type	row,
		const size_type	col,
		const slip::Range< int > &	range
	)

Returns a read/write iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range.

Parameters

row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns: end reverse_slice_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: the range must be compatible with the slice dimensions; The range must be inside the whole range of the GenericMultiComponent3d.

Example:: slip::GenericMultiComponent3d<slip::color<double> > A1(8,8,8);

slip::GenericMultiComponent3d<slip::color<double> > A2(4,8,8);

slip::Range<int> range(0,A1.dim1()-1,2);

//copy the the elements of the line (0,0) of A1 iterated according to the

//range in the line (1,1) of A2

std::copy(A1.slice_rbegin(0,0,range),A1.slice_rend(0,0,range),A2.slice_rbegin(1,1));

template<typename Block>

const_reverse_slice_range_iterator slip::GenericMultiComponent3d< Block >::slice_rend	(	const size_type	row,
		const size_type	col,
		const slip::Range< int > &	range
	)		const

Returns a read_only iterator that points one past the lastto the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range.

Parameters

row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns: end const_reverse_slice_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: the range must be compatible with the slice dimensions; The range must be inside the whole range of the GenericMultiComponent3d.

Example:: slip::GenericMultiComponent3d<slip::color<double> > const A1(8,8,8);

slip::GenericMultiComponent3d<slip::color<double> > const A2(4,8,8);

slip::Range<int> range(0,A1.dim1()-1,2);

//copy the the elements of the line (0,0) of A1 iterated according to the

//range in the line (1,1) of A2

std::copy(A1.slice_rbegin(0,0,range),A1.slice_rend(0,0,range),A2.slice_rbegin(1,1));

template<typename Block>

reverse_component_slice_iterator slip::GenericMultiComponent3d< Block >::slice_rend	(	const std::size_t	component,
		const size_type	row,
		const size_type	col
	)

Returns a read/write iterator that points to the one before the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number).

Parameters

component	The component number.
row	row coordinate of the line
col	col coordinate of the line

Returns: reverse_slice_iterator value

template<typename Block>

const_reverse_component_slice_iterator slip::GenericMultiComponent3d< Block >::slice_rend	(	const std::size_t	component,
		const size_type	row,
		const size_type	col
	)		const

Returns a read (constant) iterator that points to the one before the first element of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order (decreasing slice number).

Parameters

component	The component number.
row	row coordinate of the line
col	col coordinate of the line

Returns: const_reverse_slice_iterator value

template<typename Block>

reverse_component_slice_range_iterator slip::GenericMultiComponent3d< Block >::slice_rend	(	const std::size_t	component,
		const size_type	row,
		const size_type	col,
		const slip::Range< int > &	range
	)

Returns a read/write iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range.

Parameters

component	The component number.
row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns: end reverse_slice_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: the range must be compatible with the slice dimensions; The range must be inside the whole range of the GenericMultiComponent3d.

template<typename Block>

const_reverse_component_slice_range_iterator slip::GenericMultiComponent3d< Block >::slice_rend	(	const std::size_t	component,
		const size_type	row,
		const size_type	col,
		const slip::Range< int > &	range
	)		const

Returns a read_only iterator that points one past the lastto the first element of the Range range of the of the line (row,col) threw the slices in the GenericMultiComponent3d. Iteration is done in reverse element order according to the Range.

Parameters

component	The component number.
row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns: end const_reverse_slice_range_iterator value

Remarks: This iterator is compatible with RandomAccessIterator algorithms.

Precondition: the range must be compatible with the slice dimensions; The range must be inside the whole range of the GenericMultiComponent3d.

template<typename Block >

GenericMultiComponent3d< Block >::size_type slip::GenericMultiComponent3d< Block >::slice_size ( ) const

inline

Returns the number of elements in a slice of the GenericMultiComponent3d.

Definition at line 7631 of file GenericMultiComponent3d.hpp.

template<typename Block >

GenericMultiComponent3d< Block >::size_type slip::GenericMultiComponent3d< Block >::slices ( ) const

inline

Returns the number of slices (first dimension size) in the GenericMultiComponent3d.

Definition at line 7599 of file GenericMultiComponent3d.hpp.

template<typename Block >

void slip::GenericMultiComponent3d< Block >::swap ( self & M )

inline

Swaps data with another GenericMultiComponent3d.

Parameters

M	A GenericMultiComponent3d of the same element type

Definition at line 7639 of file GenericMultiComponent3d.hpp.

Friends And Related Function Documentation

template<typename Block>

friend class boost::serialization::access

friend

Definition at line 5268 of file GenericMultiComponent3d.hpp.

template<typename Block>

bool operator!=	(	const GenericMultiComponent3d< Block > &	x,
		const GenericMultiComponent3d< Block > &	y
	)

friend

GenericMultiComponent3d inequality comparison.

Parameters

x	A GenericMultiComponent3d
y	A GenericMultiComponent3d of the same type of x

Returns: true if !(x == y)

Precondition: x.size() == y.size()

Definition at line 7697 of file GenericMultiComponent3d.hpp.

template<typename Block>

std::ostream& operator<<	(	std::ostream &	out,
		const self &	a
	)

friend

Write the GenericMultiComponent3d to the ouput stream.

Parameters

out	output stream
a	GenericMultiComponent3d to write to the output stream

Definition at line 7552 of file GenericMultiComponent3d.hpp.

template<typename Block>

bool operator==	(	const GenericMultiComponent3d< Block > &	x,
		const GenericMultiComponent3d< Block > &	y
	)

friend

GenericMultiComponent3d equality comparison.

Parameters

x	A GenericMultiComponent3d
y	A GenericMultiComponent3d of the same type of x

Returns: true iff the size and the elements of the Arrays are equal

Precondition: x.size() == y.size()

Definition at line 7688 of file GenericMultiComponent3d.hpp.

Member Data Documentation

template<typename Block>

const std::size_t slip::GenericMultiComponent3d< Block >::COMPONENTS = Block::SIZE

static

Definition at line 313 of file GenericMultiComponent3d.hpp.

template<typename Block>

const std::size_t slip::GenericMultiComponent3d< Block >::DIM = 3

static

Definition at line 312 of file GenericMultiComponent3d.hpp.

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

src/Container/GenericMultiComponent3d.hpp

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

template<typename Block> class slip::GenericMultiComponent3d< Block >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<typename Block>
class slip::GenericMultiComponent3d< Block >