Interface base class for 2D containers. More...

#include <STK_ITContainer.h>

Inheritance diagram for STK::ITContainerBase< 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 IRecursiveTemplate< Derived >	Base

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

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

typedef TRange< sizeRows_ >	RowRange
	Type of the Range for the rows.

typedef TRange< sizeCols_ >	ColRange
	Type of the Range for the columns.

Public Member Functions
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	firstIdxCols () const

int	firstIdxRows () const

int	lastIdxCols () const

int	lastIdxRows () const

RowRange const &	rangeRowsInCol (int) const

ColRange const &	rangeColsInRow (int) const

bool	empty () const

int	size () const

TypeConst	elt (int i, int j) const

TypeConst	elt (int i) const

TypeConst	elt () const

Type &	elt (int i, int j)

Type &	elt (int i)

Type &	elt ()

TypeConst	at (int i, int j) const

TypeConst	at (int i) const

Type &	at (int i, int j)

Type &	at (int i)

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() ()

Public Member Functions inherited from STK::IRecursiveTemplate< Derived >
Derived &	asDerived ()
	static cast : return a reference of this with a cast to the derived class.

Derived const &	asDerived () const
	static cast : return a const reference of this with a cast to the derived class.

Derived *	asPtrDerived ()
	static cast : return a ptr on a `Derived` of this with a cast to the derived class.

Derived const *	asPtrDerived () const
	static cast : return a ptr on a constant `Derived` of this with a cast to the derived class.

Derived *	clone () const
	create a leaf using the copy constructor of the Derived class.

Derived *	clone (bool isRef) const
	create a leaf using the copy constructor of the Derived class and a flag determining if the clone is a reference or not.

Protected Member Functions
	ITContainerBase ()
	Default constructor.

	~ITContainerBase ()
	destructor.

Protected Member Functions inherited from STK::IRecursiveTemplate< Derived >
	IRecursiveTemplate ()
	constructor.

	~IRecursiveTemplate ()
	destructor.

Detailed Description

template<class Derived>
class STK::ITContainerBase< Derived >

Interface base class for 2D containers.

Use the curious recursive template paradigm : the template parameter Derived is the name of the class that implements the interface ITContainer. For example

template<class Type>
class Derived: public ITContainer< Derived<Type> >
{...}

The ITContainerBase class is the base class for all two-dimensional containers. A two-dimensional container is defined by an horizontal range of index for the columns and a vertical range of index for the rows.

The pseudo virtual function defined in this interface and to implement in the derived classes have the following definitions for the dimensions:

ColRange const& colsImpl() const;

RowRange const& rowsImpl() const;

STK::TRange< sizeCols_ >

and for the accessors the following definitions:

Type elt2Impl( int i, int j) const;

Type& elt2Impl( int i, int j);

STK::ITContainerBase::Type

hidden::Traits< Derived >::Type Type

Definition STK_ITContainer.h:108

STK::MultidimRegression

The MultidimRegression class allows to regress a multidimensional output variable among a multivariat...

Definition STK_MultidimRegression.h:52

for all kind of arrays.

For the diagonal arrays, vectors and points (row-vectors) the following accessors have to be implemented

Type elt1Impl( int i) const; // when return by reference is not possible
Type& elt1Impl( int i);
Type const& elt1Impl( int i) const;

Finaly the following accesors have to be implemented for number-like arrays

Type elt0Impl() const; // when return by reference is not possible
Type& elt0Impl();
Type const& elt0Impl() const;

Definition at line 104 of file STK_ITContainer.h.

Member Typedef Documentation

◆ Base

template<class Derived >

typedef IRecursiveTemplate<Derived> STK::ITContainerBase< Derived >::Base

Definition at line 107 of file STK_ITContainer.h.

◆ ColRange

template<class Derived >

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

Type of the Range for the columns.

Definition at line 121 of file STK_ITContainer.h.

◆ RowRange

template<class Derived >

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

Type of the Range for the rows.

Definition at line 119 of file STK_ITContainer.h.

◆ Type

template<class Derived >

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

Definition at line 108 of file STK_ITContainer.h.

◆ TypeConst

template<class Derived >

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

Definition at line 109 of file STK_ITContainer.h.

Member Enumeration Documentation

◆ anonymous enum

template<class Derived >

anonymous enum

Enumerator
structure_
orient_
sizeRows_
sizeCols_
storage_

Definition at line 110 of file STK_ITContainer.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

◆ ITContainerBase()

template<class Derived >

STK::ITContainerBase< Derived >::ITContainerBase ( )

inlineprotected

Default constructor.

Definition at line 125 of file STK_ITContainer.h.

125: Base() {}

STK::ITContainerBase::Base

IRecursiveTemplate< Derived > Base

Definition STK_ITContainer.h:107

◆ ~ITContainerBase()

template<class Derived >

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

inlineprotected

destructor.

Definition at line 127 of file STK_ITContainer.h.

127{}

Member Function Documentation

◆ at() [1/4]

template<class Derived >

Type & STK::ITContainerBase< Derived >::at ( int i )

inline

Returns: safely a reference on the element (i)

Note: this method is only valid for arrays as it allow to modify an element.

Parameters

i	index of the element

Definition at line 264 of file STK_ITContainer.h.

    {
      STK_STATIC_ASSERT_ONE_DIMENSION_ONLY(Derived);
      if (this->asDerived().begin() > i) { STKOUT_OF_RANGE_1ARG(ITContainerBase::at, i, begin() > i);}
      if (this->asDerived().end() <= i)  { STKOUT_OF_RANGE_1ARG(ITContainerBase::at, i, end() <= i);}
      return this->asDerived().elt1Impl(i);
    }

References STK::IRecursiveTemplate< Derived >::asDerived(), STK::ITContainerBase< Derived >::at(), STK_STATIC_ASSERT_ONE_DIMENSION_ONLY, and STKOUT_OF_RANGE_1ARG.

◆ at() [2/4]

template<class Derived >

TypeConst STK::ITContainerBase< Derived >::at ( int i ) const

inline

Returns: safely the constant ith element

Parameters

i	index of the element

Definition at line 241 of file STK_ITContainer.h.

    {
      STK_STATIC_ASSERT_ONE_DIMENSION_ONLY(Derived);
      if (this->asDerived().begin() > i) { STKOUT_OF_RANGE_1ARG(ITContainerBase::at, i, begin() > i);}
      if (this->asDerived().end() <= i)  { STKOUT_OF_RANGE_1ARG(ITContainerBase::at, i, end() <= i);}
      return this->asDerived().elt1Impl(i);
    }

References STK::IRecursiveTemplate< Derived >::asDerived(), STK::ITContainerBase< Derived >::at(), STK_STATIC_ASSERT_ONE_DIMENSION_ONLY, and STKOUT_OF_RANGE_1ARG.

◆ at() [3/4]

template<class Derived >

Type & STK::ITContainerBase< Derived >::at	(	int	i,
		int	j
	)

inline

Returns: safely a reference on the element (i, j)

Note: this method is only valid for arrays as it allow to modify an element.

Parameters

i,j	row and column indexes

Definition at line 252 of file STK_ITContainer.h.

    {
      if (this->beginRows() > i) { STKOUT_OF_RANGE_2ARG(ITContainerBase::at, i, j, beginRows() > i);}
      if (this->endRows() <= i)  { STKOUT_OF_RANGE_2ARG(ITContainerBase::at, i, j, endRows() <= i);}
      if (this->beginCols() > j) { STKOUT_OF_RANGE_2ARG(ITContainerBase::at, i, j, beginCols() > j);}
      if (this->endCols() <= j)  { STKOUT_OF_RANGE_2ARG(ITContainerBase::at, i, j, endCols() <= j);}
      return this->asDerived().elt2Impl(i,j);
    }

References STK::IRecursiveTemplate< Derived >::asDerived(), STK::ITContainerBase< Derived >::at(), STK::ITContainerBase< Derived >::beginCols(), STK::ITContainerBase< Derived >::beginRows(), STK::ITContainerBase< Derived >::endCols(), STK::ITContainerBase< Derived >::endRows(), and STKOUT_OF_RANGE_2ARG.

◆ at() [4/4]

template<class Derived >

TypeConst STK::ITContainerBase< Derived >::at	(	int	i,
		int	j
	)		const

inline

Returns: safely reference on element (i, j).

Parameters

i,j	row and column indexes

Definition at line 230 of file STK_ITContainer.h.

    {
      if (this->beginRows() > i) { STKOUT_OF_RANGE_2ARG(ITContainerBase::at, i, j, beginRows() > i);}
      if (this->endRows() <= i)  { STKOUT_OF_RANGE_2ARG(ITContainerBase::at, i, j, endRows() <= i);}
      if (this->beginCols() > j) { STKOUT_OF_RANGE_2ARG(ITContainerBase::at, i, j, beginCols() > j);}
      if (this->endCols() <= j)  { STKOUT_OF_RANGE_2ARG(ITContainerBase::at, i, j, endCols() <= j);}
      return this->asDerived().elt2Impl(i, j);
    }

References STK::IRecursiveTemplate< Derived >::asDerived(), STK::ITContainerBase< Derived >::at(), STK::ITContainerBase< Derived >::beginCols(), STK::ITContainerBase< Derived >::beginRows(), STK::ITContainerBase< Derived >::endCols(), STK::ITContainerBase< Derived >::endRows(), and STKOUT_OF_RANGE_2ARG.

Referenced by STK::ITContainerBase< Derived >::at(), STK::ITContainer< Derived, Arrays::diagonal_ >::at(), STK::ITContainerBase< Derived >::at(), STK::ITContainerBase< Derived >::at(), and STK::ITContainerBase< Derived >::at().

◆ beginCols()

template<class Derived >

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

inline

Returns: the index of the first column

Definition at line 133 of file STK_ITContainer.h.

133{ return cols().begin();}

STK::ITContainerBase::cols

ColRange const & cols() const

Definition STK_ITContainer.h:131

STK::RangeBase::begin

int begin() const

get the first index of the TRange.

Definition STK_Range.h:93

References STK::RangeBase< Derived >::begin(), and STK::ITContainerBase< Derived >::cols().

Referenced by STK::ITContainerBase< Derived >::at(), STK::ITContainerBase< Derived >::at(), STK::ITContainerBase< Derived >::elt(), STK::ITContainerBase< Derived >::elt(), STK::ITContainerBase< Derived >::firstIdxCols(), STK::ITContainerBase< Derived >::operator()(), and STK::ITContainerBase< Derived >::operator()().

◆ beginRows()

template<class Derived >

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

inline

Returns: the index of the first row

Definition at line 142 of file STK_ITContainer.h.

142{ return rows().begin();}

STK::ITContainerBase::rows

RowRange const & rows() const

Definition STK_ITContainer.h:140

References STK::RangeBase< Derived >::begin(), and STK::ITContainerBase< Derived >::rows().

Referenced by STK::ITContainerBase< Derived >::at(), STK::ITContainerBase< Derived >::at(), STK::ITContainerBase< Derived >::elt(), STK::ITContainerBase< Derived >::elt(), STK::ITContainerBase< Derived >::firstIdxRows(), STK::ITContainerBase< Derived >::operator()(), and STK::ITContainerBase< Derived >::operator()().

◆ cols()

template<class Derived >

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

inline

Returns: the columns range

Definition at line 131 of file STK_ITContainer.h.

131{ return this->asDerived().colsImpl();};

References STK::IRecursiveTemplate< Derived >::asDerived().

Referenced by STK::ITContainerBase< Derived >::beginCols(), STK::ITContainerBase< Derived >::endCols(), STK::ITContainerBase< Derived >::rangeColsInRow(), and STK::ITContainerBase< Derived >::sizeCols().

◆ elt() [1/6]

template<class Derived >

Type & STK::ITContainerBase< Derived >::elt ( )

inline

Returns: a value on the number

Definition at line 225 of file STK_ITContainer.h.

225{ return this->asDerived().elt0Impl();}

References STK::IRecursiveTemplate< Derived >::asDerived().

◆ elt() [2/6]

template<class Derived >

TypeConst STK::ITContainerBase< Derived >::elt ( ) const

inline

Returns: a value on the number

Definition at line 200 of file STK_ITContainer.h.

200{ return this->asDerived().elt0Impl();}

References STK::IRecursiveTemplate< Derived >::asDerived().

Referenced by STK::ITContainerBase< Derived >::elt(), STK::ITContainerBase< Derived >::elt(), STK::ITContainerBase< Derived >::elt(), STK::ITContainerBase< Derived >::operator()(), STK::ITContainerBase< Derived >::operator()(), STK::ITContainerBase< Derived >::operator()(), STK::ITContainerBase< Derived >::operator[](), and STK::ITContainerBase< Derived >::operator[]().

◆ elt() [3/6]

template<class Derived >

Type & STK::ITContainerBase< Derived >::elt ( int i )

inline

Definition at line 215 of file STK_ITContainer.h.

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

References STK::IRecursiveTemplate< Derived >::asDerived(), STK::ITContainerBase< Derived >::elt(), STK_STATIC_ASSERT_ONE_DIMENSION_ONLY, and STKOUT_OF_RANGE_1ARG.

◆ elt() [4/6]

template<class Derived >

TypeConst STK::ITContainerBase< Derived >::elt ( int i ) const

inline

Returns: the constant ith element

Parameters

i	index of the element to get

Definition at line 190 of file STK_ITContainer.h.

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

References STK::IRecursiveTemplate< Derived >::asDerived(), STK::ITContainerBase< Derived >::elt(), STK_STATIC_ASSERT_ONE_DIMENSION_ONLY, and STKOUT_OF_RANGE_1ARG.

◆ elt() [5/6]

template<class Derived >

Type & STK::ITContainerBase< Derived >::elt	(	int	i,
		int	j
	)

inline

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

Parameters

i,j	row and column indexes

Definition at line 205 of file STK_ITContainer.h.

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

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

◆ elt() [6/6]

template<class Derived >

TypeConst STK::ITContainerBase< Derived >::elt	(	int	i,
		int	j
	)		const

inline

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

Parameters

i,j	row and column indexes

Definition at line 177 of file STK_ITContainer.h.

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

References STK::IRecursiveTemplate< Derived >::asDerived(), STK::ITContainerBase< Derived >::beginCols(), STK::ITContainerBase< Derived >::beginRows(), STK::ITContainerBase< Derived >::elt(), STK::ITContainerBase< Derived >::endCols(), STK::ITContainerBase< Derived >::endRows(), and STKOUT_OF_RANGE_2ARG.

◆ empty()

template<class Derived >

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

inline

Returns: true if the container is empty, false otherwise

Definition at line 168 of file STK_ITContainer.h.

168{ return (sizeCols()<=0 || sizeRows()<=0);}

STK::ITContainerBase::sizeCols

int sizeCols() const

Definition STK_ITContainer.h:137

STK::ITContainerBase::sizeRows

int sizeRows() const

Definition STK_ITContainer.h:146

References STK::ITContainerBase< Derived >::sizeCols(), and STK::ITContainerBase< Derived >::sizeRows().

◆ endCols()

template<class Derived >

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

inline

Returns: the ending index of the columns

Definition at line 135 of file STK_ITContainer.h.

135{ return cols().end();}

STK::TRange::end

int end() const

get the ending index of the TRange.

Definition STK_Range.h:192

References STK::ITContainerBase< Derived >::cols(), and STK::TRange< Size_ >::end().

Referenced by STK::ITContainerBase< Derived >::at(), STK::ITContainerBase< Derived >::at(), STK::ITContainerBase< Derived >::elt(), STK::ITContainerBase< Derived >::elt(), STK::ITContainerBase< Derived >::lastIdxCols(), STK::ITContainerBase< Derived >::operator()(), and STK::ITContainerBase< Derived >::operator()().

◆ endRows()

template<class Derived >

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

inline

Returns: the ending index of the rows

Definition at line 144 of file STK_ITContainer.h.

144{ return rows().end();}

References STK::TRange< Size_ >::end(), and STK::ITContainerBase< Derived >::rows().

Referenced by STK::ITContainerBase< Derived >::at(), STK::ITContainerBase< Derived >::at(), STK::ITContainerBase< Derived >::elt(), STK::ITContainerBase< Derived >::elt(), STK::ITContainerBase< Derived >::lastIdxRows(), STK::ITContainerBase< Derived >::operator()(), and STK::ITContainerBase< Derived >::operator()().

◆ firstIdxCols()

template<class Derived >

int STK::ITContainerBase< Derived >::firstIdxCols ( ) const

inline

Returns: the index of the first column

Definition at line 150 of file STK_ITContainer.h.

150{ return beginCols();}

References STK::ITContainerBase< Derived >::beginCols().

◆ firstIdxRows()

template<class Derived >

int STK::ITContainerBase< Derived >::firstIdxRows ( ) const

inline

Returns: the index of the first row

Definition at line 152 of file STK_ITContainer.h.

152{ return beginRows();}

References STK::ITContainerBase< Derived >::beginRows().

◆ lastIdxCols()

template<class Derived >

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

inline

Returns: the index of the last column

Definition at line 154 of file STK_ITContainer.h.

154{ return endCols()-1;}

References STK::ITContainerBase< Derived >::endCols().

◆ lastIdxRows()

template<class Derived >

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

inline

Returns: the index of the last row

Definition at line 156 of file STK_ITContainer.h.

156{ return endRows()-1;}

References STK::ITContainerBase< Derived >::endRows().

◆ operator()() [1/4]

template<class Derived >

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

inline

Returns: reference on the number

Definition at line 329 of file STK_ITContainer.h.

     {
       STK_STATIC_ASSERT_ZERO_DIMENSION_ONLY(Derived);
       return this->elt();
     }

References STK::ITContainerBase< Derived >::elt(), and STK_STATIC_ASSERT_ZERO_DIMENSION_ONLY.

◆ operator()() [2/4]

template<class Derived >

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

inline

Returns: reference on the number

Definition at line 323 of file STK_ITContainer.h.

     {
       STK_STATIC_ASSERT_ZERO_DIMENSION_ONLY(Derived);
       return this->elt();
     }

References STK::ITContainerBase< Derived >::elt(), and STK_STATIC_ASSERT_ZERO_DIMENSION_ONLY.

◆ operator()() [3/4]

template<class Derived >

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

inline

Returns: value of the element (i,j) of the 2D container.

Parameters

i,j	row and column indexes

Definition at line 288 of file STK_ITContainer.h.

     {
 #ifdef STK_BOUNDS_CHECK
       if (this->beginRows() > i) { STKOUT_OF_RANGE_2ARG(ITContainer::operator(), i, j, beginRows() > i);}
       if (this->endRows() <= i)  { STKOUT_OF_RANGE_2ARG(ITContainer::operator(), i, j, endRows() <= i);}
       if (this->beginCols() > j) { STKOUT_OF_RANGE_2ARG(ITContainer::operator(), i, j, beginCols() > j);}
       if (this->endCols() <= j)  { STKOUT_OF_RANGE_2ARG(ITContainer::eoperator()lt, i, j, endCols() <= j);}
 #endif
       return this->asDerived().elt2Impl(i,j);
     }

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

◆ operator()() [4/4]

template<class Derived >

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

inline

Returns: safely a constant value of the element (i,j) of the 2D container.

Parameters

i,j	row and column indexes

Definition at line 275 of file STK_ITContainer.h.

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

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

◆ operator[]() [1/2]

template<class Derived >

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

inline

Returns: reference on the ith element

Parameters

i	index of the element to get

Definition at line 313 of file STK_ITContainer.h.

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

References STK::IRecursiveTemplate< Derived >::asDerived(), STK::ITContainerBase< Derived >::elt(), STK_STATIC_ASSERT_ONE_DIMENSION_ONLY, and STKOUT_OF_RANGE_1ARG.

◆ operator[]() [2/2]

template<class Derived >

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

inline

Returns: reference on the ith element

Parameters

i	index of the element to get

Definition at line 301 of file STK_ITContainer.h.

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

References STK::IRecursiveTemplate< Derived >::asDerived(), STK::ITContainerBase< Derived >::elt(), STK_STATIC_ASSERT_ONE_DIMENSION_ONLY, and STKOUT_OF_RANGE_1ARG.

◆ rangeColsInRow()

template<class Derived >

ColRange const & STK::ITContainerBase< Derived >::rangeColsInRow ( int ) const

inline

Returns: the range of the effectively stored elements in the row. (default implementation)

Definition at line 165 of file STK_ITContainer.h.

165{ return cols();}

References STK::ITContainerBase< Derived >::cols().

◆ rangeRowsInCol()

template<class Derived >

RowRange const & STK::ITContainerBase< Derived >::rangeRowsInCol ( int ) const

inline

Returns: the range of the effectively stored elements in the column. (default implementation)

Definition at line 161 of file STK_ITContainer.h.

161{ return rows();}

References STK::ITContainerBase< Derived >::rows().

◆ rows()

template<class Derived >

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

inline

Returns: the range of the rows

Definition at line 140 of file STK_ITContainer.h.

140{ return this->asDerived().rowsImpl();}

References STK::IRecursiveTemplate< Derived >::asDerived().

Referenced by STK::ITContainerBase< Derived >::beginRows(), STK::ITContainerBase< Derived >::endRows(), STK::ITContainerBase< Derived >::rangeRowsInCol(), and STK::ITContainerBase< Derived >::sizeRows().

◆ size()

template<class Derived >

int STK::ITContainerBase< Derived >::size ( ) const

inline

Returns: the size of the container (the number of rows by the number of columns

Definition at line 171 of file STK_ITContainer.h.

171{ return sizeRows()*sizeCols();}

References STK::ITContainerBase< Derived >::sizeCols(), and STK::ITContainerBase< Derived >::sizeRows().

◆ sizeCols()

template<class Derived >

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

inline

Returns: the Horizontal size (the number of column)

Definition at line 137 of file STK_ITContainer.h.

137{ return cols().size();}

STK::TRange::size

int size() const

get the size of the TRange (the number of elements).

Definition STK_Range.h:196

References STK::ITContainerBase< Derived >::cols(), and STK::TRange< Size_ >::size().

Referenced by STK::ITContainerBase< Derived >::empty(), and STK::ITContainerBase< Derived >::size().

◆ sizeRows()

template<class Derived >

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

inline

Returns: the Vertical size (the number of rows)

Definition at line 146 of file STK_ITContainer.h.

146{ return rows().size();}

References STK::ITContainerBase< Derived >::rows(), and STK::TRange< Size_ >::size().

Referenced by STK::ITContainerBase< Derived >::empty(), and STK::ITContainerBase< Derived >::size().

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

STK_ITContainer.h

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ Base

◆ ColRange

◆ RowRange

◆ Type

◆ TypeConst

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ ITContainerBase()

◆ ~ITContainerBase()

Member Function Documentation

◆ at() [1/4]

◆ at() [2/4]

◆ at() [3/4]

◆ at() [4/4]

◆ beginCols()

◆ beginRows()

◆ cols()

◆ elt() [1/6]

◆ elt() [2/6]

◆ elt() [3/6]

◆ elt() [4/6]

◆ elt() [5/6]

◆ elt() [6/6]

◆ empty()

◆ endCols()

◆ endRows()

◆ firstIdxCols()

◆ firstIdxRows()

◆ lastIdxCols()

◆ lastIdxRows()

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ rangeColsInRow()

◆ rangeRowsInCol()

◆ rows()

◆ size()

◆ sizeCols()

◆ sizeRows()