Interface class for 2D containers. More...

#include <STK_IContainer2D.h>

Inheritance diagram for STK::IContainer2D:

Public Member Functions
virtual	~IContainer2D ()
	virtual destructor.
Integer const &	sizeHo () const
	Number of columns.
Integer const &	firstCol () const
	Index of the first column.
Integer const &	lastCol () const
	Index of the last column.
Range const &	rangeHo () const
	Range of the column of the container.
Integer const &	sizeVe () const
	Number of rows.
Integer const &	firstRow () const
	Index of the first row.
Integer const &	lastRow () const
	Index of the last row.
Range const &	rangeVe () const
	Range of the rows of the container.
bool	empty () const
	Is there some data ?
void	resize (Range const &I, Range const &J)
	resize the container: call `shift`(I.first(), J.first() call `popBackCols()` (`insertRows()`) and/or `popBackCols()` (`popBackRows()`).
Protected Member Functions
	IContainer2D (Range const &I=Range(), Range const &J=Range())
	Default constructor.
	IContainer2D (const IContainer2D &T)
	Copy constructor.
void	setRange (Range const &I=Range(), Range const &J=Range())
	Set range of the container.
void	setRangeVe (Range const &I=Range())
	Set the range of the number of rows.
void	incRangeVe (Integer const &inc=1)
	Increment the range of the number of rows.
void	decRangeVe (Integer const &dec=1)
	Decrement range of the number of rows.
void	setFirstVe (Integer const &beg=1)
	Set the beginning of the rows.
void	incFirstVe (Integer const &inc=1)
	Increment the beginning of the number of rows.
void	decFirstVe (Integer const &dec=1)
	Decrement the beginning of the number of rows.
void	incLastVe (Integer const &inc=1)
	Increment the end of the number of rows.
void	decLastVe (Integer const &dec=1)
	Decrement the end of the number of rows.
void	infVe (Range const &I=Range())
	Set the inf of the range of the rows and of I.
void	supVe (Range const &I=Range())
	Set the sup of the range of the rows and of I.
void	setRangeHo (Range const &J=Range())
	Set the range of the columns.
void	incRangeHo (Integer const &inc=1)
	Increment the range of the number of columns.
void	decRangeHo (Integer const &dec=1)
	Decrement range of the number of columns.
void	setFirstHo (Integer const &beg=1)
	Set the beginning of the number of columns.
void	incFirstHo (Integer const &inc=1)
	inc the beginning of the number of columns.
void	decFirstHo (Integer const &dec=1)
	Decrement the beginning of the number of columns.
void	incLastHo (Integer const &inc=1)
	Increment the end of the number of columns.
void	decLastHo (Integer const &dec=1)
	Decrement the end of the number of columns.
void	infHo (Range const &J=Range())
	Set the inf of the range of the cols and of I.
void	supHo (Range const &J=Range())
	Set the sup of the range of the cols and of I.
void	swap (IContainer2D &T)
	swap this container with T
virtual void	shift (Integer const &rbeg, Integer const &cbeg)=0
	Pure virtual method.
virtual void	pushBackCols (Integer const &n=1)=0
	Pure virtual method.
virtual void	popBackCols (Integer const &n=1)=0
	Pure virtual method.
virtual void	pushBackRows (Integer const &n=1)=0
	Pure virtual method.
virtual void	popBackRows (Integer const &n=1)=0
	Pure virtual method.
Protected Attributes
Range	rangeHo_
	Range of the cols.
Range	rangeVe_
	Range of the rows.

Detailed Description

Interface class for 2D containers.

The IContainer2D class is the base class for all two-dimensional containers.

The pure virtual function defined in this interface have the following definition:

   void shift(Integer const& rbeg =1, Integer const& cbeg =1);
   void pushBackCols(Integer const& n =1);
   void popBackCols(Integer const& n =1);
   void pushBackRows(Integer const& n =1);
   void popBackRows(Integer const& n =1);

and they are used in the resize(I,J) method.

Definition at line 66 of file STK_IContainer2D.h.

Constructor & Destructor Documentation

STK::IContainer2D::IContainer2D	(	Range const &	I = `Range()`,
		Range const &	J = `Range()`
	)		`[inline, protected]`

Default constructor.

rangeHo_ = 1:0 and rangeVe_ = 1:0.

Parameters:

I	the vertical range
J	the horizontal range

Definition at line 76 of file STK_IContainer2D.h.

                : rangeHo_(J)
                , rangeVe_(I)
    { ;}

STK::IContainer2D::IContainer2D ( const IContainer2D & T ) [inline, protected]

Copy constructor.

Parameters:

T	the container to copy

Definition at line 84 of file STK_IContainer2D.h.

                : rangeHo_(T.rangeHo_)
                , rangeVe_(T.rangeVe_)
    { ;}

virtual STK::IContainer2D::~IContainer2D ( ) [inline, virtual]

virtual destructor.

Definition at line 91 of file STK_IContainer2D.h.

{ ;}

Member Function Documentation

Integer const& STK::IContainer2D::sizeHo ( ) const [inline]

Number of columns.

Returns:: the Horizontal size

Definition at line 96 of file STK_IContainer2D.h.

References rangeHo_, and STK::Range::size().

Referenced by STK::Svd::bidiag(), STK::Qr::eraseCol(), STK::IArray2D< Integer, Array2D< Integer > >::eraseCols(), STK::DataFrame::eraseCols(), STK::Svd::init(), STK::DataFrame::insertDataFrame(), STK::ITStatModel< Real, Point, Vector, Matrix >::ITStatModel(), STK::Svd::ncolU(), STK::Svd::ncolV(), STK::RecursiveArray2D< TYPE, Container2D >::operator=(), STK::MatrixUpperTriangular::operator=(), STK::MatrixLowerTriangular::operator=(), STK::Array2D< Real >::operator=(), STK::DataFrame::operator=(), STK::Array2D< Integer >::operator=(), STK::IArray2D< Integer, Array2D< Integer > >::popBackCols(), STK::DataFrame::popBackCols(), STK::IArray2DBase< TYPE, TYPE *, ArrayHo< TYPE >, Array1D< TYPE >, Container2D >::pushBackByTransfer(), STK::IArray2D< Integer, Array2D< Integer > >::pushBackCols(), STK::DataFrame::pushBackDataFrame(), STK::Stat::Multivariate< TYPE, TContainerHo, TContainerVe, TContainer2D >::run(), STK::Qr::run(), and STK::transpose().

{ return rangeHo_.size();}

Integer const& STK::IContainer2D::firstCol ( ) const [inline]

Index of the first column.

Returns:: the index of the first column

Definition at line 100 of file STK_IContainer2D.h.

References STK::Range::first(), and rangeHo_.

{ return rangeHo_.first();}

Integer const& STK::IContainer2D::lastCol ( ) const [inline]

Index of the last column.

Returns:: the index of the last column

Definition at line 104 of file STK_IContainer2D.h.

References STK::Range::last(), and rangeHo_.

{ return rangeHo_.last();}

Range const& STK::IContainer2D::rangeHo ( ) const [inline]

Range of the column of the container.

Returns:: the Horizontal range

Definition at line 108 of file STK_IContainer2D.h.

References rangeHo_.

Referenced by STK::applySort(), STK::Array2D< Real >::Array2D(), STK::Array2D< Integer >::Array2D(), STK::ITContainer2D< Real, ArrayHo< Real >, Array1D< Real >, MatrixUpperTriangular >::atRow(), STK::Stat::center(), STK::GaussianStatModel::compCovariance(), STK::GaussianStatModel::compMean(), STK::LocalVariance::computeAxis(), STK::Svd::compV(), STK::GaussianStatModel::compWeightedCovariance(), STK::GaussianStatModel::compWeightedMean(), STK::IArray2D< Integer, Array2D< Integer > >::freeMem(), STK::IArray2DBase< TYPE, TYPE *, ArrayHo< TYPE >, Array1D< TYPE >, Container2D >::IArray2DBase(), STK::LocalVariance::initializeMemory(), STK::IArray2D< Integer, Array2D< Integer > >::insertCols(), STK::Law::MultivariateNormal< Container1D >::logLikelihood(), STK::MatrixLowerTriangular::MatrixLowerTriangular(), STK::MatrixUpperTriangular::MatrixUpperTriangular(), STK::Stat::mean(), STK::mult(), STK::multLeftTranspose(), STK::ITContainer2D< Real, ArrayHo< Real >, Array1D< Real >, MatrixUpperTriangular >::operator()(), STK::RecursiveArray2D< TYPE, Container2D >::operator=(), STK::MatrixUpperTriangular::operator=(), STK::MatrixSquare::operator=(), STK::MatrixLowerTriangular::operator=(), STK::Array2D< Real >::operator=(), STK::DataFrame::operator=(), STK::Array2D< Integer >::operator=(), STK::IArray2DBase< TYPE, TYPE *, ArrayHo< TYPE >, Array1D< TYPE >, Container2D >::pushBackByTransfer(), STK::IArray2D< Integer, Array2D< Integer > >::pushBackCols(), STK::IArray2D< Integer, Array2D< Integer > >::pushBackRows(), STK::RecursiveArray2D< TYPE, Container2D >::RecursiveArray2D(), STK::Array2D< Real >::row(), STK::IArray2D< Integer, Array2D< Integer > >::row(), STK::Stat::Multivariate< TYPE, TContainerHo, TContainerVe, TContainer2D >::run(), STK::EigenvaluesSymmetric::run(), STK::Stat::standardize(), swap(), STK::transpose(), STK::Stat::variance(), STK::Stat::varianceWithFixedMean(), STK::weightedMultLeftTranspose(), and STK::IArray2D< Integer, Array2D< Integer > >::~IArray2D().

{ return rangeHo_;};

Integer const& STK::IContainer2D::sizeVe ( ) const [inline]

Number of rows.

Returns:: the Vertical size

Definition at line 112 of file STK_IContainer2D.h.

References rangeVe_, and STK::Range::size().

Referenced by STK::Svd::bidiag(), STK::LocalVariance::computeCovarianceMatrices(), STK::Qr::eraseCol(), STK::Svd::init(), STK::DataFrame::insertDataFrame(), STK::DataFrame::insertVariable(), STK::ITStatModel< Real, Point, Vector, Matrix >::ITStatModel(), STK::Law::MultivariateNormal< Container1D >::logLikelihood(), STK::Svd::nrowU(), STK::Svd::nrowV(), STK::RecursiveArray2D< TYPE, Container2D >::operator=(), STK::MatrixUpperTriangular::operator=(), STK::MatrixLowerTriangular::operator=(), STK::Array2D< Real >::operator=(), STK::Array2D< Integer >::operator=(), STK::IArray2D< Integer, Array2D< Integer > >::popBackRows(), STK::DataFrame::popBackRows(), STK::DataFrame::pushBackDataFrame(), STK::IArray2D< Integer, Array2D< Integer > >::pushBackRows(), STK::DataFrame::pushBackVariable(), STK::Stat::Multivariate< TYPE, TContainerHo, TContainerVe, TContainer2D >::run(), STK::Qr::run(), and STK::transpose().

{ return rangeVe_.size();}

Integer const& STK::IContainer2D::firstRow ( ) const [inline]

Index of the first row.

Returns:: the index of the first row

Definition at line 116 of file STK_IContainer2D.h.

References STK::Range::first(), and rangeVe_.

Referenced by STK::Array2D< Real >::Array2D(), STK::Array2D< Integer >::Array2D(), STK::ITContainer2DBase< Integer, Array2D< Integer > >::at(), STK::ITContainer2D< Real, ArrayHo< Real >, Array1D< Real >, MatrixUpperTriangular >::at(), STK::ITContainer2D< Real, ArrayHo< Real >, Array1D< Real >, MatrixUpperTriangular >::atRow(), STK::Svd::bidiag(), STK::MatrixUpperTriangular::compFirstHo(), STK::MatrixUpperTriangular::compFirstVe(), STK::MatrixLowerTriangular::compFirstVe(), STK::MatrixLowerTriangular::compLastHo(), STK::MatrixUpperTriangular::compLastVe(), STK::ITStatModel< Real, Point, Vector, Matrix >::compLogLikelihood(), STK::MatrixUpperTriangular::compRangeVe(), STK::MatrixUpperTriangular::compSizeVe(), STK::LocalVariance::computeCovarianceMatrices(), STK::LocalVariance::computeWeightedCovarianceMatrices(), STK::IArray2D< Integer, Array2D< Integer > >::eraseRows(), STK::DataFrame::eraseRows(), STK::ExportToCsv::ExportToCsv(), STK::IArray2DBase< TYPE, TYPE *, ArrayHo< TYPE >, Array1D< TYPE >, Container2D >::IArray2DBase(), STK::DataFrame::insertDataFrame(), STK::IArray2D< Integer, Array2D< Integer > >::insertRows(), STK::DataFrame::insertRows(), STK::DataFrame::insertVariable(), STK::Law::MultivariateNormal< Container1D >::logLikelihood(), STK::MatrixLowerTriangular::MatrixLowerTriangular(), STK::MatrixUpperTriangular::MatrixUpperTriangular(), STK::LocalVariance::minimalDistance(), STK::mult(), STK::multLefTranspose(), STK::multLeftTranspose(), STK::multRightTranspose(), STK::normInf(), STK::Array2D< Real >::operator*=(), STK::Array2D< Real >::operator+=(), STK::Array2D< Real >::operator-=(), STK::Array2D< Real >::operator/=(), STK::RecursiveArray2D< TYPE, Container2D >::operator=(), STK::Array2D< Real >::operator=(), STK::Array2D< Integer >::operator=(), STK::LocalVariance::prim(), STK::ITContainer2D< Real, ArrayHo< Real >, Array1D< Real >, MatrixUpperTriangular >::pushBackCol(), STK::DataFrame::pushBackDataFrame(), STK::DataFrame::pushBackVariable(), STK::Law::ITUnivariate< Real >::rand2D(), STK::RecursiveArray2D< TYPE, Container2D >::RecursiveArray2D(), STK::Stat::Multivariate< TYPE, TContainerHo, TContainerVe, TContainer2D >::run(), STK::DataFrame::shift(), STK::IArray2D< Integer, Array2D< Integer > >::shiftVe(), STK::LinearAAModel::simul(), STK::RecursiveArray2D< TYPE, Container2D >::swapRows(), STK::Array2D< Real >::swapRows(), STK::Array2D< Integer >::swapRows(), STK::transpose(), STK::weightedMultLeftTranspose(), and STK::DataFrame::writeDataFrame().

{ return rangeVe_.first();}

Integer const& STK::IContainer2D::lastRow ( ) const [inline]

Index of the last row.

Returns:: the index of the last row

Definition at line 120 of file STK_IContainer2D.h.

References STK::Range::last(), and rangeVe_.

Referenced by STK::Array2D< Real >::Array2D(), STK::Array2D< Integer >::Array2D(), STK::ITContainer2DBase< Integer, Array2D< Integer > >::at(), STK::ITContainer2D< Real, ArrayHo< Real >, Array1D< Real >, MatrixUpperTriangular >::at(), STK::ITContainer2D< Real, ArrayHo< Real >, Array1D< Real >, MatrixUpperTriangular >::atRow(), STK::Svd::bidiag(), STK::MatrixUpperTriangular::compLastVe(), STK::MatrixLowerTriangular::compLastVe(), STK::ITStatModel< Real, Point, Vector, Matrix >::compLogLikelihood(), STK::MatrixLowerTriangular::compRangeVe(), STK::MatrixLowerTriangular::compSizeVe(), STK::LocalVariance::computeCovarianceMatrices(), STK::LocalVariance::computeWeightedCovarianceMatrices(), STK::Qr::eraseCol(), STK::IArray2D< Integer, Array2D< Integer > >::eraseRows(), STK::DataFrame::eraseRows(), STK::ExportToCsv::ExportToCsv(), STK::IArray2DBase< TYPE, TYPE *, ArrayHo< TYPE >, Array1D< TYPE >, Container2D >::IArray2DBase(), STK::Qr::insertCol(), STK::IArray2D< Integer, Array2D< Integer > >::insertRows(), STK::DataFrame::insertRows(), STK::leftHouseholder(), STK::Law::MultivariateNormal< Container1D >::logLikelihood(), STK::MatrixLowerTriangular::MatrixLowerTriangular(), STK::MatrixUpperTriangular::MatrixUpperTriangular(), STK::LocalVariance::minimalDistance(), STK::mult(), STK::multLefTranspose(), STK::multLeftTranspose(), STK::multRightTranspose(), STK::normInf(), STK::Array2D< Real >::operator*=(), STK::Array2D< Real >::operator+=(), STK::Array2D< Real >::operator-=(), STK::Array2D< Real >::operator/=(), STK::RecursiveArray2D< TYPE, Container2D >::operator=(), STK::Array2D< Real >::operator=(), STK::Array2D< Integer >::operator=(), STK::IArray2D< Integer, Array2D< Integer > >::popBackRows(), STK::LocalVariance::prim(), STK::ITContainer2D< Real, ArrayHo< Real >, Array1D< Real >, MatrixUpperTriangular >::pushBackCol(), STK::IArray2D< Integer, Array2D< Integer > >::pushBackRows(), STK::Law::ITUnivariate< Real >::rand2D(), STK::RecursiveArray2D< TYPE, Container2D >::RecursiveArray2D(), resize(), STK::rightHouseholder(), STK::Stat::Multivariate< TYPE, TContainerHo, TContainerVe, TContainer2D >::run(), STK::LinearAAModel::simul(), STK::RecursiveArray2D< TYPE, Container2D >::swapRows(), STK::Array2D< Real >::swapRows(), STK::Array2D< Integer >::swapRows(), STK::transpose(), STK::weightedMultLeftTranspose(), and STK::DataFrame::writeDataFrame().

{ return rangeVe_.last();}

Range const& STK::IContainer2D::rangeVe ( ) const [inline]

Range of the rows of the container.

Returns:: the Vertical range

Definition at line 124 of file STK_IContainer2D.h.

References rangeVe_.

Referenced by STK::applySort(), STK::ITContainer2D< Real, ArrayHo< Real >, Array1D< Real >, MatrixUpperTriangular >::atCol(), STK::Svd::bidiag(), STK::Stat::center(), STK::Array2D< Real >::col(), STK::IArray2D< Integer, Array2D< Integer > >::col(), STK::RecursiveArray2D< TYPE, Container2D >::compRangeVe(), STK::Array2D< Real >::compRangeVe(), STK::Array2D< Integer >::compRangeVe(), STK::Qr::insertCol(), STK::IArray2D< Integer, Array2D< Integer > >::insertCols(), STK::mult(), STK::multLefTranspose(), STK::multLeftTranspose(), STK::multRightTranspose(), STK::Array2D< Real >::operator*=(), STK::Array2D< Real >::operator+=(), STK::Array2D< Real >::operator-=(), STK::Array2D< Real >::operator/=(), STK::RecursiveArray2D< TYPE, Container2D >::operator=(), STK::MatrixUpperTriangular::operator=(), STK::MatrixSquare::operator=(), STK::MatrixLowerTriangular::operator=(), STK::Array2D< Real >::operator=(), STK::Array2D< Integer >::operator=(), STK::ITContainer2D< Real, ArrayHo< Real >, Array1D< Real >, MatrixUpperTriangular >::operator[](), STK::LocalVariance::prim(), STK::IArray2DBase< TYPE, TYPE *, ArrayHo< TYPE >, Array1D< TYPE >, Container2D >::pushBackByTransfer(), STK::Qr::pushBackCol(), STK::ITContainer2D< Real, ArrayHo< Real >, Array1D< Real >, MatrixUpperTriangular >::pushBackCol(), STK::MatrixSquare::range(), STK::MatrixDiagonal::range(), STK::EigenvaluesSymmetric::run(), STK::LocalVariance::setData(), STK::AdditiveBSplineCoefficients::setData(), STK::Stat::standardize(), swap(), STK::transpose(), and STK::weightedMultLeftTranspose().

{ return rangeVe_;}

bool STK::IContainer2D::empty ( ) const [inline]

Is there some data ?

Returns:: true if the container is empty, false otherwise

Definition at line 128 of file STK_IContainer2D.h.

References STK::Range::empty(), rangeHo_, and rangeVe_.

Referenced by STK::Svd::compSvd(), STK::Svd::init(), STK::ITContainer2D< Real, ArrayHo< Real >, Array1D< Real >, MatrixUpperTriangular >::pushBackCol(), and STK::Qr::run().

{ return (rangeHo_.empty() || rangeVe_.empty());}

void STK::IContainer2D::resize	(	Range const &	I,
		Range const &	J
	)		`[inline]`

resize the container:

call shift(I.first(), J.first()
call popBackCols() (insertRows()) and/or popBackCols() (popBackRows()).

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

Parameters:

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

Reimplemented in STK::MatrixSquare.

Definition at line 139 of file STK_IContainer2D.h.

References STK::Range::first(), STK::Range::last(), lastCol(), lastRow(), popBackCols(), popBackRows(), pushBackCols(), pushBackRows(), rangeHo_, rangeVe_, and shift().

Referenced by STK::LocalVariance::computeAxis(), STK::RecursiveArray2D< TYPE, Container2D >::operator=(), STK::Array2D< Real >::operator=(), STK::Array2D< Integer >::operator=(), STK::ITContainer2D< Real, ArrayHo< Real >, Array1D< Real >, MatrixUpperTriangular >::pushBackCol(), STK::Qr::qr(), STK::LocalVariance::setData(), STK::BSplineCoefficients::setData(), STK::AdditiveBSplineCoefficients::setData(), and STK::transpose().

    {
      // check if there is something to do
      if ((rangeVe_ == I) && (rangeHo_ == J)) return;
      //  translate beg
      shift(I.first(), J.first());
      // number of rows to del or add
      Integer rinc = I.last() - lastRow();
      // number of cols to del or add
      Integer cinc = J.last() - lastCol();
      // check if we add cols
      if (cinc >=0)   // work first on rows
      {
        if (rinc < 0) popBackRows(-rinc); // less rows
        else          pushBackRows(rinc); // more rows
        pushBackCols(cinc); // add columns
      }
      else // work first on columns
      {
        popBackCols(-cinc); // remove columns
        if (rinc < 0) popBackRows(-rinc); // less rows
        else          pushBackRows(rinc); // more rows
      }
    }

void STK::IContainer2D::setRange	(	Range const &	I = `Range()`,
		Range const &	J = `Range()`
	)		`[inline, protected]`

Set range of the container.

Parameters:

I	the vertical range
J	the horizontal range

Definition at line 169 of file STK_IContainer2D.h.

References setRangeHo(), and setRangeVe().

Referenced by STK::IArray2D< Integer, Array2D< Integer > >::clear(), STK::DataFrame::clear(), and swap().

    {
      setRangeVe(I);
      setRangeHo(J);
    }

void STK::IContainer2D::setRangeVe ( Range const & I = Range() ) [inline, protected]

Set the range of the number of rows.

Parameters:

I	the range of the rows number

Definition at line 177 of file STK_IContainer2D.h.

References rangeVe_.

Referenced by STK::DataFrame::freeMem(), STK::DataFrame::freeRows(), STK::IArray2D< Integer, Array2D< Integer > >::initialize(), STK::IArray2DBase< TYPE, TYPE *, ArrayHo< TYPE >, Array1D< TYPE >, Container2D >::pushBackByTransfer(), and setRange().

    { rangeVe_ = I;}

void STK::IContainer2D::incRangeVe ( Integer const & inc = 1 ) [inline, protected]

Increment the range of the number of rows.

Parameters:

inc	the increment to apply

Definition at line 182 of file STK_IContainer2D.h.

References STK::Range::inc(), and rangeVe_.

Referenced by STK::DataFrame::pushBackRows(), and STK::IArray2D< Integer, Array2D< Integer > >::shiftVe().

    { rangeVe_.inc(inc);}

void STK::IContainer2D::decRangeVe ( Integer const & dec = 1 ) [inline, protected]

Decrement range of the number of rows.

Parameters:

dec	the decrement to apply

Definition at line 187 of file STK_IContainer2D.h.

References STK::Range::dec(), and rangeVe_.

Referenced by STK::MatrixDiagonal::shift().

    { rangeVe_.dec(dec);}

void STK::IContainer2D::setFirstVe ( Integer const & beg = 1 ) [inline, protected]

Set the beginning of the rows.

Parameters:

beg	the first index of the rows

Definition at line 192 of file STK_IContainer2D.h.

References rangeVe_, and STK::Range::shift().

Referenced by STK::DataFrame::shift().

    { rangeVe_.shift(beg);}

void STK::IContainer2D::incFirstVe ( Integer const & inc = 1 ) [inline, protected]

Increment the beginning of the number of rows.

Parameters:

inc	the increment to apply

Definition at line 197 of file STK_IContainer2D.h.

References STK::Range::incFirst(), and rangeVe_.

    { rangeVe_.incFirst(inc);}

void STK::IContainer2D::decFirstVe ( Integer const & dec = 1 ) [inline, protected]

Decrement the beginning of the number of rows.

Parameters:

dec	the decrement to apply

Definition at line 202 of file STK_IContainer2D.h.

References STK::Range::decFirst(), and rangeVe_.

    { rangeVe_.decFirst(dec);}

void STK::IContainer2D::incLastVe ( Integer const & inc = 1 ) [inline, protected]

Increment the end of the number of rows.

Parameters:

inc	the increment to apply

Definition at line 207 of file STK_IContainer2D.h.

References STK::Range::incLast(), and rangeVe_.

Referenced by STK::DataFrame::insertDataFrame(), STK::IArray2D< Integer, Array2D< Integer > >::insertRows(), STK::DataFrame::insertRows(), STK::DataFrame::insertVariable(), STK::DataFrame::pushBackDataFrame(), STK::IArray2D< Integer, Array2D< Integer > >::pushBackRows(), and STK::DataFrame::pushBackVariable().

    { rangeVe_.incLast(inc);}

void STK::IContainer2D::decLastVe ( Integer const & dec = 1 ) [inline, protected]

Decrement the end of the number of rows.

Parameters:

dec	the decrement to apply

Definition at line 212 of file STK_IContainer2D.h.

References STK::Range::decLast(), and rangeVe_.

Referenced by STK::IArray2D< Integer, Array2D< Integer > >::eraseRows(), STK::DataFrame::eraseRows(), STK::IArray2D< Integer, Array2D< Integer > >::popBackRows(), and STK::DataFrame::popBackRows().

    { rangeVe_.decLast(dec);}

void STK::IContainer2D::infVe ( Range const & I = Range() ) [inline, protected]

Set the inf of the range of the rows and of I.

Parameters:

I	the range to apply

Definition at line 217 of file STK_IContainer2D.h.

References STK::Range::inf(), and rangeVe_.

    { rangeVe_.inf(I);}

void STK::IContainer2D::supVe ( Range const & I = Range() ) [inline, protected]

Set the sup of the range of the rows and of I.

Parameters:

I	the range to apply

Definition at line 222 of file STK_IContainer2D.h.

References rangeVe_, and STK::Range::sup().

    { rangeVe_.sup(I);}

void STK::IContainer2D::setRangeHo ( Range const & J = Range() ) [inline, protected]

Set the range of the columns.

Parameters:

J	the range of the cols number

Definition at line 227 of file STK_IContainer2D.h.

References rangeHo_.

Referenced by STK::IArray2DBase< TYPE, TYPE *, ArrayHo< TYPE >, Array1D< TYPE >, Container2D >::freeHo(), STK::DataFrame::freeMem(), STK::IArray2D< Integer, Array2D< Integer > >::initialize(), STK::IArray2D< Integer, Array2D< Integer > >::insertCols(), STK::IArray2DBase< TYPE, TYPE *, ArrayHo< TYPE >, Array1D< TYPE >, Container2D >::mallocHo(), STK::IArray2DBase< TYPE, TYPE *, ArrayHo< TYPE >, Array1D< TYPE >, Container2D >::pushBackByTransfer(), STK::IArray2DBase< TYPE, TYPE *, ArrayHo< TYPE >, Array1D< TYPE >, Container2D >::reallocHo(), and setRange().

    { rangeHo_ = J;}

void STK::IContainer2D::incRangeHo ( Integer const & inc = 1 ) [inline, protected]

Increment the range of the number of columns.

Parameters:

inc	the increment to apply

Definition at line 232 of file STK_IContainer2D.h.

References STK::Range::inc(), and rangeHo_.

Referenced by STK::IArray2DBase< TYPE, TYPE *, ArrayHo< TYPE >, Array1D< TYPE >, Container2D >::shiftHo().

    { rangeHo_.inc(inc);}

void STK::IContainer2D::decRangeHo ( Integer const & dec = 1 ) [inline, protected]

Decrement range of the number of columns.

Parameters:

dec	the decrement to apply

Definition at line 237 of file STK_IContainer2D.h.

References STK::Range::dec(), and rangeHo_.

Referenced by STK::MatrixDiagonal::shift().

    { rangeHo_.dec(dec);}

void STK::IContainer2D::setFirstHo ( Integer const & beg = 1 ) [inline, protected]

Set the beginning of the number of columns.

Parameters:

beg	the new first index

Definition at line 242 of file STK_IContainer2D.h.

References rangeHo_, and STK::Range::shift().

Referenced by STK::DataFrame::shift().

    { rangeHo_.shift(beg);}

void STK::IContainer2D::incFirstHo ( Integer const & inc = 1 ) [inline, protected]

inc the beginning of the number of columns.

Parameters:

inc	the increment to apply

Definition at line 247 of file STK_IContainer2D.h.

References STK::Range::incFirst(), and rangeHo_.

    { rangeHo_.incFirst(inc);}

void STK::IContainer2D::decFirstHo ( Integer const & dec = 1 ) [inline, protected]

Decrement the beginning of the number of columns.

Parameters:

dec	the decrement to apply

Definition at line 252 of file STK_IContainer2D.h.

References STK::Range::decFirst(), and rangeHo_.

    { rangeHo_.decFirst(dec);}

void STK::IContainer2D::incLastHo ( Integer const & inc = 1 ) [inline, protected]

Increment the end of the number of columns.

Parameters:

inc	the increment to apply

Definition at line 257 of file STK_IContainer2D.h.

References STK::Range::incLast(), and rangeHo_.

Referenced by STK::IArray2D< Integer, Array2D< Integer > >::insertCols(), STK::DataFrame::insertCols(), STK::DataFrame::insertDataFrame(), STK::DataFrame::insertVariable(), STK::IArray2D< Integer, Array2D< Integer > >::pushBackCols(), STK::DataFrame::pushBackCols(), STK::DataFrame::pushBackDataFrame(), and STK::DataFrame::pushBackVariable().

    { rangeHo_.incLast(inc);}

void STK::IContainer2D::decLastHo ( Integer const & dec = 1 ) [inline, protected]

Decrement the end of the number of columns.

Parameters:

dec	the decrement to apply

Definition at line 262 of file STK_IContainer2D.h.

References STK::Range::decLast(), and rangeHo_.

Referenced by STK::IArray2D< Integer, Array2D< Integer > >::eraseCols(), STK::DataFrame::eraseCols(), STK::IArray2D< Integer, Array2D< Integer > >::popBackCols(), and STK::DataFrame::popBackCols().

    { rangeHo_.decLast(dec);}

void STK::IContainer2D::infHo ( Range const & J = Range() ) [inline, protected]

Set the inf of the range of the cols and of I.

Parameters:

J	the range to apply

Definition at line 267 of file STK_IContainer2D.h.

References STK::Range::inf(), and rangeHo_.

    { rangeHo_.inf(J);}

void STK::IContainer2D::supHo ( Range const & J = Range() ) [inline, protected]

Set the sup of the range of the cols and of I.

Parameters:

J	the range to apply

Definition at line 272 of file STK_IContainer2D.h.

References rangeHo_, and STK::Range::sup().

    { rangeHo_.sup(J);}

void STK::IContainer2D::swap ( IContainer2D & T ) [inline, protected]

swap this container with T

Parameters:

T	the container to swap with T

Definition at line 278 of file STK_IContainer2D.h.

References rangeHo(), rangeVe(), and setRange().

Referenced by STK::IArray2DBase< TYPE, TYPE *, ArrayHo< TYPE >, Array1D< TYPE >, Container2D >::swap(), and STK::DataFrame::swapCols().

     {
       // get ranges of this
       Range range_ho(rangeHo());
       Range range_ve(rangeVe());
       // set range of T to this
       setRange(T.rangeVe(), T.rangeHo());
       // set range of this to T
       T.setRange(range_ve, range_ho);
     }

virtual void STK::IContainer2D::shift	(	Integer const &	rbeg,
		Integer const &	cbeg
	)		`[protected, pure virtual]`

Pure virtual method.

Shift the ranges of the container.

Parameters:

rbeg	the first index for the rows of the container
cbeg	the first index for the columns of the container

Implemented in STK::MatrixDiagonal, STK::DataFrame, STK::IArray2D< TYPE, TArray2D >, STK::IArray2D< TYPE, Container2D >, STK::IArray2D< TYPE, Array2D< TYPE > >, STK::IArray2D< Real, Array2D< Real > >, STK::IArray2D< Real, MatrixLowerTriangular >, STK::IArray2D< Real, MatrixUpperTriangular >, and STK::IArray2D< Integer, Array2D< Integer > >.

Referenced by resize().

virtual void STK::IContainer2D::pushBackCols ( Integer const & n = 1 ) [protected, pure virtual]

Pure virtual method.

Add n columns to the container.

Parameters:

n	number of columns to add to the container

Implemented in STK::MatrixDiagonal, STK::DataFrame, STK::IArray2D< TYPE, TArray2D >, STK::IArray2D< TYPE, Container2D >, STK::IArray2D< TYPE, Array2D< TYPE > >, STK::IArray2D< Real, Array2D< Real > >, STK::IArray2D< Real, MatrixLowerTriangular >, STK::IArray2D< Real, MatrixUpperTriangular >, and STK::IArray2D< Integer, Array2D< Integer > >.

Referenced by STK::ITContainer2D< Real, ArrayHo< Real >, Array1D< Real >, MatrixUpperTriangular >::pushBackCol(), and resize().

virtual void STK::IContainer2D::popBackCols ( Integer const & n = 1 ) [protected, pure virtual]

Pure virtual method.

remove n last columns to the container.

Parameters:

n	number of columns to remove to the container

Implemented in STK::MatrixDiagonal, STK::DataFrame, STK::IArray2D< TYPE, TArray2D >, STK::IArray2D< TYPE, Container2D >, STK::IArray2D< TYPE, Array2D< TYPE > >, STK::IArray2D< Real, Array2D< Real > >, STK::IArray2D< Real, MatrixLowerTriangular >, STK::IArray2D< Real, MatrixUpperTriangular >, and STK::IArray2D< Integer, Array2D< Integer > >.

Referenced by resize().

virtual void STK::IContainer2D::pushBackRows ( Integer const & n = 1 ) [protected, pure virtual]

Pure virtual method.

Add n columns to the container.

Parameters:

n	number of columns to add to the container

Implemented in STK::MatrixDiagonal, STK::DataFrame, STK::IArray2D< TYPE, TArray2D >, STK::IArray2D< TYPE, Container2D >, STK::IArray2D< TYPE, Array2D< TYPE > >, STK::IArray2D< Real, Array2D< Real > >, STK::IArray2D< Real, MatrixLowerTriangular >, STK::IArray2D< Real, MatrixUpperTriangular >, and STK::IArray2D< Integer, Array2D< Integer > >.

Referenced by resize().

virtual void STK::IContainer2D::popBackRows ( Integer const & n = 1 ) [protected, pure virtual]

Pure virtual method.

Add n columns to the container.

Parameters:

n	number of columns to add to the container

Implemented in STK::MatrixDiagonal, STK::DataFrame, STK::IArray2D< TYPE, TArray2D >, STK::IArray2D< TYPE, Container2D >, STK::IArray2D< TYPE, Array2D< TYPE > >, STK::IArray2D< Real, Array2D< Real > >, STK::IArray2D< Real, MatrixLowerTriangular >, STK::IArray2D< Real, MatrixUpperTriangular >, and STK::IArray2D< Integer, Array2D< Integer > >.

Referenced by resize().

Member Data Documentation

Range STK::IContainer2D::rangeHo_ [protected]

Range of the cols.

Definition at line 69 of file STK_IContainer2D.h.

Referenced by decFirstHo(), decLastHo(), decRangeHo(), empty(), firstCol(), incFirstHo(), incLastHo(), incRangeHo(), infHo(), STK::ITContainer2DBase< Integer, Array2D< Integer > >::ITContainer2DBase(), lastCol(), rangeHo(), resize(), setFirstHo(), setRangeHo(), sizeHo(), and supHo().

Range STK::IContainer2D::rangeVe_ [protected]

Range of the rows.

Definition at line 70 of file STK_IContainer2D.h.

Referenced by decFirstVe(), decLastVe(), decRangeVe(), empty(), firstRow(), incFirstVe(), incLastVe(), incRangeVe(), infVe(), STK::ITContainer2DBase< Integer, Array2D< Integer > >::ITContainer2DBase(), lastRow(), rangeVe(), resize(), setFirstVe(), setRangeVe(), sizeVe(), and supVe().

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

STK_IContainer2D.h

STK::IContainer2D Class ReferenceSubproject STKernel::TContainer

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

STK::IContainer2D Class Reference
Subproject STKernel::TContainer