STK::IArray2D< Derived > Class Template Reference

template interface base class for two-dimensional arrays. More...

#include <STK_IArray2D.h>

Inheritance diagram for STK::IArray2D< Derived >:

Public Types
enum	{   structure_ = hidden::Traits<Derived>::structure_ , orient_ = hidden::Traits<Derived>::orient_ , sizeRows_ = hidden::Traits<Derived>::sizeRows_ , sizeCols_ = hidden::Traits<Derived>::sizeCols_ ,   storage_ = hidden::Traits<Derived>::storage_ }
typedef hidden::Traits< Derived >::Type	Type
typedef hidden::Traits< Derived >::TypeConst	TypeConst
typedef hidden::Traits< Derived >::Row	Row
typedef hidden::Traits< Derived >::Col	Col
typedef hidden::Traits< Derived >::SubRow	SubRow
typedef hidden::Traits< Derived >::SubCol	SubCol
typedef hidden::Traits< Derived >::SubArray	SubArray
typedef hidden::Traits< Derived >::SubVector	SubVector
typedef hidden::Traits< Derived >::ColVector	ColVector
typedef ColVector *	PtrCol
typedef ColVector const *	PtrColConst
typedef TRange< sizeRows_ >	RowRange
	Type of the Range for the rows.
typedef TRange< sizeCols_ >	ColRange
	Type of the Range for the columns.
typedef IContainer2D< sizeRows_, sizeCols_ >	Base2D
	Type for the IContainer2D base Class.
typedef MemAllocator< PtrCol, sizeCols_ >	Allocator
	Type for the Base Class.
typedef ArrayBase< Derived >	Base
	type of the Base Container Class.
Public Types inherited from STK::ArrayBase< Derived >
enum	{   structure_ = hidden::Traits<Derived>::structure_ , orient_ = hidden::Traits<Derived>::orient_ , sizeRows_ = hidden::Traits<Derived>::sizeRows_ , sizeCols_ = hidden::Traits<Derived>::sizeCols_ ,   storage_ = hidden::Traits<Derived>::storage_ }
typedef ExprBase< Derived >	Base
typedef hidden::Traits< Derived >::Type	Type
typedef hidden::Traits< Derived >::TypeConst	TypeConst
Public Types inherited from STK::ExprBase< Derived >
enum	{   structure_ = hidden::Traits<Derived>::structure_ , orient_ = hidden::Traits<Derived>::orient_ , sizeRows_ = hidden::Traits<Derived>::sizeRows_ , sizeCols_ = hidden::Traits<Derived>::sizeCols_ ,   storage_ = hidden::Traits<Derived>::storage_ }
typedef ITContainer< Derived, structure_ >	Base
typedef hidden::Traits< Derived >::Type	Type
typedef hidden::Traits< Derived >::TypeConst	TypeConst

Public Member Functions
void	clear ()
	clear the object.
Derived &	move (Derived const &T)
	move T to this.
void	exchange (IArray2D &T)
	exchange this container with T.
bool	isRef () const
RowRange const &	rowsImpl () const
ColRange const &	colsImpl () const
RowRange const &	rows () const
int	beginRows () const
int	endRows () const
int	sizeRows () const
ColRange const &	cols () const
int	beginCols () const
int	endCols () const
int	sizeCols () const
int	lastIdxCols () const
int	lastIdxRows () const
bool	empty () const
Allocator const &	allocator () const
PtrColConst	ptr (int j) const
int	availableCols () const
int	capacityCol (int col) const
Array1D< Range, sizeCols_ > const &	rangeCols () const
Range const &	rangeCol (int col) const
void	setValueImpl (int j, TypeConst v)
	implement setValue for vector/point/diagonal arrays
void	setValueImpl (int i, int j, TypeConst v)
	implement setValue for vector/point/diagonal arrays
Type &	elt2Impl (int i, int j)
	access to an element.
TypeConst	elt2Impl (int i, int j) const
	constant access to an element.
TypeConst	operator() (int i, int j) const
Type &	operator() (int i, int j)
TypeConst	operator[] (int i) const
Type &	operator[] (int i)
TypeConst	operator() () const
Type &	operator() ()
Col	col (int j) const
	access to a part of a column.
SubCol	col (Range const &I, int j) const
	access to a part of a column.
SubArray	col (Range const &J) const
	access to many columns.
Row	row (int i) const
	access to a part of a row.
SubRow	row (int i, Range const &J) const
	access to a part of a row.
SubArray	row (Range const &I) const
	access to many rows.
SubVector	sub (Range const &J) const
SubArray	sub (Range const &I, Range const &J) const
	access to a sub-array.
SubVector	operator[] (Range const &I) const
SubCol	operator() (Range const &I, int j) const
SubRow	operator() (int i, Range const &J) const
SubArray	operator() (Range const &I, Range const &J) const
SubCol	atCol (int j) const
Row	atRow (int i) const
void	reserve (int sizeRows, int sizeCols)
	function for reserving memory in all the columns
void	reserveRows (int size)
	Reserve a certain amount of rows in all columns.
void	reserveCols (int sizeCols)
	Reserve a certain amount of columns.
void	shift (int rbeg, int cbeg)
	Set new beginning indexes to the array.
void	shift (int beg)
	New first index for the object (only for vectors/points/square/... arrays)
void	shiftRows (int beg)
	New first index for the rows of the array.
void	shiftCols (int cbeg)
	New first index for the columns of the object.
Derived &	resize (Range const &I, Range const &J)
	resize the array.
Derived &	resize (Range const &I)
void	insertRows (int pos, int n=1)
	Insert n rows at position pos in the array If pos is outside the range of a column, then the method do nothing (useful for triangular/diagonal/... arrays).
void	eraseRows (int pos, int n=1)
	Delete n rows at the position pos.
void	pushFrontRows (int n=1)
	Insert n rows in front of the array.
void	pushBackRows (int n=1)
	Add n rows to the array.
void	popFrontRows (int n=1)
	Delete n first rows of the array.
void	popBackRows (int n=1)
	Delete n latest rows of the array.
template<class Other >
Derived &	pushFrontRows (ExprBase< Other > const &other)
	set other at the beginning of this (concatenate).
template<class Other >
Derived &	pushBackRows (ExprBase< Other > const &other)
	set other at the end of this (concatenate).
void	insertCols (int pos, int n=1)
	Insert n columns at the index pos to the array.
void	eraseCols (int pos, int n=1)
	Delete n columns at the specified position of the array.
void	pushFrontCols (int n=1)
	Insert n columns at the beginning of the array.
void	pushBackCols (int n=1)
	Add n columns at the end of the array.
void	popFrontCols (int n=1)
	Delete first columns of the array.
void	popBackCols (int n=1)
	Delete last columns of the array.
template<class Other >
Derived &	pushFrontCols (ExprBase< Other > const &other)
	merge (by value) the array other with this.
template<class Other >
Derived &	pushBackCols (IArray1D< Other > const &other)
	Specialization for Array1D.
void	push_front (Type const &v)
	STL compatibility: push front an element.
void	push_back (Type const &v)
	STL compatibility: append an element v.
void	insert (Range const &I, Type const &v)
	STL compatibility: insert element v in the range I of the Array.
void	erase (int pos, int n=1)
	STL compatibility:Delete n elements at the pos index from the container.
void	swapCols (int pos1, int pos2)
	Swapping two columns.
void	swap (int i, int j)
	swap two elements: only for vectors and points
template<class OtherDerived >
void	merge (IArray2D< OtherDerived > const &other)
	Append the container other to this without copying the data explicitly.
template<class OtherDerived >
void	merge (IArray1D< OtherDerived > const &other)
	Append the vector other to this without copying the data explicitly.
void	update (Range const &J)
	Update columns of the array at a specified range.
void	update (int col)
	Update column of the array at specified position.
void	setCols (ColRange const &J=ColRange())
	Set the columns range.
void	setRows (RowRange const &I=RowRange())
	Set the range of the number of rows.
Public Member Functions inherited from STK::ArrayBase< Derived >
template<typename Visitor >
void	apply (Visitor &visitor)
	Apply the Visitor visitor to the whole coefficients of the array.
Derived &	randUnif ()
	set random values to this using a uniform law.
Derived &	randGauss ()
	set random values to this using a standard gaussian law.
Derived &	rand (Law::IUnivLaw< Type > const &law)
	set random values to this using a distribution law given by the user.
Derived &	setOnes ()
	set one to this using a Visitor.
Derived &	setZeros ()
	set zero to this using a Visitor.
Derived &	ones ()
	set one to this using a Visitor.
Derived &	zeros ()
	set zero to this using a Visitor.
Derived &	setValue (TypeConst value)
	set a value to this container.
void	setValue (int i, TypeConst value)
	set a value to this container at index i.
void	setValue (int i, int j, TypeConst value)
	set a value to this container at position (i,j).
template<class Rhs >
Derived &	assign (ExprBase< Rhs > const &rhs)
Derived &	operator= (Type const &value)
Derived &	operator= (Derived const &rhs)
template<typename Rhs >
Derived &	operator= (ExprBase< Rhs > const &rhs)
template<typename Rhs >
Derived &	operator+= (ExprBase< Rhs > const &other)
	Add Rhs to this.
template<typename Rhs >
Derived &	operator-= (ExprBase< Rhs > const &other)
	subtract a Rhs to this.
template<typename Rhs >
Derived &	operator/= (ExprBase< Rhs > const &other)
	divide this by Rhs.
template<typename Rhs >
Derived &	operator%= (ExprBase< Rhs > const &other)
	Take modulo of this by Rhs.
template<typename Rhs >
Derived &	operator*= (ExprBase< Rhs > const &other)
	multiply this by Rhs.
Derived &	operator+= (Type const &other)
	Adding a constant to this.
Derived &	operator-= (Type const &other)
	Subtract a constant to this.
Derived &	operator*= (Type const &other)
	product of this by a constant.
Derived &	operator/= (Type const &other)
	dividing this by a constant.
Derived &	operator%= (Type const &other)
	take modulo of this by a constant.
template<class Rhs >
Derived &	copy (ExprBase< Rhs > const &rhs)
	overwrite this with src.
TransposeOperator< Derived > const	transpose () const
TransposeAccessor< Derived >	transpose ()
DiagonalizeOperator< Derived > const	diagonalize () const
DiagonalizeAccessor< Derived >	diagonalize ()
DiagonalGetterOperator< Derived > const	getDiagonal () const
DiagonalGetterAccessor< Derived >	getDiagonal ()
UpperTriangularizeOperator< Derived > const	upperTriangularize () const
UpperTriangularizeAccessor< Derived >	upperTriangularize ()
LowerTriangularizeOperator< Derived > const	lowerTriangularize () const
LowerTriangularizeAccessor< Derived >	lowerTriangularize ()
SymmetrizeOperator< Derived > const	symmetrize () const
SymmetrizeAccessor< Derived >	symmetrize ()
UpperSymmetrizeOperator< Derived > const	upperSymmetrize () const
UpperSymmetrizeAccessor< Derived >	upperSymmetrize ()
LowerSymmetrizeOperator< Derived > const	lowerSymmetrize () const
LowerSymmetrizeAccessor< Derived >	lowerSymmetrize ()
ColOperator< Derived > const	col (int j) const
RowOperator< Derived > const	row (int i) const
template<int Size_>
SubVectorOperator< Derived, Size_ > const	sub (TRange< Size_ > const &I) const
template<int SizeRows_, int SizeCols_>
SubOperator< Derived, SizeRows_, SizeCols_ > const	sub (TRange< SizeRows_ > const &I, TRange< SizeCols_ > const &J) const
ColAccessor< Derived >	col (int j)
RowAccessor< Derived >	row (int i)
template<int Size_>
SubVectorAccessor< Derived, Size_ >	sub (TRange< Size_ > const &I)
template<int SizeRows_, int SizeCols_>
SubAccessor< Derived, SizeRows_, SizeCols_ >	sub (TRange< SizeRows_ > const &I, TRange< SizeCols_ > const &J)
TypeConst	operator() (int i, int j) const
Type &	operator() (int i, int j)
TypeConst	operator[] (int i) const
Type &	operator[] (int i)
TypeConst	operator() () const
Type &	operator() ()
ArrayInitializer< Derived >	operator<< (Type const &s)
	Convenient operator to set the coefficients of a matrix.
template<typename Rhs >
ArrayInitializer< Derived >	operator<< (ArrayBase< Rhs > const &other)
Public Member Functions inherited from STK::ExprBase< Derived >
template<typename Visitor >
Visitor::TypeConst	visit (Visitor &visitor) const
	Visit the container using a constant visitor.
int	count () const
	compute the value of non-zero element in an expression.
bool const	any () const
	check if there is any non-zero element in an expression.
bool const	all () const
	check if all the elements in an expression are not zero.
int	nbAvailableValues () const
Type const	minElt (int &row, int &col) const
Type const	minEltSafe (int &row, int &col) const
Type const	maxElt (int &row, int &col) const
Type const	maxEltSafe (int &row, int &col) const
Type const	minElt (int &pos) const
Type const	minEltSafe (int &pos) const
Type const	maxElt (int &pos) const
Type const	maxEltSafe (int &pos) const
Type const	minElt () const
Type const	minEltSafe () const
Type const	maxElt () const
Type const	maxEltSafe () const
Type const	sum () const
Type const	sumSafe () const
Type const	norm () const
Type const	normSafe () const
Type const	norm2 () const
Type const	norm2Safe () const
Type const	normInf () const
Type const	mean () const
Type const	meanSafe () const
Type const	variance () const
Type const	varianceSafe () const
Type const	variance (Type const &mean) const
Type const	varianceSafe (Type const &mean) const
template<typename Rhs >
Type const	wsum (ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wsumSafe (ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wnorm (ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wnormSafe (ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wnorm2 (ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wnorm2Safe (ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wmean (ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wmeanSafe (ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wvariance (ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wvarianceSafe (ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wvariance (Type const &mean, ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wvarianceSafe (Type const &mean, ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::equalOp_ >::Result const	operator== (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::notEqualOp_ >::Result const	operator!= (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::greaterThanOp_ >::Result const	operator> (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::lessThanOp_ >::Result const	operator< (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::greaterThanOrEqualOp_ >::Result const	operator>= (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::lessThanOrEqualOp_ >::Result const	operator<= (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::sumOp_ >::Result const	operator+ (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::differenceOp_ >::Result const	operator- (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::productOp_ >::Result const	prod (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::divisionOp_ >::Result const	operator/ (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::moduloOp_ >::Result const	operator% (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::minOp_ >::Result const	min (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::maxOp_ >::Result const	max (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::logicalAndOp_ >::Result const	operator&& (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::logicalOrOp_ >::Result const	operator|| (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::bitwiseAndOp_ >::Result const	operator& (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::bitwiseOrOp_ >::Result const	operator| (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::bitwiseXorOp_ >::Result const	operator^ (ExprBase< Rhs > const &other) const
UnaryOperator< OppositeOp< Type >, Derived >	operator- () const
UnaryOperator< IsNaOp< Type >, Derived >	isNA () const
UnaryOperator< NegOp< Type >, Derived >	neg () const
UnaryOperator< IsFiniteOp< Type >, Derived >	isFinite () const
UnaryOperator< IsInfiniteOp< Type >, Derived >	isInfinite () const
UnaryOperator< AbsOp< Type >, Derived >	abs () const
UnaryOperator< ExpOp< Type >, Derived >	exp () const
UnaryOperator< LogOp< Type >, Derived >	log () const
UnaryOperator< SqrtOp< Type >, Derived >	sqrt () const
UnaryOperator< CosOp< Type >, Derived >	cos () const
UnaryOperator< SinOp< Type >, Derived >	sin () const
UnaryOperator< AcosOp< Type >, Derived >	acos () const
UnaryOperator< AsinOp< Type >, Derived >	asin () const
UnaryOperator< TanOp< Type >, Derived >	tan () const
UnaryOperator< InverseOp< Type >, Derived >	inverse () const
UnaryOperator< SquareOp< Type >, Derived >	square () const
UnaryOperator< CubeOp< Type >, Derived >	cube () const
UnaryOperator< EqualWithOp< Type >, Derived >	operator== (Type const &value) const
UnaryOperator< NotEqualWithOp< Type >, Derived >	operator!= (Type const &value) const
UnaryOperator< GreaterThanOp< Type >, Derived >	operator> (Type const &value) const
UnaryOperator< LessThanOp< Type >, Derived >	operator< (Type const &value) const
UnaryOperator< LeqThanOp< Type >, Derived >	operator<= (Type const &value) const
UnaryOperator< GeqThanOp< Type >, Derived >	operator>= (Type const &value) const
UnaryOperator< MinWithOp< Type >, Derived >	min (Type const &value) const
UnaryOperator< MaxWithOp< Type >, Derived >	max (Type const &value) const
UnaryOperator< SumWithOp< Type >, Derived >	operator+ (Type const &value) const
UnaryOperator< DifferenceWithOp< Type >, Derived >	operator- (Type const &value) const
UnaryOperator< ProductWithOp< Type >, Derived >	operator* (Type const &value) const
UnaryOperator< DivisionWithOp< Type >, Derived >	operator/ (Type const &value) const
UnaryOperator< ModuloWithOp< Type >, Derived >	operator% (Type const &value) const
UnaryOperator< LogicalAndWithOp< Type >, Derived >	operator&& (Type const &value) const
UnaryOperator< LogicalOrWithOp< Type >, Derived >	operator|| (Type const &value) const
UnaryOperator< BitwiseAndWithOp< Type >, Derived >	operator& (Type const &value) const
UnaryOperator< BitwiseOrWithOp< Type >, Derived >	operator| (Type const &value) const
UnaryOperator< BitwiseXorWithOp< Type >, Derived >	operator^ (Type const &value) const
UnaryOperator< PowOp< Type >, Derived >	pow (Type const &value) const
UnaryOperator< SafeInverseOp< Type >, Derived >	safeInverse (Type const &value) const
UnaryOperator< SafeOp< Type >, Derived > const	safe (Type const value=Type()) const
template<typename OtherType >
UnaryOperator< CastOp< Type, OtherType >, Derived > const	cast () const
UnaryOperator< Law::PdfOp< Type >, Derived >	pdf (Law::IUnivLaw< Type > const &law) const
	compute pdf values to this using distribution law given by user
UnaryOperator< Law::LogPdfOp< Type >, Derived >	lpdf (Law::IUnivLaw< Type > const &law) const
	compute log-pdf values to this using distribution law given by user
UnaryOperator< Law::CdfOp< Type >, Derived >	cdf (Law::IUnivLaw< Type > const &law) const
	compute cumulative distribution function of this using distribution law given by user
UnaryOperator< Law::LogCdfOp< Type >, Derived >	lcdf (Law::IUnivLaw< Type > const &law) const
	compute log-cumulative distribution function of this using distribution law given by user
UnaryOperator< Law::CdfcOp< Type >, Derived >	cdfc (Law::IUnivLaw< Type > const &law) const
	compute complementary cumulative distribution function of this using distribution law given by user
UnaryOperator< Law::LogCdfcOp< Type >, Derived >	lcdfc (Law::IUnivLaw< Type > const &law) const
	compute complementary cumulative distribution function of this using distribution law given by user
UnaryOperator< Law::IcdfOp< Type >, Derived >	icdf (Law::IUnivLaw< Type > const &law) const
	compute inverse cumulative distribution function using distribution law given by user
template<template< typename > class OtherOperator>
UnaryOperator< OtherOperator< Type >, Derived > const	funct0 () const
template<template< typename > class OtherOperator>
UnaryOperator< OtherOperator< Type >, Derived > const	funct1 (Type const value) const
TransposeOperator< Derived > const	transpose () const
DiagonalizeOperator< Derived > const	diagonalize () const
DiagonalGetterOperator< Derived > const	getDiagonal () const
UpperTriangularizeOperator< Derived > const	upperTriangularize () const
LowerTriangularizeOperator< Derived > const	lowerTriangularize () const
SymmetrizeOperator< Derived > const	symmetrize () const
UpperSymmetrizeOperator< Derived > const	upperSymmetrize () const
LowerSymmetrizeOperator< Derived > const	lowerSymmetrize () const
template<int Size_>
SubVectorOperator< Derived, Size_ > const	sub (TRange< Size_ > const &I) const
ColOperator< Derived > const	col (int j) const
RowOperator< Derived > const	row (int i) const
template<int Size_>
SubOperator< Derived, sizeRows_, Size_ > const	col (TRange< Size_ > const &J) const
template<int Size_>
SubOperator< Derived, Size_, sizeCols_ > const	row (TRange< Size_ > const &I) const
template<int SizeRows_, int SizeCols_>
SubOperator< Derived, SizeRows_, SizeCols_ > const	sub (TRange< SizeRows_ > const &I, TRange< SizeCols_ > const &J) const
template<class Rhs >
hidden::Promote< Type, typenameRhs::Type >::result_type const	dot (ExprBase< Rhs > const &other) const
template<class Rhs >
hidden::Promote< Type, typenameRhs::Type >::result_type const	dotSafe (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::ProductSelector< Derived, Rhs, hidden::Traits< Derived >::structure_, hidden::Traits< Rhs >::structure_ >::ProductType const	operator* (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wsum (ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wsumSafe (ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wnorm (ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wnormSafe (ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wnorm2 (ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wnorm2Safe (ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wmean (ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wmeanSafe (ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wvariance (ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wvarianceSafe (ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wvariance (Type const &mean, ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wvarianceSafe (Type const &mean, ExprBase< Rhs > const &weights) const

Protected Member Functions
	IArray2D ()
	Default constructor.
	IArray2D (Range const &I, Range const &J)
	constructor with specified ranges
	IArray2D (IArray2D const &T, bool ref=false)
	Copy constructor If we want to wrap T, the main ptr will be wrapped in MemAllocator class.
template<class OtherDerived >
	IArray2D (IArray2D< OtherDerived > const &T, Range const &I, Range const &J)
	constructor by reference, ref_=1.
	~IArray2D ()
	destructor.
Allocator &	allocator ()
void	transferCol (int pos1, int pos2)
	Transfer the column pos2 to the column pos1 of this.
void	reallocCols (Range const &J)
	Method for memory reallocation and initialization of the horizontal range of the container.
void	nullCols (ColRange const &J)
	Internal method for initializing to default values (null pointer and null range) to a range of columns.
Protected Member Functions inherited from STK::IContainer2D< hidden::Traits< Derived >::sizeRows_, hidden::Traits< Derived >::sizeCols_ >
void	shift (int rbeg, int cbeg)
	Set the first index of the rows and columns.
void	setRanges (RowRange const &I=RowRange(), ColRange const &J=ColRange())
	Set the ranges of the container.
void	setRows (RowRange const &I=RowRange())
	Set the range of the number of rows.
void	shiftRows (int beg)
	Set the first index of the rows.
void	incRangeRows (int inc)
	Increment the range of the number of rows.
void	incBeginRows (int inc)
	Increment the first index of the number of rows.
void	decBeginRows (int dec)
	Decrement the first index of the number of rows.
void	incEndRows (int inc)
	Increment the end of the number of rows.
void	decEndRows (int dec)
	Decrement the end of the number of rows.
void	setCols (ColRange const &J=ColRange())
	Set the columns range.
void	shiftCols (int beg)
	Shift the columns first index to beg.
void	incRangeCols (int inc)
	Increment the columns range.
void	incBeginCols (int inc)
	increment the first index of the columns.
void	decBeginCols (int dec)
	Decrement the columns first index.
void	incEndCols (int inc)
	Increment the last index of the columns.
void	decEndCols (int dec)
	Decrement the last index of the columns.
void	exchange (IContainer2D &T)
	exchange this container with T
void	incLastIdxRows (int inc)
	Increment the end of the number of rows.
void	decLastIdxRows (int dec)
	Decrement the end of the number of rows.
void	incLastIdxCols (int inc)
	Increment the last index of the columns.
void	decLastIdxCols (int dec)
	Decrement the last index of the columns.
	IContainer2D ()
	Default constructor.
	IContainer2D (RowRange const &I, ColRange const &J)
	Constructor with specified ranges.
	IContainer2D (IContainer2D const &T)
	Copy constructor.
	~IContainer2D ()
	destructor.
ColRange const &	cols () const
int	beginCols () const
int	endCols () const
int	sizeCols () const
RowRange const &	rows () const
int	beginRows () const
int	endRows () const
int	sizeRows () const
int	lastIdxCols () const
int	lastIdxRows () const
bool	empty () const
Protected Member Functions inherited from STK::ArrayBase< Derived >
	ArrayBase ()
	Default constructor.
	~ArrayBase ()
	destructor
template<typename Visitor >
void	apply (Visitor &visitor)
	Apply the Visitor visitor to the whole coefficients of the array.
Derived &	randUnif ()
	set random values to this using a uniform law.
Derived &	randGauss ()
	set random values to this using a standard gaussian law.
Derived &	rand (Law::IUnivLaw< Type > const &law)
	set random values to this using a distribution law given by the user.
Derived &	setOnes ()
	set one to this using a Visitor.
Derived &	setZeros ()
	set zero to this using a Visitor.
Derived &	ones ()
	set one to this using a Visitor.
Derived &	zeros ()
	set zero to this using a Visitor.
Derived &	setValue (TypeConst value)
	set a value to this container.
void	setValue (int i, TypeConst value)
	set a value to this container at index i.
void	setValue (int i, int j, TypeConst value)
	set a value to this container at position (i,j).
template<class Rhs >
Derived &	assign (ExprBase< Rhs > const &rhs)
Derived &	operator= (Type const &value)
Derived &	operator= (Derived const &rhs)
template<typename Rhs >
Derived &	operator= (ExprBase< Rhs > const &rhs)
template<typename Rhs >
Derived &	operator+= (ExprBase< Rhs > const &other)
	Add Rhs to this.
template<typename Rhs >
Derived &	operator-= (ExprBase< Rhs > const &other)
	subtract a Rhs to this.
template<typename Rhs >
Derived &	operator/= (ExprBase< Rhs > const &other)
	divide this by Rhs.
template<typename Rhs >
Derived &	operator%= (ExprBase< Rhs > const &other)
	Take modulo of this by Rhs.
template<typename Rhs >
Derived &	operator*= (ExprBase< Rhs > const &other)
	multiply this by Rhs.
Derived &	operator+= (Type const &other)
	Adding a constant to this.
Derived &	operator-= (Type const &other)
	Subtract a constant to this.
Derived &	operator*= (Type const &other)
	product of this by a constant.
Derived &	operator/= (Type const &other)
	dividing this by a constant.
Derived &	operator%= (Type const &other)
	take modulo of this by a constant.
template<class Rhs >
Derived &	copy (ExprBase< Rhs > const &rhs)
	overwrite this with src.
TransposeOperator< Derived > const	transpose () const
TransposeAccessor< Derived >	transpose ()
DiagonalizeOperator< Derived > const	diagonalize () const
DiagonalizeAccessor< Derived >	diagonalize ()
DiagonalGetterOperator< Derived > const	getDiagonal () const
DiagonalGetterAccessor< Derived >	getDiagonal ()
UpperTriangularizeOperator< Derived > const	upperTriangularize () const
UpperTriangularizeAccessor< Derived >	upperTriangularize ()
LowerTriangularizeOperator< Derived > const	lowerTriangularize () const
LowerTriangularizeAccessor< Derived >	lowerTriangularize ()
SymmetrizeOperator< Derived > const	symmetrize () const
SymmetrizeAccessor< Derived >	symmetrize ()
UpperSymmetrizeOperator< Derived > const	upperSymmetrize () const
UpperSymmetrizeAccessor< Derived >	upperSymmetrize ()
LowerSymmetrizeOperator< Derived > const	lowerSymmetrize () const
LowerSymmetrizeAccessor< Derived >	lowerSymmetrize ()
ColOperator< Derived > const	col (int j) const
RowOperator< Derived > const	row (int i) const
template<int Size_>
SubVectorOperator< Derived, Size_ > const	sub (TRange< Size_ > const &I) const
template<int SizeRows_, int SizeCols_>
SubOperator< Derived, SizeRows_, SizeCols_ > const	sub (TRange< SizeRows_ > const &I, TRange< SizeCols_ > const &J) const
ColAccessor< Derived >	col (int j)
RowAccessor< Derived >	row (int i)
template<int Size_>
SubVectorAccessor< Derived, Size_ >	sub (TRange< Size_ > const &I)
template<int SizeRows_, int SizeCols_>
SubAccessor< Derived, SizeRows_, SizeCols_ >	sub (TRange< SizeRows_ > const &I, TRange< SizeCols_ > const &J)
TypeConst	operator() (int i, int j) const
Type &	operator() (int i, int j)
TypeConst	operator[] (int i) const
Type &	operator[] (int i)
TypeConst	operator() () const
Type &	operator() ()
ArrayInitializer< Derived >	operator<< (Type const &s)
	Convenient operator to set the coefficients of a matrix.
template<typename Rhs >
ArrayInitializer< Derived >	operator<< (ArrayBase< Rhs > const &other)
Protected Member Functions inherited from STK::ExprBase< Derived >
	ExprBase ()
	Default constructor.
	~ExprBase ()
	destructor
template<typename Visitor >
Visitor::TypeConst	visit (Visitor &visitor) const
	Visit the container using a constant visitor.
int	count () const
	compute the value of non-zero element in an expression.
bool const	any () const
	check if there is any non-zero element in an expression.
bool const	all () const
	check if all the elements in an expression are not zero.
int	nbAvailableValues () const
Type const	minElt (int &row, int &col) const
Type const	minEltSafe (int &row, int &col) const
Type const	maxElt (int &row, int &col) const
Type const	maxEltSafe (int &row, int &col) const
Type const	minElt (int &pos) const
Type const	minEltSafe (int &pos) const
Type const	maxElt (int &pos) const
Type const	maxEltSafe (int &pos) const
Type const	minElt () const
Type const	minEltSafe () const
Type const	maxElt () const
Type const	maxEltSafe () const
Type const	sum () const
Type const	sumSafe () const
Type const	norm () const
Type const	normSafe () const
Type const	norm2 () const
Type const	norm2Safe () const
Type const	normInf () const
Type const	mean () const
Type const	meanSafe () const
Type const	variance () const
Type const	varianceSafe () const
Type const	variance (Type const &mean) const
Type const	varianceSafe (Type const &mean) const
template<typename Rhs >
Type const	wsum (ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wsumSafe (ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wnorm (ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wnormSafe (ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wnorm2 (ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wnorm2Safe (ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wmean (ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wmeanSafe (ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wvariance (ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wvarianceSafe (ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wvariance (Type const &mean, ExprBase< Rhs > const &weights) const
template<typename Rhs >
Type const	wvarianceSafe (Type const &mean, ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::equalOp_ >::Result const	operator== (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::notEqualOp_ >::Result const	operator!= (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::greaterThanOp_ >::Result const	operator> (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::lessThanOp_ >::Result const	operator< (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::greaterThanOrEqualOp_ >::Result const	operator>= (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::lessThanOrEqualOp_ >::Result const	operator<= (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::sumOp_ >::Result const	operator+ (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::differenceOp_ >::Result const	operator- (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::productOp_ >::Result const	prod (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::divisionOp_ >::Result const	operator/ (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::moduloOp_ >::Result const	operator% (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::minOp_ >::Result const	min (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::maxOp_ >::Result const	max (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::logicalAndOp_ >::Result const	operator&& (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::logicalOrOp_ >::Result const	operator|| (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::bitwiseAndOp_ >::Result const	operator& (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::bitwiseOrOp_ >::Result const	operator| (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::OperatorSelector< Derived, Rhs, Arrays::bitwiseXorOp_ >::Result const	operator^ (ExprBase< Rhs > const &other) const
UnaryOperator< OppositeOp< Type >, Derived >	operator- () const
UnaryOperator< IsNaOp< Type >, Derived >	isNA () const
UnaryOperator< NegOp< Type >, Derived >	neg () const
UnaryOperator< IsFiniteOp< Type >, Derived >	isFinite () const
UnaryOperator< IsInfiniteOp< Type >, Derived >	isInfinite () const
UnaryOperator< AbsOp< Type >, Derived >	abs () const
UnaryOperator< ExpOp< Type >, Derived >	exp () const
UnaryOperator< LogOp< Type >, Derived >	log () const
UnaryOperator< SqrtOp< Type >, Derived >	sqrt () const
UnaryOperator< CosOp< Type >, Derived >	cos () const
UnaryOperator< SinOp< Type >, Derived >	sin () const
UnaryOperator< AcosOp< Type >, Derived >	acos () const
UnaryOperator< AsinOp< Type >, Derived >	asin () const
UnaryOperator< TanOp< Type >, Derived >	tan () const
UnaryOperator< InverseOp< Type >, Derived >	inverse () const
UnaryOperator< SquareOp< Type >, Derived >	square () const
UnaryOperator< CubeOp< Type >, Derived >	cube () const
UnaryOperator< EqualWithOp< Type >, Derived >	operator== (Type const &value) const
UnaryOperator< NotEqualWithOp< Type >, Derived >	operator!= (Type const &value) const
UnaryOperator< GreaterThanOp< Type >, Derived >	operator> (Type const &value) const
UnaryOperator< LessThanOp< Type >, Derived >	operator< (Type const &value) const
UnaryOperator< LeqThanOp< Type >, Derived >	operator<= (Type const &value) const
UnaryOperator< GeqThanOp< Type >, Derived >	operator>= (Type const &value) const
UnaryOperator< MinWithOp< Type >, Derived >	min (Type const &value) const
UnaryOperator< MaxWithOp< Type >, Derived >	max (Type const &value) const
UnaryOperator< SumWithOp< Type >, Derived >	operator+ (Type const &value) const
UnaryOperator< DifferenceWithOp< Type >, Derived >	operator- (Type const &value) const
UnaryOperator< ProductWithOp< Type >, Derived >	operator* (Type const &value) const
UnaryOperator< DivisionWithOp< Type >, Derived >	operator/ (Type const &value) const
UnaryOperator< ModuloWithOp< Type >, Derived >	operator% (Type const &value) const
UnaryOperator< LogicalAndWithOp< Type >, Derived >	operator&& (Type const &value) const
UnaryOperator< LogicalOrWithOp< Type >, Derived >	operator|| (Type const &value) const
UnaryOperator< BitwiseAndWithOp< Type >, Derived >	operator& (Type const &value) const
UnaryOperator< BitwiseOrWithOp< Type >, Derived >	operator| (Type const &value) const
UnaryOperator< BitwiseXorWithOp< Type >, Derived >	operator^ (Type const &value) const
UnaryOperator< PowOp< Type >, Derived >	pow (Type const &value) const
UnaryOperator< SafeInverseOp< Type >, Derived >	safeInverse (Type const &value) const
UnaryOperator< SafeOp< Type >, Derived > const	safe (Type const value=Type()) const
template<typename OtherType >
UnaryOperator< CastOp< Type, OtherType >, Derived > const	cast () const
UnaryOperator< Law::PdfOp< Type >, Derived >	pdf (Law::IUnivLaw< Type > const &law) const
	compute pdf values to this using distribution law given by user
UnaryOperator< Law::LogPdfOp< Type >, Derived >	lpdf (Law::IUnivLaw< Type > const &law) const
	compute log-pdf values to this using distribution law given by user
UnaryOperator< Law::CdfOp< Type >, Derived >	cdf (Law::IUnivLaw< Type > const &law) const
	compute cumulative distribution function of this using distribution law given by user
UnaryOperator< Law::LogCdfOp< Type >, Derived >	lcdf (Law::IUnivLaw< Type > const &law) const
	compute log-cumulative distribution function of this using distribution law given by user
UnaryOperator< Law::CdfcOp< Type >, Derived >	cdfc (Law::IUnivLaw< Type > const &law) const
	compute complementary cumulative distribution function of this using distribution law given by user
UnaryOperator< Law::LogCdfcOp< Type >, Derived >	lcdfc (Law::IUnivLaw< Type > const &law) const
	compute complementary cumulative distribution function of this using distribution law given by user
UnaryOperator< Law::IcdfOp< Type >, Derived >	icdf (Law::IUnivLaw< Type > const &law) const
	compute inverse cumulative distribution function using distribution law given by user
template<template< typename > class OtherOperator>
UnaryOperator< OtherOperator< Type >, Derived > const	funct0 () const
template<template< typename > class OtherOperator>
UnaryOperator< OtherOperator< Type >, Derived > const	funct1 (Type const value) const
TransposeOperator< Derived > const	transpose () const
DiagonalizeOperator< Derived > const	diagonalize () const
DiagonalGetterOperator< Derived > const	getDiagonal () const
UpperTriangularizeOperator< Derived > const	upperTriangularize () const
LowerTriangularizeOperator< Derived > const	lowerTriangularize () const
SymmetrizeOperator< Derived > const	symmetrize () const
UpperSymmetrizeOperator< Derived > const	upperSymmetrize () const
LowerSymmetrizeOperator< Derived > const	lowerSymmetrize () const
template<int Size_>
SubVectorOperator< Derived, Size_ > const	sub (TRange< Size_ > const &I) const
ColOperator< Derived > const	col (int j) const
RowOperator< Derived > const	row (int i) const
template<int Size_>
SubOperator< Derived, sizeRows_, Size_ > const	col (TRange< Size_ > const &J) const
template<int Size_>
SubOperator< Derived, Size_, sizeCols_ > const	row (TRange< Size_ > const &I) const
template<int SizeRows_, int SizeCols_>
SubOperator< Derived, SizeRows_, SizeCols_ > const	sub (TRange< SizeRows_ > const &I, TRange< SizeCols_ > const &J) const
template<class Rhs >
hidden::Promote< Type, typenameRhs::Type >::result_type const	dot (ExprBase< Rhs > const &other) const
template<class Rhs >
hidden::Promote< Type, typenameRhs::Type >::result_type const	dotSafe (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::ProductSelector< Derived, Rhs, hidden::Traits< Derived >::structure_, hidden::Traits< Rhs >::structure_ >::ProductType const	operator* (ExprBase< Rhs > const &other) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wsum (ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wsumSafe (ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wnorm (ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wnormSafe (ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wnorm2 (ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wnorm2Safe (ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wmean (ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wmeanSafe (ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wvariance (ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wvarianceSafe (ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wvariance (Type const &mean, ExprBase< Rhs > const &weights) const
template<typename Rhs >
hidden::Traits< Derived >::Type const	wvarianceSafe (Type const &mean, ExprBase< Rhs > const &weights) const

Protected Attributes
Allocator	allocator_
	allocator of the column data set
Array1D< Range, sizeCols_ >	rangeCols_
	range of the index of the columns of the container.

Private Member Functions
void	freeMem ()
	Internal method for memory deallocation.
void	mallocCols (ColRange const &J)
	Internal method for memory allocation and initialization of the horizontal range of the container.
void	initializeCols (Range const &J)
	Internal method for memory allocation and initialization of a range of columns.
void	freeCols (Range const &J)
	Internal method for releasing memory in a given range of columns.
void	reserveRowsCols (Range const &J, int size)
	Internal method for reserving memory in a range of columns.
void	copyCol (IArray2D const &src, int j)
	copy column j of src into column j of this
template<class OtherDerived >
void	transferCol (IArray2D< OtherDerived > &T, int pos)
	Internal method transferring column pos of container T to column pos of this.
void	nullCol (int col)
	Internal method setting default parameters and dimension to a column of the container.
void	initializeCol (int col, Range const &I)
	Internal method for initializing a column.
void	freeCol (int col)
	Internal method for memory deallocation.
void	shiftRowCol (int col, int beg)
	internal method for translating a column.
void	resizeRowCol (int col, Range const &I)
	Internal method for resizing a column with a specified range.
void	reserveRowCol (int col, int size)
	Internal method for reserving rows to a specified column.
void	insertRowsCol (int col, int pos, int n)
	Internal method for inserting rows to a specified column.
void	eraseRowsCol (int col, int pos, int n)
	Internal method for deleting rows from a specified column.

Friends
template<class OtherDerived >
class	IArray2D

Additional Inherited Members
Protected Types inherited from STK::IContainer2D< hidden::Traits< Derived >::sizeRows_, hidden::Traits< Derived >::sizeCols_ >
typedef TRange< SizeRows_ >	RowRange
	Type of the Range for the rows.
typedef TRange< SizeCols_ >	ColRange
	Type of the Range for the columns.
Protected Types inherited from STK::ArrayBase< Derived >
enum	{   structure_ = hidden::Traits<Derived>::structure_ , orient_ = hidden::Traits<Derived>::orient_ , sizeRows_ = hidden::Traits<Derived>::sizeRows_ , sizeCols_ = hidden::Traits<Derived>::sizeCols_ ,   storage_ = hidden::Traits<Derived>::storage_ }
typedef ExprBase< Derived >	Base
typedef hidden::Traits< Derived >::Type	Type
typedef hidden::Traits< Derived >::TypeConst	TypeConst
Protected Types inherited from STK::ExprBase< Derived >
enum	{   structure_ = hidden::Traits<Derived>::structure_ , orient_ = hidden::Traits<Derived>::orient_ , sizeRows_ = hidden::Traits<Derived>::sizeRows_ , sizeCols_ = hidden::Traits<Derived>::sizeCols_ ,   storage_ = hidden::Traits<Derived>::storage_ }
typedef ITContainer< Derived, structure_ >	Base
typedef hidden::Traits< Derived >::Type	Type
typedef hidden::Traits< Derived >::TypeConst	TypeConst

Detailed Description

template<class Derived>
class STK::IArray2D< Derived >

template interface base class for two-dimensional arrays.

A IArray2D is an interface class for two-dimensional Arrays stored in columns and having flexible dimensions. It is possible to add, remove easily columns and rows in Derived class.

Each column has a Range stored in the array rangeCols_. It should be worth noting that we always have

(rangeCols_[j].size() <= capacityCol(j)) == true;
(rangeCols_[j].isIn(this->rows()) == true;

Pseudo virtual function expected by this interface in derived classes are

void setValue1D(int i, TypeConst value); // for 1D arrays
void resize1D(Range const& I); // for 1D arrays
void shift1D(beg); // for 1D arrays*
 
void pushBack(int n=1);

Template Parameters

Derived

is the name of the class that implements IArray2D.

Definition at line 77 of file STK_IArray2D.h.

Member Typedef Documentation

Allocator

template<class Derived >

typedef MemAllocator<PtrCol, sizeCols_> STK::IArray2D< Derived >::Allocator

Type for the Base Class.

Definition at line 114 of file STK_IArray2D.h.

Base

template<class Derived >

typedef ArrayBase<Derived> STK::IArray2D< Derived >::Base

type of the Base Container Class.

Definition at line 116 of file STK_IArray2D.h.

Base2D

template<class Derived >

typedef IContainer2D<sizeRows_, sizeCols_ > STK::IArray2D< Derived >::Base2D

Type for the IContainer2D base Class.

Definition at line 112 of file STK_IArray2D.h.

Col

template<class Derived >

typedef hidden::Traits<Derived>::Col STK::IArray2D< Derived >::Col

Definition at line 88 of file STK_IArray2D.h.

ColRange

template<class Derived >

typedef TRange<sizeCols_> STK::IArray2D< Derived >::ColRange

Type of the Range for the columns.

Definition at line 110 of file STK_IArray2D.h.

ColVector

template<class Derived >

typedef hidden::Traits<Derived>::ColVector STK::IArray2D< Derived >::ColVector

Definition at line 95 of file STK_IArray2D.h.

PtrCol

template<class Derived >

typedef ColVector* STK::IArray2D< Derived >::PtrCol

Definition at line 96 of file STK_IArray2D.h.

PtrColConst

template<class Derived >

typedef ColVector const* STK::IArray2D< Derived >::PtrColConst

Definition at line 97 of file STK_IArray2D.h.

Row

template<class Derived >

typedef hidden::Traits<Derived>::Row STK::IArray2D< Derived >::Row

Definition at line 87 of file STK_IArray2D.h.

RowRange

template<class Derived >

typedef TRange<sizeRows_> STK::IArray2D< Derived >::RowRange

Type of the Range for the rows.

Definition at line 108 of file STK_IArray2D.h.

SubArray

template<class Derived >

typedef hidden::Traits<Derived>::SubArray STK::IArray2D< Derived >::SubArray

Definition at line 91 of file STK_IArray2D.h.

SubCol

template<class Derived >

typedef hidden::Traits<Derived>::SubCol STK::IArray2D< Derived >::SubCol

Definition at line 90 of file STK_IArray2D.h.

SubRow

template<class Derived >

typedef hidden::Traits<Derived>::SubRow STK::IArray2D< Derived >::SubRow

Definition at line 89 of file STK_IArray2D.h.

SubVector

template<class Derived >

typedef hidden::Traits<Derived>::SubVector STK::IArray2D< Derived >::SubVector

Definition at line 93 of file STK_IArray2D.h.

Type

template<class Derived >

typedef hidden::Traits<Derived>::Type STK::IArray2D< Derived >::Type

Definition at line 84 of file STK_IArray2D.h.

TypeConst

template<class Derived >

typedef hidden::Traits<Derived>::TypeConst STK::IArray2D< Derived >::TypeConst

Definition at line 85 of file STK_IArray2D.h.

Member Enumeration Documentation

anonymous enum

template<class Derived >

anonymous enum

Enumerator
structure_
orient_
sizeRows_
sizeCols_
storage_

Definition at line 99 of file STK_IArray2D.h.

    {
      structure_ = hidden::Traits<Derived>::structure_,
      orient_    = hidden::Traits<Derived>::orient_,
      sizeRows_  = hidden::Traits<Derived>::sizeRows_,
      sizeCols_  = hidden::Traits<Derived>::sizeCols_,
      storage_   = hidden::Traits<Derived>::storage_
    };

Constructor & Destructor Documentation

IArray2D() [1/4]

template<class Derived >

STK::IArray2D< Derived >::IArray2D ( )

protected

Default constructor.

Definition at line 786 of file STK_IArray2D.h.

                           : Base2D(), Base()
                             , allocator_()
                             , rangeCols_()
{ mallocCols(this->cols());}

References STK::IArray2D< Derived >::cols(), and STK::IArray2D< Derived >::mallocCols().

IArray2D() [2/4]

template<class Derived >

STK::IArray2D< Derived >::IArray2D ( Range const &  I, Range const &  J  )

protected

constructor with specified ranges

Constructor with specified ranges.

Parameters

I,J	rows and columns range
I,J	range of the rows and columns

Definition at line 794 of file STK_IArray2D.h.

                           : Base2D(I,J), Base()
                           , allocator_()
                           , rangeCols_()
{  mallocCols(this->cols()); initializeCols(J);}

References STK::IArray2D< Derived >::cols(), STK::IArray2D< Derived >::initializeCols(), and STK::IArray2D< Derived >::mallocCols().

IArray2D() [3/4]

template<class Derived >

STK::IArray2D< Derived >::IArray2D ( IArray2D< Derived > const &  T, bool  ref = false  )

protected

Copy constructor If we want to wrap T, the main ptr will be wrapped in MemAllocator class.

If we want to copy T, Allocator is initialized to default values.

Note

bug correction, we have to use a copy of T.rangeCols_. in case we are using the code

Array2DVector<TYPE> Dref(D.sub(J), true)

we would get an error.

Parameters

T	the container to copy
ref	true if we wrap T

Definition at line 804 of file STK_IArray2D.h.

                           : Base2D(T), Base()
                           , allocator_(T.allocator_, ref)
                           , rangeCols_(T.rangeCols_, false) //  have to be created again, in case T is a temporary
{
  if (!ref)
  {
    initializeCols(T.cols()); // initialize the Columns
    for (int j=T.beginCols(); j<T.endCols(); j++)
    { copyCol(T, j);}
  }
}

References STK::IArray2D< Derived >::beginCols(), STK::IArray2D< Derived >::cols(), STK::IArray2D< Derived >::copyCol(), STK::IArray2D< Derived >::endCols(), and STK::IArray2D< Derived >::initializeCols().

IArray2D() [4/4]

template<class Derived >

template<class OtherDerived >

STK::IArray2D< Derived >::IArray2D ( IArray2D< OtherDerived > const &  T, Range const &  I, Range const &  J  )

protected

constructor by reference, ref_=1.

Parameters

T	the container to wrap
I,J	rows and columns to wrap

Definition at line 822 of file STK_IArray2D.h.

                           : Base2D(I,J), Base()
                           , allocator_(T.allocator_, J, true)  // a reference
                           , rangeCols_(T.rangeCols_, J, false) //  have to be created again, in case T is a temporary
                                          // T.rangeCols_ is itself a temporary that will be deleted
                                          // Tref(T.sub(J), true) for example
{
  for (int j=J.begin(); j<J.end(); j++)
  { rangeCols_[j] = inf(I, T.rangeCols()[j]);}
}

References STK::inf(), and STK::IArray2D< Derived >::rangeCols_.

~IArray2D()

template<class Derived >

STK::IArray2D< Derived >::~IArray2D ( )

protected

destructor.

Allocated horizontal memory (the array with the pointers on the columns) is liberated by the Allocator.

Definition at line 837 of file STK_IArray2D.h.

{ if (!isRef()) freeCols(cols());}

Member Function Documentation

allocator() [1/2]

template<class Derived >

Allocator & STK::IArray2D< Derived >::allocator ( )

inlineprotected

Returns

the allocator.

Definition at line 649 of file STK_IArray2D.h.

{ return allocator_;}

References STK::IArray2D< Derived >::allocator_.

allocator() [2/2]

template<class Derived >

Allocator const & STK::IArray2D< Derived >::allocator ( ) const

inline

Returns

the allocator.

Definition at line 204 of file STK_IArray2D.h.

{ return allocator_;}

References STK::IArray2D< Derived >::allocator_.

atCol()

template<class Derived >

hidden::Traits< Derived >::SubCol STK::IArray2D< Derived >::atCol

(

int

j

)

const

Returns

the column j.

Parameters

j	index of the column

Definition at line 159 of file STK_IArray2DSlicers.h.

{
  if (this->beginCols() > j) { STKOUT_OF_RANGE_1ARG(IArray2D::atCol, j, beginCols() > j);}
  if (this->endCols() <= j)  { STKOUT_OF_RANGE_1ARG(IArray2D::atCol, j, endCols() <= j);}
  return col(j);
}

References STK::IArray2D< Derived >::atCol(), and STKOUT_OF_RANGE_1ARG.

Referenced by STK::IArray2D< Derived >::atCol().

atRow()

template<class Derived >

hidden::Traits< Derived >::Row STK::IArray2D< Derived >::atRow

(

int

i

)

const

Returns

the row i.

Parameters

i	the index of the row

Definition at line 169 of file STK_IArray2DSlicers.h.

{
  if (this->beginRows() > i) { STKOUT_OF_RANGE_1ARG(IArray2D::atRow, i, beginRows() > i);}
  if (this->endRows() <= i)  { STKOUT_OF_RANGE_1ARG(IArray2D::at, i, lastIdxRows() < i);}
  return row(i);
}

References STK::IArray2D< Derived >::atRow(), and STKOUT_OF_RANGE_1ARG.

Referenced by STK::IArray2D< Derived >::atRow().

availableCols()

template<class Derived >

int STK::IArray2D< Derived >::availableCols ( ) const

inline

Returns

the maximum possible number of columns without reallocation.

Definition at line 210 of file STK_IArray2D.h.

{ return allocator_.size();}

References STK::IArray2D< Derived >::allocator_, and STK::MemAllocator< Type_, Size_ >::size().

beginCols()

template<class Derived >

int STK::IArray2D< Derived >::beginCols ( ) const

inline

Returns

the index of the first column

Definition at line 189 of file STK_IArray2D.h.

{ return Base2D::beginCols();}

References STK::IContainer2D< SizeRows_, SizeCols_ >::beginCols().

Referenced by STK::IArray2D< Derived >::IArray2D(), STK::IArray2D< Derived >::operator()(), STK::IArray2D< Derived >::operator()(), STK::IArray2D< Derived >::swapCols(), STK::IArray2D< Derived >::update(), and STK::IArray2D< Derived >::update().

beginRows()

template<class Derived >

int STK::IArray2D< Derived >::beginRows ( ) const

inline

Returns

the index of the first row

Definition at line 180 of file STK_IArray2D.h.

{ return Base2D::beginRows();}

References STK::IContainer2D< SizeRows_, SizeCols_ >::beginRows().

Referenced by STK::Svd< Array >::diag(), main(), STK::IArray2D< Derived >::operator()(), STK::IArray2D< Derived >::operator()(), and STK::Qr::qr().

capacityCol()

template<class Derived >

int STK::IArray2D< Derived >::capacityCol ( int  col ) const

inline

Returns

the capacity of the column col.

Parameters

col	index of the column we want the capacity

Definition at line 214 of file STK_IArray2D.h.

{ return ptr(col) ? ptr(col)->capacity() : 0;}

References STK::IArray2D< Derived >::col(), and STK::IArray2D< Derived >::ptr().

clear()

template<class Derived >

void STK::IArray2D< Derived >::clear

(

)

clear the object.

This will free all allocated memory and reset all range to Range(). (while freeMem() does not modify rows range (rows_)

Definition at line 844 of file STK_IArray2D.h.

{
  // Nothing to do for reference
  if (isRef()) return;
  freeMem();
  this->setRanges();
}

Referenced by STK::AdditiveBSplineCoefficients< Array >::run(), STK::IQr< Derived >::setData(), and STK::Stat::Univariate< TContainer1D, Real >::setData().

col() [1/3]

template<class Derived >

hidden::Traits< Derived >::Col STK::IArray2D< Derived >::col ( int  j ) const

inline

access to a part of a column.

Parameters

j	index of the column

Returns

a reference in the range I of the column j of this

Definition at line 47 of file STK_IArray2DSlicers.h.

{
#ifdef STK_BOUNDS_CHECK
       if (beginCols() > j) { STKOUT_OF_RANGE_1ARG(IArray::elt, j, beginCols() > j);}
       if (endCols() <= j)  { STKOUT_OF_RANGE_1ARG(IArray::elt, j, endCols() <= j);}
#endif
  return Col( this->asDerived(), this->rangeRowsInCol(j), j);
}

References STKOUT_OF_RANGE_1ARG.

Referenced by STK::IArray2D< Derived >::capacityCol(), main(), main(), STK::IArray2D< Derived >::rangeCol(), and STK::IArray2D< Derived >::update().

col() [2/3]

template<class Derived >

hidden::Traits< Derived >::SubCol STK::IArray2D< Derived >::col ( Range const &  I, int  j  ) const

inline

access to a part of a column.

Parameters

I	range of the rows
j	index of the col

Returns

a reference in the range I of the column j of this

Definition at line 61 of file STK_IArray2DSlicers.h.

{
#ifdef STK_BOUNDS_CHECK
  if (beginRows() > I.begin()) { STKOUT_OF_RANGE_2ARG(IArray::col, I, j, beginRows() > I.begin());}
  if (endRows() < I.end())    { STKOUT_OF_RANGE_2ARG(IArray::col, I, j, endRows() <= I.end());}
  if (beginCols() > j) { STKOUT_OF_RANGE_2ARG(IArray::col, I, j, beginCols() > j);}
  if (endCols() <= j)  { STKOUT_OF_RANGE_2ARG(IArray::col, I, j, endCols() <= j);}
#endif
  return SubCol( this->asDerived(), inf(I, this->rangeRowsInCol(j)), j);
}

References STK::inf(), and STKOUT_OF_RANGE_2ARG.

col() [3/3]

template<class Derived >

hidden::Traits< Derived >::SubArray STK::IArray2D< Derived >::col ( Range const &  J ) const

inline

access to many columns.

Parameters

J	range of the index of the cols

Returns

a 2D array containing the Container in the Horizontal range J

Definition at line 76 of file STK_IArray2DSlicers.h.

{ return SubArray( this->asDerived(), this->rows(), J);}

cols()

template<class Derived >

ColRange const & STK::IArray2D< Derived >::cols ( ) const

inline

Returns

the Horizontal range

Definition at line 187 of file STK_IArray2D.h.

{ return Base2D::cols();}

References STK::IContainer2D< SizeRows_, SizeCols_ >::cols().

Referenced by STK::IArray2D< Derived >::IArray2D(), STK::IArray2D< Derived >::IArray2D(), STK::IArray2D< Derived >::IArray2D(), STK::IArray2D< Derived >::merge(), and STK::IArray2D< Derived >::merge().

colsImpl()

template<class Derived >

ColRange const & STK::IArray2D< Derived >::colsImpl ( ) const

inline

Returns

the Horizontal range

Definition at line 175 of file STK_IArray2D.h.

{ return Base2D::cols();}

References STK::IContainer2D< SizeRows_, SizeCols_ >::cols().

copyCol()

template<class Derived >

void STK::IArray2D< Derived >::copyCol ( IArray2D< Derived > const &  src, int  j  )

private

copy column j of src into column j of this

Parameters

src	source to copy
j	index of the columns to copy

Definition at line 966 of file STK_IArray2D.h.

{
  PtrCol dp =allocator_.elt(j), sp =src.allocator_.elt(j);
  dp->assign(*sp);
}

Referenced by STK::IArray2D< Derived >::IArray2D().

elt2Impl() [1/2]

template<class Derived >

Type & STK::IArray2D< Derived >::elt2Impl ( int  i, int  j  )

inline

access to an element.

Parameters

i,j	indexes of the element to get

Returns

a reference on the (i,j) element

Definition at line 235 of file STK_IArray2D.h.

{ return allocator_.elt(j)->elt(i);}

References STK::IArray2D< Derived >::allocator_, and STK::MemAllocator< Type_, Size_ >::elt().

elt2Impl() [2/2]

template<class Derived >

TypeConst STK::IArray2D< Derived >::elt2Impl ( int  i, int  j  ) const

inline

constant access to an element.

Parameters

i,j	indexes of the element to get

Returns

a constant reference on the (i,j) element

Definition at line 240 of file STK_IArray2D.h.

{ return ptr(j)->elt(i);}

References STK::IArray2D< Derived >::ptr().

empty()

template<class Derived >

bool STK::IArray2D< Derived >::empty ( ) const

inline

Returns

true if the container is empty, false otherwise

Definition at line 201 of file STK_IArray2D.h.

{ return Base2D::empty();}

References STK::IContainer2D< SizeRows_, SizeCols_ >::empty().

endCols()

template<class Derived >

int STK::IArray2D< Derived >::endCols ( ) const

inline

Returns

the ending index of columns

Definition at line 191 of file STK_IArray2D.h.

{ return Base2D::endCols();}

References STK::IContainer2D< SizeRows_, SizeCols_ >::endCols().

Referenced by STK::IArray2D< Derived >::IArray2D(), STK::IArray2D< Derived >::operator()(), STK::IArray2D< Derived >::operator()(), STK::Qr::qr(), STK::IArray2D< Derived >::swapCols(), and STK::IArray2D< Derived >::update().

endRows()

template<class Derived >

int STK::IArray2D< Derived >::endRows ( ) const

inline

Returns

the ending index of the rows

Definition at line 182 of file STK_IArray2D.h.

{ return Base2D::endRows();}

References STK::IContainer2D< SizeRows_, SizeCols_ >::endRows().

Referenced by main(), STK::IArray2D< Derived >::operator()(), STK::IArray2D< Derived >::operator()(), and STK::Qr::qr().

erase()

template<class Derived >

void STK::IArray2D< Derived >::erase	(	int	pos,
		int	n = 1
	)

STL compatibility:Delete n elements at the pos index from the container.

Parameters

pos	index where to delete elements
n	number of elements to delete (default 1)

Definition at line 583 of file STK_IArray2DModifiers.h.

{
  STK_STATIC_ASSERT_ONE_DIMENSION_ONLY(Derived);
  if (structure_ == Arrays::vector_) { eraseRows(pos, n); }
  else { eraseCols(pos, n); }
 
}

References STK_STATIC_ASSERT_ONE_DIMENSION_ONLY, and STK::Arrays::vector_.

eraseCols()

template<class Derived >

void STK::IArray2D< Derived >::eraseCols	(	int	pos,
		int	n = 1
	)

Delete n columns at the specified position of the array.

Parameters

pos	the position of the deleted Columns
n	the number of column to delete (default is 1)

Definition at line 468 of file STK_IArray2DModifiers.h.

 {
   if (n<=0) return;
   if (isRef())
   { STKRUNTIME_ERROR_2ARG(IArray2D::eraseCols,pos,n,cannot operate on reference);}
#ifdef STK_BOUNDS_CHECK
   if (beginCols() > pos)
   { STKOUT_OF_RANGE_2ARG(IArray2D::eraseCols,pos,n,beginCols() > pos);}
   if (endCols() <= pos)
   { STKOUT_OF_RANGE_2ARG(IArray2D::eraseCols,pos,n,endCols() <= pos);}
   if (endCols() < pos+n)
   { STKOUT_OF_RANGE_2ARG(IArray2D::eraseCols,pos,n,endCols() < pos+n);}
#endif
   // delete each col
   freeCols(Range(pos, n));
   // update cols_, rangeCols_
   this->decLastIdxCols(n);
   rangeCols_.erase(pos, n);
   allocator_.memmove(pos, Range(pos+n, endCols()-pos));
   // liberate memory if there is no more columns (don't use clear(), as we want to preserve rows_)
   if (sizeCols() == 0) { freeMem();}
 }

Referenced by STK::IArray2D< Array2D< Type_ > >::popBackCols(), STK::IArray2D< Array2D< Type_ > >::popFrontCols(), and STK::IArray2D< Array2D< Type_ > >::pushBackCols().

eraseRows()

template<class Derived >

void STK::IArray2D< Derived >::eraseRows	(	int	pos,
		int	n = 1
	)

Delete n rows at the position pos.

Parameters

pos	index where to delete elements
n	number of rows to delete (default is 1)

Definition at line 528 of file STK_IArray2DModifiers.h.

 {
   if (n<=0) return;
   // is this structure just a pointer?
   if (isRef())
   { STKRUNTIME_ERROR_2ARG(IArray2D::eraseRows,pos,n,cannot operate on reference);}
#ifdef STK_BOUNDS_CHECK
   if (beginRows() > pos)
   { STKOUT_OF_RANGE_2ARG(IArray2D::eraseRows,pos,n,beginRows() > pos);}
   if (endRows() <= pos)
   { STKOUT_OF_RANGE_2ARG(IArray2D::eraseRows,pos,n,endRows() <= pos);}
   if (endRows() < pos+n)
   { STKOUT_OF_RANGE_2ARG(IArray2D::eraseRows,pos,n,endRows() < pos+n);}
#endif
 
   for (int j=beginCols(); j<endCols(); j++) { eraseRowsCol(j, pos, n);}
   this->decLastIdxRows(n);
 }

References STK::IArray2D< Derived >::eraseRows(), STKOUT_OF_RANGE_2ARG, and STKRUNTIME_ERROR_2ARG.

Referenced by STK::SArray2DVector< Type_ >::erase(), STK::IArray2D< Derived >::eraseRows(), and main().

eraseRowsCol()

template<class Derived >

void STK::IArray2D< Derived >::eraseRowsCol ( int  col, int  pos, int  n  )

private

Internal method for deleting rows from a specified column.

Delete n rows at the position pos to the column col of the array.

Note

It is possible to remove data outside the range of the column (but not outside the range of the array). In this case it is assumed that the data are zero and are not stored by the array (like for triangular or diagonal matrices).

Warning

No check is done about indexes.

Parameters

col,pos,n

index of the column, row position and number of elements to delete

Definition at line 643 of file STK_IArray2DModifiers.h.

{
  // check trivial cases
  if (rangeCols_[col].lastIdx() < pos) return;
  if (rangeCols_[col].begin()> pos+n-1)
  { shiftRowCol( col, rangeCols_[col].begin() - n); return;}
 
  // find the existing rows to delete
  Range newRange(pos, n);
  newRange.inf(rangeCols_[col]);
  if (newRange == rangeCols_[col]) { freeCol(col); return;}
 
  // copy remaining rows
  allocator_.elt(col)->memmove(newRange.begin(), newRange.end(), rangeCols_[col].end() - newRange.end());
  rangeCols_[col].decLast(newRange.size());
 
  // shift if necessary [if pos<newRange.begin() there is a "padding" to take into account]
  if (pos < newRange.begin())
  { shiftRowCol( col, rangeCols_[col].begin() - (n-newRange.size()));}
}

exchange()

template<class Derived >

void STK::IArray2D< Derived >::exchange

(

IArray2D< Derived > &

T

)

exchange this container with T.

Parameters

T	the container to exchange with this

Definition at line 872 of file STK_IArray2D.h.

{
  // swap MemAllocator part
  allocator_.exchange(T.allocator_);
  Base2D::exchange(T);
  rangeCols_.exchange(T.rangeCols_);
}

References STK::IArray2D< Derived >::allocator_, and STK::IArray2D< Derived >::rangeCols_.

freeCol()

template<class Derived >

void STK::IArray2D< Derived >::freeCol ( int  col )

private

Internal method for memory deallocation.

Parameters

col	the number of the column to free

Definition at line 1051 of file STK_IArray2D.h.

{
#ifdef STK_DEBUG_ARRAY2D
  stk_cout << _T("Entering freeCol\n");
  stk_cout << _T("Deleting col=") << col <<_T(", rangeCols_[col]=") << rangeCols_[col] <<_T("\n");
  stk_cout << _T("allocator_.elt(col)=") << allocator_.elt(col) <<_T("\n");
#endif
  if (allocator_.elt(col)) // if there is a column at this position
  {
    delete allocator_.elt(col);
    allocator_.elt(col) =0;
    rangeCols_[col] = Range();
  }
}

References _T, and stk_cout.

freeCols()

template<class Derived >

void STK::IArray2D< Derived >::freeCols ( Range const &  J )

private

Internal method for releasing memory in a given range of columns.

Parameters

J	range of columns to liberate.

Definition at line 959 of file STK_IArray2D.h.

{ for (int j=J.begin(); j<J.end(); j++) { freeCol(j);}}

freeMem()

template<class Derived >

void STK::IArray2D< Derived >::freeMem ( )

private

Internal method for memory deallocation.

This method clear all allocated memory and reset ranges to default value. Do nothing if this is a reference Range of the columns is set to default. Range of the rows (rows_) remains unmodified.

Definition at line 887 of file STK_IArray2D.h.

{
  if (isRef()) return;
  freeCols(cols());
  // free memory allocated in allocator.
  // For fixed size arrays, the size remain the same
  allocator_.free();
  setCols(allocator_.range());
  // clear arrays
  rangeCols_.resize(cols());
}

initializeCol()

template<class Derived >

void STK::IArray2D< Derived >::initializeCol ( int  col, Range const &  I  )

private

Internal method for initializing a column.

Method for the allocation of memory of the column col with given range I.

Parameters

col,I

index and range of the column to initialize

Definition at line 1024 of file STK_IArray2D.h.

{
#ifdef STK_DEBUG_ARRAY2D
  stk_cout << _T("Entering initializeCol\n");
  stk_cout << _T("Initialize col=") << col <<_T(", I=") << I <<_T("\n");
#endif
  if (I.size() <=0)
  {
    allocator_.elt(col) = 0;
    rangeCols_[col] = I;
    return;
  }
  // try to allocate memory
  try
  { allocator_.elt(col) = new ColVector(I);}
  catch (std::bad_alloc & error)  // if an alloc error occur
  {
    allocator_.elt(col) = 0;
    rangeCols_[col] = Range();
    STKRUNTIME_ERROR_2ARG(IArray2D::initializeCol,col, I,memory allocation failed.);
  }
  rangeCols_[col] = I;
}

References _T, STK::IRunnerBase::error(), STK::IArray2D< Derived >::initializeCol(), stk_cout, and STKRUNTIME_ERROR_2ARG.

Referenced by STK::IArray2D< Derived >::initializeCol().

initializeCols()

template<class Derived >

void STK::IArray2D< Derived >::initializeCols ( Range const &  J )

private

Internal method for memory allocation and initialization of a range of columns.

The capacity for the rows have to be set before calling this method.

Parameters

J	vertical range of the Columns to initialize

Definition at line 935 of file STK_IArray2D.h.

{
#ifdef STK_BOUNDS_CHECK
if (beginCols() > J.begin())
{ STKOUT_OF_RANGE_1ARG(IArray2D::initializeCols, J, beginCols() > J.begin());}
if (endCols() < J.end())
{ STKOUT_OF_RANGE_1ARG(IArray2D::initializeCols, J, endCols() < J.end());}
#endif
  for (int j=J.begin(); j<J.end(); j++)
  {
    try
    { initializeCol(j, this->rangeRowsInCol(j));}
    catch (Exception const& error) // if an error occur
    {
      // free each column allocated and throw exception
      for (int k=J.begin(); k<j; k++) freeCol(k);
      throw error;
    }
  }
}

References STK::IRunnerBase::error(), STK::IArray2D< Derived >::initializeCols(), and STKOUT_OF_RANGE_1ARG.

Referenced by STK::IArray2D< Derived >::IArray2D(), STK::IArray2D< Derived >::IArray2D(), and STK::IArray2D< Derived >::initializeCols().

insert()

template<class Derived >

void STK::IArray2D< Derived >::insert	(	Range const &	I,
		Type const &	v
	)

STL compatibility: insert element v in the range I of the Array.

Parameters

v,I	value and range of indexes

Definition at line 571 of file STK_IArray2DModifiers.h.

{ // insert defined for vector, point and diagonal arrays
  STK_STATIC_ASSERT_ONE_DIMENSION_ONLY(Derived);
  this->asDerived().insertElt(I.begin(), I.size());
  for (int i=I.begin(); i<I.end(); i++) { elt(i) = v;}
}

References STK_STATIC_ASSERT_ONE_DIMENSION_ONLY.

insertCols()

template<class Derived >

void STK::IArray2D< Derived >::insertCols	(	int	pos,
		int	n = 1
	)

Insert n columns at the index pos to the array.

Parameters

pos	position to insert columns
n	the number of column to insert (default is 1)

Definition at line 440 of file STK_IArray2DModifiers.h.

 {
   if (n <= 0) return;
 
   if (isRef())
   { STKRUNTIME_ERROR_2ARG(IArray2D::insertCols,pos,n,cannot operate on reference);}
#ifdef STK_BOUNDS_CHECK
   if (beginCols() > pos)
   { STKOUT_OF_RANGE_2ARG(IArray2D::insertCols,pos,n,beginCols() > pos);}
   if (endCols() < pos)
   { STKOUT_OF_RANGE_2ARG(IArray2D::insertCols,pos,n,endCols() < pos);}
#endif
   // compute column range of the array after insertion
   Range OldRange(cols()), NewRange(cols());
   NewRange.incLast(n);
   reallocCols(NewRange);
   // translate and copy last Columns from Taux to this
   for (int k=OldRange.lastIdx(); k>=pos; k--)
   { transferCol(k+n, k);}
   // initialize the rows in the range pos:pos+n-1
   nullCols( Range(pos, n) );
   initializeCols( Range(pos, n) );
 }

Referenced by main(), and STK::IArray2D< Array2D< Type_ > >::pushFrontRows().

insertRows()

template<class Derived >

void STK::IArray2D< Derived >::insertRows	(	int	pos,
		int	n = 1
	)

Insert n rows at position pos in the array If pos is outside the range of a column, then the method do nothing (useful for triangular/diagonal/... arrays).

Parameters

pos	index where to insert rows
n	number of elements to insert (default is 1)

Definition at line 499 of file STK_IArray2DModifiers.h.

 {
   if (n <= 0) return;
   if (isRef())
   { STKRUNTIME_ERROR_2ARG(IArray2D::insertRows,pos,n,cannot operate on reference);}
#ifdef STK_BOUNDS_CHECK
   if (beginRows() > pos)
   { STKOUT_OF_RANGE_2ARG(IArray2D::insertRows,pos,n,beginRows() > pos);}
   if (endRows() < pos)
   { STKOUT_OF_RANGE_2ARG(IArray2D::insertRows,pos,n,endRows() < pos);}
#endif
 
   this->incLastIdxRows(n);
   for (int j=beginCols(); j<endCols(); j++)
   {
      if (!allocator_.elt(j))
      { initializeCol(j, this->rangeRowsInCol(j));}
      else
      {
      if ( (pos >= rangeCols_[j].begin()) && (pos <= rangeCols_[j].end()))
      { insertRowsCol(j, pos, n);}
     }
   }
 }

Referenced by STK::IArray2D< Array2D< Type_ > >::erase(), STK::IArray2D< Array2D< Type_ > >::insert(), STK::SArray2DVector< Type_ >::insertElt(), and main().

insertRowsCol()

template<class Derived >

void STK::IArray2D< Derived >::insertRowsCol ( int  col, int  pos, int  n  )

private

Internal method for inserting rows to a specified column.

Insert n rows at the position pos to the column column of the array. No check is done about the index.

Parameters

col,pos,n

column position, row position and number of rows to insert

Definition at line 625 of file STK_IArray2DModifiers.h.

{
  allocator_.elt(col)->insertElt(pos, n);
  rangeCols_[col].incLast(n);
}

isRef()

template<class Derived >

bool STK::IArray2D< Derived >::isRef ( ) const

inline

Returns

true if the container is empty, false otherwise

Definition at line 171 of file STK_IArray2D.h.

{ return allocator_.isRef();}

References STK::IArray2D< Derived >::allocator_, and STK::MemAllocator< Type_, Size_ >::isRef().

Referenced by main(), STK::IArray2D< Derived >::merge(), and STK::IArray2D< Derived >::merge().

lastIdxCols()

template<class Derived >

int STK::IArray2D< Derived >::lastIdxCols ( ) const

inline

Returns

the index of the last column

Definition at line 196 of file STK_IArray2D.h.

{ return Base2D::lastIdxCols();}

References STK::IContainer2D< SizeRows_, SizeCols_ >::lastIdxCols().

Referenced by STK::IArray2D< Derived >::update().

lastIdxRows()

template<class Derived >

int STK::IArray2D< Derived >::lastIdxRows ( ) const

inline

Returns

the index of the last row

Definition at line 198 of file STK_IArray2D.h.

{ return Base2D::lastIdxRows();}

References STK::IContainer2D< SizeRows_, SizeCols_ >::lastIdxRows().

Referenced by STK::Svd< Array >::diag().

mallocCols()

template<class Derived >

void STK::IArray2D< Derived >::mallocCols ( ColRange const &  J )

private

Internal method for memory allocation and initialization of the horizontal range of the container.

This method is called once at creation of the container.

The range of the column is not set in this method. Except if an error occur during memory allocation, cols_ will be set to default and an error thrown.

Parameters

J	horizontal range

Definition at line 905 of file STK_IArray2D.h.

{
  // try to allocate memory
  try
  {
    if (J.size() > availableCols())
    {
      // compute the necessary size
      int size= Arrays::evalSizeCapacity(J.size());
      allocator_.malloc(Range(J.begin(), size)); // allocate memory for the columns
    }
    else
    { allocator_.shift(J.begin());}
    rangeCols_.resize(J);
  }
  catch (Exception const& error)   // if an error occur
  {
    Base2D::setCols();      // set default range
    rangeCols_.clear();     // clear this->rangeCols_
    allocator_.free();      // initialize with zero
    allocator_.setValue(0); // initialize with zero
    throw error;            // throw the error
  }
  allocator_.setValue(0); // initialize with zero
}

References STK::IRunnerBase::error(), and STK::Arrays::evalSizeCapacity().

Referenced by STK::IArray2D< Derived >::IArray2D(), and STK::IArray2D< Derived >::IArray2D().

merge() [1/2]

template<class Derived >

template<class OtherDerived >

void STK::IArray2D< Derived >::merge ( IArray1D< OtherDerived > const &  other )

inline

Append the vector other to this without copying the data explicitly.

other is appended to this and other will become a reference container. The data in itself are not altered, the Array1D become a reference on its own data.

Parameters

other

the container to merge with this

Definition at line 587 of file STK_IArray2D.h.

     {
       // checks
       if (isRef())
       { STKRUNTIME_ERROR_NO_ARG(IArray2D::merge(IArray1D),*this is a reference.);}
       if (other.isRef())
       { STKRUNTIME_ERROR_NO_ARG(IArray2D::merge(IArray1D),other is a reference.);}
       // if there is no columns, we can safely modify the vertical range
       if (this->sizeCols() <= 0) setRows(other.range());
       if (this->rows() != other.range())
       { STKRUNTIME_ERROR_NO_ARG(IArray2D::merge(IArray1D),this->rows() != other.range());}
 
       // compute horizontal range of the container after insertion
       Range cols(this->cols());
 
       // reallocate memory for the columns
       cols.incLast(1);
       reallocCols(cols);
 
       // set column
       allocator_.elt(cols.lastIdx()) = const_cast<OtherDerived*>(other.asPtrDerived());
       rangeCols_[cols.lastIdx()] = other.range();
 
       // set other as reference
       other.setRef(true);
     }

References STK::IArray2D< Derived >::allocator_, STK::IArray2D< Derived >::cols(), STK::MemAllocator< Type_, Size_ >::elt(), STK::TRange< UnknownSize >::incLast(), STK::IArray2D< Derived >::isRef(), STK::TRange< Size_ >::lastIdx(), STK::IArray2D< Derived >::merge(), STK::IArray2D< Derived >::rangeCols_, STK::IArray2D< Derived >::reallocCols(), STK::IArray2D< Derived >::rows(), STK::IArray2D< Derived >::setRows(), STK::IArray2D< Derived >::sizeCols(), and STKRUNTIME_ERROR_NO_ARG.

merge() [2/2]

template<class Derived >

template<class OtherDerived >

void STK::IArray2D< Derived >::merge ( IArray2D< OtherDerived > const &  other )

inline

Append the container other to this without copying the data explicitly.

The column of other are appended to this.

Observe that the const keyword is not respected in this method: but it is useful to define this method even for constant objects.

Note

data in itself are not altered nor duplicated, thus other and this possess the same columns.

Parameters

other

the container to merge with this

Definition at line 548 of file STK_IArray2D.h.

     {
       //checks
       if (isRef())
       { STKRUNTIME_ERROR_NO_ARG(IArray2D::merge(other),*this is a reference.);}
       if (other.isRef())
       { STKRUNTIME_ERROR_NO_ARG(IArray2D::merge(other),other is a reference.);}
       // if there is no columns, we can safely modify the vertical range
       if (this->sizeCols() <= 0) setRows(other.rows());
       if (this->rows() != other.rows())
       { STKRUNTIME_ERROR_NO_ARG(IArray2D::merge(other),this->rows() != other.rows());}
 
       // break const reference
       IArray2D< OtherDerived>& Tref = const_cast<IArray2D< OtherDerived>&>(other);
       // compute horizontal range of the container after insertion
       Range cols(this->cols());
 
       // save first index of the first column added before modification of cols
       const int first = cols.end();
       // reallocate memory for the columns
       cols.incLast(Tref.sizeCols());
       reallocCols(cols);
 
       // copy data from other
       Tref.shiftCols(first); // easiest like that
       for (int j=first; j< cols.end(); j++)
       { transferCol(Tref, j);}
 
       // delete and set view on the data
       Tref.allocator().free();
       Tref.allocator().setPtr(allocator_.p_data(), Tref.cols(), true);
     }

References STK::IArray2D< Derived >::allocator_, STK::IArray2D< Derived >::cols(), STK::TRange< Size_ >::end(), STK::TRange< Size_ >::incLast(), STK::IArray2D< Derived >::isRef(), STK::IArray2D< Derived >::merge(), STK::MemAllocator< Type_, Size_ >::p_data(), STK::IArray2D< Derived >::reallocCols(), STK::IArray2D< Derived >::rows(), STK::IArray2D< Derived >::setRows(), STK::IArray2D< Derived >::sizeCols(), STKRUNTIME_ERROR_NO_ARG, and STK::IArray2D< Derived >::transferCol().

Referenced by STK::AdditiveBSplineCoefficients< Array >::extrapolate(), main(), STK::IArray2D< Derived >::merge(), STK::IArray2D< Derived >::merge(), and STK::AdditiveBSplineCoefficients< Array >::run().

move()

template<class Derived >

Derived & STK::IArray2D< Derived >::move

(

Derived const &

T

)

move T to this.

Note

: T is not modified but just set as a reference of the data it was responsible.

Parameters

T	the array to move.

Definition at line 856 of file STK_IArray2D.h.

{
  if (this->asPtrDerived() == &T) return this->asDerived();
  if (!isRef()) { freeCols(cols());}
  // move Base part
  allocator_.move(T.allocator_); // T become a reference
  rangeCols_.move(T.rangeCols_);
  // Set IContainer2D part
  setCols(T.cols());
  setRows(T.rows());
  return this->asDerived();
}

Referenced by STK::applySort1D(), main(), STK::MultidimRegression< Array, Weight >::regressionStep(), and STK::MultidimRegression< Array, Weight >::regressionStep().

nullCol()

template<class Derived >

void STK::IArray2D< Derived >::nullCol ( int  col )

private

Internal method setting default parameters and dimension to a column of the container.

Parameters

col	the position of the column to initialize to a default value.

Note

if data is allocated, it will be lost

Definition at line 1013 of file STK_IArray2D.h.

{
  allocator_.elt(col) = 0;
  rangeCols_[col] = Range();
}

nullCols()

template<class Derived >

void STK::IArray2D< Derived >::nullCols ( ColRange const &  J )

protected

Internal method for initializing to default values (null pointer and null range) to a range of columns.

Parameters

J	horizontal range

Definition at line 998 of file STK_IArray2D.h.

{
#ifdef STK_BOUNDS_CHECK
  if (beginCols() > J.begin())
  { STKOUT_OF_RANGE_1ARG(IArray2D::nullCols, J, beginCols() > J.begin());}
  if (endCols() < J.end())
  { STKOUT_OF_RANGE_1ARG(IArray2D::nullCols, J, endCols() < J.end());}
#endif
  for (int j=J.begin(); j<J.end(); ++j) { nullCol(j);}
}

References STK::IArray2D< Derived >::nullCols(), and STKOUT_OF_RANGE_1ARG.

Referenced by STK::IArray2D< Derived >::nullCols().

operator()() [1/7]

template<class Derived >

Type & STK::IArray2D< Derived >::operator() ( )

inline

Returns

the number

Definition at line 296 of file STK_IArray2D.h.

{ return elt();}

operator()() [2/7]

template<class Derived >

TypeConst STK::IArray2D< Derived >::operator() ( ) const

inline

Returns

a constant reference on the number

Definition at line 294 of file STK_IArray2D.h.

{ return elt();}

operator()() [3/7]

template<class Derived >

Type & STK::IArray2D< Derived >::operator() ( int  i, int  j  )

inline

Returns

a reference on the element (i,j) of the 2D container.

Parameters

i,j	indexes of the element to get

Definition at line 259 of file STK_IArray2D.h.

    {
#ifdef STK_BOUNDS_CHECK
       if (this->beginRows() > i) { STKOUT_OF_RANGE_2ARG(IArray2D::elt, i, j, beginRows() > i);}
       if (this->endRows() <= i)  { STKOUT_OF_RANGE_2ARG(IArray2D::elt, i, j, endRows() <= i);}
       if (this->beginCols() > j) { STKOUT_OF_RANGE_2ARG(IArray2D::elt, i, j, beginCols() > j);}
       if (this->endCols() <= j)  { STKOUT_OF_RANGE_2ARG(IArray2D::elt, i, j, endCols() <= j);}
#endif
      return elt(i,j);
    }

References STK::IArray2D< Derived >::beginCols(), STK::IArray2D< Derived >::beginRows(), STK::IArray2D< Derived >::endCols(), STK::IArray2D< Derived >::endRows(), and STKOUT_OF_RANGE_2ARG.

operator()() [4/7]

template<class Derived >

TypeConst STK::IArray2D< Derived >::operator() ( int  i, int  j  ) const

inline

Returns

a constant reference on the element (i,j) of the 2D container.

Parameters

i,j	row and column indexes

Definition at line 246 of file STK_IArray2D.h.

    {
#ifdef STK_BOUNDS_CHECK
       if (beginRows() > i) { STKOUT_OF_RANGE_2ARG(IArray::elt, i, j, beginRows() > i);}
       if (endRows() <= i)  { STKOUT_OF_RANGE_2ARG(IArray::elt, i, j, endRows() <= i);}
       if (beginCols() > j) { STKOUT_OF_RANGE_2ARG(IArray::elt, i, j, beginCols() > j);}
       if (endCols() <= j)  { STKOUT_OF_RANGE_2ARG(IArray::elt, i, j, endCols() <= j);}
#endif
      return elt(i,j);
    }

References STK::IArray2D< Derived >::beginCols(), STK::IArray2D< Derived >::beginRows(), STK::IArray2D< Derived >::endCols(), STK::IArray2D< Derived >::endRows(), and STKOUT_OF_RANGE_2ARG.

operator()() [5/7]

template<class Derived >

hidden::Traits< Derived >::SubRow STK::IArray2D< Derived >::operator() ( int  i, Range const &  J  ) const

inline

Parameters

i,J	index of the row and range of the columns

Returns

an Horizontal container containing the row i of this in the range J

Definition at line 147 of file STK_IArray2DSlicers.h.

{ return this->row(i, J);}

operator()() [6/7]

template<class Derived >

hidden::Traits< Derived >::SubCol STK::IArray2D< Derived >::operator() ( Range const &  I, int  j  ) const

inline

Parameters

I,j	range of the rows and index of the column

Returns

a Vertical container containing the column j of this in the range I

Definition at line 131 of file STK_IArray2DSlicers.h.

{
#ifdef STK_BOUNDS_CHECK
  if (beginRows() > I.begin()) { STKOUT_OF_RANGE_2ARG(IArray::operator(), I, j, beginRows() > I.begin());}
  if (endRows() < I.end())    { STKOUT_OF_RANGE_2ARG(IArray::operator(), I, j, endRows() < I.end());}
  if (beginCols() > j) { STKOUT_OF_RANGE_2ARG(IArrayBase::operator(), I, j, beginCols() > j);}
  if (endCols() <= j)  { STKOUT_OF_RANGE_2ARG(IArrayBase::operator(), I, j, endCols() < j);}
#endif
  return col(I, j);
}

References STKOUT_OF_RANGE_2ARG.

operator()() [7/7]

template<class Derived >

hidden::Traits< Derived >::SubArray STK::IArray2D< Derived >::operator() ( Range const &  I, Range const &  J  ) const

inline

Parameters

I,J	range of the rows and of the columns

Returns

a 2D container containing this in the range I, J

Definition at line 152 of file STK_IArray2DSlicers.h.

{ return sub(I, J);}

operator[]() [1/3]

template<class Derived >

Type & STK::IArray2D< Derived >::operator[] ( int  i )

inline

Returns

a reference on the ith element

Parameters

i	index of the element to get

Definition at line 284 of file STK_IArray2D.h.

    {
      STK_STATIC_ASSERT_ONE_DIMENSION_ONLY(Derived);
#ifdef STK_BOUNDS_CHECK
      if (this->asDerived().begin() > i) { STKOUT_OF_RANGE_1ARG(IArray2D::elt, i, begin() > i);}
      if (this->asDerived().end() <= i)  { STKOUT_OF_RANGE_1ARG(IArray2D::elt, i, end() <= i);}
#endif
      return elt(i);
    }

References STK_STATIC_ASSERT_ONE_DIMENSION_ONLY, and STKOUT_OF_RANGE_1ARG.

operator[]() [2/3]

template<class Derived >

TypeConst STK::IArray2D< Derived >::operator[] ( int  i ) const

inline

Returns

the ith element

Parameters

i	index of the element to get

Definition at line 272 of file STK_IArray2D.h.

    {
      STK_STATIC_ASSERT_ONE_DIMENSION_ONLY(Derived);
#ifdef STK_BOUNDS_CHECK
      if (this->asDerived().begin() > i) { STKOUT_OF_RANGE_1ARG(IArray2D::elt, i, begin() > i);}
      if (this->asDerived().end() <= i)  { STKOUT_OF_RANGE_1ARG(IArray2D::elt, i, end() <= i);}
#endif
      return elt(i);
    }

References STK_STATIC_ASSERT_ONE_DIMENSION_ONLY, and STKOUT_OF_RANGE_1ARG.

operator[]() [3/3]

template<class Derived >

hidden::Traits< Derived >::SubVector STK::IArray2D< Derived >::operator[] ( Range const &  I ) const

inline

Returns

the sub-vector in given range

Parameters

I	range to get

Definition at line 120 of file STK_IArray2DSlicers.h.

{
  STK_STATIC_ASSERT_ONE_DIMENSION_ONLY(Derived);
  return sub(I);
}

References STK_STATIC_ASSERT_ONE_DIMENSION_ONLY.

popBackCols()

template<class Derived >

void STK::IArray2D< Derived >::popBackCols

(

int

n = 1

)

Delete last columns of the array.

Parameters

n	the number of Columns to delete (default is 1)

Definition at line 371 of file STK_IArray2DModifiers.h.

{
  if (n<=0) return;
  if (isRef())
  { STKRUNTIME_ERROR_1ARG(IArray2D::popBackCols,n,cannot operate on reference);}
#ifdef STK_BOUNDS_CHECK
  if (sizeCols() < n)
  { STKOUT_OF_RANGE_1ARG(IArray2D::popBackCols,n,sizeCol() < n);}
#endif
 
  eraseCols(endCols()-n, n);
}

Referenced by main(), STK::IArray2D< Derived >::popFrontCols(), STK::IArray2D< Array2D< Type_ > >::reserveCols(), and STK::IArray2D< Array2D< Type_ > >::reserveRows().

popBackRows()

template<class Derived >

void STK::IArray2D< Derived >::popBackRows

(

int

n = 1

)

Delete n latest rows of the array.

Parameters

n	number of rows to delete (default is 1)

Definition at line 255 of file STK_IArray2DModifiers.h.

{
  if (n <= 0) return;
  if (isRef())
  { STKRUNTIME_ERROR_1ARG(IArray2D::popBackRows,n,cannot operate on reference);}
#ifdef STK_BOUNDS_CHECK
  if (sizeRows() < n)
  { STKOUT_OF_RANGE_1ARG(IArray2D::popBackRows,n,sizeRows() < n);}
#endif
  eraseRows(endRows()-n, n);
}

References STK::IArray2D< Derived >::popBackRows(), STKOUT_OF_RANGE_1ARG, and STKRUNTIME_ERROR_1ARG.

Referenced by STK::IArray2D< Derived >::popBackRows().

popFrontCols()

template<class Derived >

void STK::IArray2D< Derived >::popFrontCols

(

int

n = 1

)

Delete first columns of the array.

Parameters

n	the number of Columns to delete (default is 1)

Definition at line 355 of file STK_IArray2DModifiers.h.

{
  if (n<=0) return;
  if (isRef())
  { STKRUNTIME_ERROR_1ARG(IArray2D::popBackCols,n,cannot operate on reference);}
#ifdef STK_BOUNDS_CHECK
  if (sizeCols() < n)
  { STKOUT_OF_RANGE_1ARG(IArray2D::popBackCols,n,sizeCol() < n);}
#endif
 
  eraseCols(beginCols(), n);
}

References STK::IArray2D< Derived >::popBackCols(), STKOUT_OF_RANGE_1ARG, and STKRUNTIME_ERROR_1ARG.

popFrontRows()

template<class Derived >

void STK::IArray2D< Derived >::popFrontRows

(

int

n = 1

)

Delete n first rows of the array.

Parameters

n	number of rows to delete (default is 1)

Definition at line 240 of file STK_IArray2DModifiers.h.

{
  if (n <= 0) return;
  if (isRef())
  { STKRUNTIME_ERROR_1ARG(IArray2D::popFrontRows,n,cannot operate on reference);}
#ifdef STK_BOUNDS_CHECK
  if (sizeRows() < n)
  { STKOUT_OF_RANGE_1ARG(IArray2D::popFrontRows,n,sizeRows() < n);}
#endif
  eraseRows(endRows()-n, n);
}

References STK::IArray2D< Derived >::popFrontRows(), STKOUT_OF_RANGE_1ARG, and STKRUNTIME_ERROR_1ARG.

Referenced by STK::IArray2D< Derived >::popFrontRows().

ptr()

template<class Derived >

PtrColConst STK::IArray2D< Derived >::ptr ( int  j ) const

inline

Returns

a constant pointer on the j-th column of the container

Parameters

j	the index of the column

Definition at line 208 of file STK_IArray2D.h.

{ return allocator_.elt(j);}

References STK::IArray2D< Derived >::allocator_, and STK::MemAllocator< Type_, Size_ >::elt().

Referenced by STK::IArray2D< Derived >::capacityCol(), and STK::IArray2D< Derived >::elt2Impl().

push_back()

template<class Derived >

void STK::IArray2D< Derived >::push_back

(

Type const &

v

)

STL compatibility: append an element v.

Parameters

v	value to append back

Definition at line 561 of file STK_IArray2DModifiers.h.

{ // push_back defined for vector, point and diagonal arrays
  STK_STATIC_ASSERT_ONE_DIMENSION_ONLY(Derived);
  this->asDerived().pushBack();
  this->back() = v;
}

References STK_STATIC_ASSERT_ONE_DIMENSION_ONLY.

push_front()

template<class Derived >

void STK::IArray2D< Derived >::push_front

(

Type const &

v

)

STL compatibility: push front an element.

Parameters

v	value to push front

Definition at line 552 of file STK_IArray2DModifiers.h.

{ // push_front defined for vector, point and diagonal arrays
  STK_STATIC_ASSERT_ONE_DIMENSION_ONLY(Derived);
  insert(Range(this->begin(), 1), v);
}

References STK_STATIC_ASSERT_ONE_DIMENSION_ONLY.

pushBackCols() [1/2]

template<class Derived >

template<class Other >

Derived & STK::IArray2D< Derived >::pushBackCols

(

IArray1D< Other > const &

other

)

Specialization for Array1D.

merge (by value) the array other with this

Parameters

other

the column to add to this

Definition at line 413 of file STK_IArray2DModifiers.h.

{
  // check if the array is empty
  if (empty())
  {
    resize(other.rows(),1);
    for (int i=other.begin(); i<other.end(); i++)
      (*this)(i, lastIdxCols()) = other[i];
    return this->asDerived();
  }
  // not empty
  if (other.rows() != this->rows())
  { STKRUNTIME_ERROR_NO_ARG(IArray2D::pushBackCols(other),other.rows() != rows());}
  int last = endCols();
  pushBackCols();
  for (int i=other.begin(); i<other.end(); i++)
    (*this)(i, last) = other[i];
  // return this
  return this->asDerived();
}

pushBackCols() [2/2]

template<class Derived >

void STK::IArray2D< Derived >::pushBackCols

(

int

n = 1

)

Add n columns at the end of the array.

Parameters

n	the number of Columns to add (default is 1)

Definition at line 343 of file STK_IArray2DModifiers.h.

{
  if (n <= 0) return;
  if (isRef())
  { STKRUNTIME_ERROR_1ARG(IArray2D::pushBackCols,n,cannot operate on reference);}
 
  insertCols(endCols(), n );
}

References STK::IArray2D< Derived >::pushBackCols(), and STKRUNTIME_ERROR_1ARG.

Referenced by main(), and STK::IArray2D< Derived >::pushBackCols().

pushBackRows() [1/2]

template<class Derived >

template<class Other >

Derived & STK::IArray2D< Derived >::pushBackRows

(

ExprBase< Other > const &

other

)

set other at the end of this (concatenate).

Perform a copy of the values stored in other to this.

Parameters

other

the array to add back

Note

the size and the type have to match

Definition at line 302 of file STK_IArray2DModifiers.h.

{
  // check if the array is empty
  if (empty())
  {
    this->asDerived() = other.asDerived();
    return this->asDerived();
  }
  // not empty
  if (other.cols() != this->cols())
    STKRUNTIME_ERROR_NO_ARG(IArray2D::pushBackRows,range of the columns are different);
  // add nbRow to existing rows
  int nbRow = other.sizeRows();
  pushBackRows(nbRow);
  for (int j=beginCols(); j< endCols(); ++j)
  {
    // start from the end in order to avoid
    for (int i=this->lastIdxRows(), iOther= other.lastIdxRows(); iOther>=other.beginRows(); --i, --iOther)
    { elt(i,j) = other.elt(iOther,j);}
  }
  // return this
  return this->asDerived();
}

References STK::IArray2D< Derived >::pushBackRows(), and STKRUNTIME_ERROR_NO_ARG.

pushBackRows() [2/2]

template<class Derived >

void STK::IArray2D< Derived >::pushBackRows

(

int

n = 1

)

Add n rows to the array.

Parameters

n	number of rows to add (default is 1)

Definition at line 228 of file STK_IArray2DModifiers.h.

{
  if (n <= 0) return;
  if (isRef())
  { STKRUNTIME_ERROR_1ARG(IArray2D::pushBackRows,n,cannot operate on reference);}
 
  insertRows(endRows(), n);
}

References STK::IArray2D< Derived >::pushBackRows(), and STKRUNTIME_ERROR_1ARG.

Referenced by main(), STK::SArray2DVector< Type_ >::pushBack(), STK::IArray2D< Derived >::pushBackRows(), STK::IArray2D< Derived >::pushBackRows(), and STK::IArray2D< Derived >::pushFrontRows().

pushFrontCols() [1/2]

template<class Derived >

template<class Other >

Derived & STK::IArray2D< Derived >::pushFrontCols

(

ExprBase< Other > const &

other

)

merge (by value) the array other with this.

Parameters

other

the array to merge to this

Definition at line 388 of file STK_IArray2DModifiers.h.

{
  // if the array is empty use operator=
  if (empty())
  {
    this->asDerived() = other.asDerived();
    return this->asDerived();
  }
  // this is not empty
  if (other.rows() != this->rows())
  { STKRUNTIME_ERROR_NO_ARG(IArray2D::pushFrontCols,range of the rows are different);}
  // if the array is not empty we add the column and copy other inside
  this->asDerived().insertCols(beginCols(), other.sizeCols());
  for (int j= beginCols(), j1= other.beginCols(); j < endCols(); ++j, ++j1)
  {
    *allocator_.elt(j) = other.col(j1);
  }
  // return this
  return this->asDerived();
}

pushFrontCols() [2/2]

template<class Derived >

void STK::IArray2D< Derived >::pushFrontCols

(

int

n = 1

)

Insert n columns at the beginning of the array.

Parameters

n	the number of column to insert (default is 1)

Definition at line 331 of file STK_IArray2DModifiers.h.

{
  if (n <= 0) return;
  if (isRef())
  { STKRUNTIME_ERROR_1ARG(IArray2D::pushFrontCols,n,cannot operate on reference);}
 
  insertCols(beginCols(), n );
}

References STK::IArray2D< Derived >::pushFrontCols(), and STKRUNTIME_ERROR_1ARG.

Referenced by main(), and STK::IArray2D< Derived >::pushFrontCols().

pushFrontRows() [1/2]

template<class Derived >

template<class Other >

Derived & STK::IArray2D< Derived >::pushFrontRows

(

ExprBase< Other > const &

other

)

set other at the beginning of this (concatenate).

Perform a copy of the values stored in other to this.

Parameters

other

the array to add

Note

the size and the type have to match

Definition at line 273 of file STK_IArray2DModifiers.h.

{
  // check if the array is empty
  if (empty())
  {
    this->asDerived() = other.asDerived();
    return this->asDerived();
  }
  // not empty
  if (other.cols() != this->cols())
    STKRUNTIME_ERROR_NO_ARG(IArray2D::pushBackRows,range of the columns are different);
  // add nbRow to existing rows
  int nbRow = other.sizeRows();
  pushFrontRows(nbRow);
  for (int j=beginCols(); j< endCols(); ++j)
  {
    for (int i=beginRows(), iOther= other.beginRows(); iOther<other.endRows(); ++i, ++iOther)
    { setValue(i,j, other.elt(iOther,j));}
  }
  // return this
  return this->asDerived();
}

References STK::IArray2D< Derived >::pushBackRows(), and STKRUNTIME_ERROR_NO_ARG.

pushFrontRows() [2/2]

template<class Derived >

void STK::IArray2D< Derived >::pushFrontRows

(

int

n = 1

)

Insert n rows in front of the array.

Parameters

n	number of elements to insert (default is 1)

Definition at line 216 of file STK_IArray2DModifiers.h.

{
  if (n <= 0) return;
  if (isRef())
  { STKRUNTIME_ERROR_1ARG(IArray2D::pushFrontRows,n,cannot operate on reference);}
 
  insertRows(beginRows(), n);
}

References STK::IArray2D< Derived >::pushFrontRows(), and STKRUNTIME_ERROR_1ARG.

Referenced by main(), and STK::IArray2D< Derived >::pushFrontRows().

rangeCol()

template<class Derived >

Range const & STK::IArray2D< Derived >::rangeCol ( int  col ) const

inline

Returns

the range of a column.

Parameters

col	index of the column we want the range

Definition at line 220 of file STK_IArray2D.h.

{ return rangeCols_[col];}

References STK::IArray2D< Derived >::col(), and STK::IArray2D< Derived >::rangeCols_.

rangeCols()

template<class Derived >

Array1D< Range, sizeCols_ > const & STK::IArray2D< Derived >::rangeCols ( ) const

inline

Returns

the range of each columns.

Definition at line 216 of file STK_IArray2D.h.

{ return rangeCols_;}

References STK::IArray2D< Derived >::rangeCols_.

reallocCols()

template<class Derived >

void STK::IArray2D< Derived >::reallocCols ( Range const &  J )

protected

Method for memory reallocation and initialization of the horizontal range of the container.

The vertical range is not set in this method. If an error occur, we set the cols_ of the container to default.

Parameters

J	horizontal range

Definition at line 979 of file STK_IArray2D.h.

{
  Range oldRange(cols());
  // try to allocate memory
  if (J.size() > availableCols())
  {
    int size= Arrays::evalSizeCapacity(J.size());
    Range newRange(J.begin(), size);
    allocator_.realloc( newRange ); // reallocate memory for the columns
  }
  rangeCols_.resize(J);        // initialize this->rangeCols_
  setCols(J);
}

References STK::Arrays::evalSizeCapacity().

Referenced by STK::IArray2D< Derived >::merge(), and STK::IArray2D< Derived >::merge().

reserve()

template<class Derived >

void STK::IArray2D< Derived >::reserve	(	int	sizeRows,
		int	sizeCols
	)

function for reserving memory in all the columns

Parameters

sizeRows,sizeCols

the size to reserve for the rows and columns

Definition at line 46 of file STK_IArray2DModifiers.h.

{
  reserveCols(sizeCols);
  reserveRows(sizeRows);
}

reserveCols()

template<class Derived >

void STK::IArray2D< Derived >::reserveCols

(

int

sizeCols

)

Reserve a certain amount of columns.

Parameters

sizeCols

the size to reserve.

Definition at line 61 of file STK_IArray2DModifiers.h.

{
  if (availableCols() >= sizeCols) return;
  // is this structure just a pointer?
  if (isRef())
  { STKRUNTIME_ERROR_1ARG(IArray2D::reserveCols,sizeCols,cannot operate on references);}
  // try to allocate memory
  try
  {
    Range J(this->beginCols(), sizeCols);
    allocator_.realloc(J);
    rangeCols_.reserve(J.size());
  }
  catch (Exception const& error)   // if an error occur
  {
    STKRUNTIME_ERROR_1ARG(IArray2D::reserveCols,sizeCols,bad alloc error);
  }
}

References STK::IRunnerBase::error(), STK::IArray2D< Derived >::reserveCols(), and STKRUNTIME_ERROR_1ARG.

Referenced by STK::IArray2D< Derived >::reserveCols().

reserveRowCol()

template<class Derived >

void STK::IArray2D< Derived >::reserveRowCol ( int  col, int  size  )

private

Internal method for reserving rows to a specified column.

reserve size memory place to the column col of the array

Parameters

col,size

index of the column and size to reserve

Definition at line 95 of file STK_IArray2DModifiers.h.

{
  if (this->capacityCol(col) >= size) return;
  allocator_.elt(col)->reserve(size);
}

reserveRows()

template<class Derived >

void STK::IArray2D< Derived >::reserveRows

(

int

size

)

Reserve a certain amount of rows in all columns.

Parameters

size	the size to reserve

Definition at line 55 of file STK_IArray2DModifiers.h.

{ reserveRowsCols(cols(), size);}

reserveRowsCols()

template<class Derived >

void STK::IArray2D< Derived >::reserveRowsCols ( Range const &  J, int  size  )

private

Internal method for reserving memory in a range of columns.

Parameters

J	range of the columns to initialize
size	the size to reserve

Definition at line 85 of file STK_IArray2DModifiers.h.

{
  for (int j=J.begin(); j<J.end(); j++)
  { reserveRowCol(j, size);}
}

resize() [1/2]

template<class Derived >

Derived & STK::IArray2D< Derived >::resize

(

Range const &

I

)

Returns

the resized row/column/square array

Parameters

I	the new range for the vector/point

Definition at line 208 of file STK_IArray2DModifiers.h.

{ return this->asDerived().resize1D(I);}

resize() [2/2]

template<class Derived >

Derived & STK::IArray2D< Derived >::resize	(	Range const &	I,
		Range const &	J
	)

resize the array.

Note

The implicit assumption made by this method is that it is easiest and faster to add column than add rows to the 2D array.

Parameters

I	the new range for the rows of the array
J	the new range for the columns of the array

Definition at line 172 of file STK_IArray2DModifiers.h.

{
  // check if there is something to do
  if ((this->rows() == I) && (this->cols() == J)) return this->asDerived();
  if (isRef())
  { STKRUNTIME_ERROR_2ARG(IArray2D::resize,I,J,cannot operate on reference);}
  //  translate and check again if there is something to do
  shift(I.begin(), J.begin());
  if ((this->rows() == I) && (this->cols() == J)) return this->asDerived();
  // just clear empty container
  if (I.size()<=0 || J.size() <= 0)
  { clear(); return this->asDerived();}
 
  // number of rows and columns to delete or add
  int rinc = I.end() - endRows();
  int cinc = J.end() - endCols();
 
  // work first on rows as we add columns
  if ((cinc >=0))
  {
    if (rinc < 0) { popBackRows(-rinc);} // less rows
    else          { pushBackRows(rinc);} // more rows
    pushBackCols(cinc); // add columns
  }
  else // work first on columns as we remove column
  {
    popBackCols(-cinc); // remove columns
    if (rinc < 0) { popBackRows(-rinc);} // less rows
    else          { pushBackRows(rinc);} // more rows
  }
  return this->asDerived();
}

References STK::IArray2D< Derived >::resize(), and STKRUNTIME_ERROR_2ARG.

Referenced by STK::bidiag(), STK::Law::Categorical::computeCumProb(), STK::CategoricalBase< Derived >::initializeModelImpl(), STK::LocalVariance< Array >::LocalVariance(), STK::Qr::qr(), STK::IArray2D< Derived >::resize(), STK::SArray2DVector< Type_ >::resize1D(), STK::JointBernoulliParameters::resizeImpl(), STK::JointGammaParameters::resizeImpl(), STK::JointGaussianParameters::resizeImpl(), STK::AdditiveBSplineCoefficients< Array >::run(), STK::lapack::Qr::runImpl(), and STK::MultiLaw::Normal< RowVector >::setParameters().

resizeRowCol()

template<class Derived >

void STK::IArray2D< Derived >::resizeRowCol ( int  col, Range const &  I  )

private

Internal method for resizing a column with a specified range.

This method resize the column col to the desired range using:

• shiftRow
• either popBackRowsToCol or pushBackRowsToCol if needed.

  Parameters

  col	index of the column
  I	range to set to the column

Definition at line 601 of file STK_IArray2DModifiers.h.

{
  if (rangeCols_[col] == I) return;
  shiftRowCol(col, I.begin());
  int inc = rangeCols_[col].size() - I.size();
  if (inc == 0) return;
  if (inc < 0)
  {
    allocator_.elt(col)->pushBack(-inc);
    rangeCols_[col].incLast(-inc);
  }
  else
  {
    rangeCols_[col].decLast(inc);
    if (rangeCols_[col].size()==0) freeCol(col);
  }
}

Referenced by STK::IArray2D< Derived >::update().

row() [1/3]

template<class Derived >

hidden::Traits< Derived >::Row STK::IArray2D< Derived >::row ( int  i ) const

inline

access to a part of a row.

Parameters

i	index of the row

Returns

a reference of the row i.

Definition at line 84 of file STK_IArray2DSlicers.h.

{ return Row( this->asDerived(), this->rangeColsInRow(i), i);}

Referenced by main(), main(), and STK::Qr::qr().

row() [2/3]

template<class Derived >

hidden::Traits< Derived >::SubRow STK::IArray2D< Derived >::row ( int  i, Range const &  J  ) const

inline

access to a part of a row.

Parameters

i,J	index of the row and range of the columns

Returns

a reference of the row i.

Definition at line 92 of file STK_IArray2DSlicers.h.

{ return SubRow( this->asDerived(), inf(J, this->rangeColsInRow(i)), i);}

References STK::inf().

row() [3/3]

template<class Derived >

hidden::Traits< Derived >::SubArray STK::IArray2D< Derived >::row ( Range const &  I ) const

inline

access to many rows.

Parameters

I	range of the index of the rows

Returns

a 2D array containing the Container in the vertical range I

Definition at line 99 of file STK_IArray2DSlicers.h.

{ return SubArray(this->asDerived(), I, cols());}

rows()

template<class Derived >

RowRange const & STK::IArray2D< Derived >::rows ( ) const

inline

Returns

the Vertical range

Definition at line 178 of file STK_IArray2D.h.

{ return Base2D::rows();}

References STK::IContainer2D< SizeRows_, SizeCols_ >::rows().

Referenced by STK::IArray2D< Derived >::merge(), and STK::IArray2D< Derived >::merge().

rowsImpl()

template<class Derived >

RowRange const & STK::IArray2D< Derived >::rowsImpl ( ) const

inline

Returns

the Vertical range

Definition at line 173 of file STK_IArray2D.h.

{ return Base2D::rows();}

References STK::IContainer2D< SizeRows_, SizeCols_ >::rows().

setCols()

template<class Derived >

void STK::IContainer2D< SizeRows_, SizeCols_ >::setCols ( ColRange const &  J = ColRange() )

inline

Set the columns range.

Parameters

J	the columns range

Definition at line 143 of file STK_IContainer2D.h.

{ cols_ = J;}

setRows()

template<class Derived >

void STK::IContainer2D< SizeRows_, SizeCols_ >::setRows ( RowRange const &  I = RowRange() )

inline

Set the range of the number of rows.

Parameters

I	the range of the rows number

Definition at line 114 of file STK_IContainer2D.h.

{ rows_ = I;}

Referenced by STK::IArray2D< Derived >::merge(), and STK::IArray2D< Derived >::merge().

setValueImpl() [1/2]

template<class Derived >

void STK::IArray2D< Derived >::setValueImpl ( int  i, int  j, TypeConst  v  )

inline

implement setValue for vector/point/diagonal arrays

Definition at line 229 of file STK_IArray2D.h.

{ allocator_.elt(j)->setValue(i, v);}

References STK::IArray2D< Derived >::allocator_, and STK::MemAllocator< Type_, Size_ >::elt().

setValueImpl() [2/2]

template<class Derived >

void STK::IArray2D< Derived >::setValueImpl ( int  j, TypeConst  v  )

inline

implement setValue for vector/point/diagonal arrays

Definition at line 223 of file STK_IArray2D.h.

    {
      STK_STATIC_ASSERT_ONE_DIMENSION_ONLY(Derived);
      this->asDerived().setValue1D(j, v);
    }

References STK_STATIC_ASSERT_ONE_DIMENSION_ONLY.

shift() [1/2]

template<class Derived >

void STK::IArray2D< Derived >::shift

(

int

beg

)

New first index for the object (only for vectors/points/square/... arrays)

Parameters

beg	the index of the first element to set

Definition at line 116 of file STK_IArray2DModifiers.h.

{ this->asDerived().shift1D(beg);}

shift() [2/2]

template<class Derived >

void STK::IArray2D< Derived >::shift	(	int	rbeg,
		int	cbeg
	)

Set new beginning indexes to the array.

Parameters

rbeg,cbeg

the indexes of the first row and first column to set

Definition at line 107 of file STK_IArray2DModifiers.h.

{
  shiftCols(cbeg);
  shiftRows(rbeg);
}

Referenced by STK::SArray2DVector< Type_ >::shift1D().

shiftCols()

template<class Derived >

void STK::IArray2D< Derived >::shiftCols

(

int

cbeg

)

New first index for the columns of the object.

Parameters

cbeg	the index of the first column to set

Definition at line 140 of file STK_IArray2DModifiers.h.

{
  // if there is something to do
  if (cbeg == this->beginCols()) return;
  // is this structure just a pointer?
  if (isRef())
  { STKRUNTIME_ERROR_1ARG(IArray2D::shiftCols,cbeg,cannot operate on references);}
  // shift beginCols()
  allocator_.shift(cbeg);     // translate data
  rangeCols_.shift(cbeg);     // translate rangeCols_
  Base2D::shiftCols(cbeg);    // adjust dimensions
}

References STK::IArray2D< Derived >::shiftCols(), and STKRUNTIME_ERROR_1ARG.

Referenced by STK::IArray2D< Derived >::shiftCols().

shiftRowCol()

template<class Derived >

void STK::IArray2D< Derived >::shiftRowCol ( int  col, int  beg  )

private

internal method for translating a column.

Method for the the allocation of memory of the column pos with the given range.

Parameters

col,beg

index of the column and new begin of the column

Definition at line 159 of file STK_IArray2DModifiers.h.

{
  if (allocator_.elt(col)) { allocator_.elt(col)->shift(beg);}
  rangeCols_[col].shift(beg);
}

shiftRows()

template<class Derived >

void STK::IArray2D< Derived >::shiftRows

(

int

beg

)

New first index for the rows of the array.

Parameters

beg	the index of the first row to set

Definition at line 122 of file STK_IArray2DModifiers.h.

{
  // compute increment
  int inc = beg - beginRows();
  if (inc == 0) return;
  // is this structure just a pointer?
  if (isRef()) { STKRUNTIME_ERROR_1ARG(IArray2D::shiftRows,beg,cannot operate on reference);}
 
  // translate rows
  Base2D::shiftRows(beg);
  // if there is rows, for all cols shift
  for (int j=beginCols(); j<endCols(); j++)
  { shiftRowCol(j, rangeCols_[j].begin()+inc);}
}

References STK::IArray2D< Derived >::shiftRows(), and STKRUNTIME_ERROR_1ARG.

Referenced by STK::IArray2D< Derived >::shiftRows().

sizeCols()

template<class Derived >

int STK::IArray2D< Derived >::sizeCols ( ) const

inline

Returns

the number of columns

Definition at line 193 of file STK_IArray2D.h.

{ return Base2D::sizeCols();}

References STK::IContainer2D< SizeRows_, SizeCols_ >::sizeCols().

Referenced by STK::MultidimRegression< Array, Weight >::computeNbFreeParameter(), STK::IArray2D< Derived >::merge(), and STK::IArray2D< Derived >::merge().

sizeRows()

template<class Derived >

int STK::IArray2D< Derived >::sizeRows ( ) const

inline

Returns

the number of rows

Definition at line 184 of file STK_IArray2D.h.

{ return Base2D::sizeRows();}

References STK::IContainer2D< SizeRows_, SizeCols_ >::sizeRows().

Referenced by STK::MultidimRegression< Array, Weight >::computeNbFreeParameter().

sub() [1/2]

template<class Derived >

hidden::Traits< Derived >::SubArray STK::IArray2D< Derived >::sub ( Range const &  I, Range const &  J  ) const

inline

access to a sub-array.

Parameters

I,J	range of the rows and of the columns

Definition at line 112 of file STK_IArray2DSlicers.h.

{ return SubArray(this->asDerived(), I, J);}

sub() [2/2]

template<class Derived >

hidden::Traits< Derived >::SubVector STK::IArray2D< Derived >::sub ( Range const &  J ) const

inline

Returns

many elements.

Parameters

J	Range of the elements

Definition at line 106 of file STK_IArray2DSlicers.h.

{ return SubVector(this->asDerived(), J);}

Referenced by main().

swap()

template<class Derived >

void STK::IArray2D< Derived >::swap ( int  i, int  j  )

inline

swap two elements: only for vectors and points

Parameters

i,j	indexes of the elemet to swap

Definition at line 532 of file STK_IArray2D.h.

     {
       STK_STATIC_ASSERT_ONE_DIMENSION_ONLY(Derived);
       std::swap(elt(i), elt(j));
     }

References STK_STATIC_ASSERT_ONE_DIMENSION_ONLY.

Referenced by STK::Svd< Array >::diag(), and STK::LocalVariance< Array >::prim().

swapCols()

template<class Derived >

void STK::IArray2D< Derived >::swapCols ( int  pos1, int  pos2  )

inline

Swapping two columns.

Parameters

pos1,pos2

positions of the columns to swap

Definition at line 514 of file STK_IArray2D.h.

     {
 #ifdef STK_BOUNDS_CHECK
       if (this->beginCols() > pos1)
       { STKOUT_OF_RANGE_2ARG(IArray2D::swapCols,pos1, pos2,beginCols() >pos1);}
       if (this->endCols() <= pos1)
       { STKOUT_OF_RANGE_2ARG(IArray2D::swapCols,pos1, pos2,endCols() <= pos1);}
       if (this->beginCols() > pos2)
       { STKOUT_OF_RANGE_2ARG(IArray2D::swapCols,pos1, pos2,beginCols() >pos2);}
       if (this->endCols() <= pos2)
       { STKOUT_OF_RANGE_2ARG(IArray2D::swapCols,pos1, pos2,endCols() <=pos2);}
 #endif
       allocator_.swap(pos1, pos2);
       rangeCols_.swap(pos1,pos2);
     }

References STK::IArray2D< Derived >::allocator_, STK::IArray2D< Derived >::beginCols(), STK::IArray2D< Derived >::endCols(), STK::IArray2D< Derived >::rangeCols_, STKOUT_OF_RANGE_2ARG, STK::MemAllocator< Type_, Size_ >::swap(), and STK::IArray2D< Derived >::swapCols().

Referenced by STK::Svd< Array >::diag(), and STK::IArray2D< Derived >::swapCols().

transferCol() [1/2]

template<class Derived >

template<class OtherDerived >

void STK::IArray2D< Derived >::transferCol ( IArray2D< OtherDerived > &  T, int  pos  )

inlineprivate

Internal method transferring column pos of container T to column pos of this.

Set the column pos in T to zero. The column pos in this should not exists or should be deleted previously otherwise user will experiment a memory leak.

Parameters

T	the container with the column to transfer
pos	index of the column to transfer

Definition at line 720 of file STK_IArray2D.h.

    {
      allocator_.elt(pos) = T.allocator_.elt(pos);
      rangeCols_[pos]     = T.rangeCols_[pos];
      T.nullCol(pos);
    }

References STK::IArray2D< Derived >::allocator_, STK::MemAllocator< Type_, Size_ >::elt(), and STK::IArray2D< Derived >::rangeCols_.

transferCol() [2/2]

template<class Derived >

void STK::IArray2D< Derived >::transferCol ( int  pos1, int  pos2  )

inlineprotected

Transfer the column pos2 to the column pos1 of this.

Parameters

pos1,pos2

indexes of the columns

Definition at line 654 of file STK_IArray2D.h.

    {
      // copy by address pointer on column pos2 of T in pos1 of this
      allocator_.elt(pos1) = allocator_.elt(pos2);
      rangeCols_[pos1] = rangeCols_[pos2];
    }

References STK::IArray2D< Derived >::allocator_, STK::MemAllocator< Type_, Size_ >::elt(), and STK::IArray2D< Derived >::rangeCols_.

Referenced by STK::IArray2D< Derived >::merge().

update() [1/2]

template<class Derived >

void STK::IArray2D< Derived >::update ( int  col )

inline

Update column of the array at specified position.

Parameters

col	index of the column to update

Definition at line 630 of file STK_IArray2D.h.

     {
 #ifdef STK_BOUNDS_CHECK
       if (beginCols() > col)
       { STKOUT_OF_RANGE_1ARG(IArray2D::update,col,beginCols() > col);}
       if (this->lastIdxCols() < col)
       { STKOUT_OF_RANGE_1ARG(IArray2D::update,col,lastIdxCols() < col);}
 #endif
       if (this->rangeRowsInCol(col) != rangeCols_[col])
       { resizeRowCol(col, this->rangeRowsInCol(col));}
     }

References STK::IArray2D< Derived >::beginCols(), STK::IArray2D< Derived >::col(), STK::IArray2D< Derived >::lastIdxCols(), STK::IArray2D< Derived >::rangeCols_, STK::IArray2D< Derived >::resizeRowCol(), STKOUT_OF_RANGE_1ARG, and STK::IArray2D< Derived >::update().

update() [2/2]

template<class Derived >

void STK::IArray2D< Derived >::update ( Range const &  J )

inline

Update columns of the array at a specified range.

Parameters

J	range of the columns to update

Definition at line 616 of file STK_IArray2D.h.

     {
 #ifdef STK_BOUNDS_CHECK
       if (beginCols() > J.begin())
       { STKOUT_OF_RANGE_1ARG(IArray2D::update,J,beginCols() > J.begin());}
       if (endCols() < J.end())
       { STKOUT_OF_RANGE_1ARG(IArray2D::update,J,endCols() < J.end());}
 #endif
       for ( int icol = J.begin(); icol < J.end() ; ++icol)
       { update(icol);}
     }

References STK::IArray2D< Derived >::beginCols(), STK::IArray2D< Derived >::endCols(), STKOUT_OF_RANGE_1ARG, and STK::IArray2D< Derived >::update().

Referenced by STK::IArray2D< Derived >::update(), and STK::IArray2D< Derived >::update().

Friends And Related Symbol Documentation

IArray2D

template<class Derived >

template<class OtherDerived >

friend class IArray2D

friend

Definition at line 81 of file STK_IArray2D.h.

Member Data Documentation

allocator_

template<class Derived >

Allocator STK::IArray2D< Derived >::allocator_

protected

allocator of the column data set

Definition at line 644 of file STK_IArray2D.h.

Referenced by STK::IArray2D< Derived >::allocator(), STK::IArray2D< Derived >::allocator(), STK::IArray2D< Derived >::availableCols(), STK::IArray2D< Derived >::elt2Impl(), STK::IArray2D< Derived >::exchange(), STK::IArray2D< Derived >::isRef(), STK::IArray2D< Derived >::merge(), STK::IArray2D< Derived >::merge(), STK::IArray2D< Derived >::ptr(), STK::IArray2D< Derived >::setValueImpl(), STK::IArray2D< Derived >::swapCols(), STK::IArray2D< Derived >::transferCol(), and STK::IArray2D< Derived >::transferCol().

rangeCols_

template<class Derived >

Array1D<Range, sizeCols_> STK::IArray2D< Derived >::rangeCols_

protected

range of the index of the columns of the container.

Definition at line 646 of file STK_IArray2D.h.

Referenced by STK::IArray2D< Derived >::exchange(), STK::IArray2D< Derived >::IArray2D(), STK::IArray2D< Derived >::merge(), STK::IArray2D< Derived >::rangeCol(), STK::IArray2D< Derived >::rangeCols(), STK::IArray2D< Derived >::swapCols(), STK::IArray2D< Derived >::transferCol(), STK::IArray2D< Derived >::transferCol(), and STK::IArray2D< Derived >::update().

---

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

• STK_IArray2D.h
• STK_IArray2DModifiers.h
• STK_IArray2DSlicers.h