STK::ITContainer1D< Derived > Class Template Reference

Interface base class for homogeneous 1D containers. More...

#include <STK_ITContainer1D.h>

Inheritance diagram for STK::ITContainer1D< Derived >:

Public Types
enum	{ size_ = hidden::Traits<Derived>::size_ }
typedef hidden::Traits< Derived >::Type	Type
typedef hidden::Traits< Derived >::TypeConst	TypeConst
typedef hidden::Traits< Derived >::RowRange	RowRange
typedef hidden::Traits< Derived >::ColRange	ColRange
typedef hidden::Traits< Derived >::Row	Row
typedef hidden::Traits< Derived >::Col	Col
typedef hidden::Traits< Derived >::SubVector	SubVector
typedef hidden::Traits< Derived >::Iterator	Iterator
typedef hidden::Traits< Derived >::ConstIterator	ConstIterator
typedef hidden::Traits< Derived >::ReverseIterator	ReverseIterator
typedef hidden::Traits< Derived >::ConstReverseIterator	ConstReverseIterator

Public Member Functions
RowRange const &	range () const
int	begin () const
int	end () const
int	size () const
int	lastIdx () const
Iterator	beginIterator ()
Iterator	endIterator ()
ConstIterator	beginConstIterator () const
ConstIterator	endConstIterator () const
ReverseIterator	rbeginIterator ()
ReverseIterator	rendIterator ()
ConstReverseIterator	rbeginConstIterator () const
ConstReverseIterator	rendConstIterator () const
bool	empty () const
	Is there some data ?
Type &	elt (int i)
TypeConst	elt (int i) const
Type &	operator[] (int i)
TypeConst	operator[] (int i) const
Type &	at (int i)
TypeConst	at (int i) const
SubVector	sub (Range const &I) const
	Access to many elements.
Type &	front ()
TypeConst	front () const
Type &	back ()
TypeConst	back () const
void	shift (int beg)
Derived &	resize (Range const &I=RowRange())
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
	ITContainer1D ()
	Default constructor.
	ITContainer1D (RowRange const &I)
	constructor with a specified range.
	~ITContainer1D ()
	destructor.
void	exchange (ITContainer1D &T)
	exchange this container with T
void	setRange (RowRange const &I=RowRange())
	Set range of the rows of the container.
void	incRange (int n=1)
	increment the range of the container (can be negative).
void	incFirst (int n=1)
	increment the beginning of the container (can be negative).
void	decFirst (int n=1)
	decrement the beginning of the container.
void	incLast (int n=1)
	increment the end of the container (can be negative).
void	decLast (int n=1)
	decrement the end of the container.
Protected Member Functions inherited from STK::IRecursiveTemplate< Derived >
	IRecursiveTemplate ()
	constructor.
	~IRecursiveTemplate ()
	destructor.

Private Attributes
RowRange	range_
	range of the array.

Detailed Description

template<class Derived>
class STK::ITContainer1D< Derived >

Interface base class for homogeneous 1D containers.

The ITContainer1D class is the template base class for all homogeneous one-dimensional containers containing element of type Type where Type is not necessarily a scalar. It assumes that the derived class cannot be part of an expression and is not constant, so that it can be #- shifted, #- resized #- accessed in modification.

Implement the curious recursive template paradigm: the template parameter c Derived is the name of the class that implements ITContainer1D. For example template<class Type> class Derived: public ITContainer1D< Derived<Type> > {...}

The pseudo virtual function defined in this interface and to be implemented by derived classes have the following definitions

Type& elt1Impl(int const& pos);
Type const& elt1Impl(int const& pos) const;
void shiftImpl(int const& beg);
Derived& resizeImpl(Range const& I);

It is required that all these methods have to be implemented in Derived classes.

See also

List1D, Array1D

Definition at line 75 of file STK_ITContainer1D.h.

Member Typedef Documentation

Col

template<class Derived >

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

Definition at line 90 of file STK_ITContainer1D.h.

ColRange

template<class Derived >

typedef hidden::Traits<Derived>::ColRange STK::ITContainer1D< Derived >::ColRange

Definition at line 87 of file STK_ITContainer1D.h.

ConstIterator

template<class Derived >

typedef hidden::Traits<Derived>::ConstIterator STK::ITContainer1D< Derived >::ConstIterator

Definition at line 95 of file STK_ITContainer1D.h.

ConstReverseIterator

template<class Derived >

typedef hidden::Traits<Derived>::ConstReverseIterator STK::ITContainer1D< Derived >::ConstReverseIterator

Definition at line 97 of file STK_ITContainer1D.h.

Iterator

template<class Derived >

typedef hidden::Traits<Derived>::Iterator STK::ITContainer1D< Derived >::Iterator

Definition at line 94 of file STK_ITContainer1D.h.

ReverseIterator

template<class Derived >

typedef hidden::Traits<Derived>::ReverseIterator STK::ITContainer1D< Derived >::ReverseIterator

Definition at line 96 of file STK_ITContainer1D.h.

Row

template<class Derived >

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

Definition at line 89 of file STK_ITContainer1D.h.

RowRange

template<class Derived >

typedef hidden::Traits<Derived>::RowRange STK::ITContainer1D< Derived >::RowRange

Definition at line 86 of file STK_ITContainer1D.h.

SubVector

template<class Derived >

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

Definition at line 91 of file STK_ITContainer1D.h.

Type

template<class Derived >

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

Definition at line 83 of file STK_ITContainer1D.h.

TypeConst

template<class Derived >

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

Definition at line 84 of file STK_ITContainer1D.h.

Member Enumeration Documentation

anonymous enum

template<class Derived >

anonymous enum

Enumerator
size_

Definition at line 78 of file STK_ITContainer1D.h.

    {
      size_ = hidden::Traits<Derived>::size_
    };

Constructor & Destructor Documentation

ITContainer1D() [1/2]

template<class Derived >

STK::ITContainer1D< Derived >::ITContainer1D ( )

inlineprotected

Default constructor.

Definition at line 101 of file STK_ITContainer1D.h.

: range_() {}

ITContainer1D() [2/2]

template<class Derived >

STK::ITContainer1D< Derived >::ITContainer1D ( RowRange const &  I )

inlineprotected

constructor with a specified range.

Parameters

I	: the range of the container

Definition at line 105 of file STK_ITContainer1D.h.

: range_(I) {}

~ITContainer1D()

template<class Derived >

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

inlineprotected

destructor.

Definition at line 107 of file STK_ITContainer1D.h.

{}

Member Function Documentation

at() [1/2]

template<class Derived >

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

inline

Returns

safely the jth element

Parameters

i	index of the element

Definition at line 194 of file STK_ITContainer1D.h.

    {
      if (begin() > i) { STKOUT_OF_RANGE_1ARG(ITContainer1D::at, i, begin() > i);}
      if (end() <= i)  { STKOUT_OF_RANGE_1ARG(ITContainer1D::at, i, end() <= i);}
      return elt(i);
    }

References STK::ITContainer1D< Derived >::at(), STK::ITContainer1D< Derived >::begin(), STK::ITContainer1D< Derived >::elt(), STK::ITContainer1D< Derived >::end(), and STKOUT_OF_RANGE_1ARG.

Referenced by STK::ITContainer1D< Derived >::at(), STK::ITContainer1D< Derived >::at(), STK::MultiLaw::JointProbability< RowVector, Law >::atLaw(), and STK::MultiLaw::JointProbability< RowVector, Law >::atLaw().

at() [2/2]

template<class Derived >

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

inline

Returns

safely the constant jth element

Parameters

i	index of the element

Definition at line 203 of file STK_ITContainer1D.h.

    {
      if (begin() > i)
      { STKOUT_OF_RANGE_1ARG(ITContainer1D::at, i, begin() > i);}
      if (end() <= i)
      { STKOUT_OF_RANGE_1ARG(ITContainer1D::at, i, end() <= i);}
      return elt(i);
    }

References STK::ITContainer1D< Derived >::at(), STK::ITContainer1D< Derived >::begin(), STK::ITContainer1D< Derived >::elt(), STK::ITContainer1D< Derived >::end(), and STKOUT_OF_RANGE_1ARG.

back() [1/2]

template<class Derived >

Type & STK::ITContainer1D< Derived >::back ( )

inline

Returns

a reference on the last element

Definition at line 231 of file STK_ITContainer1D.h.

{ return elt(lastIdx());}

References STK::ITContainer1D< Derived >::elt(), and STK::ITContainer1D< Derived >::lastIdx().

Referenced by STK::Variable< Type_ >::push_back(), and STK::DataFrame::pushBackVariable().

back() [2/2]

template<class Derived >

TypeConst STK::ITContainer1D< Derived >::back ( ) const

inline

Returns

a constant reference on the last element

Definition at line 233 of file STK_ITContainer1D.h.

{ return elt(lastIdx());}

References STK::ITContainer1D< Derived >::elt(), and STK::ITContainer1D< Derived >::lastIdx().

begin()

template<class Derived >

int STK::ITContainer1D< Derived >::begin ( ) const

inline

Returns

the index of the first element

Definition at line 113 of file STK_ITContainer1D.h.

{ return range_.begin();}

References STK::ITContainer1D< Derived >::range_.

Referenced by STK::ITContainer1D< Derived >::at(), STK::ITContainer1D< Derived >::at(), STK::ITContainer1D< Derived >::beginConstIterator(), STK::ITContainer1D< Derived >::beginIterator(), STK::ITContainer1D< Derived >::elt(), STK::ITContainer1D< Derived >::elt(), STK::ITContainer1D< Derived >::front(), STK::ITContainer1D< Derived >::front(), STK::ITContainer1D< Derived >::operator[](), STK::ITContainer1D< Derived >::operator[](), and STK::ITContainer1D< Derived >::sub().

beginConstIterator()

template<class Derived >

ConstIterator STK::ITContainer1D< Derived >::beginConstIterator ( ) const

inline

Returns

an iterator on the beginning of the container

Definition at line 128 of file STK_ITContainer1D.h.

{ return ConstIterator(this->asDerived(), begin());}

References STK::IRecursiveTemplate< Derived >::asDerived(), and STK::ITContainer1D< Derived >::begin().

Referenced by STK::KernelHandler::addKernel(), STK::KernelHandler::getKernel(), STK::KernelHandler::isHandled(), and STK::ITContainer1D< Derived >::rendConstIterator().

beginIterator()

template<class Derived >

Iterator STK::ITContainer1D< Derived >::beginIterator ( )

inline

Returns

an iterator on the beginning of the container

Definition at line 123 of file STK_ITContainer1D.h.

{ return Iterator(this->asDerived(), begin());}

References STK::IRecursiveTemplate< Derived >::asDerived(), and STK::ITContainer1D< Derived >::begin().

Referenced by STK::KernelHandler::addKernel(), STK::KernelHandler::removeKernel(), STK::ITContainer1D< Derived >::rendIterator(), and STK::KernelHandler::~KernelHandler().

decFirst()

template<class Derived >

void STK::ITContainer1D< Derived >::decFirst ( int  n = 1 )

inlineprotected

decrement the beginning of the container.

Parameters

n	decrement to apply to the beginning of the range

Definition at line 267 of file STK_ITContainer1D.h.

{ range_.decFirst(n);}

References STK::ITContainer1D< Derived >::range_.

decLast()

template<class Derived >

void STK::ITContainer1D< Derived >::decLast ( int  n = 1 )

inlineprotected

decrement the end of the container.

Parameters

n	decrement to apply to the end of the range

Definition at line 275 of file STK_ITContainer1D.h.

{ range_.decLast(n);}

References STK::ITContainer1D< Derived >::range_.

elt() [1/2]

template<class Derived >

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

inline

Returns

the ith element for vector_, point_ and diagonal_ containers

Parameters

i	index of the element to get

Definition at line 150 of file STK_ITContainer1D.h.

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

References STK::IRecursiveTemplate< Derived >::asDerived(), STK::ITContainer1D< Derived >::begin(), STK::ITContainer1D< Derived >::elt(), STK::ITContainer1D< Derived >::end(), and STKOUT_OF_RANGE_1ARG.

Referenced by STK::ITContainer1D< Derived >::at(), STK::ITContainer1D< Derived >::at(), STK::ITContainer1D< Derived >::back(), STK::ITContainer1D< Derived >::back(), STK::DataFrame::elt(), STK::DataFrame::elt(), STK::ITContainer1D< Derived >::elt(), STK::ITContainer1D< Derived >::elt(), STK::ITContainer1D< Derived >::front(), STK::ITContainer1D< Derived >::front(), STK::ITContainer1D< Derived >::operator[](), and STK::ITContainer1D< Derived >::operator[]().

elt() [2/2]

template<class Derived >

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

inline

Returns

a constant reference on the ith element for vector_, point_ and diagonal_ containers

Parameters

i	index of the element to get

Definition at line 161 of file STK_ITContainer1D.h.

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

References STK::IRecursiveTemplate< Derived >::asDerived(), STK::ITContainer1D< Derived >::begin(), STK::ITContainer1D< Derived >::elt(), STK::ITContainer1D< Derived >::end(), and STKOUT_OF_RANGE_1ARG.

empty()

template<class Derived >

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

inline

Is there some data ?

Returns

true if the container is empty, false otherwise

Definition at line 145 of file STK_ITContainer1D.h.

{ return range_.empty();}

References STK::ITContainer1D< Derived >::range_.

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

end()

template<class Derived >

int STK::ITContainer1D< Derived >::end ( ) const

inline

Returns

the ending index of the elements

Definition at line 115 of file STK_ITContainer1D.h.

{ return range_.end();}

References STK::ITContainer1D< Derived >::range_.

Referenced by STK::ITContainer1D< Derived >::at(), STK::ITContainer1D< Derived >::at(), STK::ITContainer1D< Derived >::elt(), STK::ITContainer1D< Derived >::elt(), STK::ITContainer1D< Derived >::endConstIterator(), STK::ITContainer1D< Derived >::operator[](), STK::ITContainer1D< Derived >::operator[](), and STK::ITContainer1D< Derived >::sub().

endConstIterator()

template<class Derived >

ConstIterator STK::ITContainer1D< Derived >::endConstIterator ( ) const

inline

Returns

an iterator on the end of the container

Definition at line 130 of file STK_ITContainer1D.h.

{ return ConstIterator(this->asDerived(), end());}

References STK::IRecursiveTemplate< Derived >::asDerived(), and STK::ITContainer1D< Derived >::end().

Referenced by STK::KernelHandler::addKernel(), STK::KernelHandler::getKernel(), STK::KernelHandler::isHandled(), and STK::ITContainer1D< Derived >::rbeginConstIterator().

endIterator()

template<class Derived >

Iterator STK::ITContainer1D< Derived >::endIterator ( )

inline

Returns

an iterator on the end of the container

Definition at line 125 of file STK_ITContainer1D.h.

{ return Iterator(this->asDerived(), end());}

Referenced by STK::KernelHandler::addKernel(), STK::ITContainer1D< Derived >::rbeginIterator(), STK::KernelHandler::removeKernel(), and STK::KernelHandler::~KernelHandler().

exchange()

template<class Derived >

void STK::ITContainer1D< Derived >::exchange ( ITContainer1D< Derived > &  T )

inlineprotected

exchange this container with T

Parameters

T	the container to exchange with T

Definition at line 251 of file STK_ITContainer1D.h.

{ std::swap(T.range_, range_ );}

References STK::ITContainer1D< Derived >::range_.

front() [1/2]

template<class Derived >

Type & STK::ITContainer1D< Derived >::front ( )

inline

Returns

a reference on the first element.

Definition at line 227 of file STK_ITContainer1D.h.

{ return elt(begin());}

References STK::ITContainer1D< Derived >::begin(), and STK::ITContainer1D< Derived >::elt().

front() [2/2]

template<class Derived >

TypeConst STK::ITContainer1D< Derived >::front ( ) const

inline

Returns

a constant reference on the first element

Definition at line 229 of file STK_ITContainer1D.h.

{ return elt(begin());}

References STK::ITContainer1D< Derived >::begin(), and STK::ITContainer1D< Derived >::elt().

incFirst()

template<class Derived >

void STK::ITContainer1D< Derived >::incFirst ( int  n = 1 )

inlineprotected

increment the beginning of the container (can be negative).

Parameters

n	increment to apply to the beginning of the range

Definition at line 263 of file STK_ITContainer1D.h.

{ range_.incFirst(n);}

References STK::ITContainer1D< Derived >::range_.

incLast()

template<class Derived >

void STK::ITContainer1D< Derived >::incLast ( int  n = 1 )

inlineprotected

increment the end of the container (can be negative).

Parameters

n	increment to apply to the end of the range

Definition at line 271 of file STK_ITContainer1D.h.

{ range_.incLast(n);}

References STK::ITContainer1D< Derived >::range_.

incRange()

template<class Derived >

void STK::ITContainer1D< Derived >::incRange ( int  n = 1 )

inlineprotected

increment the range of the container (can be negative).

Parameters

n	increment to apply to the range

Definition at line 259 of file STK_ITContainer1D.h.

{ range_.inc(n);}

References STK::ITContainer1D< Derived >::range_.

lastIdx()

template<class Derived >

int STK::ITContainer1D< Derived >::lastIdx ( ) const

inline

Returns

the index of the last element

Definition at line 120 of file STK_ITContainer1D.h.

{ return range_.lastIdx();}

References STK::ITContainer1D< Derived >::range_.

Referenced by STK::ITContainer1D< Derived >::back(), STK::ITContainer1D< Derived >::back(), and STK::ISparseArray1D< Derived >::lastIdxRows().

operator[]() [1/2]

template<class Derived >

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

inline

Returns

the element ith element

Parameters

i	index of the element to get

Definition at line 172 of file STK_ITContainer1D.h.

    {
#ifdef STK_BOUNDS_CHECK
      if (begin() > i) { STKOUT_OF_RANGE_1ARG(ITContainer1D::operator[], i, begin() > i);}
      if (end() <= i)  { STKOUT_OF_RANGE_1ARG(ITContainer1D::operator[], i, end() <= i);}
#endif
      return elt(i);
    }

References STK::ITContainer1D< Derived >::begin(), STK::ITContainer1D< Derived >::elt(), STK::ITContainer1D< Derived >::end(), and STKOUT_OF_RANGE_1ARG.

operator[]() [2/2]

template<class Derived >

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

inline

Returns

a constant reference on the ith element

Parameters

i	index of the element to get

Definition at line 183 of file STK_ITContainer1D.h.

    {
#ifdef STK_BOUNDS_CHECK
      if (begin() > i) { STKOUT_OF_RANGE_1ARG(ITContainer1D::operator[], i, begin() > i);}
      if (end() <= i)  { STKOUT_OF_RANGE_1ARG(ITContainer1D::operator[], i, end() <= i);}
#endif
      return elt(i);
    }

References STK::ITContainer1D< Derived >::begin(), STK::ITContainer1D< Derived >::elt(), STK::ITContainer1D< Derived >::end(), and STKOUT_OF_RANGE_1ARG.

range()

template<class Derived >

RowRange const & STK::ITContainer1D< Derived >::range ( ) const

inline

Returns

the range of the container

Definition at line 111 of file STK_ITContainer1D.h.

{ return range_;}

References STK::ITContainer1D< Derived >::range_.

Referenced by STK::List1D< Type_ >::operator=().

rbeginConstIterator()

template<class Derived >

ConstReverseIterator STK::ITContainer1D< Derived >::rbeginConstIterator ( ) const

inline

Returns

a reversed iterator on the beginning of the reversed container

Definition at line 138 of file STK_ITContainer1D.h.

{ return ConstReverseIterator(endConstIterator());}

References STK::ITContainer1D< Derived >::endConstIterator().

rbeginIterator()

template<class Derived >

ReverseIterator STK::ITContainer1D< Derived >::rbeginIterator ( )

inline

Returns

a reversed iterator on the beginning of the reversed container

Definition at line 133 of file STK_ITContainer1D.h.

{ return ReverseIterator(endIterator());}

References STK::ITContainer1D< Derived >::endIterator().

rendConstIterator()

template<class Derived >

ConstReverseIterator STK::ITContainer1D< Derived >::rendConstIterator ( ) const

inline

Returns

a reversed iterator on the end of the reversed container

Definition at line 140 of file STK_ITContainer1D.h.

{ return ConstReverseIterator(beginConstIterator());}

References STK::ITContainer1D< Derived >::beginConstIterator().

rendIterator()

template<class Derived >

ReverseIterator STK::ITContainer1D< Derived >::rendIterator ( )

inline

Returns

a reversed iterator on the end of the reversed container

Definition at line 135 of file STK_ITContainer1D.h.

{ return ReverseIterator(beginIterator());}

References STK::ITContainer1D< Derived >::beginIterator().

resize()

template<class Derived >

Derived & STK::ITContainer1D< Derived >::resize ( Range const &  I = RowRange() )

inline

Returns

the resized container.

Parameters

I	the range of the container

Definition at line 244 of file STK_ITContainer1D.h.

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

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

Referenced by STK::DataFrame::operator=(), STK::Array1D< Type_, Size_ >::operator=(), STK::SArray1D< Type_, Size_, NzMax_ >::operator=(), STK::MultiLaw::JointProbability< RowVector, Law >::resize(), STK::Variable< Type_ >::resize1D(), and STK::Stat::Multivariate< Array, WColVector, Type >::run().

setRange()

template<class Derived >

void STK::ITContainer1D< Derived >::setRange ( RowRange const &  I = RowRange() )

inlineprotected

Set range of the rows of the container.

Parameters

I	the range to set (default empty)

Definition at line 255 of file STK_ITContainer1D.h.

{ range_ = I;}

References STK::ITContainer1D< Derived >::range_.

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

shift()

template<class Derived >

void STK::ITContainer1D< Derived >::shift ( int  beg )

inline

Parameters

beg	the index of the first column to set

Definition at line 236 of file STK_ITContainer1D.h.

    {
      this->asDerived().shiftImpl(beg);
      range_.shift(beg);
    }

References STK::IRecursiveTemplate< Derived >::asDerived(), and STK::ITContainer1D< Derived >::range_.

Referenced by STK::Variable< Type_ >::shift(), STK::DataFrame::shift(), and STK::Variable< Type_ >::shift1D().

size()

template<class Derived >

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

inline

Returns

the size of the container

Definition at line 117 of file STK_ITContainer1D.h.

{ return range_.size();}

References STK::ITContainer1D< Derived >::range_.

sub()

template<class Derived >

SubVector STK::ITContainer1D< Derived >::sub ( Range const &  I ) const

inline

Access to many elements.

Parameters

I	the range of the elements

Returns

a reference container with the elements of this in the range I

Definition at line 215 of file STK_ITContainer1D.h.

    {
#ifdef STK_BOUNDS_CHECK
      if ((I.begin()<begin()))
      { STKOUT_OF_RANGE_1ARG(ITContainer1D::sub,I,I.begin()<begin());}
      if ((I.end()>end()))
      { STKOUT_OF_RANGE_1ARG(ITContainer1D::sub,I,I.end()>end());}
#endif
      return SubVector(this->asDerived(), I, true);
    }

References STK::IRecursiveTemplate< Derived >::asDerived(), STK::ITContainer1D< Derived >::begin(), STK::ITContainer1D< Derived >::end(), STKOUT_OF_RANGE_1ARG, and STK::ITContainer1D< Derived >::sub().

Referenced by STK::ITContainer1D< Derived >::sub().

Member Data Documentation

range_

template<class Derived >

RowRange STK::ITContainer1D< Derived >::range_

private

range of the array.

Definition at line 279 of file STK_ITContainer1D.h.

Referenced by STK::ITContainer1D< Derived >::begin(), STK::ITContainer1D< Derived >::decFirst(), STK::ITContainer1D< Derived >::decLast(), STK::ITContainer1D< Derived >::empty(), STK::ITContainer1D< Derived >::end(), STK::ITContainer1D< Derived >::exchange(), STK::ITContainer1D< Derived >::incFirst(), STK::ITContainer1D< Derived >::incLast(), STK::ITContainer1D< Derived >::incRange(), STK::ITContainer1D< Derived >::lastIdx(), STK::ITContainer1D< Derived >::range(), STK::ITContainer1D< Derived >::setRange(), STK::ITContainer1D< Derived >::shift(), and STK::ITContainer1D< Derived >::size().

---

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

• STK_ITContainer1D.h