STK::ITContainer< Derived, Arrays::upper_symmetric_ > Class Template Reference

Specialization for upper_symmetric_. More...

#include <STK_ITContainer.h>

Inheritance diagram for STK::ITContainer< Derived, Arrays::upper_symmetric_ >:

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 ITContainerBase< 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 Types inherited from STK::ITContainerBase< 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 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
RowRange const &	range () const
int	begin () const
int	end () const
int	size () const
int	firstIdx () const
int	lastIdx () const
Type	trace () const
TypeConst	at (int i, int j) const
Type &	at (int i, int j)
Public Member Functions inherited from STK::ITContainerBase< Derived >
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
	ITContainer ()
	default constructor.
	~ITContainer ()
	destructor.
Protected Member Functions inherited from STK::ITContainerBase< Derived >
	ITContainerBase ()
	Default constructor.
	~ITContainerBase ()
	destructor.
Protected Member Functions inherited from STK::IRecursiveTemplate< Derived >
	IRecursiveTemplate ()
	constructor.
	~IRecursiveTemplate ()
	destructor.

Detailed Description

template<class Derived>
class STK::ITContainer< Derived, Arrays::upper_symmetric_ >

Specialization for upper_symmetric_.

Definition at line 684 of file STK_ITContainer.h.

Member Typedef Documentation

Base

template<class Derived >

typedef ITContainerBase<Derived> STK::ITContainer< Derived, Arrays::upper_symmetric_ >::Base

Definition at line 687 of file STK_ITContainer.h.

ColRange

template<class Derived >

typedef TRange<sizeCols_> STK::ITContainer< Derived, Arrays::upper_symmetric_ >::ColRange

Type of the Range for the columns.

Definition at line 701 of file STK_ITContainer.h.

RowRange

template<class Derived >

typedef TRange<sizeRows_> STK::ITContainer< Derived, Arrays::upper_symmetric_ >::RowRange

Type of the Range for the rows.

Definition at line 699 of file STK_ITContainer.h.

Type

template<class Derived >

typedef hidden::Traits<Derived>::Type STK::ITContainer< Derived, Arrays::upper_symmetric_ >::Type

Definition at line 688 of file STK_ITContainer.h.

TypeConst

template<class Derived >

typedef hidden::Traits<Derived>::TypeConst STK::ITContainer< Derived, Arrays::upper_symmetric_ >::TypeConst

Definition at line 689 of file STK_ITContainer.h.

Member Enumeration Documentation

anonymous enum

template<class Derived >

anonymous enum

Enumerator
structure_
orient_
sizeRows_
sizeCols_
storage_

Definition at line 690 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

ITContainer()

template<class Derived >

STK::ITContainer< Derived, Arrays::upper_symmetric_ >::ITContainer ( )

inlineprotected

default constructor.

Definition at line 705 of file STK_ITContainer.h.

: Base() {}

~ITContainer()

template<class Derived >

STK::ITContainer< Derived, Arrays::upper_symmetric_ >::~ITContainer ( )

inlineprotected

destructor.

Definition at line 707 of file STK_ITContainer.h.

{}

Member Function Documentation

at() [1/2]

template<class Derived >

Type & STK::ITContainer< Derived, Arrays::upper_symmetric_ >::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 the element.

Parameters

i,j	row and column indexes

Definition at line 746 of file STK_ITContainer.h.

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

References STKOUT_OF_RANGE_2ARG.

at() [2/2]

template<class Derived >

TypeConst STK::ITContainer< Derived, Arrays::upper_symmetric_ >::at ( int  i, int  j  ) const

inline

Returns

safely the constant element (i, j).

Parameters

i,j	indexes of the element to get

Definition at line 734 of file STK_ITContainer.h.

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

References STKOUT_OF_RANGE_2ARG.

begin()

template<class Derived >

int STK::ITContainer< Derived, Arrays::upper_symmetric_ >::begin ( ) const

inline

Returns

the first index of the square container.

Definition at line 713 of file STK_ITContainer.h.

{ return range().begin();}

end()

template<class Derived >

int STK::ITContainer< Derived, Arrays::upper_symmetric_ >::end ( ) const

inline

Returns

the ending index of the square container.

Definition at line 715 of file STK_ITContainer.h.

{ return range().end();}

firstIdx()

template<class Derived >

int STK::ITContainer< Derived, Arrays::upper_symmetric_ >::firstIdx ( ) const

inline

Returns

the first index of the square container

Definition at line 721 of file STK_ITContainer.h.

{ return this->beginRows();}

lastIdx()

template<class Derived >

int STK::ITContainer< Derived, Arrays::upper_symmetric_ >::lastIdx ( ) const

inline

Returns

the last index of the square container.

Definition at line 723 of file STK_ITContainer.h.

{ return this->endRows()-1;}

range()

template<class Derived >

RowRange const & STK::ITContainer< Derived, Arrays::upper_symmetric_ >::range ( ) const

inline

Returns

the range of the square container.

Definition at line 711 of file STK_ITContainer.h.

{ return this->rows();}

size()

template<class Derived >

int STK::ITContainer< Derived, Arrays::upper_symmetric_ >::size ( ) const

inline

Returns

the size of the rows and columns of the container.

Definition at line 717 of file STK_ITContainer.h.

{ return range().size();}

trace()

template<class Derived >

Type STK::ITContainer< Derived, Arrays::upper_symmetric_ >::trace ( ) const

inline

Definition at line 725 of file STK_ITContainer.h.

    {
      Type sum = 0.0;
      for (int k = begin(); k< end(); k++) sum += this->elt(k, k);
      return sum;
    }

References STK::sum().

---

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

• STK_ITContainer.h