slip::Matrix3d< Block > Class Template Reference

Numerical matrix3d class. This container statisfies the RandomAccessContainer concepts of the STL except the simple bracket which is replaced by a double bracket. It extends the interface of Array3d adding arithmetical: +=, -=, *=, /=,+,-,/,*... and mathematical operators : min, max, abs, sqrt, cos, acos, sin, asin, tan, atan, exp, log, cosh, sinh, tanh, log10, sum, apply... More...

#include <GenericMultiComponent3d.hpp>

Inheritance diagram for slip::Matrix3d< Block >:

Public Types
typedef T	value_type
typedef Matrix3d< T >	self
typedef const Matrix3d< T >	const_self
typedef value_type *	pointer
typedef value_type const *	const_pointer
typedef value_type &	reference
typedef value_type const &	const_reference
typedef ptrdiff_t	difference_type
typedef std::size_t	size_type
typedef pointer	iterator
typedef const_pointer	const_iterator
typedef std::reverse_iterator < iterator >	reverse_iterator
typedef std::reverse_iterator < const_iterator >	const_reverse_iterator
typedef slip::stride_iterator < pointer >	slice_iterator
typedef slip::stride_iterator < const_pointer >	const_slice_iterator
typedef pointer	row_iterator
typedef const_pointer	const_row_iterator
typedef slip::stride_iterator < pointer >	col_iterator
typedef slip::stride_iterator < const_pointer >	const_col_iterator
typedef slip::stride_iterator < slice_iterator >	slice_range_iterator
typedef slip::stride_iterator < const_slice_iterator >	const_slice_range_iterator
typedef slip::stride_iterator < pointer >	row_range_iterator
typedef slip::stride_iterator < const_pointer >	const_row_range_iterator
typedef slip::stride_iterator < col_iterator >	col_range_iterator
typedef slip::stride_iterator < const_col_iterator >	const_col_range_iterator
typedef std::reverse_iterator < slice_iterator >	reverse_slice_iterator
typedef std::reverse_iterator < const_slice_iterator >	const_reverse_slice_iterator
typedef std::reverse_iterator < iterator >	reverse_row_iterator
typedef std::reverse_iterator < const_iterator >	const_reverse_row_iterator
typedef std::reverse_iterator < col_iterator >	reverse_col_iterator
typedef std::reverse_iterator < const_col_iterator >	const_reverse_col_iterator
typedef std::reverse_iterator < slice_range_iterator >	reverse_slice_range_iterator
typedef std::reverse_iterator < const_slice_range_iterator >	const_reverse_slice_range_iterator
typedef std::reverse_iterator < row_range_iterator >	reverse_row_range_iterator
typedef std::reverse_iterator < const_row_range_iterator >	const_reverse_row_range_iterator
typedef std::reverse_iterator < col_range_iterator >	reverse_col_range_iterator
typedef std::reverse_iterator < const_col_range_iterator >	const_reverse_col_range_iterator
typedef slip::Array3d< T > ::iterator2d	iterator2d
typedef slip::Array3d< T > ::const_iterator2d	const_iterator2d
typedef std::reverse_iterator < iterator2d >	reverse_iterator2d
typedef std::reverse_iterator < const_iterator2d >	const_reverse_iterator2d
typedef slip::Array3d< T > ::iterator3d	iterator3d
typedef slip::Array3d< T > ::const_iterator3d	const_iterator3d
typedef slip::Array3d< T > ::iterator3d_range	iterator3d_range
typedef slip::Array3d< T > ::const_iterator3d_range	const_iterator3d_range
typedef std::reverse_iterator < iterator3d >	reverse_iterator3d
typedef std::reverse_iterator < const_iterator3d >	const_reverse_iterator3d
typedef std::reverse_iterator < iterator3d_range >	reverse_iterator3d_range
typedef std::reverse_iterator < const_iterator3d_range >	const_reverse_iterator3d_range
typedef iterator3d	default_iterator
typedef const_iterator3d	const_default_iterator

Public Member Functions
void	resize (std::size_t d1, std::size_t d2, std::size_t d3, const T &val=T())
	Resizes a Matrix3d. More...
std::string	name () const
	Returns the name of the class. More...
size_type	dim1 () const
	Returns the number of slices (first dimension size) in the Matrix3d. More...
size_type	slices () const
	Returns the number of slices (first dimension size) in the Matrix3d. More...
size_type	dim2 () const
	Returns the number of rows (second dimension size) in the Matrix3d. More...
size_type	rows () const
	Returns the number of rows (second dimension size) in the Matrix3d. More...
size_type	dim3 () const
	Returns the number of columns (third dimension size) in the Matrix3d. More...
size_type	cols () const
	Returns the number of columns (third dimension size) in the Matrix3d. More...
size_type	columns () const
	Returns the number of columns (third dimension size) in the Matrix3d. More...
size_type	size () const
	Returns the number of elements in the Matrix3d. More...
size_type	max_size () const
	Returns the maximal size (number of elements) in the Matrix3d. More...
size_type	slice_size () const
	Returns the number of elements in a slice of the Matrix3d. More...
bool	empty () const
	Returns true if the Matrix3d is empty. (Thus size() == 0) More...
void	swap (Matrix3d &M)
	Swaps data with another Matrix3d. More...
template<typename T >
	Matrix3d (const typename Matrix3d< T >::size_type d1, const typename Matrix3d< T >::size_type d2, const typename Matrix3d< T >::size_type d3)
template<typename T >
	Matrix3d (const typename Matrix3d< T >::size_type d1, const typename Matrix3d< T >::size_type d2, const typename Matrix3d< T >::size_type d3, const T &val)
template<typename T >
	Matrix3d (const typename Matrix3d< T >::size_type d1, const typename Matrix3d< T >::size_type d2, const typename Matrix3d< T >::size_type d3, const T *val)
Constructors & Destructors
	Matrix3d ()
	Constructs a Matrix3d. More...
	Matrix3d (const std::size_t d1, const std::size_t d2, const std::size_t d3)
	Constructs a Matrix3d. More...
	Matrix3d (const std::size_t d1, const std::size_t d2, const std::size_t d3, const T &val)
	Constructs a Matrix3d initialized by the scalar value val. More...
	Matrix3d (const std::size_t d1, const std::size_t d2, const std::size_t d3, const T *val)
	Constructs a Matrix3d initialized by an array val. More...
template<typename InputIterator >
	Matrix3d (const size_type d1, const size_type d2, const size_type d3, InputIterator first, InputIterator last)
	Contructs a Matrix3d from a range. More...
	Matrix3d (const Matrix3d< T > &rhs)
	Constructs a copy of the Matrix3d rhs. More...
	~Matrix3d ()
	Destructor of the Matrix3d. More...
One dimensionnal global iterators
const_iterator	begin () const
	Returns a read-only (constant) iterator that points to the first element in the Matrix3d. Iteration is done in ordinary element order. More...
iterator	begin ()
	Returns a read/write iterator that points to the first element in the Matrix3d. Iteration is done in ordinary element order. More...
iterator	end ()
	Returns a read/write iterator that points one past the last element in the Matrix3d. 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 Matrix3d. 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 Matrix3d. 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 Matrix3d. 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 Matrix3d. 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 Matrix3d. Iteration is done in reverse element order. More...
One dimensionnal slice iterators
slice_iterator	slice_begin (const size_type row, const size_type col)
	Returns a read/write iterator that points to the first element of the line (row,col) threw the slices in the Matrix3d. Iteration is done in ordinary element order (increasing slice number). More...
const_slice_iterator	slice_begin (const size_type row, const size_type col) const
	Returns a read-only (constant) iterator that points to the first element of the line (row,col) threw the slices in the Matrix3d. Iteration is done in ordinary element order (increasing slice number). More...
slice_iterator	slice_end (const size_type row, const size_type col)
	Returns a read/write iterator that points to the one past the end element of the line (row,col) threw the slices in the Matrix3d. Iteration is done in ordinary element order (increasing slice number). More...
const_slice_iterator	slice_end (const size_type row, const size_type col) const
	Returns a read-only (constant) iterator that points to the one past the end element of the line (row,col) threw the slices in the Matrix3d. Iteration is done in ordinary element order (increasing slice number). More...
reverse_slice_iterator	slice_rbegin (const size_type row, const size_type col)
	Returns a read/write iterator that points to the last element of the line (row,col) threw the slices in the Matrix3d. Iteration is done in reverse element order (decreasing slice number). More...
const_reverse_slice_iterator	slice_rbegin (const size_type row, const size_type col) const
	Returns a read-only (constant) iterator that points to the last element of the line (row,col) threw the slices in the Matrix3d. Iteration is done in reverse element order (decreasing slice number). More...
reverse_slice_iterator	slice_rend (const size_type row, const size_type col)
	Returns a read/write iterator that points to the one before the first element of the line (row,col) threw the slices in the Matrix3d. Iteration is done in reverse element order (decreasing slice number). More...
const_reverse_slice_iterator	slice_rend (const size_type row, const size_type col) const
	Returns a read (constant) iterator that points to the one before the first element of the line (row,col) threw the slices in the Matrix3d. Iteration is done in reverse element order (decreasing slice number). More...
One dimensionnal row iterators
row_iterator	row_begin (const size_type slice, const size_type row)
	Returns a read/write iterator that points to the first element of the row row of the slice slice in the Matrix3d. Iteration is done in ordinary element order. More...
const_row_iterator	row_begin (const size_type slice, const size_type row) const
	Returns a read_only iterator that points to the first element of the row row of the slice slice in the Matrix3d. Iteration is done in ordinary element order. More...
row_iterator	row_end (const size_type slice, const size_type row)
	Returns a read/write iterator that points to the past-the-end element of the row row of the slice slice in the Matrix3d. Iteration is done in ordinary element order. More...
const_row_iterator	row_end (const size_type slice, const size_type row) const
	Returns a read_only iterator that points to the past-the-end element of the row row of the slice slice in the Matrix3d. Iteration is done in ordinary element order. More...
reverse_row_iterator	row_rbegin (const size_type slice, const size_type row)
	Returns a read/write reverse iterator that points to the last element of the row row of the slice slice in the Matrix3d. Iteration is done in reverse element order. More...
const_reverse_row_iterator	row_rbegin (const size_type slice, const size_type row) const
	Returns a read_only reverse iterator that points to the last element of the row row of the slice slice in the Matrix3d. Iteration is done in reverse element order. More...
reverse_row_iterator	row_rend (const size_type slice, const size_type row)
	Returns a read/write reverse iterator that points to the first element of the row row of the slice slice in the Matrix3d. Iteration is done in reverse element order. More...
const_reverse_row_iterator	row_rend (const size_type slice, const size_type row) const
	Returns a read_only reverse iterator that points to the first element of the row row of the slice slice in the Matrix3d. Iteration is done in reverse element order. More...
One dimensionnal col iterators
col_iterator	col_begin (const size_type slice, const size_type col)
	Returns a read/write iterator that points to the first element of the column column of the slice slice in the Matrix3d. Iteration is done modulo the number of columns. More...
const_col_iterator	col_begin (const size_type slice, const size_type col) const
	Returns a read_only iterator that points to the first element of the column column of the slice slice in the Matrix3d. Iteration is done modulo the number of columns. More...
col_iterator	col_end (const size_type slice, const size_type col)
	Returns a read/write iterator that points to the past-the-end element of the column column of the slice slice in the Matrix3d. Iteration is done modulo the number of columns. More...
const_col_iterator	col_end (const size_type slice, const size_type col) const
	Returns a read_only iterator that points to the past-the-end element of the column column of the slice slice in the Matrix3d. Iteration is done modulo the number of columns. More...
reverse_col_iterator	col_rbegin (const size_type slice, const size_type col)
	Returns a read/write reverse iterator that points to the last element of the column column of the slice slice in the Matrix3d. Iteration is done modulo the number of columns. More...
const_reverse_col_iterator	col_rbegin (const size_type slice, const size_type col) const
	Returns a read_only reverse iterator that points to the last element of the column column of the slice slice in the Matrix3d. Iteration is done modulo the number of columns. More...
reverse_col_iterator	col_rend (const size_type slice, const size_type col)
	Returns a read/write reverse iterator that points to the first element of the column column of the slice slice in the Matrix3d. Iteration is done modulo the number of columns. More...
const_reverse_col_iterator	col_rend (const size_type slice, const size_type col) const
	Returns a read_only reverse iterator that points to the first element of the column column of the slice slice in the Matrix3d. Iteration is done modulo the number of columns. More...
One dimensionnal slice range iterators
slice_range_iterator	slice_begin (const size_type row, const size_type col, const slip::Range< int > &range)
	Returns a read/write iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the Matrix3d. Iteration is done in ordinary element order according to the Range. More...
slice_range_iterator	slice_end (const size_type row, const size_type col, const slip::Range< int > &range)
	Returns a read/write iterator that points one past the end element of the Range range of the of the line (row,col) threw the slices in the Matrix3d. Iteration is done in ordinary element order according to the Range. More...
const_slice_range_iterator	slice_begin (const size_type row, const size_type col, const slip::Range< int > &range) const
	Returns a read only (constant) iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the Matrix3d. Iteration is done in ordinary element order according to the Range. More...
const_slice_range_iterator	slice_end (const size_type row, const size_type col, const slip::Range< int > &range) const
	Returns a read_only iterator that points one past the last element of the Range range of the of the line (row,col) threw the slices in the Matrix3d. Iteration is done in ordinary element order according to the Range. More...
reverse_slice_range_iterator	slice_rbegin (const size_type row, const size_type col, const slip::Range< int > &range)
	Returns a read/write iterator that points to the last element of the Range range of the of the line (row,col) threw the slices in the Matrix3d. Iteration is done in the reverse element order according to the Range. More...
reverse_slice_range_iterator	slice_rend (const size_type row, const size_type col, const slip::Range< int > &range)
	Returns a read/write iterator that points to the first element of the Range range of the of the line (row,col) threw the slices in the Matrix3d. Iteration is done in reverse element order according to the Range. More...
const_reverse_slice_range_iterator	slice_rbegin (const size_type row, const size_type col, const slip::Range< int > &range) const
	Returns a read only (constant) iterator that points to the last element of the Range range of the of the line (row,col) threw the slices in the Matrix3d. Iteration is done in reverse element order according to the Range. More...
const_reverse_slice_range_iterator	slice_rend (const size_type row, const size_type col, const slip::Range< int > &range) const
	Returns a read_only iterator that points one past the lastto the first element of the Range range of the of the line (row,col) threw the slices in the Matrix3d. Iteration is done in reverse element order according to the Range. More...
One dimensionnal row range iterators
row_range_iterator	row_begin (const size_type slice, const size_type row, const slip::Range< int > &range)
	Returns a read/write iterator that points to the first element of the Range range of the row row in the Matrix3d. Iteration is done in ordinary element order according to the Range. More...
row_range_iterator	row_end (const size_type slice, const size_type row, const slip::Range< int > &range)
	Returns a read/write iterator that points one past the end element of the Range range of the row row in the Matrix3d. Iteration is done in ordinary element order according to the Range. More...
const_row_range_iterator	row_begin (const size_type slice, const size_type row, const slip::Range< int > &range) const
	Returns a read-only iterator that points to the first element of the Range range of the row row in the Matrix3d. Iteration is done in ordinary element order according to the Range. More...
const_row_range_iterator	row_end (const size_type slice, const size_type row, const slip::Range< int > &range) const
	Returns a read_only iterator that points one past the last element of the Range range of the row row in the Matrix3d. Iteration is done in ordinary element order according to the Range. More...
reverse_row_range_iterator	row_rbegin (const size_type slice, const size_type row, const slip::Range< int > &range)
	Returns a read-write iterator that points to the last element of the Range range of the row of a slice row and slice in the Matrix3d. Iteration is done in the reverse element order according to the Range. More...
reverse_row_range_iterator	row_rend (const size_type slice, const size_type row, const slip::Range< int > &range)
	Returns a read-write iterator that points one before the first element of the Range range of the row of a slice row in the Matrix3d. Iteration is done in the reverse element order according to the Range. More...
const_reverse_row_range_iterator	row_rbegin (const size_type slice, const size_type row, const slip::Range< int > &range) const
	Returns a read-only iterator that points to the last element of the Range range of the row of a slice row in the Matrix3d. Iteration is done in the reverse element order according to the Range. More...
const_reverse_row_range_iterator	row_rend (const size_type slice, const size_type row, const slip::Range< int > &range) const
	Returns a read-only iterator that points one before the first element of the Range range of the row of a slice row in the Matrix3d. Iteration is done in the reverse element order according to the Range. More...
One dimensionnal col range iterators
col_range_iterator	col_begin (const size_type slice, const size_type col, const slip::Range< int > &range)
	Returns a read-write iterator that points to the first element of the Range range of the col col in the Matrix3d. Iteration is done in ordinary element order according to the Range. More...
col_range_iterator	col_end (const size_type slice, const size_type col, const slip::Range< int > &range)
	Returns a read-write iterator that points to the past the end element of the Range range of the col col in the Matrix3d. Iteration is done in ordinary element order according to the Range. More...
const_col_range_iterator	col_begin (const size_type slice, const size_type col, const slip::Range< int > &range) const
	Returns a read-only iterator that points to the first element of the Range range of the col col in the Matrix3d. Iteration is done in ordinary element order according to the Range. More...
const_col_range_iterator	col_end (const size_type slice, const size_type col, const slip::Range< int > &range) const
	Returns a read-only iterator that points to the past the end element of the Range range of the col col in the Matrix3d. Iteration is done in ordinary element order according to the Range. More...
reverse_col_range_iterator	col_rbegin (const size_type slice, const size_type col, const slip::Range< int > &range)
	Returns a read-write iterator that points to the last element of the Range range of the col of a slice col in the Matrix3d. Iteration is done in the reverse element order according to the Range. More...
reverse_col_range_iterator	col_rend (const size_type slice, const size_type col, const slip::Range< int > &range)
	Returns a read-write iterator that points to one before the first element of the Range range of the col of a slice col in the Matrix3d. Iteration is done in the reverse element order according to the Range. More...
const_reverse_col_range_iterator	col_rbegin (const size_type slice, const size_type col, const slip::Range< int > &range) const
	Returns a read_only iterator that points to the last element of the Range & range of the col of a slice col in the Matrix3d. Iteration is done in the reverse element order according to the Range. More...
const_reverse_col_range_iterator	col_rend (const size_type slice, const size_type col, const slip::Range< int > &range) const
	Returns a read-only iterator that points to the first element of the Range range of the col of a slice col in the Matrix3d. Iteration is done in the reverse element order according to the Range. More...
One dimensionnal global plane iterators
iterator	plane_begin (const size_type slice)
	Returns a read/write iterator that points to the first element in the in the slice plane of the Matrix3d. Iteration is done in ordinary element order. More...
const_iterator	plane_begin (const size_type slice) const
	Returns a read-only (constant) iterator that points to the first element in the slice plane of the Matrix3d. Iteration is done in ordinary element order. More...
iterator	plane_end (const size_type slice)
	Returns a read/write iterator that points one past the last element in the slice plane of the Matrix3d. Iteration is done in ordinary element order. More...
const_iterator	plane_end (const size_type slice) const
	Returns a read-only (constant) iterator that points one past the last element in the slice plane of the Matrix3d. Iteration is done in ordinary element order. More...
reverse_iterator	plane_rbegin (const size_type slice)
	Returns a read/write reverse iterator that points to the last element in the slice plane of the Matrix3d. Iteration is done in reverse element order. More...
const_reverse_iterator	plane_rbegin (const size_type slice) const
	Returns a read-only (constant) reverse iterator that points to the last element in the slice plane k of the Matrix3d. Iteration is done in reverse element order. More...
reverse_iterator	plane_rend (const size_type slice)
	Returns a read/write reverse iterator that points to one before the first element in the slice plane of the Matrix3d. Iteration is done in reverse element order. More...
const_reverse_iterator	plane_rend (const size_type slice) const
	Returns a read-only (constant) reverse iterator that points to one before the first element in the slice plane of the Matrix3d. Iteration is done in reverse element order. More...
two dimensionnal plane iterators : Global iterators
iterator2d	plane_upper_left (PLANE_ORIENTATION P, const size_type plane_coordinate)
	Returns a read/write iterator that points to the first element of the plane in the Matrix3d. It points to the upper left element of the plane Iteration is done in ordinary element order. More...
iterator2d	plane_bottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate)
	Returns a read/write iterator that points to the last element of the plane in the Matrix3d. It points to past the end element of the bottom right element of the plane Iteration is done in ordinary element order. More...
const_iterator2d	plane_upper_left (PLANE_ORIENTATION P, const size_type plane_coordinate) const
	Returns a read/write const iterator that points to the first element of the plane in the Matrix3d. It points to the upper left element of the plane Iteration is done in ordinary element order. More...
const_iterator2d	plane_bottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate) const
	Returns a read/write const iterator that points to the last element of the plane in the Matrix3d. It points to past the end element of the bottom right element of the plane Iteration is done in ordinary element order. More...
reverse_iterator2d	plane_rupper_left (PLANE_ORIENTATION P, const size_type plane_coordinate)
	Returns a read/write reverse_iterator that points to the bottom right element of the plane in the Matrix3d. Iteration is done in backward element order. More...
reverse_iterator2d	plane_rbottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate)
	Returns a read/write reverse_iterator that points to the upper left element of the plane in the Matrix3d. Iteration is done in backward element order. More...
const_reverse_iterator2d	plane_rupper_left (PLANE_ORIENTATION P, const size_type plane_coordinate) const
	Returns a read/write const reverse iterator that points to the bottom right element of the plane in the Matrix3d. Iteration is done in backward element order. More...
const_reverse_iterator2d	plane_rbottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate) const
	Returns a read/write const reverse iterator that points to the upper left element of the plane in the Matrix3d. Iteration is done in backward element order. More...
two dimensionnal plane iterators : box iterators
iterator2d	plane_upper_left (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b)
	Returns a read/write iterator that points to the first element of a box within a plane in the Matrix3d. It points to the upper left element of the box Iteration is done in ordinary element order. More...
iterator2d	plane_bottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b)
	Returns a read/write iterator that points to the last element of a box within a plane in the Matrix3d. It points to past the end element of the bottom right element of the plane Iteration is done in ordinary element order. More...
const_iterator2d	plane_upper_left (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b) const
	Returns a read/write const iterator that points to the first element of a box within a plane in the Matrix3d. It points to the upper left element of the plane Iteration is done in ordinary element order. More...
const_iterator2d	plane_bottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b) const
	Returns a read/write const iterator that points to the last element of a box within a plane in the Matrix3d. It points to past the end element of the bottom right element of the plane Iteration is done in ordinary element order. More...
reverse_iterator2d	plane_rupper_left (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b)
	Returns a read/write reverse iterator that points to the last element of a box within a plane in the Matrix3d. It points to the bottom right element of the box Iteration is done in backward element order. More...
reverse_iterator2d	plane_rbottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b)
	Returns a read/write reverse iterator that points to the first element of a box within a plane in the Matrix3d. It points to the upper left element of the plane Iteration is done in backward element order. More...
const_reverse_iterator2d	plane_rupper_left (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b) const
	Returns a read/write const reverse iterator that points to the last element of a box within a plane in the Matrix3d. It points to the bottom right element of the plane Iteration is done in backward element order. More...
const_reverse_iterator2d	plane_rbottom_right (PLANE_ORIENTATION P, const size_type plane_coordinate, const Box2d< int > &b) const
	Returns a read/write const reverse iterator that points to the first element of a box within a plane in the Matrix3d. It points to the bottom right element of the plane Iteration is done in backward element order. More...
three dimensionnal iterators : Global iterators
iterator3d	front_upper_left ()
	Returns a read/write iterator3d that points to the first element of the Matrix3d. It points to the front upper left element of the Matrix3d. More...
iterator3d	back_bottom_right ()
	Returns a read/write iterator3d that points to the past the end element of the Matrix3d. It points to past the end element of the back bottom right element of the Matrix3d. More...
const_iterator3d	front_upper_left () const
	Returns a read-only iterator3d that points to the first element of the Matrix3d. It points to the front upper left element of the Matrix3d. More...
const_iterator3d	back_bottom_right () const
	Returns a read-only iterator3d that points to the past the end element of the Matrix3d. It points to past the end element of the back bottom right element of the Matrix3d. More...
reverse_iterator3d	rfront_upper_left ()
	Returns a read/write reverse iterator3d. It points to the back bottom right element of the Matrix3d. Iteration is done within the Matrix3d in the reverse order. More...
reverse_iterator3d	rback_bottom_right ()
	Returns a read/write reverse iterator3d. It points to past the front upper left element of the Matrix3d. Iteration is done in the reverse order. More...
const_reverse_iterator3d	rfront_upper_left () const
	Returns a read only reverse iterator3d that points. It points to the back bottom right element of the Matrix3d. Iteration is done within the Matrix3d in the reverse order. More...
const_reverse_iterator3d	rback_bottom_right () const
	Returns a read only reverse iterator3d. It points to past the front upper left element of the Matrix3d. Iteration is done in the reverse order. More...
three dimensionnal iterators : Box iterators
iterator3d	front_upper_left (const Box3d< int > &box)
	Returns a read/write iterator3d that points to the first element of the Matrix3d. It points to the front upper left element of the Box3d associated to the Matrix3d. More...
iterator3d	back_bottom_right (const Box3d< int > &box)
	Returns a read/write iterator3d that points to the past the end element of the Matrix3d. It points to past the end element of the back bottom right element of the Box3d associated to the Matrix3d. More...
const_iterator3d	front_upper_left (const Box3d< int > &box) const
	Returns a read only iterator3d that points to the first element of the Matrix3d. It points to the front upper left element of the Box3d associated to the Matrix3d. More...
const_iterator3d	back_bottom_right (const Box3d< int > &box) const
	Returns a read only iterator3d that points to the past the end element of the Matrix3d. It points to past the end element of the back bottom right element of the Box3d associated to the Matrix3d. More...
reverse_iterator3d	rfront_upper_left (const Box3d< int > &box)
	Returns a read/write reverse iterator3d. It points to the back bottom right element of the Box3d associated to the Matrix3d. Iteration is done in the reverse order. More...
reverse_iterator3d	rback_bottom_right (const Box3d< int > &box)
	Returns a read/write reverse iterator3d. It points to one before the front upper left element of the Box3d box associated to the Matrix3d. More...
const_reverse_iterator3d	rfront_upper_left (const Box3d< int > &box) const
	Returns a read only reverse iterator3d. It points to the back bottom right element of the Box3d box associated to the Matrix3d. Iteration is done in the reverse order. More...
const_reverse_iterator3d	rback_bottom_right (const Box3d< int > &box) const
	Returns a read-only reverse iterator3d. It points to one before the front element of the bottom right element of the Box3d box associated to the Matrix3d. More...
three dimensionnal iterators : Range iterators
iterator3d_range	front_upper_left (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range)
	Returns a read/write iterator3d_range that points to the front upper left element of the ranges slice_range, row_range and col_range associated to the Matrix3d. More...
iterator3d_range	back_bottom_right (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range)
	Returns a read/write iterator3d_range that points to the past the end back bottom right element of the ranges slice_range, row_range and col_range associated to the Matrix3d. More...
const_iterator3d_range	front_upper_left (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range) const
	Returns a read-only iterator3d_range that points to the to the front upper left element of the ranges slice_range, row_range and col_range associated to the Matrix3d. More...
const_iterator3d_range	back_bottom_right (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range) const
	Returns a read-only iterator3d_range that points to the past the end back bottom right element of the ranges slice_range, row_range and col_range associated to the Matrix3d. More...
reverse_iterator3d_range	rfront_upper_left (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range)
	Returns a read/write reverse_iterator3d_range that points to the past the back bottom right element of the ranges row_range and col_range associated to the Matrix3d. Iteration is done in the reverse order. More...
reverse_iterator3d_range	rback_bottom_right (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range)
	Returns a read/write reverse_iterator3d_range that points to one before the front upper left element of the ranges row_range and col_range associated to the Matrix3d. Iteration is done in the reverse order. More...
const_reverse_iterator3d_range	rfront_upper_left (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range) const
	Returns a read-only reverse_iterator3d_range that points to the past the back bottom right element of the ranges row_range and col_range associated to the Matrix3d. Iteration is done in the reverse order. More...
const_reverse_iterator3d_range	rback_bottom_right (const Range< int > &slice_range, const Range< int > &row_range, const Range< int > &col_range) const
	Returns a read-only reverse_iterator3d_range that points to one before the front upper left element of the ranges row_range and col_range associated to the Matrix3d.Iteration is done in the reverse order. More...
Assignment operators and methods
self &	operator= (const Matrix3d< T > &rhs)
	Assign a Matrix3d. More...
self &	operator= (const T &value)
	Assign all the elments of the Matrix3d by value. More...
void	fill (const T &value)
	Fills the container range [begin(),begin()+size()) with copies of value. More...
void	fill (const T *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...
Element access operators
T **	operator[] (const size_type k)
	Subscript access to the slice datas contained in the GenericMultiComponent3d. More...
const T *const *	operator[] (const size_type k) const
	Subscript access to the slice datas contained in the GenericMultiComponent3d. More...
reference	operator() (const size_type k, const size_type i, const size_type j)
	Subscript access to the data contained in the Matrix3d. More...
const_reference	operator() (const size_type k, const size_type i, const size_type j) const
	Subscript access to the data contained in the Matrix3d. More...
Arithmetic operators
self &	operator+= (const T &val)
	Add val to each element of the Matrix. More...
self &	operator-= (const T &val)
self &	operator*= (const T &val)
self &	operator/= (const T &val)
self	operator- () const
self &	operator+= (const self &rhs)
self &	operator-= (const self &rhs)
self &	operator*= (const self &rhs)
self &	operator/= (const self &rhs)
Mathematic operators
T &	min () const
	Returns the min element of the Matrix according to the operator <. More...
T &	max () const
	Returns the max element of the Matrix according to the operator <. More...
T	sum () const
	Returns the sum of the elements of the Matrix. More...
Matrix3d< T > &	apply (T(*fun)(T))
	Applys the one-parameter C-function fun to each element of the Matrix3d. More...
Matrix3d< T > &	apply (T(*fun)(const T &))
	Applys the one-parameter C-function fun to each element of the Matrix3d. More...

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

Friends
class	boost::serialization::access
i/o operators
std::ostream &	operator<< (std::ostream &out, const self &a)
	Write the Matrix3d to the ouput stream. More...
Comparison operators
bool	operator== (const Matrix3d< T > &x, const Matrix3d< T > &y)
	Matrix3d equality comparison More...
bool	operator!= (const Matrix3d< T > &x, const Matrix3d< T > &y)
	Matrix3d inequality comparison More...
bool	operator< (const Matrix3d< T > &x, const Matrix3d< T > &y)
	Less than comparison operator (Matrix3d ordering relation) More...
bool	operator> (const Matrix3d< T > &x, const Matrix3d< T > &y)
	More than comparison operator. More...
bool	operator<= (const Matrix3d< T > &x, const Matrix3d< T > &y)
	Less than equal comparison operator. More...
bool	operator>= (const Matrix3d< T > &x, const Matrix3d< T > &y)
	More than equal comparison operator. More...

Related Functions
(Note that these are not member functions.)
template<typename T >
T &	min (const Matrix3d< T > &M1)
	Returns the min element of a Matrix3d. More...
template<typename T >
T &	max (const Matrix3d< T > &M1)
	Returns the max element of a Matrix3d. More...
template<typename T >
Matrix3d< T >	abs (const Matrix3d< T > &V)
	Returns the abs value of each element of the Matrix3d. More...
template<typename T >
Matrix3d< T >	sqrt (const Matrix3d< T > &V)
	Returns the sqrt value of each element of the Matrix3d. More...
template<typename T >
Matrix3d< T >	cos (const Matrix3d< T > &V)
	Returns the cos value of each element of the Matrix3d. More...
template<typename T >
Matrix3d< T >	acos (const Matrix3d< T > &V)
	Returns the acos value of each element of the Matrix3d. More...
template<typename T >
Matrix3d< T >	sin (const Matrix3d< T > &V)
	Returns the sin value of each element of the Matrix3d. More...
template<typename T >
Matrix3d< T >	asin (const Matrix3d< T > &V)
	Returns the sin value of each element of the Matrix3d. More...
template<typename T >
Matrix3d< T >	tan (const Matrix3d< T > &V)
	Returns the tan value of each element of the Matrix3d. More...
template<typename T >
Matrix3d< T >	atan (const Matrix3d< T > &V)
	Returns the atan value of each element of the Matrix3d. More...
template<typename T >
Matrix3d< T >	exp (const Matrix3d< T > &V)
	Returns the exp value of each element of the Matrix3d. More...
template<typename T >
Matrix3d< T >	log (const Matrix3d< T > &V)
	Returns the log value of each element of the Matrix3d. More...
template<typename T >
Matrix3d< T >	cosh (const Matrix3d< T > &V)
	Returns the cosh value of each element of the Matrix3d. More...
template<typename T >
Matrix3d< T >	sinh (const Matrix3d< T > &V)
	Returns the sinh value of each element of the Matrix3d. More...
template<typename T >
Matrix3d< T >	tanh (const Matrix3d< T > &V)
	Returns the tanh value of each element of the Matrix3d. More...
template<typename T >
Matrix3d< T >	log10 (const Matrix3d< T > &V)
	Returns the log10 value of each element of the Matrix3d. More...

Detailed Description

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

Numerical matrix3d class. This container statisfies the RandomAccessContainer concepts of the STL except the simple bracket which is replaced by a double bracket. It extends the interface of Array3d adding arithmetical: +=, -=, *=, /=,+,-,/,*... and mathematical operators : min, max, abs, sqrt, cos, acos, sin, asin, tan, atan, exp, log, cosh, sinh, tanh, log10, sum, apply...

Author

Benoit Tremblais <tremblais_AT_sic.univ-poitiers.fr>

Version

0.0.2

Date

2014/03/25

Since

1.0.0

Parameters

T	Type of object in the Matrix3d

Axis conventions:

axis and notation conventions

Definition at line 124 of file GenericMultiComponent3d.hpp.

Member Typedef Documentation

template<typename Block>

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

Definition at line 182 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 188 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 183 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 189 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 231 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 172 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 214 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 220 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 222 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 164 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 166 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 196 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 202 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 175 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 216 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 225 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 227 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 194 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 200 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 192 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 198 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 181 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 187 of file Matrix3d.hpp.

template<typename Block>

typedef const Matrix3d<T> slip::Matrix3d< Block >::const_self

Definition at line 161 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 179 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 185 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 230 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 168 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 171 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 213 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 219 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 221 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 163 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 165 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 195 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 201 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 174 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 215 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 224 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 226 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 193 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 199 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 191 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 197 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 180 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 186 of file Matrix3d.hpp.

template<typename Block>

typedef Matrix3d<T> slip::Matrix3d< Block >::self

Definition at line 160 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 169 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 178 of file Matrix3d.hpp.

template<typename Block>

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

Definition at line 184 of file Matrix3d.hpp.

template<typename Block>

typedef T slip::Matrix3d< Block >::value_type

Definition at line 159 of file Matrix3d.hpp.

Constructor & Destructor Documentation

template<typename T >

slip::Matrix3d< T >::Matrix3d ( )

inline

Constructs a Matrix3d.

Definition at line 3844 of file Matrix3d.hpp.

template<typename Block>

slip::Matrix3d< Block >::Matrix3d	(	const std::size_t	d1,
		const std::size_t	d2,
		const std::size_t	d3
	)

Constructs a Matrix3d.

Parameters

d1	first dimension of the Matrix3d
d2	second dimension of the Matrix3d
d3	third dimension of the Matrix3d

The Matrix3d is initialized by the default value of T.

template<typename Block>

slip::Matrix3d< Block >::Matrix3d	(	const std::size_t	d1,
		const std::size_t	d2,
		const std::size_t	d3,
		const T &	val
	)

Constructs a Matrix3d initialized by the scalar value val.

Parameters

d1	first dimension of the Matrix3d
d2	second dimension of the Matrix3d
d3	third dimension of the Matrix3d
val	initialization value of the elements

template<typename Block>

slip::Matrix3d< Block >::Matrix3d	(	const std::size_t	d1,
		const std::size_t	d2,
		const std::size_t	d3,
		const T *	val
	)

Constructs a Matrix3d initialized by an array val.

Parameters

d1	first dimension of the Matrix3d
d2	second dimension of the Matrix3d
d3	third dimension of the Matrix3d
val	initialization array value of the elements

template<typename Block>

template<typename InputIterator >

slip::Matrix3d< Block >::Matrix3d ( const size_type  d1, const size_type  d2, const size_type  d3, InputIterator  first, InputIterator  last  )

inline

Contructs a Matrix3d from a range.

Parameters

d1	first dimension of the Matrix3d
d2	second dimension of the Matrix3d
d3	third dimension of the Matrix3d
first	An input iterator.
last	An input iterator.

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

Definition at line 296 of file Matrix3d.hpp.

template<typename T >

slip::Matrix3d< T >::Matrix3d ( const Matrix3d< T > &  rhs )

inline

Constructs a copy of the Matrix3d rhs.

Definition at line 3877 of file Matrix3d.hpp.

template<typename T >

slip::Matrix3d< T >::~Matrix3d ( )

inline

Destructor of the Matrix3d.

Definition at line 3883 of file Matrix3d.hpp.

template<typename Block>

template<typename T >

slip::Matrix3d< Block >::Matrix3d ( const typename Matrix3d< T >::size_type  d1, const typename Matrix3d< T >::size_type  d2, const typename Matrix3d< T >::size_type  d3  )

inline

Definition at line 3850 of file Matrix3d.hpp.

template<typename Block>

template<typename T >

slip::Matrix3d< Block >::Matrix3d ( const typename Matrix3d< T >::size_type  d1, const typename Matrix3d< T >::size_type  d2, const typename Matrix3d< T >::size_type  d3, const T &  val  )

inline

Definition at line 3858 of file Matrix3d.hpp.

template<typename Block>

template<typename T >

slip::Matrix3d< Block >::Matrix3d ( const typename Matrix3d< T >::size_type  d1, const typename Matrix3d< T >::size_type  d2, const typename Matrix3d< T >::size_type  d3, const T *  val  )

inline

Definition at line 3867 of file Matrix3d.hpp.

Member Function Documentation

template<typename T >

Matrix3d< T > & slip::Matrix3d< T >::apply ( T(*)(T)  fun )

inline

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

Parameters

fun	The one-parameter C function

Returns

the resulting Matrix3d

Definition at line 5558 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > & slip::Matrix3d< T >::apply ( T(*)(const T &)  fun )

inline

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

Parameters

fun	The one-const-parameter C function

Returns

the resulting Matrix3d

Definition at line 5566 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::iterator3d slip::Matrix3d< T >::back_bottom_right ( )

inline

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

Returns

begin iterator3d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example

slip::Matrix3d<double> M(3,4,5);
//Print M
std::copy(M.front_upper_left(),M.back_bottom_right(),
          std::ostream_iterator<double>(std::cout," "));

Definition at line 5045 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::const_iterator3d slip::Matrix3d< T >::back_bottom_right ( ) const

inline

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

Returns

begin const iterator3d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example

slip::Matrix3d<double> const M(3,4,5);
//Print M
std::copy(M.front_upper_left(),M.back_bottom_right(),
          std::ostream_iterator<double>(std::cout," "));

Definition at line 5052 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::iterator3d slip::Matrix3d< T >::back_bottom_right ( const Box3d< int > &  box )

inline

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

Parameters

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

Returns

end iterator3d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Precondition

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

Example

slip::Matrix3d<double> M(3,4,5);
slip::Box3d<int> b(1,1,1,2,2,3);
//Print M within a box
std::copy(M.front_upper_left(b),M.back_bottom_right(b),
          std::ostream_iterator<double>(std::cout," "));

Definition at line 5113 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::const_iterator3d slip::Matrix3d< T >::back_bottom_right ( const Box3d< int > &  box ) const

inline

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

Parameters

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

Returns

end const iterator3d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Precondition

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

Example

slip::Matrix3d<double> const M(3,4,5);
slip::Box3d<int> b(1,1,1,2,2,4);
//Print M within a box
std::copy(M.front_upper_left(b),M.back_bottom_right(b),
          std::ostream_iterator<double>(std::cout," "));

Definition at line 5121 of file Matrix3d.hpp.

template<typename T >

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

inline

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

Parameters

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

Precondition

slice_range, row_range and col_range must be valid.

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

Returns

iterator3d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example

slip::Matrix3d<double> M(3,4,5);
slip::Range<int> sr(0,2,2);
slip::Range<int> rr(0,3,2);
slip::Range<int> cr(0,4,2);
//Print M within a range
std::copy(M.front_upper_left(sr,rr,cr),M.back_bottom_right(sr,rr,cr),
          std::ostream_iterator<double>(std::cout," "));

Definition at line 5176 of file Matrix3d.hpp.

template<typename T >

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

inline

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

Parameters

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

Precondition

slice_range, row_range and col_range must be valid.

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

Returns

const_iterator3d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example

slip::Matrix3d<double> const M(3,4,5);
slip::Range<int> sr(0,2,2);
slip::Range<int> rr(0,3,2);
slip::Range<int> cr(0,4,2);
//Print M within a range
std::copy(M.front_upper_left(sr,rr,cr),M.back_bottom_right(sr,rr,cr),
          std::ostream_iterator<double>(std::cout," "));

Definition at line 5199 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::const_iterator slip::Matrix3d< T >::begin ( ) const

inline

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

Returns

const begin iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

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

Definition at line 3953 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::iterator slip::Matrix3d< T >::begin ( )

inline

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

Returns

begin iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

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

Definition at line 3939 of file Matrix3d.hpp.

template<typename Block>

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

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

Parameters

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

Returns

begin col_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

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

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

Parameters

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

Returns

begin const_col_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

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

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

Parameters

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

Returns

begin col_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the Matrix3d.

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

Example:

 slip::Matrix3d<double> A1(8,8,8);
 slip::Matrix3d<double> A2(4,8,5);
 slip::Range<int> range(0,A1.dim2()-1,2);
//copy the the elements of the column 0 of the slice 0 of A1 iterated according to the
//range in the column 1 of the slice 1 of A2
std::copy(A1.col_begin(0,0,range),A1.col_end(0,0,range),A2.col_begin(1,1));

template<typename Block>

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

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

Parameters

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

Returns

begin const_col_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the Matrix3d.

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

Example:

 slip::Matrix3d<double> const A1(8,8,8);
 slip::Matrix3d<double> A2(4,8,5);
 slip::Range<int> range(0,A1.dim2()-1,2);
//copy the the elements of the column 0 of the slice 0 of A1 iterated according to the
//range in the column 1 of the slice 1 of A2
std::copy(A1.col_begin(0,0,range),A1.col_end(0,0,range),A2.col_begin(1,1));

template<typename Block>

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

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

Parameters

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

Returns

end col_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

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

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

Parameters

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

Returns

end const_col_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

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

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

Parameters

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

Returns

begin col_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the Matrix3d.

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

Example:

 slip::Matrix3d<double> A1(8,8,8);
 slip::Matrix3d<double> A2(4,8,5);
 slip::Range<int> range(0,A1.dim2()-1,2);
//copy the the elements of the column 0 of the slice 0 of A1 iterated according to the
//range in the column 1 of the slice 1 of A2
std::copy(A1.col_begin(0,0,range),A1.col_end(0,0,range),A2.col_begin(1,1));

template<typename Block>

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

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

Parameters

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

Returns

begin const_col_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the Matrix3d.

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

Example:

 slip::Matrix3d<double> const A1(8,8,8);
 slip::Matrix3d<double> A2(4,8,5);
 slip::Range<int> range(0,A1.dim2()-1,2);
//copy the the elements of the column 0 of the slice 0 of A1 iterated according to the
//range in the column 1 of the slice 1 of A2
std::copy(A1.col_begin(0,0,range),A1.col_end(0,0,range),A2.col_begin(1,1));

template<typename Block>

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

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

Parameters

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

Returns

begin reverse_col_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

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

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

Parameters

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

Returns

begin const_reverse_col_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

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

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

Parameters

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

Returns

begin reverse_col_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the Matrix3d.

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

template<typename Block>

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

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

Parameters

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

Returns

begin const_reverse_col_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the Matrix3d.

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

template<typename Block>

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

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

Parameters

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

Returns

end reverse_col_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

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

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

Parameters

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

Returns

end const_reverse_col_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

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

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

Parameters

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

Returns

reverse_col_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the Matrix3d.

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

template<typename Block>

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

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

Parameters

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

Returns

const_reverse_col_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

col must be compatible with the range of the Matrix3d.

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

template<typename T >

Matrix3d< T >::size_type slip::Matrix3d< T >::cols ( ) const

inline

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

Definition at line 5342 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::size_type slip::Matrix3d< T >::columns ( ) const

inline

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

Definition at line 5347 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::size_type slip::Matrix3d< T >::dim1 ( ) const

inline

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

Definition at line 5317 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::size_type slip::Matrix3d< T >::dim2 ( ) const

inline

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

Definition at line 5327 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::size_type slip::Matrix3d< T >::dim3 ( ) const

inline

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

Definition at line 5337 of file Matrix3d.hpp.

template<typename T >

bool slip::Matrix3d< T >::empty ( ) const

inline

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

Definition at line 5368 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::iterator slip::Matrix3d< T >::end ( )

inline

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

Returns

end iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

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

Definition at line 3946 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::const_iterator slip::Matrix3d< T >::end ( ) const

inline

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

Returns

const end iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

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

Definition at line 3961 of file Matrix3d.hpp.

template<typename Block>

void slip::Matrix3d< Block >::fill ( const T &  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 3197 of file Matrix3d.hpp.

template<typename Block>

void slip::Matrix3d< Block >::fill ( const T *  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 3208 of file Matrix3d.hpp.

template<typename Block>

template<typename InputIterator >

void slip::Matrix3d< 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 3222 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::iterator3d slip::Matrix3d< T >::front_upper_left ( )

inline

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

Returns

begin iterator3d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example

slip::Matrix3d<double> M(3,4,5);
//Print M
std::copy(M.front_upper_left(),M.back_bottom_right(),
          std::ostream_iterator<double>(std::cout," "));

Definition at line 5030 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::const_iterator3d slip::Matrix3d< T >::front_upper_left ( ) const

inline

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

Returns

begin const iterator3d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example

slip::Matrix3d<double> const M(3,4,5);
//Print M
std::copy(M.front_upper_left(),M.back_bottom_right(),
          std::ostream_iterator<double>(std::cout," "));

Definition at line 5037 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::iterator3d slip::Matrix3d< T >::front_upper_left ( const Box3d< int > &  box )

inline

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

Parameters

box	A Box3d defining the range of indices to iterate within the Matrix3d.

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Returns

end iterator3d value

Precondition

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

Example

slip::Matrix3d<double> M(3,4,5);
slip::Box3d<int> b(1,1,1,2,2,3);
//Print M within a box
std::copy(M.front_upper_left(b),M.back_bottom_right(b),
          std::ostream_iterator<double>(std::cout," "));

Definition at line 5096 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::const_iterator3d slip::Matrix3d< T >::front_upper_left ( const Box3d< int > &  box ) const

inline

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

Parameters

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

Returns

end const iterator3d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Precondition

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

Example

slip::Matrix3d<double> const M(3,4,5);
slip::Box3d<int> b(1,1,1,2,2,4);
//Print M within a box
std::copy(M.front_upper_left(b),M.back_bottom_right(b),
          std::ostream_iterator<double>(std::cout," "));

Definition at line 5103 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::iterator3d_range slip::Matrix3d< T >::front_upper_left ( const Range< int > &  slice_range, const Range< int > &  row_range, const Range< int > &  col_range  )

inline

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

Parameters

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

Precondition

slice_range, row_range and col_range must be valid.

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

Returns

iterator3d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example

slip::Matrix3d<double> M(3,4,5);
slip::Range<int> sr(0,2,2);
slip::Range<int> rr(0,3,2);
slip::Range<int> cr(0,4,2);
//Print M within a range
std::copy(M.front_upper_left(sr,rr,cr),M.back_bottom_right(sr,rr,cr),
          std::ostream_iterator<double>(std::cout," "));

Definition at line 5166 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::const_iterator3d_range slip::Matrix3d< T >::front_upper_left ( const Range< int > &  slice_range, const Range< int > &  row_range, const Range< int > &  col_range  ) const

inline

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

Parameters

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

Precondition

slice_range, row_range and col_range must be valid.

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

Returns

const_iterator3d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example

slip::Matrix3d<double> const M(3,4,5);
slip::Range<int> sr(0,2,2);
slip::Range<int> rr(0,3,2);
slip::Range<int> cr(0,4,2);
//Print M within a range
std::copy(M.front_upper_left(sr,rr,cr),M.back_bottom_right(sr,rr,cr),
          std::ostream_iterator<double>(std::cout," "));

Definition at line 5187 of file Matrix3d.hpp.

template<typename T >

T & slip::Matrix3d< T >::max ( ) const

inline

Returns the max element of the Matrix according to the operator <.

Precondition

size() != 0

Definition at line 5541 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::size_type slip::Matrix3d< T >::max_size ( ) const

inline

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

Definition at line 5358 of file Matrix3d.hpp.

template<typename T >

T & slip::Matrix3d< T >::min ( ) const

inline

Returns the min element of the Matrix according to the operator <.

Precondition

size() != 0

Definition at line 5533 of file Matrix3d.hpp.

template<typename T >

std::string slip::Matrix3d< T >::name ( ) const

inline

Returns the name of the class.

Definition at line 5311 of file Matrix3d.hpp.

template<typename Block>

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

Subscript access to the data contained in the Matrix3d.

Parameters

k	The index of the slice for which the data should be accessed.
i	The index of the row for which the data should be accessed.
j	The index of the column for which the data should be accessed.

Returns

Read/Write reference to data.

Precondition

k < slices()

i < rows()

j < cols() This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

template<typename Block>

const_reference slip::Matrix3d< Block >::operator()	(	const size_type	k,
		const size_type	i,
		const size_type	j
	)		const

Subscript access to the data contained in the Matrix3d.

Parameters

k	The index of the slice for which the data should be accessed.
i	The index of the row for which the data should be accessed.
j	The index of the column for which the data should be accessed.

Returns

Read_only (constant) reference to data.

Precondition

k < slices()

i < rows()

j < cols() This operator allows for easy, 3d array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined.

template<typename T >

Matrix3d< T > & slip::Matrix3d< T >::operator*= ( const T &  val )

inline

Definition at line 5463 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > & slip::Matrix3d< T >::operator*= ( const self &  rhs )

inline

Definition at line 5511 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > & slip::Matrix3d< T >::operator+= ( const T &  val )

inline

Add val to each element of the Matrix.

Parameters

val

value

Returns

reference to the resulting Matrix

Definition at line 5447 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > & slip::Matrix3d< T >::operator+= ( const self &  rhs )

inline

Definition at line 5488 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > slip::Matrix3d< T >::operator- ( ) const

inline

Definition at line 5479 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > & slip::Matrix3d< T >::operator-= ( const T &  val )

inline

Definition at line 5455 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > & slip::Matrix3d< T >::operator-= ( const self &  rhs )

inline

Definition at line 5500 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > & slip::Matrix3d< T >::operator/= ( const T &  val )

inline

Definition at line 5471 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > & slip::Matrix3d< T >::operator/= ( const self &  rhs )

inline

Definition at line 5522 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > & slip::Matrix3d< T >::operator= ( const Matrix3d< T > &  rhs )

inline

Assign a Matrix3d.

Assign elements of Matrix3d in rhs

Parameters

rhs	Matrix3d to get the values from.

Returns

Definition at line 3896 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > & slip::Matrix3d< T >::operator= ( const T &  value )

inline

Assign all the elments of the Matrix3d by value.

Parameters

value

A reference-to-const of arbitrary type.

Returns

Definition at line 3907 of file Matrix3d.hpp.

template<typename Block>

T** slip::Matrix3d< Block >::operator[]

(

const size_type

k

)

Subscript access to the slice datas contained in the GenericMultiComponent3d.

Parameters

k	The index of the slice for which data should be accessed.

Returns

Read/write pointer* to the slice data.

Precondition

k < slices()

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

template<typename Block>

const T* const* slip::Matrix3d< Block >::operator[]

(

const size_type

k

)

const

Subscript access to the slice datas contained in the GenericMultiComponent3d.

Parameters

k	The index of the slice for which data should be accessed.

Returns

Read-only pointer* to the slice data.

Precondition

k < slices()

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

template<typename Block>

iterator slip::Matrix3d< Block >::plane_begin

(

const size_type

slice

)

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

Parameters

slice

the slice coordinate of the plane

Returns

begin iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

slip::Matrix3d<double> A1(2,3,2);
slip::Matrix3d<double> A2(2,3,2);
//copy the first plane (in slice direction) of A1 in A2
std::copy(A1.plane_begin(0),A1.plane_end(0),A2.plane_begin(0));

template<typename Block>

const_iterator slip::Matrix3d< Block >::plane_begin

(

const size_type

slice

)

const

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

Parameters

slice

the slice coordinate of the plane

Returns

const begin iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

slip::Matrix3d<double> const A1(2,3,2);
slip::Matrix3d<double> A2(2,3,2);
//copy the first plane (in slice direction) of A1 in A2
std::copy(A1.plane_begin(0),A1.plane_end(0),A2.plane_begin(0));

template<typename Block>

iterator2d slip::Matrix3d< Block >::plane_bottom_right	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate
	)

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

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate

Returns

begin iterator2d value

Precondition

P must be 0,1 or 2

Remarks

This iterator is compatible with BidirectionnalAccessIterator algorithms.

This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example:

slip::Matrix3d<double> M(3,4,5);
//Print the 2nd plane of M in the KI_PLANE direction
std::copy(M.plane_upper_left(slip::KI_PLANE,2),M.plane_bottom_right(
          slip::KI_PLANE,2),std::ostream_iterator<double>(std::cout," "));

template<typename Block>

const_iterator2d slip::Matrix3d< Block >::plane_bottom_right	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate
	)		const

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

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate

Returns

begin const_iterator2d value

Precondition

P must be 0,1 or 2

Remarks

This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example:

slip::Matrix3d<double> const M(3,4,5);
//Print the 2nd plane of M in the KI_PLANE direction
std::copy(M.plane_upper_left(slip::KI_PLANE,2),M.plane_bottom_right(
          slip::KI_PLANE,2),std::ostream_iterator<double>(std::cout," "));

template<typename T >

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

inline

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

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate
b	The box within the plane

Returns

begin iterator2d value

Precondition

P must be 0,1 or 2

b must be within the plane

Remarks

This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example

slip::Matrix3d<double> M(3,4,5);
slip::Box2d<int> b(1,1,3,3);
//Print the 2nd plane of M in the KI_PLANE direction within a box
std::copy(M.plane_upper_left(slip::KI_PLANE,2,b),M.plane_bottom_right(
          slip::KI_PLANE,2,b),std::ostream_iterator<double>(std::cout," "));

Definition at line 4964 of file Matrix3d.hpp.

template<typename T >

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

inline

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

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate
b	The box within the plane

Returns

begin const_iterator2d value

Precondition

P must be 0,1 or 2

b must be within the plane

Remarks

This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example

slip::Matrix3d<double> const M(3,4,5);
slip::Box2d<int> b(1,1,3,3);
//Print the 2nd plane of M in the KI_PLANE direction within a box
std::copy(M.plane_upper_left(slip::KI_PLANE,2,b),M.plane_bottom_right(
          slip::KI_PLANE,2,b),std::ostream_iterator<double>(std::cout," "));

Definition at line 4981 of file Matrix3d.hpp.

template<typename Block>

iterator slip::Matrix3d< Block >::plane_end

(

const size_type

slice

)

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

Parameters

slice

the slice coordinate of the plane

Returns

end iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

slip::Matrix3d<double> A1(2,3,2);
slip::Matrix3d<double> A2(2,3,2);
//copy the first plane (in slice direction) of A1 in A2
std::copy(A1.plane_begin(0),A1.plane_end(0),A2.plane_begin(0));

template<typename Block>

const_iterator slip::Matrix3d< Block >::plane_end

(

const size_type

slice

)

const

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

Parameters

slice

the slice coordinate of the plane

Returns

const end iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

slip::Matrix3d<double> const A1(2,3,2);
slip::Matrix3d<double> A2(2,3,2);
//copy the first plane (in slice direction) of A1 in A2
std::copy(A1.plane_begin(0),A1.plane_end(0),A2.plane_begin(0));

template<typename Block>

reverse_iterator slip::Matrix3d< Block >::plane_rbegin

(

const size_type

slice

)

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

Parameters

slice

the slice coordinate of the plane

Returns

reverse begin iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

slip::Matrix3d<double> A1(2,3,2);
slip::Matrix3d<double> A2(2,3,2);
//copy the first plane (in slice direction) of A1 in A2 in reverse order
std::copy(A1.plane_rbegin(0),A1.plane_rend(0),A2.plane_begin(0));

template<typename Block>

const_reverse_iterator slip::Matrix3d< Block >::plane_rbegin

(

const size_type

slice

)

const

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

Parameters

slice

the slice coordinate of the plane

Returns

const reverse begin iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

slip::Matrix3d<double> const A1(2,3,2);
slip::Matrix3d<double> A2(2,3,2);
//copy the first plane (in slice direction) of A1 in A2 in reverse order
std::copy(A1.plane_rbegin(0),A1.plane_rend(0),A2.plane_begin(0));

template<typename Block>

reverse_iterator2d slip::Matrix3d< Block >::plane_rbottom_right	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate
	)

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

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate

Returns

begin iterator2d value

Precondition

P must be 0,1 or 2

Remarks

This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example :

slip::Matrix3d<double> M(3,4,5);
//Print the 2nd plane of M in the KI_PLANE direction in reverse order
std::copy(M.plane_rupper_left(slip::KI_PLANE,2),M.plane_rbottom_right(
          slip::KI_PLANE,2),std::ostream_iterator<double>(std::cout," "));

template<typename Block>

const_reverse_iterator2d slip::Matrix3d< Block >::plane_rbottom_right	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate
	)		const

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

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate

Returns

begin const_iterator2d value

Precondition

P must be 0,1 or 2

Remarks

This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example

slip::Matrix3d<double> const M(3,4,5);
//Print the 2nd plane of M in the KI_PLANE direction in reverse order
std::copy(M.plane_rupper_left(slip::KI_PLANE,2),M.plane_rbottom_right(
          slip::KI_PLANE,2),std::ostream_iterator<double>(std::cout," "));

template<typename T >

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

inline

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

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate
b	The box within the plane

Returns

begin reverse_iterator2d value

Precondition

P must be 0,1 or 2

b must be within the plane

Remarks

This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example

slip::Matrix3d<double> M(3,4,5);
slip::Box2d<int> b(1,1,3,3);
//Print the 2nd plane of M in the KI_PLANE direction within a box in a reverse order
std::copy(M.plane_rupper_left(slip::KI_PLANE,2,b),M.plane_rbottom_right(
          slip::KI_PLANE,2,b),std::ostream_iterator<double>(std::cout," "));

Definition at line 4998 of file Matrix3d.hpp.

template<typename T >

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

inline

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

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate
b	The box within the plane

Returns

begin const_reverse_iterator2d value

Precondition

P must be 0,1 or 2

b must be within the plane

Remarks

This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example

slip::Matrix3d<double> const M(3,4,5);
slip::Box2d<int> b(1,1,3,3);
//Print the 2nd plane of M in the KI_PLANE direction within a box in a reverse order
std::copy(M.plane_rupper_left(slip::KI_PLANE,2,b),M.plane_rbottom_right(
          slip::KI_PLANE,2,b),std::ostream_iterator<double>(std::cout," "));

Definition at line 5015 of file Matrix3d.hpp.

template<typename Block>

reverse_iterator slip::Matrix3d< Block >::plane_rend

(

const size_type

slice

)

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

Parameters

slice

the slice coordinate of the plane

Returns

reverse end iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

slip::Matrix3d<double> A1(2,3,2);
slip::Matrix3d<double> A2(2,3,2);
//copy the first plane (in slice direction) of A1 in A2 in reverse order
std::copy(A1.plane_rbegin(0),A1.plane_rend(0),A2.plane_begin(0));

template<typename Block>

const_reverse_iterator slip::Matrix3d< Block >::plane_rend

(

const size_type

slice

)

const

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

Parameters

slice

the slice coordinate of the plane

Returns

const reverse end iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

slip::Matrix3d<double> const A1(2,3,2);
slip::Matrix3d<double> A2(2,3,2);
//copy the first plane (in slice direction) of A1 in A2 in reverse order
std::copy(A1.plane_rbegin(0),A1.plane_rend(0),A2.plane_begin(0));

template<typename Block>

reverse_iterator2d slip::Matrix3d< Block >::plane_rupper_left	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate
	)

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

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate

Returns

begin iterator2d value

Precondition

P must be 0,1 or 2

Remarks

This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example:

slip::Matrix3d<double> M(3,4,5);
//Print the 2nd plane of M in the KI_PLANE direction in reverse order
std::copy(M.plane_rupper_left(slip::KI_PLANE,2),M.plane_rbottom_right(
          slip::KI_PLANE,2),std::ostream_iterator<double>(std::cout," "));

template<typename Block>

const_reverse_iterator2d slip::Matrix3d< Block >::plane_rupper_left	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate
	)		const

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

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate

Returns

begin const_iterator2d value

Precondition

P must be 0,1 or 2

Remarks

This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example :

slip::Matrix3d<double> const M(3,4,5);
//Print the 2nd plane of M in the KI_PLANE direction in reverse order
std::copy(M.plane_rupper_left(slip::KI_PLANE,2),M.plane_rbottom_right(
          slip::KI_PLANE,2),std::ostream_iterator<double>(std::cout," "));

template<typename T >

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

inline

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

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate
b	The box within the plane

Returns

begin reverse_iterator2d value

Precondition

P must be 0,1 or 2

b must be within the plane

Remarks

This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example

slip::Matrix3d<double> M(3,4,5);
slip::Box2d<int> b(1,1,3,3);
//Print the 2nd plane of M in the KI_PLANE direction within a box in a reverse order
std::copy(M.plane_rupper_left(slip::KI_PLANE,2,b),M.plane_rbottom_right(
          slip::KI_PLANE,2,b),std::ostream_iterator<double>(std::cout," "));

Definition at line 4990 of file Matrix3d.hpp.

template<typename T >

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

inline

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

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate
b	The box within the plane

Returns

begin const_reverse_iterator2d value

Precondition

P must be 0,1 or 2

b must be within the plane

Remarks

This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example

slip::Matrix3d<double> const M(3,4,5);
slip::Box2d<int> b(1,1,3,3);
//Print the 2nd plane of M in the KI_PLANE direction within a box in a reverse order
std::copy(M.plane_rupper_left(slip::KI_PLANE,2,b),M.plane_rbottom_right(
          slip::KI_PLANE,2,b),std::ostream_iterator<double>(std::cout," "));

Definition at line 5006 of file Matrix3d.hpp.

template<typename Block>

iterator2d slip::Matrix3d< Block >::plane_upper_left	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate
	)

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

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate

Returns

begin iterator2d value

Precondition

P must be 0,1 or 2

Remarks

This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example:

slip::Matrix3d<double> M(3,4,5);
//Print the 2nd plane of M in the KI_PLANE direction
std::copy(M.plane_upper_left(slip::KI_PLANE,2),M.plane_bottom_right(
          slip::KI_PLANE,2),std::ostream_iterator<double>(std::cout," "));

template<typename Block>

const_iterator2d slip::Matrix3d< Block >::plane_upper_left	(	PLANE_ORIENTATION	P,
		const size_type	plane_coordinate
	)		const

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

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate

Returns

begin const_iterator2d value

Precondition

P must be 0,1 or 2

Remarks

This iterator is compatible with BidirectionnalAccessIterator algorithms.

This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example:

slip::Matrix3d<double> const M(3,4,5);
//Print the 2nd plane of M in the KI_PLANE direction
std::copy(M.plane_upper_left(slip::KI_PLANE,2),M.plane_bottom_right(
          slip::KI_PLANE,2),std::ostream_iterator<double>(std::cout," "));

template<typename T >

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

inline

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

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate
b	The box within the plane

Returns

begin iterator2d value

Precondition

P must be 0,1 or 2

b must be within the plane

Remarks

This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example

slip::Matrix3d<double> M(3,4,5);
slip::Box2d<int> b(1,1,3,3);
//Print the 2nd plane of M in the KI_PLANE direction within a box
std::copy(M.plane_upper_left(slip::KI_PLANE,2,b),M.plane_bottom_right(
          slip::KI_PLANE,2,b),std::ostream_iterator<double>(std::cout," "));

Definition at line 4956 of file Matrix3d.hpp.

template<typename T >

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

inline

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

Parameters

P	number of the plane axe (PLANE_ORIENTATION).
plane_coordinate	The constant coordinate
b	The box within the plane

Returns

begin const_iterator2d value

Precondition

P must be 0,1 or 2

b must be within the plane

Remarks

This iterator is compatible with BidirectionnalAccessIterator algorithms.

Example

slip::Matrix3d<double> const M(3,4,5);
slip::Box2d<int> b(1,1,3,3);
//Print the 2nd plane of M in the KI_PLANE direction within a box
std::copy(M.plane_upper_left(slip::KI_PLANE,2,b),M.plane_bottom_right(
          slip::KI_PLANE,2,b),std::ostream_iterator<double>(std::cout," "));

Definition at line 4972 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::reverse_iterator3d slip::Matrix3d< T >::rback_bottom_right ( )

inline

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

Returns

reverse iterator3d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example

slip::Matrix3d<double> M(3,4,5);
//Print M in a reverse order
std::copy(M.rfront_upper_left(),M.rback_bottom_right(),
          std::ostream_iterator<double>(std::cout," "));

Definition at line 5061 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::const_reverse_iterator3d slip::Matrix3d< T >::rback_bottom_right ( ) const

inline

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

Returns

const reverse iterator3d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example

slip::Matrix3d<double> const M(3,4,5);
//Print M in a reverse order
std::copy(M.rfront_upper_left(),M.rback_bottom_right(),
          std::ostream_iterator<double>(std::cout," "));

Definition at line 5069 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::reverse_iterator3d slip::Matrix3d< T >::rback_bottom_right ( const Box3d< int > &  box )

inline

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

Parameters

box	A Box3d defining the range of indices to iterate within the Matrix3d.

Precondition

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

Returns

reverse iterator3d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 5130 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::const_reverse_iterator3d slip::Matrix3d< T >::rback_bottom_right ( const Box3d< int > &  box ) const

inline

Returns a read-only reverse iterator3d. It points to one before the front element of the bottom right element of the Box3d box associated to the Matrix3d.

Parameters

box	A Box3d defining the range of indices to iterate within the Matrix3d.

Precondition

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

Returns

const reverse iterator3d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 5138 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::reverse_iterator3d_range slip::Matrix3d< T >::rback_bottom_right ( const Range< int > &  slice_range, const Range< int > &  row_range, const Range< int > &  col_range  )

inline

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

Parameters

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

Precondition

slice_range, row_range and col_range must be valid.

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

Returns

reverse_iterator3d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example

slip::Matrix3d<double> M(3,4,5);
slip::Range<int> sr(0,2,2);
slip::Range<int> rr(0,3,2);
slip::Range<int> cr(0,4,2);
//Print M within a range in reverse order
std::copy(M.rfront_upper_left(sr,rr,cr),M.rback_bottom_right(sr,rr,cr),
          std::ostream_iterator<double>(std::cout," "));

Definition at line 5231 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::const_reverse_iterator3d_range slip::Matrix3d< T >::rback_bottom_right ( const Range< int > &  slice_range, const Range< int > &  row_range, const Range< int > &  col_range  ) const

inline

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

Parameters

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

Precondition

slice_range, row_range and col_range must be valid.

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

Returns

const_reverse_iterator3d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example

slip::Matrix3d<double> const M(3,4,5);
slip::Range<int> sr(0,2,2);
slip::Range<int> rr(0,3,2);
slip::Range<int> cr(0,4,2);
//Print M within a range in reverse order
std::copy(M.rfront_upper_left(sr,rr,cr),M.rback_bottom_right(sr,rr,cr),
          std::ostream_iterator<double>(std::cout," "));

Definition at line 5241 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::reverse_iterator slip::Matrix3d< T >::rbegin ( )

inline

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

Returns

reverse begin iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

 slip::Matrix3d<double> A1(10,9,5);
 slip::Matrix3d<double> A2(10,9,5);
 slip::Matrix3d<double> S(10,9,5);
//copy the sum of A1 and A2 in S
std::transform(A1.rbegin(),A1.rend(),
               A2.rbegin(),S.rbegin(),
               std::plus<double>());

Definition at line 3970 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::const_reverse_iterator slip::Matrix3d< T >::rbegin ( ) const

inline

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

Returns

const reverse begin iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

 slip::Matrix3d<double> const A1(10,9,5);
 slip::Matrix3d<double> const A2(10,9,5);
 slip::Matrix3d<double> S(10,9,5);
//copy the sum of A1 and A2 in S
std::transform(A1.rbegin(),A1.rend(),
               A2.rbegin(),S.rbegin(),
               std::plus<double>());

Definition at line 3984 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::reverse_iterator slip::Matrix3d< T >::rend ( )

inline

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

Returns

reverse end iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

 slip::Matrix3d<double> A1(10,9,5);
 slip::Matrix3d<double> A2(10,9,5);
 slip::Matrix3d<double> S(10,9,5);
//copy the sum of A1 and A2 in S
std::transform(A1.rbegin(),A1.rend(),
               A2.rbegin(),S.rbegin(),
               std::plus<double>());

Definition at line 3977 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::const_reverse_iterator slip::Matrix3d< T >::rend ( ) const

inline

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

Returns

const reverse end iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

 slip::Matrix3d<double> const A1(10,9,5);
 slip::Matrix3d<double> const A2(10,9,5);
 slip::Matrix3d<double> S(10,9,5);
//copy the sum of A1 and A2 in S
std::transform(A1.rbegin(),A1.rend(),
               A2.rbegin(),S.rbegin(),
               std::plus<double>());

Definition at line 3991 of file Matrix3d.hpp.

template<typename Block>

void slip::Matrix3d< T >::resize ( std::size_t  d1, std::size_t  d2, std::size_t  d3, const T &  val = T()  )

inline

Resizes a Matrix3d.

Parameters

d1	new first dimension
d2	new second dimension
d3	new third dimension
val	new value for all the elements

Definition at line 3915 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::reverse_iterator3d slip::Matrix3d< T >::rfront_upper_left ( )

inline

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

Returns

reverse_iterator3d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example

slip::Matrix3d<double> M(3,4,5);
//Print M in a reverse order
std::copy(M.rfront_upper_left(),M.rback_bottom_right(),
          std::ostream_iterator<double>(std::cout," "));

Definition at line 5078 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::const_reverse_iterator3d slip::Matrix3d< T >::rfront_upper_left ( ) const

inline

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

Returns

const_reverse_iterator3d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example

slip::Matrix3d<double> const M(3,4,5);
//Print M in a reverse order
std::copy(M.rfront_upper_left(),M.rback_bottom_right(),
          std::ostream_iterator<double>(std::cout," "));

Definition at line 5086 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::reverse_iterator3d slip::Matrix3d< T >::rfront_upper_left ( const Box3d< int > &  box )

inline

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

Parameters

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

Precondition

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

Returns

reverse iterator3d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 5147 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::const_reverse_iterator3d slip::Matrix3d< T >::rfront_upper_left ( const Box3d< int > &  box ) const

inline

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

Parameters

box	A Box3d defining the range of indices to iterate within the Matrix3d.

Precondition

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

Returns

const reverse iterator3d value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Definition at line 5155 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::reverse_iterator3d_range slip::Matrix3d< T >::rfront_upper_left ( const Range< int > &  slice_range, const Range< int > &  row_range, const Range< int > &  col_range  )

inline

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

Parameters

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

Precondition

slice_range, row_range and col_range must be valid.

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

Returns

reverse_iterator3d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example

slip::Matrix3d<double> M(3,4,5);
slip::Range<int> sr(0,2,2);
slip::Range<int> rr(0,3,2);
slip::Range<int> cr(0,4,2);
//Print M within a range in reverse order
std::copy(M.rfront_upper_left(sr,rr,cr),M.rback_bottom_right(sr,rr,cr),
          std::ostream_iterator<double>(std::cout," "));

Definition at line 5210 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::const_reverse_iterator3d_range slip::Matrix3d< T >::rfront_upper_left ( const Range< int > &  slice_range, const Range< int > &  row_range, const Range< int > &  col_range  ) const

inline

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

Parameters

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

Precondition

slice_range, row_range and col_range must be valid.

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

Returns

const_reverse_iterator3d_range value

Remarks

This iterator is compatible with BidirectionalIterator algorithms.

Example

slip::Matrix3d<double> const M(3,4,5);
slip::Range<int> sr(0,2,2);
slip::Range<int> rr(0,3,2);
slip::Range<int> cr(0,4,2);
//Print M within a range in reverse order
std::copy(M.rfront_upper_left(sr,rr,cr),M.rback_bottom_right(sr,rr,cr),
          std::ostream_iterator<double>(std::cout," "));

Definition at line 5220 of file Matrix3d.hpp.

template<typename Block>

row_iterator slip::Matrix3d< Block >::row_begin	(	const size_type	slice,
		const size_type	row
	)

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

Parameters

slice	The index of the slice.
row	The index of the row.

Returns

begin row_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

const_row_iterator slip::Matrix3d< Block >::row_begin	(	const size_type	slice,
		const size_type	row
	)		const

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

Parameters

slice	The index of the slice.
row	The index of the row.

Returns

begin const_row_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

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

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

Parameters

slice	The index of the slice.
row	The index of the row to iterate.
range	Range of the row to iterate.

Returns

begin row_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the Matrix3d.

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

Example:

 slip::Matrix3d<double> A1(8,8,8);
 slip::Matrix3d<double> A2(8,4,5);
 slip::Range<int> range(0,A1.dim3()-1,2);
//copy the the elements of the row 0 of the slice 0 of A1 iterated according to the
//range in the row 1 of the slice 1 of A2
std::copy(A1.row_begin(0,0,range),A1.row_end(0,0,range),A2.row_begin(1,1));

template<typename Block>

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

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

Parameters

slice	The index of the slice.
row	The index of the row to iterate.
range	Range of the row to iterate.

Returns

begin const_row_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the Matrix3d.

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

Example:

 slip::Matrix3d<double> const A1(8,8,8);
 slip::Matrix3d<double> A2(8,4,5);
 slip::Range<int> range(0,A1.dim3()-1,2);
//copy the the elements of the row 0 of the slice 0 of A1 iterated according to the
//range in the row 1 of the slice 1 of A2
std::copy(A1.row_begin(0,0,range),A1.row_end(0,0,range),A2.row_begin(1,1));

template<typename Block>

row_iterator slip::Matrix3d< Block >::row_end	(	const size_type	slice,
		const size_type	row
	)

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

Parameters

slice	The index of the slice.
row	The index of the row.

Returns

end row_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

const_row_iterator slip::Matrix3d< Block >::row_end	(	const size_type	slice,
		const size_type	row
	)		const

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

Parameters

slice	The index of the slice.
row	The index of the row.

Returns

end const_row_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

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

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

Parameters

slice	The index of the slice.
row	The index of the row to iterate.
range	Range of the row to iterate.

Returns

end row_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the Matrix3d.

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

Example:

 slip::Matrix3d<double> A1(8,8,8);
 slip::Matrix3d<double> A2(8,4,5);
 slip::Range<int> range(0,A1.dim3()-1,2);
//copy the the elements of the row 0 of the slice 0 of A1 iterated according to the
//range in the row 1 of the slice 1 of A2
std::copy(A1.row_begin(0,0,range),A1.row_end(0,0,range),A2.row_begin(1,1));

template<typename Block>

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

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

Parameters

slice	The index of the slice.
row	Row to iterate.
range	Range of the row to iterate

Returns

begin const_row_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the Matrix3d.

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

Example:

 slip::Matrix3d<double> const A1(8,8,8);
 slip::Matrix3d<double> A2(8,4,5);
 slip::Range<int> range(0,A1.dim3()-1,2);
//copy the the elements of the row 0 of the slice 0 of A1 iterated according to the
//range in the row 1 of the slice 1 of A2
std::copy(A1.row_begin(0,0,range),A1.row_end(0,0,range),A2.row_begin(1,1));

template<typename Block>

reverse_row_iterator slip::Matrix3d< Block >::row_rbegin	(	const size_type	slice,
		const size_type	row
	)

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

Parameters

slice	The index of the slice.
row	The index of the row.

Returns

begin reverse_row_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

const_reverse_row_iterator slip::Matrix3d< Block >::row_rbegin	(	const size_type	slice,
		const size_type	row
	)		const

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

Parameters

slice	The index of the slice.
row	The index of the row.

Returns

begin const_reverse_row_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

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

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

Parameters

slice	The index of the slice.
row	The index of the row to iterate.
range	Range of the row to iterate.

Returns

reverse_row_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the Matrix3d.

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

template<typename Block>

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

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

Parameters

slice	The index of the slice.
row	The index of the row to iterate.
range	Range of the row to iterate

Returns

begin const_reverse_row_range_iterator value

Precondition

row must be compatible with the range of the Matrix3d.

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

template<typename Block>

reverse_row_iterator slip::Matrix3d< Block >::row_rend	(	const size_type	slice,
		const size_type	row
	)

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

Parameters

slice	The index of the slice.
row	The index of the row.

Returns

end reverse_row_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

const_reverse_row_iterator slip::Matrix3d< Block >::row_rend	(	const size_type	slice,
		const size_type	row
	)		const

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

Parameters

slice	The index of the slice.
row	The index of the row.

Returns

end const_reverse_row_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

template<typename Block>

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

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

Parameters

slice	The index of the slice.
row	The index of the row to iterate.
range	Range of the row to iterate.

Returns

reverse_row_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the Matrix3d.

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

template<typename Block>

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

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

Parameters

slice	The index of the slice.
row	The index of the row to iterate.
range	Range of the row to iterate

Returns

const_reverse_row_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

row must be compatible with the range of the Matrix3d.

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

template<typename T >

Matrix3d< T >::size_type slip::Matrix3d< T >::rows ( ) const

inline

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

Definition at line 5332 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::size_type slip::Matrix3d< T >::size ( ) const

inline

Returns the number of elements in the Matrix3d.

Definition at line 5353 of file Matrix3d.hpp.

template<typename Block>

slice_iterator slip::Matrix3d< Block >::slice_begin	(	const size_type	row,
		const size_type	col
	)

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

Parameters

row	row coordinate of the line
col	col coordinate of the line

Returns

slice_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

slip::Matrix3d<double> A1(10,9,5);
slip::Matrix3d<double> A2(10,9,5);
slip::Matrix3d<double> S(10,9,5);
//copy the sum of the first slice of A1 and A2 in the first slice of S
std::transform(A1.begin_slice(0),A1.end_slice(0),
              A2.begin_slice(0),S.begin_slice(0),
              std::plus<double>());

template<typename Block>

const_slice_iterator slip::Matrix3d< Block >::slice_begin	(	const size_type	row,
		const size_type	col
	)		const

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

Parameters

row	row coordinate of the line
col	col coordinate of the line

Returns

const_slice_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

slip::Matrix3d<double> const A1(10,9,5);
slip::Matrix3d<double> const A2(10,9,5);
slip::Matrix3d<double> S(10,9,5);
//copy the sum of the first slice of A1 and A2 in the first slice of S
std::transform(A1.begin_slice(0),A1.end_slice(0),
              A2.begin_slice(0),S.begin_slice(0),
              std::plus<double>());

template<typename Block>

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

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

Parameters

row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns

begin slice_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

the range must be compatible with the slice dimensions

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

Example:

 slip::Matrix3d<double> A1(8,8,8);
 slip::Matrix3d<double> A2(4,8,8);
 slip::Range<int> range(0,A1.dim1()-1,2);
//copy the the elements of the line (0,0) of A1 iterated according to the
//range in the line (1,1) of A2
std::copy(A1.slice_begin(0,0,range),A1.slice_end(0,0,range),A2.slice_begin(1,1));

template<typename Block>

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

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

Parameters

row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns

begin const_slice_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

the range must be compatible with the slice dimensions

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

Example:

 slip::Matrix3d<double> const A1(M); //M is an already existing %Matrix3d
 slip::Range<int> range(0,A1.dim1()-1,2);
//display the elements of the line (0,0) of A1 iterated according to the range
std::copy(A1.slice_begin(0,0,range),A1.slice_end(0,0,range),
std::ostream_iterator<double>(std::cout," "));

template<typename Block>

slice_iterator slip::Matrix3d< Block >::slice_end	(	const size_type	row,
		const size_type	col
	)

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

Parameters

row	row coordinate of the line
col	col coordinate of the line

Returns

slice_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

slip::Matrix3d<double> A1(10,9,5);
slip::Matrix3d<double> A2(10,9,5);
slip::Matrix3d<double> S(10,9,5);
//copy the sum of the first slice of A1 and A2 in the first slice of S
std::transform(A1.begin_slice(0),A1.end_slice(0),
              A2.begin_slice(0),S.begin_slice(0),
              std::plus<double>());

template<typename Block>

const_slice_iterator slip::Matrix3d< Block >::slice_end	(	const size_type	row,
		const size_type	col
	)		const

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

Parameters

row	row coordinate of the line
col	col coordinate of the line

Returns

const_slice_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

slip::Matrix3d<double> const A1(10,9,5);
slip::Matrix3d<double> const A2(10,9,5);
slip::Matrix3d<double> S(10,9,5);
//copy the sum of the first slice of A1 and A2 in the first slice of S
std::transform(A1.begin_slice(0),A1.end_slice(0),
              A2.begin_slice(0),S.begin_slice(0),
              std::plus<double>());

template<typename Block>

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

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

Parameters

row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns

end slice_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

the range must be compatible with the slice dimensions

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

Example:

 slip::Matrix3d<double> A1(8,8,8);
 slip::Matrix3d<double> A2(4,8,8);
 slip::Range<int> range(0,A1.dim1()-1,2);
//copy the the elements of the line (0,0) of A1 iterated according to the
//range in the line (1,1) of A2
std::copy(A1.slice_begin(0,0,range),A1.slice_end(0,0,range),A2.slice_begin(1,1));

template<typename Block>

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

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

Parameters

row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns

end const_slice_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

the range must be compatible with the slice dimensions

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

Example:

 slip::Matrix3d<double> const A1(M); //M is an already existing %Matrix3d
 slip::Range<int> range(0,A1.dim1()-1,2);
//display the elements of the line (0,0) of A1 iterated according to the range
std::copy(A1.slice_begin(0,0,range),A1.slice_end(0,0,range),
std::ostream_iterator<double>(std::cout," "));

template<typename Block>

reverse_slice_iterator slip::Matrix3d< Block >::slice_rbegin	(	const size_type	row,
		const size_type	col
	)

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

Parameters

row	row coordinate of the line
col	col coordinate of the line

Returns

reverse_slice_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

slip::Matrix3d<double> A1(10,9,5);
slip::Matrix3d<double> A2(10,9,5);
slip::Matrix3d<double> S(10,9,5);
//copy the sum of the first slice of A1 and A2 
in the first slice of S in reverse order
std::transform(A1.rbegin_slice(0),A1.rend_slice(0),
              A2.rbegin_slice(0),S.begin_slice(0),
              std::plus<double>());

template<typename Block>

const_reverse_slice_iterator slip::Matrix3d< Block >::slice_rbegin	(	const size_type	row,
		const size_type	col
	)		const

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

Parameters

row	row coordinate of the line
col	col coordinate of the line

Returns

const_reverse_slice_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

slip::Matrix3d<double> const A1(10,9,5);
slip::Matrix3d<double> const A2(10,9,5);
slip::Matrix3d<double> S(10,9,5);
//copy the sum of the first slice of A1 and A2 
in the first slice of S in reverse order
std::transform(A1.rbegin_slice(0),A1.rend_slice(0),
              A2.rbegin_slice(0),S.begin_slice(0),
              std::plus<double>());

template<typename Block>

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

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

Parameters

row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns

begin reverse_slice_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

the range must be compatible with the slice dimensions

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

template<typename Block>

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

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

Parameters

row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns

begin const_reverse_slice_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

the range must be compatible with the slice dimensions

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

template<typename Block>

reverse_slice_iterator slip::Matrix3d< Block >::slice_rend	(	const size_type	row,
		const size_type	col
	)

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

Parameters

row	row coordinate of the line
col	col coordinate of the line

Returns

reverse_slice_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

slip::Matrix3d<double> A1(10,9,5);
slip::Matrix3d<double> A2(10,9,5);
slip::Matrix3d<double> S(10,9,5);
//copy the sum of the first slice of A1 and A2 
in the first slice of S in reverse order
std::transform(A1.rbegin_slice(0),A1.rend_slice(0),
              A2.rbegin_slice(0),S.begin_slice(0),
              std::plus<double>());

template<typename Block>

const_reverse_slice_iterator slip::Matrix3d< Block >::slice_rend	(	const size_type	row,
		const size_type	col
	)		const

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

Parameters

row	row coordinate of the line
col	col coordinate of the line

Returns

const_reverse_slice_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Example:

slip::Matrix3d<double> const A1(10,9,5);
slip::Matrix3d<double> const A2(10,9,5);
slip::Matrix3d<double> S(10,9,5);
//copy the sum of the first slice of A1 and A2 
in the first slice of S in reverse order
std::transform(A1.rbegin_slice(0),A1.rend_slice(0),
              A2.rbegin_slice(0),S.begin_slice(0),
              std::plus<double>());

template<typename Block>

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

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

Parameters

row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns

end reverse_slice_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

the range must be compatible with the slice dimensions

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

template<typename Block>

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

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

Parameters

row	row coordinate of the line
col	col coordinate of the line
range	Range of the line to iterate.

Returns

end const_reverse_slice_range_iterator value

Remarks

This iterator is compatible with RandomAccessIterator algorithms.

Precondition

the range must be compatible with the slice dimensions

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

template<typename T >

Matrix3d< T >::size_type slip::Matrix3d< T >::slice_size ( ) const

inline

Returns the number of elements in a slice of the Matrix3d.

Definition at line 5364 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T >::size_type slip::Matrix3d< T >::slices ( ) const

inline

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

Definition at line 5322 of file Matrix3d.hpp.

template<typename T >

T slip::Matrix3d< T >::sum ( ) const

inline

Returns the sum of the elements of the Matrix.

Precondition

size() != 0

Definition at line 5549 of file Matrix3d.hpp.

template<typename Block>

void slip::Matrix3d< T >::swap ( Matrix3d< Block > &  M )

inline

Swaps data with another Matrix3d.

Parameters

M	A Matrix3d of the same element type

Precondition

dim1() == M.dim1()

dim2() == M.dim2()

dim3() == M.dim3()

Definition at line 5372 of file Matrix3d.hpp.

Friends And Related Function Documentation

template<typename T >

Matrix3d< T > abs ( const Matrix3d< T > &  V )

related

Returns the abs value of each element of the Matrix3d.

Parameters

V	The Matrix3d

Returns

the resulting Matrix3d

Definition at line 5714 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > acos ( const Matrix3d< T > &  V )

related

Returns the acos value of each element of the Matrix3d.

Parameters

V	The Matrix3d

Returns

the resulting Matrix3d

Definition at line 5742 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > asin ( const Matrix3d< T > &  V )

related

Returns the sin value of each element of the Matrix3d.

Parameters

V	The Matrix3d

Returns

the resulting Matrix3d

Definition at line 5760 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > atan ( const Matrix3d< T > &  V )

related

Returns the atan value of each element of the Matrix3d.

Parameters

V	The Matrix3d

Returns

the resulting Matrix3d

Definition at line 5778 of file Matrix3d.hpp.

template<typename Block>

friend class boost::serialization::access

friend

Definition at line 3527 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > cos ( const Matrix3d< T > &  V )

related

Returns the cos value of each element of the Matrix3d.

Parameters

V	The Matrix3d

Returns

the resulting Matrix3d

Definition at line 5733 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > cosh ( const Matrix3d< T > &  V )

related

Returns the cosh value of each element of the Matrix3d.

Parameters

V	The Matrix3d

Returns

the resulting Matrix3d

Definition at line 5805 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > exp ( const Matrix3d< T > &  V )

related

Returns the exp value of each element of the Matrix3d.

Parameters

V	The Matrix3d

Returns

the resulting Matrix3d

Definition at line 5787 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > log ( const Matrix3d< T > &  V )

related

Returns the log value of each element of the Matrix3d.

Parameters

V	The Matrix3d

Returns

the resulting Matrix3d

Definition at line 5796 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > log10 ( const Matrix3d< T > &  V )

related

Returns the log10 value of each element of the Matrix3d.

Parameters

V	The Matrix3d

Returns

the resulting Matrix3d

Definition at line 5832 of file Matrix3d.hpp.

template<typename T >

T & max ( const Matrix3d< T > &  M1 )

related

Returns the max element of a Matrix3d.

Parameters

M1	the Matrix3d

Returns

the min element

Definition at line 5707 of file Matrix3d.hpp.

template<typename T >

T & min ( const Matrix3d< T > &  M1 )

related

Returns the min element of a Matrix3d.

Parameters

M1	the Matrix3d

Returns

the min element

Definition at line 5700 of file Matrix3d.hpp.

template<typename Block>

bool operator!= ( const Matrix3d< T > &  x, const Matrix3d< T > &  y  )

friend

Matrix3d inequality comparison

Parameters

x	A Matrix3d
y	A Matrix3d of the same type of x

Returns

true if !(x == y)

Definition at line 5394 of file Matrix3d.hpp.

template<typename Block>

bool operator< ( const Matrix3d< T > &  x, const Matrix3d< T > &  y  )

friend

Less than comparison operator (Matrix3d ordering relation)

Parameters

x	A Matrix3d
y	A Matrix3d of the same type of x

Returns

true iff x is lexicographically less than y

Definition at line 5406 of file Matrix3d.hpp.

template<typename Block>

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

friend

Write the Matrix3d to the ouput stream.

Parameters

out	output std::ostream
a	Matrix3d to write to the output stream

Definition at line 5258 of file Matrix3d.hpp.

template<typename Block>

bool operator<= ( const Matrix3d< T > &  x, const Matrix3d< T > &  y  )

friend

Less than equal comparison operator.

Parameters

x	A Matrix3d
y	A Matrix3d of the same type of x

Returns

true iff !(y > x)

Definition at line 5424 of file Matrix3d.hpp.

template<typename Block>

bool operator== ( const Matrix3d< T > &  x, const Matrix3d< T > &  y  )

friend

Matrix3d equality comparison

Parameters

x	A Matrix3d
y	A Matrix3d of the same type of x

Returns

true iff the size and the elements of the Arrays are equal

Definition at line 5385 of file Matrix3d.hpp.

template<typename Block>

bool operator> ( const Matrix3d< T > &  x, const Matrix3d< T > &  y  )

friend

More than comparison operator.

Parameters

x	A Matrix3d
y	A Matrix3d of the same type of x

Returns

true iff y > x

Definition at line 5416 of file Matrix3d.hpp.

template<typename Block>

bool operator>= ( const Matrix3d< T > &  x, const Matrix3d< T > &  y  )

friend

More than equal comparison operator.

Parameters

x	A Matrix3d
y	A Matrix3d of the same type of x

Returns

true iff !(x < y)

Definition at line 5432 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > sin ( const Matrix3d< T > &  V )

related

Returns the sin value of each element of the Matrix3d.

Parameters

V	The Matrix3d

Returns

the resulting Matrix3d

Definition at line 5751 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > sinh ( const Matrix3d< T > &  V )

related

Returns the sinh value of each element of the Matrix3d.

Parameters

V	The Matrix3d

Returns

the resulting Matrix3d

Definition at line 5814 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > sqrt ( const Matrix3d< T > &  V )

related

Returns the sqrt value of each element of the Matrix3d.

Parameters

V	The Matrix3d

Returns

the resulting Matrix3d

Definition at line 5724 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > tan ( const Matrix3d< T > &  V )

related

Returns the tan value of each element of the Matrix3d.

Parameters

V	The Matrix3d

Returns

the resulting Matrix3d

Definition at line 5769 of file Matrix3d.hpp.

template<typename T >

Matrix3d< T > tanh ( const Matrix3d< T > &  V )

related

Returns the tanh value of each element of the Matrix3d.

Parameters

V	The Matrix3d

Returns

the resulting Matrix3d

Definition at line 5823 of file Matrix3d.hpp.

Member Data Documentation

template<typename Block>

const std::size_t slip::Matrix3d< Block >::DIM = 3

static

Definition at line 233 of file Matrix3d.hpp.

---

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

• src/Container/GenericMultiComponent3d.hpp
• src/Container/Matrix3d.hpp