slip::GenericMultiComponent2d< Block > Class Template Reference

This is a GenericMultiComponent2d class. This container statisfies the BidirectionnalContainer concepts of the STL. It is also an 2d extension of the RandomAccessContainer concept. That is to say the bracket element access is replaced by the double bracket element access. Data are stored using a Matrix of Block. It is essentially an internal class used to define slip::ColorImage, slip::MultispectralImage, slip::DenseVector2dField2d, slip::DenseVector3dField2d. But it can be used to define other 2d Multicomponent structures. More...

#include <GenericMultiComponent2d.hpp>

Inheritance diagram for slip::GenericMultiComponent2d< Block >:

Public Types
typedef Block	value_type
typedef GenericMultiComponent2d< Block >	self
typedef const GenericMultiComponent2d< 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 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::Matrix< Block > ::iterator2d	iterator2d
typedef slip::Matrix< Block > ::const_iterator2d	const_iterator2d
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 slip::Matrix< Block > ::iterator2d_range	iterator2d_range
typedef slip::Matrix< Block > ::const_iterator2d_range	const_iterator2d_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 < 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 < iterator2d >	reverse_iterator2d
typedef std::reverse_iterator < const_iterator2d >	const_reverse_iterator2d
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 std::reverse_iterator < iterator2d_range >	reverse_iterator2d_range
typedef std::reverse_iterator < const_iterator2d_range >	const_reverse_iterator2d_range
typedef std::reverse_iterator < component_iterator >	reverse_component_iterator
typedef std::reverse_iterator < const_component_iterator >	const_reverse_component_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 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 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_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_iterator2d_box < self, Block::SIZE >	component_iterator2d
typedef std::reverse_iterator < component_iterator2d >	reverse_component_iterator2d
typedef slip::const_component_iterator2d_box < const_self, Block::SIZE >	const_component_iterator2d
typedef std::reverse_iterator < const_component_iterator2d >	const_reverse_component_iterator2d
typedef slip::component_iterator2d_range < self, Block::SIZE >	component_iterator2d_range
typedef std::reverse_iterator < component_iterator2d_range >	reverse_component_iterator2d_range
typedef slip::const_component_iterator2d_range < const_self, Block::SIZE >	const_component_iterator2d_range
typedef std::reverse_iterator < const_component_iterator2d_range >	const_reverse_component_iterator2d_range
typedef iterator2d	default_iterator
typedef const_iterator2d	const_default_iterator

Public Member Functions
void	resize (const size_type height, const size_type width, const Block &val=Block())
	Resizes a GenericMultiComponent2d. More...
size_type	dim1 () const
	Returns the number of rows (first dimension size) in the GenericMultiComponent2d. More...
size_type	rows () const
	Returns the number of rows (first dimension size) in the GenericMultiComponent2d. More...
size_type	height () const
	Returns the height (first dimension size) in the GenericMultiComponent2d. More...
size_type	dim2 () const
	Returns the number of columns (second dimension size) in the GenericMultiComponent2d. More...
size_type	columns () const
	Returns the number of columns (second dimension size) in the GenericMultiComponent2d. More...
size_type	cols () const
	Returns the number of columns (second dimension size) in the GenericMultiComponent2d. More...
size_type	width () const
	Returns the number of columns (second dimension size) in the GenericMultiComponent2d. More...
size_type	size () const
	Returns the number of elements in the GenericMultiComponent2d. More...
size_type	max_size () const
	Returns the maximal size (number of elements) in the GenericMultiComponent2d. More...
bool	empty () const
	Returns true if the GenericMultiComponent2d is empty. (Thus size() == 0) More...
void	swap (self &M)
	Swaps data with another GenericMultiComponent2d. More...
Block	min () const
	Returns the min elements of the GenericMultiComponent2d according to the operator <. More...
Block	max () const
	Returns the max elements of the GenericMultiComponent2d according to the operator <. More...
GenericMultiComponent2d< Block > &	apply (Block(*fun)(Block))
	Returns the sums of the elements of the GenericMultiComponent2d. More...
GenericMultiComponent2d< Block > &	apply (Block(*fun)(const Block &))
	Applys the one-parameter C-function fun to each element of the GenericMultiComponent2d. More...
template<typename Block>
	GenericMultiComponent2d (const typename GenericMultiComponent2d< Block >::size_type height, const typename GenericMultiComponent2d< Block >::size_type width)
template<typename Block>
	GenericMultiComponent2d (const typename GenericMultiComponent2d< Block >::size_type height, const typename GenericMultiComponent2d< Block >::size_type width, typename Block::const_pointer val)
template<typename Block>
	GenericMultiComponent2d (const typename GenericMultiComponent2d< Block >::size_type height, const typename GenericMultiComponent2d< Block >::size_type width, const Block &val)
template<typename Block>
	GenericMultiComponent2d (const typename GenericMultiComponent2d< Block >::size_type height, const typename GenericMultiComponent2d< Block >::size_type width, const Block *val)
Constructors & Destructors
	GenericMultiComponent2d ()
	Constructs a GenericMultiComponent2d. More...
	GenericMultiComponent2d (const size_type height, const size_type width)
	Constructs a GenericMultiComponent2d. More...
	GenericMultiComponent2d (const size_type height, const size_type width, const Block &val)
	Constructs a GenericMultiComponent2d initialized by the scalar value val. More...
	GenericMultiComponent2d (const size_type height, const size_type width, typename Block::const_pointer val)
	Constructs a GenericMultiComponent2d initialized by an array val. More...
	GenericMultiComponent2d (const size_type height, const size_type width, const Block *val)
	Constructs a GenericMultiComponent2d initialized by an array val. More...
template<typename InputIterator >
	GenericMultiComponent2d (const size_type height, const size_type width, InputIterator first, InputIterator last)
	Contructs a GenericMultiComponent2d from a range. More...
template<typename InputIterator >
	GenericMultiComponent2d (const size_type height, const size_type width, std::vector< InputIterator > first_iterators_list, InputIterator last)
	Contructs a GenericMultiComponent2d from a 3 ranges. More...
	GenericMultiComponent2d (const self &rhs)
	Constructs a copy of the GenericMultiComponent2d rhs. More...
virtual	~GenericMultiComponent2d ()
	Destructor of the GenericMultiComponent2d. More...
iterators
iterator	begin ()
	Returns a read/write iterator that points to the first element in the GenericMultiComponent2d. Iteration is done in ordinary element order. More...
iterator	end ()
	Returns a read/write iterator that points one past the last element in the GenericMultiComponent2d. 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 GenericMultiComponent2d. 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 GenericMultiComponent2d. 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 GenericMultiComponent2d. 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 GenericMultiComponent2d. 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 GenericMultiComponent2d. 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 GenericMultiComponent2d. Iteration is done in reverse element order. More...
row_iterator	row_begin (const size_type row)
	Returns a read/write iterator that points to the first element of the row row in the GenericMultiComponent2d. Iteration is done in ordinary element order. More...
row_iterator	row_end (const size_type row)
	Returns a read/write iterator that points one past the end element of the row row in the GenericMultiComponent2d. Iteration is done in ordinary element order. More...
const_row_iterator	row_begin (const size_type row) const
	Returns a read-only iterator that points to the first element of the row row in the GenericMultiComponent2d. Iteration is done in ordinary element order. More...
const_row_iterator	row_end (const size_type row) const
	Returns a read-only iterator that points one past the end element of the row row in the GenericMultiComponent2d. Iteration is done in ordinary element order. More...
col_iterator	col_begin (const size_type col)
	Returns a read/write iterator that points to the first element of the column column in the GenericMultiComponent2d. Iteration is done modulo the number of columns. More...
col_iterator	col_end (const size_type col)
	Returns a read/write iterator that points one past the end element of the column column in the GenericMultiComponent2d. Iteration is done modulo the number of columns. More...
const_col_iterator	col_begin (const size_type col) const
	Returns a read-only iterator that points to the first element of the column column in the GenericMultiComponent2d. Iteration is done modulo the number of columns. More...
const_col_iterator	col_end (const size_type col) const
	Returns a read-only iterator that points one past the end element of the column column in the GenericMultiComponent2d. Iteration is done modulo the number of columns. More...
row_range_iterator	row_begin (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 GenericMultiComponent2d. Iteration is done in ordinary element order according to the Range. More...
row_range_iterator	row_end (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 GenericMultiComponent2d. Iteration is done in ordinary element order according to the Range. More...
const_row_range_iterator	row_begin (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 GenericMultiComponent2d. Iteration is done in ordinary element order according to the Range. More...
const_row_range_iterator	row_end (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 GenericMultiComponent2d. Iteration is done in ordinary element order according to the Range. More...
col_range_iterator	col_begin (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 GenericMultiComponent2d. Iteration is done in ordinary element order according to the Range. More...
col_range_iterator	col_end (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 GenericMultiComponent2d. Iteration is done in ordinary element order according to the Range. More...
const_col_range_iterator	col_begin (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 GenericMultiComponent2d. Iteration is done in ordinary element order according to the Range. More...
const_col_range_iterator	col_end (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 GenericMultiComponent2d. Iteration is done in ordinary element order according to the Range. More...
reverse_row_iterator	row_rbegin (const size_type row)
	Returns a read/write reverse iterator that points to the last element of the row row in the GenericMultiComponent2d. Iteration is done in the reverse element order. More...
reverse_row_iterator	row_rend (const size_type row)
	Returns a read/write reverse iterator that points one past the first element of the row row in the GenericMultiComponent2d. Iteration is done in the reverse element order. More...
const_reverse_row_iterator	row_rbegin (const size_type row) const
	Returns a read-only reverse iterator that points to the last element of the row row in the GenericMultiComponent2d. Iteration is done in the reverse element order. More...
const_reverse_row_iterator	row_rend (const size_type row) const
	Returns a read-only reverse iterator that points one past the first element of the row row in the GenericMultiComponent2d. Iteration is done in the reverse element order. More...
reverse_col_iterator	col_rbegin (const size_type col)
	Returns a read/write reverse iterator that points to the last element of the column column in the GenericMultiComponent2d. Iteration is done modulo the number of columns and in the reverse element order. More...
reverse_col_iterator	col_rend (const size_type col)
	Returns a read/write reverse iterator that points one past the first element of the column column in the GenericMultiComponent2d. Iteration is done modulo the number of columns and in the reverse element order. More...
const_reverse_col_iterator	col_rbegin (const size_type col) const
	Returns a read-only reverse iterator that points to the last element of the column column in the GenericMultiComponent2d. Iteration is done modulo the number of columns and in the reverse element order. More...
const_reverse_col_iterator	col_rend (const size_type col) const
	Returns a read-only reverse iterator that points one past the first element of the column column in the GenericMultiComponent2d. Iteration is done modulo the number of columns and in the reverse element order. More...
reverse_row_range_iterator	row_rbegin (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 row in the GenericMultiComponent2d. Iteration is done in the reverse element order according to the Range. More...
reverse_row_range_iterator	row_rend (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 row in the GenericMultiComponent2d. Iteration is done in the reverse element order according to the Range. More...
const_reverse_row_range_iterator	row_rbegin (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 row in the GenericMultiComponent2d. Iteration is done in the reverse element order according to the Range. More...
const_reverse_row_range_iterator	row_rend (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 row in the GenericMultiComponent2d. Iteration is done in the reverse element order according to the Range. More...
reverse_col_range_iterator	col_rbegin (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 col in the GenericMultiComponent2d. Iteration is done in the reverse element order according to the Range. More...
reverse_col_range_iterator	col_rend (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 col in the GenericMultiComponent2d. Iteration is done in the reverse element order according to the Range. More...
const_reverse_col_range_iterator	col_rbegin (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 col in the GenericMultiComponent2d. Iteration is done in the reverse element order according to the Range. More...
const_reverse_col_range_iterator	col_rend (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 GenericMultiComponent2d. Iteration is done in the reverse element order according to the Range. More...
iterator2d	upper_left ()
	Returns a read/write iterator2d that points to the first element of the GenericMultiComponent2d. It points to the upper left element of the GenericMultiComponent2d. More...
iterator2d	bottom_right ()
	Returns a read/write iterator2d that points to the past the end element of the GenericMultiComponent2d. It points to past the end element of the bottom right element of the GenericMultiComponent2d. More...
const_iterator2d	upper_left () const
	Returns a read-only iterator2d that points to the first element of the GenericMultiComponent2d. It points to the upper left element of the GenericMultiComponent2d. More...
const_iterator2d	bottom_right () const
	Returns a read-only iterator2d that points to the past the end element of the GenericMultiComponent2d. It points to past the end element of the bottom right element of the GenericMultiComponent2d. More...
iterator2d	upper_left (const Box2d< int > &box)
	Returns a read/write iterator2d that points to the first element of the GenericMultiComponent2d. It points to the upper left element of the Box2d associated to the GenericMultiComponent2d. More...
iterator2d	bottom_right (const Box2d< int > &box)
	Returns a read/write iterator2d that points to the past the end element of the GenericMultiComponent2d. It points to past the end element of the bottom right element of the Box2d associated to the GenericMultiComponent2d. More...
const_iterator2d	upper_left (const Box2d< int > &box) const
	Returns a read only iterator2d that points to the first element of the GenericMultiComponent2d. It points to the upper left element of the Box2d associated to the GenericMultiComponent2d. More...
const_iterator2d	bottom_right (const Box2d< int > &box) const
	Returns a read only iterator2d that points to the past the end element of the GenericMultiComponent2d. It points to past the end element of the bottom right element of the Box2d associated to the GenericMultiComponent2d. More...
iterator2d_range	upper_left (const Range< int > &row_range, const Range< int > &col_range)
	Returns a read/write iterator2d_range that points to the upper left element of the ranges row_range and col_range associated to the GenericMultiComponent2d. More...
iterator2d_range	bottom_right (const Range< int > &row_range, const Range< int > &col_range)
	Returns a read/write iterator2d_range that points to the past the end bottom right element of the ranges row_range and col_range associated to the GenericMultiComponent2d. More...
const_iterator2d_range	upper_left (const Range< int > &row_range, const Range< int > &col_range) const
	Returns a read-only iterator2d_range that points to the to the upper left element of the ranges row_range and col_range associated to the GenericMultiComponent2d. More...
const_iterator2d_range	bottom_right (const Range< int > &row_range, const Range< int > &col_range) const
	Returns a read-only iterator2d_range that points to the past the end bottom right element of the ranges row_range and col_range associated to the GenericMultiComponent2d. More...
iterator2d_range	upper_left (const Range< int > &range)
	Returns a read/write iterator2d_range that points to the upper left element of the Range range associated to the GenericMultiComponent2d. The same range is applied for rows and cols. More...
iterator2d_range	bottom_right (const Range< int > &range)
	Returns a read/write iterator2d_range that points to the past the end bottom right element of the Range range associated to the GenericMultiComponent2d. The same range is applied for rows and cols. More...
const_iterator2d_range	upper_left (const Range< int > &range) const
	Returns a read-only iterator2d_range that points to the to the upper left element of the Range range associated to the GenericMultiComponent2d. More...
const_iterator2d_range	bottom_right (const Range< int > &range) const
	Returns a read-only const_iterator2d_range that points to the past the end bottom right element of the Range range associated to the GenericMultiComponent2d. The same range is applied for rows and cols. More...
reverse_iterator2d	rupper_left ()
	Returns a read/write reverse iterator2d. It points to the bottom right element of the GenericMultiComponent2d. Iteration is done within the GenericMultiComponent2d in the reverse order. More...
reverse_iterator2d	rbottom_right ()
	Returns a read/write reverse iterator2d. It points to past the upper left element of the GenericMultiComponent2d. Iteration is done in the reverse order. More...
const_reverse_iterator2d	rupper_left () const
	Returns a read only reverse iterator2d that points. It points to the bottom right element of the GenericMultiComponent2d. Iteration is done within the GenericMultiComponent2d in the reverse order. More...
const_reverse_iterator2d	rbottom_right () const
	Returns a read only reverse iterator2d. It points to past the upper left element of the GenericMultiComponent2d. Iteration is done in the reverse order. More...
reverse_iterator2d	rupper_left (const Box2d< int > &box)
	Returns a read/write reverse iterator2d. It points to the bottom right element of the Box2d associated to the GenericMultiComponent2d. Iteration is done in the reverse order. More...
reverse_iterator2d	rbottom_right (const Box2d< int > &box)
	Returns a read/write reverse iterator2d. It points to one before the upper left element of the Box2d box associated to the GenericMultiComponent2d. More...
const_reverse_iterator2d	rupper_left (const Box2d< int > &box) const
	Returns a read only reverse iterator2d. It points to the bottom right element of the Box2d box associated to the GenericMultiComponent2d. Iteration is done in the reverse order. More...
const_reverse_iterator2d	rbottom_right (const Box2d< int > &box) const
	Returns a read-only reverse iterator2d. It points to one before the element of the bottom right element of the Box2d box associated to the GenericMultiComponent2d. More...
reverse_iterator2d_range	rupper_left (const Range< int > &row_range, const Range< int > &col_range)
	Returns a read/write reverse_iterator2d_range that points to the past the bottom right element of the ranges row_range and col_range associated to the GenericMultiComponent2d. Iteration is done in the reverse order. More...
reverse_iterator2d_range	rbottom_right (const Range< int > &row_range, const Range< int > &col_range)
	Returns a read/write reverse_iterator2d_range that points to one before the upper left element of the ranges row_range and col_range associated to the GenericMultiComponent2d. Iteration is done in the reverse order. More...
const_reverse_iterator2d_range	rupper_left (const Range< int > &row_range, const Range< int > &col_range) const
	Returns a read-only reverse_iterator2d_range that points to the past the bottom right element of the ranges row_range and col_range associated to the GenericMultiComponent2d. Iteration is done in the reverse order. More...
const_reverse_iterator2d_range	rbottom_right (const Range< int > &row_range, const Range< int > &col_range) const
	Returns a read-only reverse_iterator2d_range that points to one before the upper left element of the ranges row_range and col_range associated to the GenericMultiComponent2d.Iteration is done in the reverse order. More...
reverse_iterator2d_range	rupper_left (const Range< int > &range)
	Returns a read/write reverse_iterator2d_range that points to the bottom right element of the Range range associated to the GenericMultiComponent2d. The same range is applied for rows and cols. Iteration is done in the reverse order. More...
reverse_iterator2d_range	rbottom_right (const Range< int > &range)
	Returns a read/write reverse_iterator2d_range that points to one before the upper left element of the Range range associated to the GenericMultiComponent2d. The same range is applied for rows and cols. Iteration is done in the reverse order. More...
const_reverse_iterator2d_range	rupper_left (const Range< int > &range) const
	Returns a read-only reverse_iterator2d_range that points to the to the bottom right element of the Range range associated to the GenericMultiComponent2d. The same range is applied for rows and cols. Iteration is done in the reverse order. More...
const_reverse_iterator2d_range	rbottom_right (const Range< int > &range) const
	Returns a read_only reverse_iterator2d_range that points to one before the upper left element of the Range range associated to the GenericMultiComponent2d. The same range is applied for rows and cols. Iteration is done in the reverse order. More...
component_iterator	begin (const std::size_t component)
	Returns a read/write iterator that points to the first element in the GenericMultiComponent2d. 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 GenericMultiComponent2d. 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 GenericMultiComponent2d. 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 GenericMultiComponent2d. 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 GenericMultiComponent2d. 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 GenericMultiComponent2d. 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 GenericMultiComponent2d. 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 GenericMultiComponent2d. Iteration is done in ordinary element order. More...
component_row_iterator	row_begin (const std::size_t component, const std::size_t row)
	Returns a read/write iterator that points to the first element in the GenericMultiComponent2d. Iteration is done in ordinary element order. More...
const_component_row_iterator	row_begin (const std::size_t component, const std::size_t row) const
	Returns a read-only (constant) iterator that points to the first element in the GenericMultiComponent2d. Iteration is done in ordinary element order. More...
component_row_iterator	row_end (const std::size_t component, const std::size_t row)
	Returns a read/write iterator that points one past the last element in the GenericMultiComponent2d. Iteration is done in ordinary element order. More...
const_component_row_iterator	row_end (const std::size_t component, const std::size_t row) const
	Returns a read-only (constant) iterator that points one past the last element in the GenericMultiComponent2d. Iteration is done in ordinary element order. More...
reverse_component_row_iterator	row_rbegin (const std::size_t component, const std::size_t row)
	Returns a read/write iterator that points to the first element in the GenericMultiComponent2d. Iteration is done in ordinary element order. More...
const_reverse_component_row_iterator	row_rbegin (const std::size_t component, const std::size_t row) const
	Returns a read-only (constant) iterator that points to the first element in the GenericMultiComponent2d. Iteration is done in ordinary element order. More...
reverse_component_row_iterator	row_rend (const std::size_t component, const std::size_t row)
	Returns a read/write iterator that points one past the last element in the GenericMultiComponent2d. Iteration is done in ordinary element order. More...
const_reverse_component_row_iterator	row_rend (const std::size_t component, const std::size_t row) const
	Returns a read-only (constant) iterator that points one past the last element in the GenericMultiComponent2d. Iteration is done in ordinary element order. More...
component_col_iterator	col_begin (const std::size_t component, const std::size_t col)
	Returns a read/write iterator that points to the first element in the GenericMultiComponent2d. Iteration is done in ordinary element order. More...
const_component_col_iterator	col_begin (const std::size_t component, const std::size_t col) const
	Returns a read-only (constant) iterator that points to the first element in the GenericMultiComponent2d. Iteration is done in ordinary element order. More...
component_col_iterator	col_end (const std::size_t component, const std::size_t col)
	Returns a read/write iterator that points one past the last element in the GenericMultiComponent2d. Iteration is done in ordinary element order. More...
const_component_col_iterator	col_end (const std::size_t component, const std::size_t col) const
	Returns a read-only (constant) iterator that points one past the last element in the GenericMultiComponent2d. Iteration is done in ordinary element order. More...
reverse_component_col_iterator	col_rbegin (const std::size_t component, const std::size_t col)
	Returns a read/write iterator that points to the last element of the col col in the GenericMultiComponent2d. Iteration is done in reverse element order. More...
const_reverse_component_col_iterator	col_rbegin (const std::size_t component, const std::size_t col) const
	Returns a read-only (constant) iterator that points to the last element of the col col in the GenericMultiComponent2d. Iteration is done in reverse element order. More...
reverse_component_col_iterator	col_rend (const std::size_t component, const std::size_t col)
	Returns a read/write iterator that points one before the first element of the col col in the GenericMultiComponent2d. Iteration is done in the reverse element order. More...
const_reverse_component_col_iterator	col_rend (const std::size_t component, const std::size_t col) const
	Returns a read-only (constant) iterator that points one before the first element of the col col in the GenericMultiComponent2d. Iteration is done in ordinary element order. More...
component_row_range_iterator	row_begin (const std::size_t component, 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 GenericMultiComponent2d. 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 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 GenericMultiComponent2d. 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 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 GenericMultiComponent2d. 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 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 GenericMultiComponent2d. Iteration is done in ordinary element order according to the Range. More...
component_col_range_iterator	col_begin (const std::size_t component, 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 GenericMultiComponent2d. 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 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 GenericMultiComponent2d. 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 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 GenericMultiComponent2d. 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 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 GenericMultiComponent2d. 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 row, const slip::Range< int > &range)
	Returns a read-write iterator that points to the last element of the Range range of the row row in the GenericMultiComponent2d. 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 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 row in the GenericMultiComponent2d. 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 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 row in the GenericMultiComponent2d. 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 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 row in the GenericMultiComponent2d. Iteration is done in the reverse element order according to the Range. More...
reverse_component_col_range_iterator	col_rbegin (const std::size_t component, 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 col in the GenericMultiComponent2d. 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 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 col in the GenericMultiComponent2d. 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 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 col in the GenericMultiComponent2d. 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 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 GenericMultiComponent2d. Iteration is done in the reverse element order according to the Range. More...
component_iterator2d	upper_left (const std::size_t component)
	Returns a read/write component_iterator2d that points to the first element of the GenericMultiComponent2d. It points to the upper left element of the GenericMultiComponent2d. More...
component_iterator2d	bottom_right (const std::size_t component)
	Returns a read/write component_iterator2d that points to the past the end element of the GenericMultiComponent2d. It points to past the end element of the bottom right element of the GenericMultiComponent2d. More...
const_component_iterator2d	upper_left (const std::size_t component) const
	Returns a read only const_component_iterator2d that points to the first element of the GenericMultiComponent2d. It points to the upper left element of the GenericMultiComponent2d. More...
const_component_iterator2d	bottom_right (const std::size_t component) const
	Returns a read only const_component_iterator2d that points to the past the end element of the GenericMultiComponent2d. It points to past the end element of the bottom right element of the GenericMultiComponent2d. More...
reverse_component_iterator2d	rupper_left (const std::size_t component)
	Returns a read/write reverse component iterator2d. It points to the bottom right element of the GenericMultiComponent2d. Iteration is done within the GenericMultiComponent2d in the reverse order. More...
reverse_component_iterator2d	rbottom_right (const std::size_t component)
	Returns a read/write reverse component iterator2d. It points to past the upper left element of the GenericMultiComponent2d. Iteration is done in the reverse order. More...
const_reverse_component_iterator2d	rupper_left (const std::size_t component) const
	Returns a read only reverse component iterator2d that points. It points to the bottom right element of the GenericMultiComponent2d. Iteration is done within the GenericMultiComponent2d in the reverse order. More...
const_reverse_component_iterator2d	rbottom_right (const std::size_t component) const
	Returns a read only reverse component iterator2d. It points to past the upper left element of the GenericMultiComponent2d. Iteration is done in the reverse order. More...
component_iterator2d	upper_left (const std::size_t component, const Box2d< int > &box)
	Returns a read/write component iterator2d that points to the first element of the GenericMultiComponent2d. It points to the upper left element of the Box2d associated to the GenericMultiComponent2d. More...
component_iterator2d	bottom_right (const std::size_t component, const Box2d< int > &box)
	Returns a read/write component iterator2d that points to the past the end element of the GenericMultiComponent2d. It points to past the end element of the bottom right element of the Box2d associated to the GenericMultiComponent2d. More...
const_component_iterator2d	upper_left (const std::size_t component, const Box2d< int > &box) const
	Returns a read only component iterator2d that points to the first element of the GenericMultiComponent2d. It points to the upper left element of the Box2d associated to the GenericMultiComponent2d. More...
const_component_iterator2d	bottom_right (const std::size_t component, const Box2d< int > &box) const
	Returns a read only component iterator2d that points to the past the end element of the GenericMultiComponent2d. It points to past the end element of the bottom right element of the Box2d associated to the GenericMultiComponent2d. More...
component_iterator2d_range	upper_left (const std::size_t component, const Range< int > &row_range, const Range< int > &col_range)
	Returns a read/write component iterator2d_range that points to the upper left element of the ranges row_range and col_range associated to the GenericMultiComponent2d. More...
component_iterator2d_range	bottom_right (const std::size_t component, const Range< int > &row_range, const Range< int > &col_range)
	Returns a read/write component iterator2d_range that points to the past the end bottom right element of the ranges row_range and col_range associated to the GenericMultiComponent2d. More...
const_component_iterator2d_range	upper_left (const std::size_t component, const Range< int > &row_range, const Range< int > &col_range) const
	Returns a read-only component iterator2d_range that points to the to the upper left element of the ranges row_range and col_range associated to the GenericMultiComponent2d. More...
const_component_iterator2d_range	bottom_right (const std::size_t component, const Range< int > &row_range, const Range< int > &col_range) const
	Returns a read-only component iterator2d_range that points to the past the end bottom right element of the ranges row_range and col_range associated to the GenericMultiComponent2d. More...
reverse_component_iterator2d	rupper_left (const std::size_t component, const Box2d< int > &box)
	Returns a read/write reverse component iterator2d. It points to the bottom right element of the Box2d associated to the GenericMultiComponent2d. Iteration is done in the reverse order. More...
reverse_component_iterator2d	rbottom_right (const std::size_t component, const Box2d< int > &box)
	Returns a read/write reverse component iterator2d. It points to one before the upper left element of the Box2d box associated to the GenericMultiComponent2d. More...
const_reverse_component_iterator2d	rupper_left (const std::size_t component, const Box2d< int > &box) const
	Returns a read only reverse component iterator2d. It points to the bottom right element of the Box2d box associated to the GenericMultiComponent2d. Iteration is done in the reverse order. More...
const_reverse_component_iterator2d	rbottom_right (const std::size_t component, const Box2d< int > &box) const
	Returns a read-only reverse component iterator2d. It points to one before the element of the bottom right element of the Box2d box associated to the GenericMultiComponent2d. More...
reverse_component_iterator2d_range	rupper_left (const std::size_t component, const Range< int > &row_range, const Range< int > &col_range)
	Returns a read/write reverse component iterator2d_range that points to the past the bottom right element of the ranges row_range and col_range associated to the GenericMultiComponent2d. Iteration is done in the reverse order. More...
reverse_component_iterator2d_range	rbottom_right (const std::size_t component, const Range< int > &row_range, const Range< int > &col_range)
	Returns a read/write reverse_component_iterator2d_range that points to one before the upper left element of the ranges row_range and col_range associated to the GenericMultiComponent2d. Iteration is done in the reverse order. More...
const_reverse_component_iterator2d_range	rupper_left (const std::size_t component, const Range< int > &row_range, const Range< int > &col_range) const
	Returns a read-only reverse_component_iterator2d_range that points to the past the bottom right element of the ranges row_range and col_range associated to the GenericMultiComponent2d. Iteration is done in the reverse order. More...
const_reverse_component_iterator2d_range	rbottom_right (const std::size_t component, const Range< int > &row_range, const Range< int > &col_range) const
	Returns a read-only reverse_component_iterator2d_range that points to one before the upper left element of the ranges row_range and col_range associated to the GenericMultiComponent2d.Iteration is done in the reverse order. More...
Assignment operators and methods
self &	operator= (const self &rhs)
	Assign a GenericMultiComponent2d. More...
self &	operator= (const Block &val)
	Affects all the element of the GenericMultiComponent2d by val. More...
self &	operator= (const typename Block::value_type &val)
	Affects all the element of the GenericMultiComponent2d 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 (GenericMultiComponent2d ordering relation) Parameters x A GenericMultiComponent2d y A GenericMultiComponent2d 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 GenericMultiComponent2d y A GenericMultiComponent2d of the same type of x Returns true iff y > x Precondition x.size() == y.size() Less than equal comparison operator Parameters x A GenericMultiComponent2d y A GenericMultiComponent2d of the same type of x Returns true iff !(y > x) Precondition x.size() == y.size() More than equal comparison operator Parameters x A GenericMultiComponent2d y A GenericMultiComponent2d of the same type of x Returns true iff !(x < y) Precondition x.size() == y.size()
pointer	operator[] (const size_type i)
	Subscript access to the row datas contained in the GenericMultiComponent2d. More...
const_pointer	operator[] (const size_type i) const
	Subscript access to the row datas contained in the GenericMultiComponent2d. More...
reference	operator() (const size_type i, const size_type j)
	Subscript access to the data contained in the GenericMultiComponent2d. More...
const_reference	operator() (const size_type i, const size_type j) const
	Subscript access to the data contained in the GenericMultiComponent2d. More...
reference	operator() (const Point2d< size_type > &point2d)
	Subscript access to the data contained in the GenericMultiComponent2d. More...
const_reference	operator() (const Point2d< size_type > &point2d) const
	Subscript access to the data contained in the GenericMultiComponent2d. More...
self	operator() (const Range< int > &row_range, const Range< int > &col_range)
	Subscript access to the data contained in the GenericMultiComponent2d. More...

Static Public Attributes
static const std::size_t	DIM = 2
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 GenericMultiComponent2d to the ouput stream. More...
Comparison operators
bool	operator== (const GenericMultiComponent2d< Block > &x, const GenericMultiComponent2d< Block > &y)
	GenericMultiComponent2d equality comparison. More...
bool	operator!= (const GenericMultiComponent2d< Block > &x, const GenericMultiComponent2d< Block > &y)
	GenericMultiComponent2d inequality comparison. More...

Detailed Description

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

This is a GenericMultiComponent2d class. This container statisfies the BidirectionnalContainer concepts of the STL. It is also an 2d extension of the RandomAccessContainer concept. That is to say the bracket element access is replaced by the double bracket element access. Data are stored using a Matrix of Block. It is essentially an internal class used to define slip::ColorImage, slip::MultispectralImage, slip::DenseVector2dField2d, slip::DenseVector3dField2d. But it can be used to define other 2d Multicomponent structures.

Author

Benoit Tremblais <tremblais_AT_sic.univ-poitiers.fr>

Denis Arrivault <arrivault_AT_sic.univ-poitiers.fr>

Version

0.0.1

Date

2007/02/24

Since

1.0.0

Parameters

Block

Type of object in the GenericMultiComponent2d Must be a static block

Axis conventions:

axis and notation conventions

Definition at line 129 of file GenericMultiComponent2d.hpp.

Member Typedef Documentation

template<typename Block>

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

Definition at line 229 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 231 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 228 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 215 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 223 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 260 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 262 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 233 of file GenericMultiComponent2d.hpp.

template<typename Block>

typedef slip::component_iterator2d_box<self,Block::SIZE> slip::GenericMultiComponent2d< Block >::component_iterator2d

Definition at line 269 of file GenericMultiComponent2d.hpp.

template<typename Block>

typedef slip::component_iterator2d_range<self,Block::SIZE> slip::GenericMultiComponent2d< Block >::component_iterator2d_range

Definition at line 274 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 251 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 253 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 230 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 232 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 216 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 224 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 261 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 263 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 234 of file GenericMultiComponent2d.hpp.

template<typename Block>

typedef slip::const_component_iterator2d_box<const_self,Block::SIZE> slip::GenericMultiComponent2d< Block >::const_component_iterator2d

Definition at line 271 of file GenericMultiComponent2d.hpp.

template<typename Block>

typedef slip::const_component_iterator2d_range<const_self,Block::SIZE> slip::GenericMultiComponent2d< Block >::const_component_iterator2d_range

Definition at line 276 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 252 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 254 of file GenericMultiComponent2d.hpp.

template<typename Block>

typedef const_iterator2d slip::GenericMultiComponent2d< Block >::const_default_iterator

Definition at line 281 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 207 of file GenericMultiComponent2d.hpp.

template<typename Block>

typedef slip::Matrix<Block>::const_iterator2d slip::GenericMultiComponent2d< Block >::const_iterator2d

Definition at line 220 of file GenericMultiComponent2d.hpp.

template<typename Block>

typedef slip::Matrix<Block>::const_iterator2d_range slip::GenericMultiComponent2d< Block >::const_iterator2d_range

Definition at line 226 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 199 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 201 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 239 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 245 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 265 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 267 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 249 of file GenericMultiComponent2d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_component_iterator2d> slip::GenericMultiComponent2d< Block >::const_reverse_component_iterator2d

Definition at line 272 of file GenericMultiComponent2d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_component_iterator2d_range> slip::GenericMultiComponent2d< Block >::const_reverse_component_iterator2d_range

Definition at line 277 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 256 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 258 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 210 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 241 of file GenericMultiComponent2d.hpp.

template<typename Block>

typedef std::reverse_iterator<const_iterator2d_range> slip::GenericMultiComponent2d< Block >::const_reverse_iterator2d_range

Definition at line 247 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 237 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 243 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 214 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 222 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 197 of file GenericMultiComponent2d.hpp.

template<typename Block>

typedef iterator2d slip::GenericMultiComponent2d< Block >::default_iterator

Definition at line 280 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 203 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 206 of file GenericMultiComponent2d.hpp.

template<typename Block>

typedef slip::Matrix<Block>::iterator2d slip::GenericMultiComponent2d< Block >::iterator2d

Definition at line 219 of file GenericMultiComponent2d.hpp.

template<typename Block>

typedef slip::Matrix<Block>::iterator2d_range slip::GenericMultiComponent2d< Block >::iterator2d_range

Definition at line 225 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 198 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 200 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 238 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 244 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 264 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 266 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 248 of file GenericMultiComponent2d.hpp.

template<typename Block>

typedef std::reverse_iterator<component_iterator2d> slip::GenericMultiComponent2d< Block >::reverse_component_iterator2d

Definition at line 270 of file GenericMultiComponent2d.hpp.

template<typename Block>

typedef std::reverse_iterator<component_iterator2d_range> slip::GenericMultiComponent2d< Block >::reverse_component_iterator2d_range

Definition at line 275 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 255 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 257 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 209 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 240 of file GenericMultiComponent2d.hpp.

template<typename Block>

typedef std::reverse_iterator<iterator2d_range> slip::GenericMultiComponent2d< Block >::reverse_iterator2d_range

Definition at line 246 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 236 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 242 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 213 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 221 of file GenericMultiComponent2d.hpp.

template<typename Block>

typedef GenericMultiComponent2d<Block> slip::GenericMultiComponent2d< Block >::self

Definition at line 196 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

Definition at line 204 of file GenericMultiComponent2d.hpp.

template<typename Block>

typedef Block slip::GenericMultiComponent2d< Block >::value_type

Definition at line 195 of file GenericMultiComponent2d.hpp.

Constructor & Destructor Documentation

template<typename Block >

slip::GenericMultiComponent2d< Block >::GenericMultiComponent2d ( )

inline

Constructs a GenericMultiComponent2d.

Definition at line 3443 of file GenericMultiComponent2d.hpp.

template<typename Block>

slip::GenericMultiComponent2d< Block >::GenericMultiComponent2d	(	const size_type	height,
		const size_type	width
	)

Constructs a GenericMultiComponent2d.

Parameters

height	first dimension of the GenericMultiComponent2d
width	second dimension of the GenericMultiComponent2d

template<typename Block>

slip::GenericMultiComponent2d< Block >::GenericMultiComponent2d	(	const size_type	height,
		const size_type	width,
		const Block &	val
	)

Constructs a GenericMultiComponent2d initialized by the scalar value val.

Parameters

height	first dimension of the GenericMultiComponent2d
width	second dimension of the GenericMultiComponent2d
val	initialization value of the elements

template<typename Block>

slip::GenericMultiComponent2d< Block >::GenericMultiComponent2d	(	const size_type	height,
		const size_type	width,
		typename Block::const_pointer	val
	)

Constructs a GenericMultiComponent2d initialized by an array val.

Parameters

height	first dimension of the GenericMultiComponent2d
width	second dimension of the GenericMultiComponent2d
val	initialization linear array value of the elements

template<typename Block>

slip::GenericMultiComponent2d< Block >::GenericMultiComponent2d	(	const size_type	height,
		const size_type	width,
		const Block *	val
	)

Constructs a GenericMultiComponent2d initialized by an array val.

Parameters

height	first dimension of the GenericMultiComponent2d
width	second dimension of the GenericMultiComponent2d
val	initialization array value of the elements

template<typename Block>

template<typename InputIterator >

slip::GenericMultiComponent2d< Block >::GenericMultiComponent2d ( const size_type  height, const size_type  width, InputIterator  first, InputIterator  last  )

inline

Contructs a GenericMultiComponent2d from a range.

Parameters

height	first dimension of the GenericMultiComponent2d
width	second dimension of the GenericMultiComponent2d
first	An input iterator.
last	An input iterator.

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

Definition at line 346 of file GenericMultiComponent2d.hpp.

template<typename Block>

template<typename InputIterator >

slip::GenericMultiComponent2d< Block >::GenericMultiComponent2d ( const size_type  height, const size_type  width, std::vector< InputIterator >  first_iterators_list, InputIterator  last  )

inline

Contructs a GenericMultiComponent2d from a 3 ranges.

Parameters

height	first dimension of the GenericMultiComponent2d
width	second dimension of the GenericMultiComponent2d
first_iterators_list	A std::vector of the first input iterators.
last	An input iterator.

Create a GenericMultiComponent2d 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 368 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

inline

Constructs a copy of the GenericMultiComponent2d rhs.

Definition at line 3491 of file GenericMultiComponent2d.hpp.

template<typename Block >

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

inlinevirtual

Destructor of the GenericMultiComponent2d.

Definition at line 3497 of file GenericMultiComponent2d.hpp.

template<typename Block>

template<typename Block>

slip::GenericMultiComponent2d< Block >::GenericMultiComponent2d ( const typename GenericMultiComponent2d< Block >::size_type  height, const typename GenericMultiComponent2d< Block >::size_type  width  )

inline

Definition at line 3449 of file GenericMultiComponent2d.hpp.

template<typename Block>

template<typename Block>

slip::GenericMultiComponent2d< Block >::GenericMultiComponent2d ( const typename GenericMultiComponent2d< Block >::size_type  height, const typename GenericMultiComponent2d< Block >::size_type  width, typename Block::const_pointer  val  )

inline

Definition at line 3456 of file GenericMultiComponent2d.hpp.

template<typename Block>

template<typename Block>

slip::GenericMultiComponent2d< Block >::GenericMultiComponent2d ( const typename GenericMultiComponent2d< Block >::size_type  height, const typename GenericMultiComponent2d< Block >::size_type  width, const Block &  val  )

inline

Definition at line 3475 of file GenericMultiComponent2d.hpp.

template<typename Block>

template<typename Block>

slip::GenericMultiComponent2d< Block >::GenericMultiComponent2d ( const typename GenericMultiComponent2d< Block >::size_type  height, const typename GenericMultiComponent2d< Block >::size_type  width, const Block *  val  )

inline

Definition at line 3483 of file GenericMultiComponent2d.hpp.

Member Function Documentation

template<typename Block>

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

inline

Returns the sums of the elements of the GenericMultiComponent2d.

Precondition

size() != 0

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

Parameters

fun	The one-parameter C function

Returns

the resulting GenericMultiComponent2d

Definition at line 4910 of file GenericMultiComponent2d.hpp.

template<typename Block>

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

inline

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

Parameters

fun	The one-const-parameter C function

Returns

the resulting GenericMultiComponent2d

Definition at line 4918 of file GenericMultiComponent2d.hpp.

template<typename Block >

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

inline

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

Returns

begin iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > S(10,9);
//copy the sum of the elements of A1 and A2 in S
std::transform(A1.begin(),A1.end(),
               A2.begin(),S.begin(),
               std::plus<slip::Vector2d<double> >());

Definition at line 3541 of file GenericMultiComponent2d.hpp.

template<typename Block >

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

inline

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

Returns

const begin iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > S(10,9);
//copy the sum of A1 and A2 in S
std::transform(A1.begin(),A1.end(),
               A2.begin(),S.begin(),
               std::plus<slip::Vector2d<double> >());

Definition at line 3555 of file GenericMultiComponent2d.hpp.

template<typename Block>

component_iterator slip::GenericMultiComponent2d< Block >::begin

(

const std::size_t

component

)

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

Parameters

component

The component number.

Returns

begin component_iterator value

template<typename Block>

const_component_iterator slip::GenericMultiComponent2d< Block >::begin

(

const std::size_t

component

)

const

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

Parameters

component

The component number.

Returns

const begin component_iterator value

template<typename Block >

GenericMultiComponent2d< Block >::iterator2d slip::GenericMultiComponent2d< Block >::bottom_right ( )

inline

Returns a read/write iterator2d that points to the past the end element of the GenericMultiComponent2d. It points to past the end element of the bottom right element of the GenericMultiComponent2d.

Returns

begin iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(8,8);
//copy the elements of A1 in A2
std::copy(A1.upper_left(),A1.bottom_right(),A2.upper_left());

Definition at line 3901 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_iterator2d slip::GenericMultiComponent2d< Block >::bottom_right ( ) const

inline

Returns a read-only iterator2d that points to the past the end element of the GenericMultiComponent2d. It points to past the end element of the bottom right element of the GenericMultiComponent2d.

Returns

begin const iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(8,8);
//copy the elements of A1 in A2
std::copy(A1.upper_left(),A1.bottom_right(),A2.upper_left());

Definition at line 3908 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::iterator2d slip::GenericMultiComponent2d< Block >::bottom_right ( const Box2d< int > &  box )

inline

Returns a read/write iterator2d that points to the past the end element of the GenericMultiComponent2d. It points to past the end element of the bottom right element of the Box2d associated to the GenericMultiComponent2d.

Parameters

box	a Box2d defining the range of indices to iterate within the GenericMultiComponent2d.

Returns

end iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Precondition

The box indices must be inside the range of the GenericMultiComponent2d ones.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(3,2);
 slip::Box2d<int> box(1,1,3,2);
//copy the elements of A1 inside the box which upper_left element 
//is located in (1,1) and the bottom right element is in (3,2)
std::copy(A1.upper_left(box),A1.bottom_right(box),A2.upper_left());

Definition at line 3932 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_iterator2d slip::GenericMultiComponent2d< Block >::bottom_right ( const Box2d< int > &  box ) const

inline

Returns a read only iterator2d that points to the past the end element of the GenericMultiComponent2d. It points to past the end element of the bottom right element of the Box2d associated to the GenericMultiComponent2d.

Parameters

box	a Box2d defining the range of indices to iterate within the GenericMultiComponent2d.

Returns

end const iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Precondition

The box indices must be inside the range of the GenericMultiComponent2d ones.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(3,2);
 slip::Box2d<int> box(1,1,3,2);
//copy the elements of A1 inside the box which upper_left element 
//is located in (1,1) and the bottom right element is in (3,2)
std::copy(A1.upper_left(box),A1.bottom_right(box),A2.upper_left());

Definition at line 3939 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::iterator2d_range slip::GenericMultiComponent2d< Block >::bottom_right ( const Range< int > &  row_range, const Range< int > &  col_range  )

inline

Returns a read/write iterator2d_range that points to the past the end bottom right element of the ranges row_range and col_range associated to the GenericMultiComponent2d.

Parameters

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

Precondition

row_range and col_range must be valid.

The ranges indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(4,4);
 slip::Range<int> row_range(0,A1.dim2()-1,2);
 slip::Range<int> col_range(0,A1.dim1()-1,2);
//copy the elements of A1 within the ranges row_range and col_range
//in A2
std::copy(A1.upper_left(row_range,col_range),
A1.bottom_right(row_range,col_range),A2.upper_left());

Definition at line 3968 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_iterator2d_range slip::GenericMultiComponent2d< Block >::bottom_right ( const Range< int > &  row_range, const Range< int > &  col_range  ) const

inline

Returns a read-only iterator2d_range that points to the past the end bottom right element of the ranges row_range and col_range associated to the GenericMultiComponent2d.

Parameters

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

Precondition

row_range and col_range must be valid.

The ranges indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

const_iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(4,4);
 slip::Range<int> row_range(0,A1.dim2()-1,2);
 slip::Range<int> col_range(0,A1.dim1()-1,2);
//copy the elements of A1 within the ranges row_range and col_range
//in A2
std::copy(A1.upper_left(row_range,col_range),
A1.bottom_right(row_range,col_range),A2.upper_left());

Definition at line 3977 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::iterator2d_range slip::GenericMultiComponent2d< Block >::bottom_right ( const Range< int > &  range )

inline

Returns a read/write iterator2d_range that points to the past the end bottom right element of the Range range associated to the GenericMultiComponent2d. The same range is applied for rows and cols.

Parameters

range

The range of the rows and the cols.

Precondition

range must be valid.

The range indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(4,4);
 slip::Range<int> range(0,A1.dim2()-1,2);
//copy the elements of A1 within the range range
//in A2
std::copy(A1.upper_left(range),A1.bottom_right(range),A2.upper_left());

Definition at line 4004 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_iterator2d_range slip::GenericMultiComponent2d< Block >::bottom_right ( const Range< int > &  range ) const

inline

Returns a read-only const_iterator2d_range that points to the past the end bottom right element of the Range range associated to the GenericMultiComponent2d. The same range is applied for rows and cols.

Parameters

range

The range of the rows and the cols.

Precondition

range must be valid.

The range indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

const_iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(4,4);
 slip::Range<int> range(0,A1.dim2()-1,2);
//copy the elements of A1 within the range range
//in A2
std::copy(A1.upper_left(range),A1.bottom_right(range),A2.upper_left());

Definition at line 4012 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::component_iterator2d slip::GenericMultiComponent2d< Block >::bottom_right ( const std::size_t  component )

inline

Returns a read/write component_iterator2d that points to the past the end element of the GenericMultiComponent2d. It points to past the end element of the bottom right element of the GenericMultiComponent2d.

Parameters

component

The component number.

Returns

begin iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(8,8);
//copy the first component of the elements of A1 in A2
std::copy(A1.upper_left(0),A1.bottom_right(0),A2.upper_left(0));

Definition at line 4534 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_component_iterator2d slip::GenericMultiComponent2d< Block >::bottom_right ( const std::size_t  component ) const

inline

Returns a read only const_component_iterator2d that points to the past the end element of the GenericMultiComponent2d. It points to past the end element of the bottom right element of the GenericMultiComponent2d.

Parameters

component

The component number.

Returns

begin iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4552 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::component_iterator2d slip::GenericMultiComponent2d< Block >::bottom_right ( const std::size_t  component, const Box2d< int > &  box  )

inline

Returns a read/write component iterator2d that points to the past the end element of the GenericMultiComponent2d. It points to past the end element of the bottom right element of the Box2d associated to the GenericMultiComponent2d.

Parameters

component	The component number.
box	a Box2d defining the range of indices to iterate within the GenericMultiComponent2d.

Returns

end iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Precondition

The box indices must be inside the range of the GenericMultiComponent2d ones.

Definition at line 4606 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_component_iterator2d slip::GenericMultiComponent2d< Block >::bottom_right ( const std::size_t  component, const Box2d< int > &  box  ) const

inline

Returns a read only component iterator2d that points to the past the end element of the GenericMultiComponent2d. It points to past the end element of the bottom right element of the Box2d associated to the GenericMultiComponent2d.

Parameters

component	The component number.
box	a Box2d defining the range of indices to iterate within the GenericMultiComponent2d.

Returns

end const iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Precondition

The box indices must be inside the range of the GenericMultiComponent2d ones.

Definition at line 4625 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::component_iterator2d_range slip::GenericMultiComponent2d< Block >::bottom_right ( const std::size_t  component, const Range< int > &  row_range, const Range< int > &  col_range  )

inline

Returns a read/write component iterator2d_range that points to the past the end bottom right element of the ranges row_range and col_range associated to the GenericMultiComponent2d.

Parameters

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

Precondition

row_range and col_range must be valid.

The ranges indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4645 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_component_iterator2d_range slip::GenericMultiComponent2d< Block >::bottom_right ( const std::size_t  component, const Range< int > &  row_range, const Range< int > &  col_range  ) const

inline

Returns a read-only component iterator2d_range that points to the past the end bottom right element of the ranges row_range and col_range associated to the GenericMultiComponent2d.

Parameters

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

Precondition

row_range and col_range must be valid.

The ranges indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

const_iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4666 of file GenericMultiComponent2d.hpp.

template<typename Block>

col_iterator slip::GenericMultiComponent2d< Block >::col_begin

(

const size_type

col

)

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

Parameters

col	The index of the column to iterate.

Returns

begin col_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the GenericMultiComponent2d

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(10,9);
//copy the elements of the column 0 of A1 in the column 1 of A2
std::copy(A1.col_begin(0),A1.col_end(0),A2.col_begin(1));

template<typename Block>

const_col_iterator slip::GenericMultiComponent2d< Block >::col_begin

(

const size_type

col

)

const

Returns a read-only iterator that points to the first element of the column column in the GenericMultiComponent2d. Iteration is done modulo the number of columns.

Parameters

col	The index of the column to iterate.

Returns

begin const_col_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(10,9);
//copy the elements of the column 0 of A1 in the column 1 of A2
std::copy(A1.col_begin(0),A1.col_end(0),A2.col_begin(1));

template<typename Block>

col_range_iterator slip::GenericMultiComponent2d< Block >::col_begin	(	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 GenericMultiComponent2d. Iteration is done in ordinary element order according to the Range.

Parameters

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 GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(4,8);
 slip::Range<int> range(0,A1.dim1()-1,2);
//copy 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_col_range_iterator slip::GenericMultiComponent2d< Block >::col_begin	(	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 GenericMultiComponent2d. Iteration is done in ordinary element order according to the Range.

Parameters

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 GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(4,8);
 slip::Range<int> range(0,A1.dim1()-1,2);
//copy 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>

component_col_iterator slip::GenericMultiComponent2d< Block >::col_begin	(	const std::size_t	component,
		const std::size_t	col
	)

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

Parameters

component	The component number.
col	The col within the component.

Returns

begin component_col_iterator value.

template<typename Block>

const_component_col_iterator slip::GenericMultiComponent2d< Block >::col_begin	(	const std::size_t	component,
		const std::size_t	col
	)		const

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

Parameters

component	The component number.
col	The col within the component.

Returns

const begin component_col_iterator value

template<typename Block >

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

inline

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

Parameters

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

Returns

begin component_col_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(4,8);
 slip::Range<int> range(0,A1.dim1()-1,2);
//copy the first component of 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,0,range),A1.col_end(0,0,range),A2.col_begin(0,1));

Definition at line 4417 of file GenericMultiComponent2d.hpp.

template<typename Block >

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

inline

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

Parameters

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

Returns

begin const_component_col_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(4,8);
 slip::Range<int> range(0,A1.dim1()-1,2);
//copy the first component of 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,0,range),A1.col_end(0,0,range),A2.col_begin(0,1));

Definition at line 4435 of file GenericMultiComponent2d.hpp.

template<typename Block>

col_iterator slip::GenericMultiComponent2d< Block >::col_end

(

const size_type

col

)

Returns a read/write iterator that points one past the end element of the column column in the GenericMultiComponent2d. Iteration is done modulo the number of columns.

Parameters

col	The index of the column to iterate.

Returns

begin col_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(10,9);
//copy the elements of the column 0 of A1 in the column 1 of A2
std::copy(A1.col_begin(0),A1.col_end(0),A2.col_begin(1));

template<typename Block>

const_col_iterator slip::GenericMultiComponent2d< Block >::col_end

(

const size_type

col

)

const

Returns a read-only iterator that points one past the end element of the column column in the GenericMultiComponent2d. Iteration is done modulo the number of columns.

Parameters

col	The index of the column

Returns

begin const_col_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(10,9);
//copy the elements of the column 0 of A1 in the column 1 of A2
std::copy(A1.col_begin(0),A1.col_end(0),A2.col_begin(1));

template<typename Block>

col_range_iterator slip::GenericMultiComponent2d< Block >::col_end	(	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 GenericMultiComponent2d. Iteration is done in ordinary element order according to the Range.

Parameters

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 GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(4,8);
 slip::Range<int> range(0,A1.dim1()-1,2);
//copy 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_col_range_iterator slip::GenericMultiComponent2d< Block >::col_end	(	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 GenericMultiComponent2d. Iteration is done in ordinary element order according to the Range.

Parameters

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 GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(4,8);
 slip::Range<int> range(0,A1.dim1()-1,2);
//copy 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>

component_col_iterator slip::GenericMultiComponent2d< Block >::col_end	(	const std::size_t	component,
		const std::size_t	col
	)

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

Parameters

component	The component number.
col	The col within the component.

Returns

end component_col_iterator value

template<typename Block>

const_component_col_iterator slip::GenericMultiComponent2d< Block >::col_end	(	const std::size_t	component,
		const std::size_t	col
	)		const

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

Parameters

component	The component number.
col	The col within the component.

Returns

const end component_col_iterator value

template<typename Block >

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

inline

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

Parameters

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

Returns

begin component_col_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(4,8);
 slip::Range<int> range(0,A1.dim1()-1,2);
//copy the first component of 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,0,range),A1.col_end(0,0,range),A2.col_begin(0,1));

Definition at line 4426 of file GenericMultiComponent2d.hpp.

template<typename Block >

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

inline

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

Parameters

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

Returns

begin const_component_col_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(4,8);
 slip::Range<int> range(0,A1.dim1()-1,2);
//copy the first component of 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,0,range),A1.col_end(0,0,range),A2.col_begin(0,1));

Definition at line 4444 of file GenericMultiComponent2d.hpp.

template<typename Block>

reverse_col_iterator slip::GenericMultiComponent2d< Block >::col_rbegin

(

const size_type

col

)

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

Parameters

col	The index of the column to iterate.

Returns

begin col_reverse_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the GenericMultiComponent2d.

template<typename Block>

const_reverse_col_iterator slip::GenericMultiComponent2d< Block >::col_rbegin

(

const size_type

col

)

const

Returns a read-only reverse iterator that points to the last element of the column column in the GenericMultiComponent2d. Iteration is done modulo the number of columns and in the reverse element order.

Parameters

col	The index of the column to iterate.

Returns

begin const_reverse_col_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the GenericMultiComponent2d.

template<typename Block>

reverse_col_range_iterator slip::GenericMultiComponent2d< Block >::col_rbegin	(	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 col in the GenericMultiComponent2d. Iteration is done in the reverse element order according to the Range.

Parameters

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 GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

template<typename Block>

const_reverse_col_range_iterator slip::GenericMultiComponent2d< Block >::col_rbegin	(	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 col in the GenericMultiComponent2d. Iteration is done in the reverse element order according to the Range.

Parameters

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 GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

template<typename Block>

reverse_component_col_iterator slip::GenericMultiComponent2d< Block >::col_rbegin	(	const std::size_t	component,
		const std::size_t	col
	)

Returns a read/write iterator that points to the last element of the col col in the GenericMultiComponent2d. Iteration is done in reverse element order.

Parameters

component	The component number.
col	The col within the component.

Returns

begin reverse_component_col_iterator value.

template<typename Block>

const_reverse_component_col_iterator slip::GenericMultiComponent2d< Block >::col_rbegin	(	const std::size_t	component,
		const std::size_t	col
	)		const

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

Parameters

component	The component number.
col	The col within the component.

Returns

const reverse_component_col_iterator value

template<typename Block >

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

inline

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

Parameters

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

Returns

begin reverse_component_col_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Definition at line 4489 of file GenericMultiComponent2d.hpp.

template<typename Block >

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

inline

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

Parameters

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

Returns

begin const_reverse_component_col_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Definition at line 4508 of file GenericMultiComponent2d.hpp.

template<typename Block>

reverse_col_iterator slip::GenericMultiComponent2d< Block >::col_rend

(

const size_type

col

)

Returns a read/write reverse iterator that points one past the first element of the column column in the GenericMultiComponent2d. Iteration is done modulo the number of columns and in the reverse element order.

Parameters

col	The index of the column to iterate.

Returns

end reverse_col_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the GenericMultiComponent2d.

template<typename Block>

const_reverse_col_iterator slip::GenericMultiComponent2d< Block >::col_rend

(

const size_type

col

)

const

Returns a read-only reverse iterator that points one past the first element of the column column in the GenericMultiComponent2d. Iteration is done modulo the number of columns and in the reverse element order.

Parameters

col	The index of the column to iterate.

Returns

end const_reverse_col_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the GenericMultiComponent2d.

template<typename Block>

reverse_col_range_iterator slip::GenericMultiComponent2d< Block >::col_rend	(	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 col in the GenericMultiComponent2d. Iteration is done in the reverse element order according to the Range.

Parameters

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 GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

template<typename Block>

const_reverse_col_range_iterator slip::GenericMultiComponent2d< Block >::col_rend	(	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 GenericMultiComponent2d. Iteration is done in the reverse element order according to the Range.

Parameters

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 GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

template<typename Block>

reverse_component_col_iterator slip::GenericMultiComponent2d< Block >::col_rend	(	const std::size_t	component,
		const std::size_t	col
	)

Returns a read/write iterator that points one before the first element of the col col in the GenericMultiComponent2d. Iteration is done in the reverse element order.

Parameters

component	The component number.
col	The col within the component.

Returns

end component_col_iterator value

template<typename Block>

const_reverse_component_col_iterator slip::GenericMultiComponent2d< Block >::col_rend	(	const std::size_t	component,
		const std::size_t	col
	)		const

Returns a read-only (constant) iterator that points one before the first element of the col col in the GenericMultiComponent2d. Iteration is done in ordinary element order.

Parameters

component	The component number.
col	The col within the component.

Returns

const end component_col_iterator value

template<typename Block >

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

inline

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

Parameters

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

Returns

reverse_component_col_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Definition at line 4498 of file GenericMultiComponent2d.hpp.

template<typename Block >

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

inline

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

Parameters

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

Returns

const_reverse_component_col_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Definition at line 4517 of file GenericMultiComponent2d.hpp.

template<typename Block >

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

inline

Returns the number of columns (second dimension size) in the GenericMultiComponent2d.

Definition at line 4856 of file GenericMultiComponent2d.hpp.

template<typename Block >

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

inline

Returns the number of columns (second dimension size) in the GenericMultiComponent2d.

Definition at line 4852 of file GenericMultiComponent2d.hpp.

template<typename Block >

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

inline

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

Definition at line 4832 of file GenericMultiComponent2d.hpp.

template<typename Block >

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

inline

Returns the number of columns (second dimension size) in the GenericMultiComponent2d.

Definition at line 4844 of file GenericMultiComponent2d.hpp.

template<typename Block >

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

inline

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

Definition at line 4869 of file GenericMultiComponent2d.hpp.

template<typename Block >

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

inline

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

Returns

end iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > S(10,9);
//copy the sum of the elements of A1 and A2 in S
std::transform(A1.begin(),A1.end(),
               A2.begin(),S.begin(),
               std::plus<slip::Vector2d<double> >());

Definition at line 3548 of file GenericMultiComponent2d.hpp.

template<typename Block >

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

inline

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

Returns

const end iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > S(10,9);
//copy the sum of the elements of A1 and A2 in S
std::transform(A1.begin(),A1.end(),
               A2.begin(),S.begin(),
               std::plus<slip::Vector2d<double> >());

Definition at line 3563 of file GenericMultiComponent2d.hpp.

template<typename Block>

component_iterator slip::GenericMultiComponent2d< Block >::end

(

const std::size_t

component

)

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

Parameters

component

The component number.

Returns

end component_iterator value

template<typename Block>

const_component_iterator slip::GenericMultiComponent2d< Block >::end

(

const std::size_t

component

)

const

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

Parameters

component

The component number.

Returns

const end component_iterator value

template<typename Block>

void slip::GenericMultiComponent2d< 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 3050 of file GenericMultiComponent2d.hpp.

template<typename Block>

void slip::GenericMultiComponent2d< 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 3061 of file GenericMultiComponent2d.hpp.

template<typename Block>

void slip::GenericMultiComponent2d< 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 3072 of file GenericMultiComponent2d.hpp.

template<typename Block>

template<typename InputIterator >

void slip::GenericMultiComponent2d< 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 3086 of file GenericMultiComponent2d.hpp.

template<typename Block>

template<typename InputIterator >

void slip::GenericMultiComponent2d< 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 3101 of file GenericMultiComponent2d.hpp.

template<typename Block>

template<typename InputIterator >

void slip::GenericMultiComponent2d< 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 3133 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::size_type slip::GenericMultiComponent2d< Block >::height ( ) const

inline

Returns the height (first dimension size) in the GenericMultiComponent2d.

Definition at line 4836 of file GenericMultiComponent2d.hpp.

template<typename Block >

Block slip::GenericMultiComponent2d< Block >::max ( ) const

inline

Returns the max elements of the GenericMultiComponent2d according to the operator <.

Precondition

size() != 0

Definition at line 4896 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::size_type slip::GenericMultiComponent2d< Block >::max_size ( ) const

inline

Returns the maximal size (number of elements) in the GenericMultiComponent2d.

Definition at line 4864 of file GenericMultiComponent2d.hpp.

template<typename Block >

Block slip::GenericMultiComponent2d< Block >::min ( ) const

inline

Returns the min elements of the GenericMultiComponent2d according to the operator <.

Precondition

size() != 0

Definition at line 4882 of file GenericMultiComponent2d.hpp.

template<typename Block>

reference slip::GenericMultiComponent2d< Block >::operator()	(	const size_type	i,
		const size_type	j
	)

Subscript access to the data contained in the GenericMultiComponent2d.

Parameters

i	The index of the row for which the data should be accessed.
j	The index of the columns for which the data should be accessed.

Returns

Read/write reference to data.

Precondition

i < rows()

j < columns()

This operator allows for easy, 2d 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::GenericMultiComponent2d< Block >::operator()	(	const size_type	i,
		const size_type	j
	)		const

Subscript access to the data contained in the GenericMultiComponent2d.

Parameters

i	The index of the row for which the data should be accessed.
j	The index of the columns for which the data should be accessed.

Returns

Read_only (constant) reference to data.

Precondition

i < rows()

j < columns()

This operator allows for easy, 2d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

template<typename Block>

reference slip::GenericMultiComponent2d< Block >::operator()

(

const Point2d< size_type > &

point2d

)

Subscript access to the data contained in the GenericMultiComponent2d.

Parameters

point2d

A Point2d which indicate the subscripts of the data to access.

Returns

Read/write reference to data.

Precondition

point2d must be defined in the range of the GenericMultiComponent2d.

This operator allows for easy, 2d 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::GenericMultiComponent2d< Block >::operator()

(

const Point2d< size_type > &

point2d

)

const

Subscript access to the data contained in the GenericMultiComponent2d.

Parameters

point2d

A Point2d which indicate the subscripts of the data to access.

Returns

Read_only (constant) reference to data.

Precondition

point2d must be defined in the range of the GenericMultiComponent2d.

This operator allows for easy, 2d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

template<typename Block >

GenericMultiComponent2d< Block > slip::GenericMultiComponent2d< Block >::operator() ( const Range< int > &  row_range, const Range< int > &  col_range  )

inline

Subscript access to the data contained in the GenericMultiComponent2d.

Parameters

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

Returns

a copy of the range.

Precondition

row_range and col_range must be valid.

The ranges indices must be inside the ranges of the GenericMultiComponent2d ones.

This operator allows for easy, 2d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

Definition at line 4814 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block > & slip::GenericMultiComponent2d< Block >::operator= ( const self &  rhs )

inline

Assign a GenericMultiComponent2d.

Assign elements of GenericMultiComponent2d in rhs

Parameters

rhs	GenericMultiComponent2d to get the values from.

Returns

Definition at line 3504 of file GenericMultiComponent2d.hpp.

template<typename Block>

GenericMultiComponent2d< Block > & slip::GenericMultiComponent2d< Block >::operator= ( const Block &  val )

inline

Affects all the element of the GenericMultiComponent2d by val.

Parameters

val	affectation value

Returns

reference to corresponding GenericMultiComponent2d

Definition at line 3515 of file GenericMultiComponent2d.hpp.

template<typename Block>

GenericMultiComponent2d< Block > & slip::GenericMultiComponent2d< Block >::operator= ( const typename Block::value_type &  val )

inline

Affects all the element of the GenericMultiComponent2d by val.

Parameters

val	affectation value

Returns

reference to corresponding GenericMultiComponent2d

Definition at line 3523 of file GenericMultiComponent2d.hpp.

template<typename Block>

pointer slip::GenericMultiComponent2d< Block >::operator[]

(

const size_type

i

)

Subscript access to the row datas contained in the GenericMultiComponent2d.

Parameters

i	The index of the row for which data should be accessed.

Returns

Read/write pointer to the row data.

Precondition

i < rows()

This operator allows for easy, 2d 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 slip::GenericMultiComponent2d< Block >::operator[]

(

const size_type

i

)

const

Subscript access to the row datas contained in the GenericMultiComponent2d.

Parameters

i	The index of the row for which data should be accessed.

Returns

Read-only (constant) pointer to the row data.

Precondition

i < rows()

This operator allows for easy, 2d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

template<typename Block >

GenericMultiComponent2d< Block >::reverse_iterator slip::GenericMultiComponent2d< Block >::rbegin ( )

inline

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

Returns

reverse begin iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > S(10,9);
//copy the sum of the elements of A1 and A2 
//in S (iterated in the reverse order element)
std::transform(A1.begin(),A1.end(),
               A2.begin(),S.rbegin(),
               std::plus<slip::Vector2d<double> >());

Definition at line 3572 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_reverse_iterator slip::GenericMultiComponent2d< Block >::rbegin ( ) const

inline

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

Returns

const reverse begin iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > S(10,9);
//copy the sum of the elements of A1 (iterated in the reverse order element)
//and A2 in S 
std::transform(A1.rbegin(),A1.rend(),
               A2.begin(),S.begin(),
               std::plus<slip::Vector2d<double> >());

Definition at line 3586 of file GenericMultiComponent2d.hpp.

template<typename Block>

reverse_component_iterator slip::GenericMultiComponent2d< Block >::rbegin

(

const std::size_t

component

)

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

Parameters

component

The component number.

Returns

begin reverse_component_iterator value

template<typename Block>

const_reverse_component_iterator slip::GenericMultiComponent2d< Block >::rbegin

(

const std::size_t

component

)

const

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

Parameters

component

The component number.

Returns

const begin reverse_component_iterator value

template<typename Block >

GenericMultiComponent2d< Block >::reverse_iterator2d slip::GenericMultiComponent2d< Block >::rbottom_right ( )

inline

Returns a read/write reverse iterator2d. It points to past the upper left element of the GenericMultiComponent2d. Iteration is done in the reverse order.

Returns

reverse iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4022 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_reverse_iterator2d slip::GenericMultiComponent2d< Block >::rbottom_right ( ) const

inline

Returns a read only reverse iterator2d. It points to past the upper left element of the GenericMultiComponent2d. Iteration is done in the reverse order.

Returns

const reverse iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4030 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::reverse_iterator2d slip::GenericMultiComponent2d< Block >::rbottom_right ( const Box2d< int > &  box )

inline

Returns a read/write reverse iterator2d. It points to one before the upper left element of the Box2d box associated to the GenericMultiComponent2d.

Parameters

box	A Box2d defining the range of indices to iterate within the GenericMultiComponent2d.

Precondition

The box indices must be inside the range of the GenericMultiComponent2d ones.

Returns

reverse iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4056 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_reverse_iterator2d slip::GenericMultiComponent2d< Block >::rbottom_right ( const Box2d< int > &  box ) const

inline

Returns a read-only reverse iterator2d. It points to one before the element of the bottom right element of the Box2d box associated to the GenericMultiComponent2d.

Parameters

box	A Box2d defining the range of indices to iterate within the GenericMultiComponent2d.

Precondition

The box indices must be inside the range of the GenericMultiComponent2d ones.

Returns

const reverse iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4064 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::reverse_iterator2d_range slip::GenericMultiComponent2d< Block >::rbottom_right ( const Range< int > &  row_range, const Range< int > &  col_range  )

inline

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

Parameters

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

Precondition

row_range and col_range must be valid.

The ranges indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

reverse_iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4109 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_reverse_iterator2d_range slip::GenericMultiComponent2d< Block >::rbottom_right ( const Range< int > &  row_range, const Range< int > &  col_range  ) const

inline

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

Parameters

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

Precondition

row_range and col_range must be valid.

The ranges indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

const_reverse_iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4118 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::reverse_iterator2d_range slip::GenericMultiComponent2d< Block >::rbottom_right ( const Range< int > &  range )

inline

Returns a read/write reverse_iterator2d_range that points to one before the upper left element of the Range range associated to the GenericMultiComponent2d. The same range is applied for rows and cols. Iteration is done in the reverse order.

Parameters

range

The range of the rows and the cols.

Precondition

range must be valid.

The range indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

reverse_iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4145 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_reverse_iterator2d_range slip::GenericMultiComponent2d< Block >::rbottom_right ( const Range< int > &  range ) const

inline

Returns a read_only reverse_iterator2d_range that points to one before the upper left element of the Range range associated to the GenericMultiComponent2d. The same range is applied for rows and cols. Iteration is done in the reverse order.

Parameters

range

The range of the rows and the cols.

Precondition

range must be valid.

The range indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

const_reverse_iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4153 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::reverse_component_iterator2d slip::GenericMultiComponent2d< Block >::rbottom_right ( const std::size_t  component )

inline

Returns a read/write reverse component iterator2d. It points to past the upper left element of the GenericMultiComponent2d. Iteration is done in the reverse order.

Parameters

component

The component number.

Returns

reverse component iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4571 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_reverse_component_iterator2d slip::GenericMultiComponent2d< Block >::rbottom_right ( const std::size_t  component ) const

inline

Returns a read only reverse component iterator2d. It points to past the upper left element of the GenericMultiComponent2d. Iteration is done in the reverse order.

Parameters

component

The component number.

Returns

const reverse component iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4588 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::reverse_component_iterator2d slip::GenericMultiComponent2d< Block >::rbottom_right ( const std::size_t  component, const Box2d< int > &  box  )

inline

Returns a read/write reverse component iterator2d. It points to one before the upper left element of the Box2d box associated to the GenericMultiComponent2d.

Parameters

component	The component number.
box	A Box2d defining the range of indices to iterate within the GenericMultiComponent2d.

Precondition

The box indices must be inside the range of the GenericMultiComponent2d ones.

Returns

reverse iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4677 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_reverse_component_iterator2d slip::GenericMultiComponent2d< Block >::rbottom_right ( const std::size_t  component, const Box2d< int > &  box  ) const

inline

Returns a read-only reverse component iterator2d. It points to one before the element of the bottom right element of the Box2d box associated to the GenericMultiComponent2d.

Parameters

component	The component number.
box	A Box2d defining the range of indices to iterate within the GenericMultiComponent2d.

Precondition

The box indices must be inside the range of the GenericMultiComponent2d ones.

Returns

const reverse iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4696 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::reverse_component_iterator2d_range slip::GenericMultiComponent2d< Block >::rbottom_right ( const std::size_t  component, const Range< int > &  row_range, const Range< int > &  col_range  )

inline

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

Parameters

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

Precondition

row_range and col_range must be valid.

The ranges indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

reverse_iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4715 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_reverse_component_iterator2d_range slip::GenericMultiComponent2d< Block >::rbottom_right ( const std::size_t  component, const Range< int > &  row_range, const Range< int > &  col_range  ) const

inline

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

Parameters

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

Precondition

row_range and col_range must be valid.

The ranges indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

const_reverse_iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4736 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::reverse_iterator slip::GenericMultiComponent2d< Block >::rend ( )

inline

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

Returns

reverse end iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > S(10,9);
//copy the sum of the elements of A1 and A2 
//in S (iterated in the reverse order element)
std::transform(A1.begin(),A1.end(),
               A2.begin(),S.rbegin(),
               std::plus<slip::Vector2d<double> >());

Definition at line 3579 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_reverse_iterator slip::GenericMultiComponent2d< Block >::rend ( ) const

inline

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

Returns

const reverse end iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > S(10,9);
//copy the sum of the elements of A1 (iterated in the reverse order element)
//and A2 in S 
std::transform(A1.rbegin(),A1.rend(),
               A2.begin(),S.begin(),
               std::plus<slip::Vector2d<double> >());

Definition at line 3593 of file GenericMultiComponent2d.hpp.

template<typename Block>

reverse_component_iterator slip::GenericMultiComponent2d< Block >::rend

(

const std::size_t

component

)

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

Parameters

component

The component number.

Returns

end reverse_component_iterator value

template<typename Block>

const_reverse_component_iterator slip::GenericMultiComponent2d< Block >::rend

(

const std::size_t

component

)

const

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

Parameters

component

The component number.

Returns

const end reverse_component_iterator value

template<typename Block>

void slip::GenericMultiComponent2d< Block >::resize ( const size_type  height, const size_type  width, const Block &  val = Block()  )

inline

Resizes a GenericMultiComponent2d.

Parameters

height	new first dimension
width	new second dimension
val	new value for all the elements

Definition at line 3531 of file GenericMultiComponent2d.hpp.

template<typename Block>

row_iterator slip::GenericMultiComponent2d< Block >::row_begin

(

const size_type

row

)

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

Parameters

row	The index of the row to iterate.

Returns

begin row_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(10,9);
//copy the elements of the row 0 of A1 in the row 1 of A2
std::copy(A1.row_begin(0),A1.row_end(0),A2.row_begin(1));

template<typename Block>

const_row_iterator slip::GenericMultiComponent2d< Block >::row_begin

(

const size_type

row

)

const

Returns a read-only iterator that points to the first element of the row row in the GenericMultiComponent2d. Iteration is done in ordinary element order.

Parameters

row	The index of the row to iterate.

Returns

begin const_row_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(10,9);
//copy the elements of the row 0 of A1 in the row 1 of A2
std::copy(A1.row_begin(0),A1.row_end(0),A2.row_begin(1));

template<typename Block>

row_range_iterator slip::GenericMultiComponent2d< Block >::row_begin	(	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 GenericMultiComponent2d. Iteration is done in ordinary element order according to the Range.

Parameters

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 GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(8,4);
 slip::Range<int> range(0,A1.dim2()-1,2);
//copy 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_row_range_iterator slip::GenericMultiComponent2d< Block >::row_begin	(	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 GenericMultiComponent2d. Iteration is done in ordinary element order according to the Range.

Parameters

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 GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(8,4);
 slip::Range<int> range(0,A1.dim2()-1,2);
//copy 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>

component_row_iterator slip::GenericMultiComponent2d< Block >::row_begin	(	const std::size_t	component,
		const std::size_t	row
	)

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

Parameters

component	The component number.
row	The row within the component.

Returns

begin component_row_iterator value.

template<typename Block>

const_component_row_iterator slip::GenericMultiComponent2d< Block >::row_begin	(	const std::size_t	component,
		const std::size_t	row
	)		const

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

Parameters

component	The component number.
row	The row within the component.

Returns

const begin component_row_iterator value

template<typename Block >

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

inline

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

Parameters

component	The component number.
row	The index of the row to iterate.
range	Range of the row to iterate.

Returns

begin component_row_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(8,4);
 slip::Range<int> range(0,A1.dim2()-1,2);
//copy the first component of 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,0,range),A1.row_end(0,0,range),A2.row_begin(0,1));

Definition at line 4381 of file GenericMultiComponent2d.hpp.

template<typename Block >

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

inline

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

Parameters

component	The component number.
row	The index of the row to iterate.
range	Range of the row to iterate.

Returns

begin const_component_row_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(8,4);
 slip::Range<int> range(0,A1.dim2()-1,2);
//copy the first component of 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,0,range),A1.row_end(0,0,range),A2.row_begin(0,1));

Definition at line 4399 of file GenericMultiComponent2d.hpp.

template<typename Block>

row_iterator slip::GenericMultiComponent2d< Block >::row_end

(

const size_type

row

)

Returns a read/write iterator that points one past the end element of the row row in the GenericMultiComponent2d. Iteration is done in ordinary element order.

Parameters

row	The index of the row to iterate.

Returns

begin row_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(10,9);
//copy the elements of the row 0 of A1 in the row 1 of A2
std::copy(A1.row_begin(0),A1.row_end(0),A2.row_begin(1));

template<typename Block>

const_row_iterator slip::GenericMultiComponent2d< Block >::row_end

(

const size_type

row

)

const

Returns a read-only iterator that points one past the end element of the row row in the GenericMultiComponent2d. Iteration is done in ordinary element order.

Parameters

row	The index of the row to iterate.

Returns

begin const_row_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(10,9);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(10,9);
//copy the elements of the row 0 of A1 in the row 1 of A2
std::copy(A1.row_begin(0),A1.row_end(0),A2.row_begin(1));

template<typename Block>

row_range_iterator slip::GenericMultiComponent2d< Block >::row_end	(	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 GenericMultiComponent2d. Iteration is done in ordinary element order according to the Range.

Parameters

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 GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(8,4);
 slip::Range<int> range(0,A1.dim2()-1,2);
//copy 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_row_range_iterator slip::GenericMultiComponent2d< Block >::row_end	(	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 GenericMultiComponent2d. Iteration is done in ordinary element order according to the Range.

Parameters

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 GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(8,4);
 slip::Range<int> range(0,A1.dim2()-1,2);
//copy 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>

component_row_iterator slip::GenericMultiComponent2d< Block >::row_end	(	const std::size_t	component,
		const std::size_t	row
	)

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

Parameters

component	The component number.
row	The row within the component.

Returns

end component_row_iterator value

template<typename Block>

const_component_row_iterator slip::GenericMultiComponent2d< Block >::row_end	(	const std::size_t	component,
		const std::size_t	row
	)		const

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

Parameters

component	The component number.
row	The row within the component.

Returns

const end component_row_iterator value

template<typename Block >

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

inline

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

Parameters

component	The component number.
row	The index of the row to iterate.
range	Range of the row to iterate.

Returns

end component_row_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(8,4);
 slip::Range<int> range(0,A1.dim2()-1,2);
//copy the first component of 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,0,range),A1.row_end(0,0,range),A2.row_begin(0,1));

Definition at line 4390 of file GenericMultiComponent2d.hpp.

template<typename Block >

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

inline

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

Parameters

component	The component number.
row	Row to iterate.
range	Range of the row to iterate

Returns

begin const_component_row_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(8,4);
 slip::Range<int> range(0,A1.dim2()-1,2);
//copy the first component of 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,0,range),A1.row_end(0,0,range),A2.row_begin(0,1));

Definition at line 4408 of file GenericMultiComponent2d.hpp.

template<typename Block>

reverse_row_iterator slip::GenericMultiComponent2d< Block >::row_rbegin

(

const size_type

row

)

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

Parameters

row	The index of the row to iterate.

Returns

begin reverse_row_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the GenericMultiComponent2d.

template<typename Block>

const_reverse_row_iterator slip::GenericMultiComponent2d< Block >::row_rbegin

(

const size_type

row

)

const

Returns a read-only reverse iterator that points to the last element of the row row in the GenericMultiComponent2d. Iteration is done in the reverse element order.

Parameters

row	The index of the row to iterate.

Returns

begin const_reverse_row_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the GenericMultiComponent2d.

template<typename Block>

reverse_row_range_iterator slip::GenericMultiComponent2d< Block >::row_rbegin	(	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 row in the GenericMultiComponent2d. Iteration is done in the reverse element order according to the Range.

Parameters

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 GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

template<typename Block>

const_reverse_row_range_iterator slip::GenericMultiComponent2d< Block >::row_rbegin	(	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 row in the GenericMultiComponent2d. Iteration is done in the reverse element order according to the Range.

Parameters

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 GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

template<typename Block>

reverse_component_row_iterator slip::GenericMultiComponent2d< Block >::row_rbegin	(	const std::size_t	component,
		const std::size_t	row
	)

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

Parameters

component	The component number.
row	The row within the component.

Returns

reverse begin component_row_iterator value.

template<typename Block>

const_reverse_component_row_iterator slip::GenericMultiComponent2d< Block >::row_rbegin	(	const std::size_t	component,
		const std::size_t	row
	)		const

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

Parameters

component	The component number.
row	The row within the component.

Returns

const reverse begin component_row_iterator value

template<typename Block >

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

inline

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

Parameters

component	The component number.
row	The index of the row to iterate.
range	Range of the row to iterate.

Returns

reverse_component_row_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Definition at line 4453 of file GenericMultiComponent2d.hpp.

template<typename Block >

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

inline

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

Parameters

component	The component number.
row	The index of the row to iterate.
range	Range of the row to iterate

Returns

begin const_reverse_component_row_range_iterator value

Precondition

row must be compatible with the range of the GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Definition at line 4471 of file GenericMultiComponent2d.hpp.

template<typename Block>

reverse_row_iterator slip::GenericMultiComponent2d< Block >::row_rend

(

const size_type

row

)

Returns a read/write reverse iterator that points one past the first element of the row row in the GenericMultiComponent2d. Iteration is done in the reverse element order.

Parameters

row	The index of the row to iterate.

Returns

end reverse_row_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the GenericMultiComponent2d.

template<typename Block>

const_reverse_row_iterator slip::GenericMultiComponent2d< Block >::row_rend

(

const size_type

row

)

const

Returns a read-only reverse iterator that points one past the first element of the row row in the GenericMultiComponent2d. Iteration is done in the reverse element order.

Parameters

row	The index of the row to iterate.

Returns

end const_reverse_row_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the GenericMultiComponent2d.

template<typename Block>

reverse_row_range_iterator slip::GenericMultiComponent2d< Block >::row_rend	(	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 row in the GenericMultiComponent2d. Iteration is done in the reverse element order according to the Range.

Parameters

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 GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

template<typename Block>

const_reverse_row_range_iterator slip::GenericMultiComponent2d< Block >::row_rend	(	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 row in the GenericMultiComponent2d. Iteration is done in the reverse element order according to the Range.

Parameters

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 GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

template<typename Block>

reverse_component_row_iterator slip::GenericMultiComponent2d< Block >::row_rend	(	const std::size_t	component,
		const std::size_t	row
	)

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

Parameters

component	The component number.
row	The row within the component.

Returns

end reverse component_row_iterator value

template<typename Block>

const_reverse_component_row_iterator slip::GenericMultiComponent2d< Block >::row_rend	(	const std::size_t	component,
		const std::size_t	row
	)		const

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

Parameters

component	The component number.
row	The row within the component.

Returns

const reverse end component_row_iterator value

template<typename Block >

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

inline

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

Parameters

component	The component number.
row	The index of the row to iterate.
range	Range of the row to iterate.

Returns

reverse_component_row_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Definition at line 4462 of file GenericMultiComponent2d.hpp.

template<typename Block >

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

inline

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

Parameters

component	The component number.
row	The index of the row to iterate.
range	Range of the row to iterate

Returns

const_reverse_component_row_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the GenericMultiComponent2d.

The range must be inside the whole range of the GenericMultiComponent2d.

Definition at line 4480 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::size_type slip::GenericMultiComponent2d< Block >::rows ( ) const

inline

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

Definition at line 4840 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::reverse_iterator2d slip::GenericMultiComponent2d< Block >::rupper_left ( )

inline

Returns a read/write reverse iterator2d. It points to the bottom right element of the GenericMultiComponent2d. Iteration is done within the GenericMultiComponent2d in the reverse order.

Returns

reverse_iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4039 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_reverse_iterator2d slip::GenericMultiComponent2d< Block >::rupper_left ( ) const

inline

Returns a read only reverse iterator2d that points. It points to the bottom right element of the GenericMultiComponent2d. Iteration is done within the GenericMultiComponent2d in the reverse order.

Returns

const_reverse_iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4047 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::reverse_iterator2d slip::GenericMultiComponent2d< Block >::rupper_left ( const Box2d< int > &  box )

inline

Returns a read/write reverse iterator2d. It points to the bottom right element of the Box2d associated to the GenericMultiComponent2d. Iteration is done in the reverse order.

Parameters

box	a Box2d defining the range of indices to iterate within the GenericMultiComponent2d.

Precondition

The box indices must be inside the range of the GenericMultiComponent2d ones.

Returns

reverse iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4073 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_reverse_iterator2d slip::GenericMultiComponent2d< Block >::rupper_left ( const Box2d< int > &  box ) const

inline

Returns a read only reverse iterator2d. It points to the bottom right element of the Box2d box associated to the GenericMultiComponent2d. Iteration is done in the reverse order.

Parameters

box	A Box2d defining the range of indices to iterate within the GenericMultiComponent2d.

Precondition

The box indices must be inside the range of the GenericMultiComponent2d ones.

Returns

const reverse iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4081 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::reverse_iterator2d_range slip::GenericMultiComponent2d< Block >::rupper_left ( const Range< int > &  row_range, const Range< int > &  col_range  )

inline

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

Parameters

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

Precondition

row_range and col_range must be valid.

The ranges indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

reverse_iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4090 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_reverse_iterator2d_range slip::GenericMultiComponent2d< Block >::rupper_left ( const Range< int > &  row_range, const Range< int > &  col_range  ) const

inline

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

Parameters

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

Precondition

row_range and col_range must be valid.

The ranges indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

const_reverse_iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4099 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::reverse_iterator2d_range slip::GenericMultiComponent2d< Block >::rupper_left ( const Range< int > &  range )

inline

Returns a read/write reverse_iterator2d_range that points to the bottom right element of the Range range associated to the GenericMultiComponent2d. The same range is applied for rows and cols. Iteration is done in the reverse order.

Parameters

range

The range of the rows and the cols.

Precondition

range and must be valid.

The range indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

reverse_iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4128 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_reverse_iterator2d_range slip::GenericMultiComponent2d< Block >::rupper_left ( const Range< int > &  range ) const

inline

Returns a read-only reverse_iterator2d_range that points to the to the bottom right element of the Range range associated to the GenericMultiComponent2d. The same range is applied for rows and cols. Iteration is done in the reverse order.

Parameters

range

The range of the rows and the cols.

Precondition

range must be valid.

The range indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

const_reverse_iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4136 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::reverse_component_iterator2d slip::GenericMultiComponent2d< Block >::rupper_left ( const std::size_t  component )

inline

Returns a read/write reverse component iterator2d. It points to the bottom right element of the GenericMultiComponent2d. Iteration is done within the GenericMultiComponent2d in the reverse order.

Parameters

component

The component number.

Returns

reverse_component_iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4562 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_reverse_component_iterator2d slip::GenericMultiComponent2d< Block >::rupper_left ( const std::size_t  component ) const

inline

Returns a read only reverse component iterator2d that points. It points to the bottom right element of the GenericMultiComponent2d. Iteration is done within the GenericMultiComponent2d in the reverse order.

Parameters

component

The component number.

Returns

const_reverse_component_iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4579 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::reverse_component_iterator2d slip::GenericMultiComponent2d< Block >::rupper_left ( const std::size_t  component, const Box2d< int > &  box  )

inline

Returns a read/write reverse component iterator2d. It points to the bottom right element of the Box2d associated to the GenericMultiComponent2d. Iteration is done in the reverse order.

Parameters

component	The component number.
box	a Box2d defining the range of indices to iterate within the GenericMultiComponent2d.

Precondition

The box indices must be inside the range of the GenericMultiComponent2d ones.

Returns

reverse iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4686 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_reverse_component_iterator2d slip::GenericMultiComponent2d< Block >::rupper_left ( const std::size_t  component, const Box2d< int > &  box  ) const

inline

Returns a read only reverse component iterator2d. It points to the bottom right element of the Box2d box associated to the GenericMultiComponent2d. Iteration is done in the reverse order.

Parameters

component	The component number.
box	A Box2d defining the range of indices to iterate within the GenericMultiComponent2d.

Precondition

The box indices must be inside the range of the GenericMultiComponent2d ones.

Returns

const reverse iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4705 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::reverse_component_iterator2d_range slip::GenericMultiComponent2d< Block >::rupper_left ( const std::size_t  component, const Range< int > &  row_range, const Range< int > &  col_range  )

inline

Returns a read/write reverse component iterator2d_range that points to the past the bottom right element of the ranges row_range and col_range associated to the GenericMultiComponent2d. Iteration is done in the reverse order.

Parameters

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

Precondition

row_range and col_range must be valid.

The ranges indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

reverse_iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4725 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_reverse_component_iterator2d_range slip::GenericMultiComponent2d< Block >::rupper_left ( const std::size_t  component, const Range< int > &  row_range, const Range< int > &  col_range  ) const

inline

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

Parameters

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

Precondition

row_range and col_range must be valid.

The ranges indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

const_reverse_iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4746 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::size_type slip::GenericMultiComponent2d< Block >::size ( ) const

inline

Returns the number of elements in the GenericMultiComponent2d.

Definition at line 4860 of file GenericMultiComponent2d.hpp.

template<typename Block >

void slip::GenericMultiComponent2d< Block >::swap ( self &  M )

inline

Swaps data with another GenericMultiComponent2d.

Parameters

M	A GenericMultiComponent2d of the same element type

Definition at line 4873 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::iterator2d slip::GenericMultiComponent2d< Block >::upper_left ( )

inline

Returns a read/write iterator2d that points to the first element of the GenericMultiComponent2d. It points to the upper left element of the GenericMultiComponent2d.

Returns

begin iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(8,8);
//copy the elements of A1 in A2
std::copy(A1.upper_left(),A1.bottom_right(),A2.upper_left());

Definition at line 3885 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_iterator2d slip::GenericMultiComponent2d< Block >::upper_left ( ) const

inline

Returns a read-only iterator2d that points to the first element of the GenericMultiComponent2d. It points to the upper left element of the GenericMultiComponent2d.

Returns

begin const iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(8,8);
//copy the elements of A1 in A2
std::copy(A1.upper_left(),A1.bottom_right(),A2.upper_left());

Definition at line 3892 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::iterator2d slip::GenericMultiComponent2d< Block >::upper_left ( const Box2d< int > &  box )

inline

Returns a read/write iterator2d that points to the first element of the GenericMultiComponent2d. It points to the upper left element of the Box2d associated to the GenericMultiComponent2d.

Parameters

box	A Box2d defining the range of indices to iterate within the GenericMultiComponent2d.

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Returns

end iterator2d value

Precondition

The box indices must be inside the range of the GenericMultiComponent2d ones.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(3,2);
 slip::Box2d<int> box(1,1,3,2);
//copy the elements of A1 inside the box which upper_left element 
//is located in (1,1) and the bottom right element is in (3,2)
std::copy(A1.upper_left(box),A1.bottom_right(box),A2.upper_left());

Definition at line 3916 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_iterator2d slip::GenericMultiComponent2d< Block >::upper_left ( const Box2d< int > &  box ) const

inline

Returns a read only iterator2d that points to the first element of the GenericMultiComponent2d. It points to the upper left element of the Box2d associated to the GenericMultiComponent2d.

Parameters

box	a Box2d defining the range of indices to iterate within the GenericMultiComponent2d.

Returns

end const iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Precondition

The box indices must be inside the range of the GenericMultiComponent2d ones.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(3,2);
 slip::Box2d<int> box(1,1,3,2);
//copy the elements of A1 inside the box which upper_left element 
//is located in (1,1) and the bottom right element is in (3,2)
std::copy(A1.upper_left(box),A1.bottom_right(box),A2.upper_left());

Definition at line 3924 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::iterator2d_range slip::GenericMultiComponent2d< Block >::upper_left ( const Range< int > &  row_range, const Range< int > &  col_range  )

inline

Returns a read/write iterator2d_range that points to the upper left element of the ranges row_range and col_range associated to the GenericMultiComponent2d.

Parameters

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

Precondition

row_range and col_range must be valid.

The ranges indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(4,4);
 slip::Range<int> row_range(0,A1.dim2()-1,2);
 slip::Range<int> col_range(0,A1.dim1()-1,2);
//copy the elements of A1 within the ranges row_range and col_range
//in A2
std::copy(A1.upper_left(row_range,col_range),
A1.bottom_right(row_range,col_range),A2.upper_left());

Definition at line 3949 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_iterator2d_range slip::GenericMultiComponent2d< Block >::upper_left ( const Range< int > &  row_range, const Range< int > &  col_range  ) const

inline

Returns a read-only iterator2d_range that points to the to the upper left element of the ranges row_range and col_range associated to the GenericMultiComponent2d.

Parameters

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

Precondition

row_range and col_range must be valid.

The ranges indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

const_iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(4,4);
 slip::Range<int> row_range(0,A1.dim2()-1,2);
 slip::Range<int> col_range(0,A1.dim1()-1,2);
//copy the elements of A1 within the ranges row_range and col_range
//in A2
std::copy(A1.upper_left(row_range,col_range),
A1.bottom_right(row_range,col_range),A2.upper_left());

Definition at line 3958 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::iterator2d_range slip::GenericMultiComponent2d< Block >::upper_left ( const Range< int > &  range )

inline

Returns a read/write iterator2d_range that points to the upper left element of the Range range associated to the GenericMultiComponent2d. The same range is applied for rows and cols.

Parameters

range

The range of the rows and the cols.

Precondition

range and must be valid.

The range indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(4,4);
 slip::Range<int> range(0,A1.dim2()-1,2);
//copy the elements of A1 within the range range
//in A2
std::copy(A1.upper_left(range),A1.bottom_right(range),A2.upper_left());

Definition at line 3987 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_iterator2d_range slip::GenericMultiComponent2d< Block >::upper_left ( const Range< int > &  range ) const

inline

Returns a read-only iterator2d_range that points to the to the upper left element of the Range range associated to the GenericMultiComponent2d.

Parameters

range

The range of the rows and the cols.

Precondition

range must be valid.

The range indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

const_iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example:

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(4,4);
 slip::Range<int> range(0,A1.dim2()-1,2);
//copy the elements of A1 within the range range
//in A2
std::copy(A1.upper_left(range),A1.bottom_right(range),A2.upper_left());

Definition at line 3995 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::component_iterator2d slip::GenericMultiComponent2d< Block >::upper_left ( const std::size_t  component )

inline

Returns a read/write component_iterator2d that points to the first element of the GenericMultiComponent2d. It points to the upper left element of the GenericMultiComponent2d.

Parameters

component

The component number.

Returns

begin iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

 slip::GenericMultiComponent2d<slip::Vector2d<double> > A1(8,8);
 slip::GenericMultiComponent2d<slip::Vector2d<double> > A2(8,8);
//copy the first component of the elements of A1 in A2
std::copy(A1.upper_left(0),A1.bottom_right(0),A2.upper_left(0));

Definition at line 4526 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_component_iterator2d slip::GenericMultiComponent2d< Block >::upper_left ( const std::size_t  component ) const

inline

Returns a read only const_component_iterator2d that points to the first element of the GenericMultiComponent2d. It points to the upper left element of the GenericMultiComponent2d.

Parameters

component

The component number.

Returns

begin iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4544 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::component_iterator2d slip::GenericMultiComponent2d< Block >::upper_left ( const std::size_t  component, const Box2d< int > &  box  )

inline

Returns a read/write component iterator2d that points to the first element of the GenericMultiComponent2d. It points to the upper left element of the Box2d associated to the GenericMultiComponent2d.

Parameters

component	The component number.
box	A Box2d defining the range of indices to iterate within the GenericMultiComponent2d.

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Returns

end iterator2d value

Precondition

The box indices must be inside the range of the GenericMultiComponent2d ones.

Definition at line 4597 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_component_iterator2d slip::GenericMultiComponent2d< Block >::upper_left ( const std::size_t  component, const Box2d< int > &  box  ) const

inline

Returns a read only component iterator2d that points to the first element of the GenericMultiComponent2d. It points to the upper left element of the Box2d associated to the GenericMultiComponent2d.

Parameters

component	The component number.
box	a Box2d defining the range of indices to iterate within the GenericMultiComponent2d.

Returns

end const iterator2d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Precondition

The box indices must be inside the range of the GenericMultiComponent2d ones.

Definition at line 4616 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::component_iterator2d_range slip::GenericMultiComponent2d< Block >::upper_left ( const std::size_t  component, const Range< int > &  row_range, const Range< int > &  col_range  )

inline

Returns a read/write component iterator2d_range that points to the upper left element of the ranges row_range and col_range associated to the GenericMultiComponent2d.

Parameters

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

Precondition

row_range and col_range must be valid.

The ranges indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4635 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::const_component_iterator2d_range slip::GenericMultiComponent2d< Block >::upper_left ( const std::size_t  component, const Range< int > &  row_range, const Range< int > &  col_range  ) const

inline

Returns a read-only component iterator2d_range that points to the to the upper left element of the ranges row_range and col_range associated to the GenericMultiComponent2d.

Parameters

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

Precondition

row_range and col_range must be valid.

The ranges indices must be inside the ranges of the GenericMultiComponent2d ones.

Returns

const_iterator2d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 4656 of file GenericMultiComponent2d.hpp.

template<typename Block >

GenericMultiComponent2d< Block >::size_type slip::GenericMultiComponent2d< Block >::width ( ) const

inline

Returns the number of columns (second dimension size) in the GenericMultiComponent2d.

Definition at line 4848 of file GenericMultiComponent2d.hpp.

Friends And Related Function Documentation

template<typename Block>

friend class boost::serialization::access

friend

Definition at line 3420 of file GenericMultiComponent2d.hpp.

template<typename Block>

bool operator!= ( const GenericMultiComponent2d< Block > &  x, const GenericMultiComponent2d< Block > &  y  )

friend

GenericMultiComponent2d inequality comparison.

Parameters

x	A GenericMultiComponent2d
y	A GenericMultiComponent2d of the same type of x

Returns

true if !(x == y)

Precondition

x.size() == y.size()

Definition at line 4936 of file GenericMultiComponent2d.hpp.

template<typename Block>

std::ostream& operator<< ( std::ostream &  out, const self &  a  )

friend

Write the GenericMultiComponent2d to the ouput stream.

Parameters

out	output stream
a	GenericMultiComponent2d to write to the output stream

Definition at line 4760 of file GenericMultiComponent2d.hpp.

template<typename Block>

bool operator== ( const GenericMultiComponent2d< Block > &  x, const GenericMultiComponent2d< Block > &  y  )

friend

GenericMultiComponent2d equality comparison.

Parameters

x	A GenericMultiComponent2d
y	A GenericMultiComponent2d 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 4927 of file GenericMultiComponent2d.hpp.

Member Data Documentation

template<typename Block>

const std::size_t slip::GenericMultiComponent2d< Block >::COMPONENTS = Block::SIZE

static

Definition at line 284 of file GenericMultiComponent2d.hpp.

template<typename Block>

const std::size_t slip::GenericMultiComponent2d< Block >::DIM = 2

static

Definition at line 283 of file GenericMultiComponent2d.hpp.

---

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

• src/Container/GenericMultiComponent2d.hpp