STK::StructuredCAllocator< Derived, 1, 1 > Class Template Reference

specialization for the number_ case. More...

#include <STK_CAllocator.h>

Inheritance diagram for STK::StructuredCAllocator< Derived, 1, 1 >:

Public Types
enum	{   structure_ = hidden::Traits<Derived>::structure_ , orient_ = hidden::Traits<Derived>::orient_ , sizeRows_ = hidden::Traits<Derived>::sizeRows_ , sizeCols_ = hidden::Traits<Derived>::sizeCols_ ,   sizeProd_ = hidden::Traits<Derived>::sizeProd_ , storage_ = hidden::Traits<Derived>::storage_ }
typedef hidden::Traits< Derived >::Row	Row
typedef hidden::Traits< Derived >::Col	Col
typedef hidden::Traits< Derived >::Type	Type
typedef hidden::Traits< Derived >::TypeConst	TypeConst
typedef OrientedCAllocator< Derived, orient_ >	Base
typedef IContainer2D< sizeRows_, sizeCols_ >	LowBase
typedef hidden::Traits< Derived >::Allocator	Allocator
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
void	exchange (StructuredCAllocator &T)
	exchange T with this.
int	size () const
TypeConst	elt0Impl () const
Type &	elt0Impl ()
TypeConst	elt1Impl (int) const
Type &	elt1Impl (int)
void	shift2Impl (int beginRows, int beginCols)
	shift the first indexes of the allocator
void	shift1Impl (int begin)
	shift the first indexes of the allocator.
Derived &	resize1Impl (int)
	resize the allocator (for square and diagonal matrices).
void	moveImpl (StructuredCAllocator const &T)
	move T to this.

Protected Member Functions
	StructuredCAllocator (RowRange const &I, ColRange const &J)
	Default constructor.
	StructuredCAllocator (StructuredCAllocator const &A, bool ref)
	copy constructor
template<class OtherDerived , int OtherRows_, int OtherCols_>
	StructuredCAllocator (StructuredCAllocator< OtherDerived, OtherRows_, OtherCols_ > const &A, RowRange const &I, ColRange const &J)
	Reference constructor.
	StructuredCAllocator (Type *const &q, int, int)
	wrapper constructor for 0 based C-Array
	~StructuredCAllocator ()
	destructor
StructuredCAllocator &	move (StructuredCAllocator const &T)
	move T to this.

Private Attributes
int	row_
int	col_

Detailed Description

template<class Derived>
class STK::StructuredCAllocator< Derived, 1, 1 >

specialization for the number_ case.

Definition at line 794 of file STK_CAllocator.h.

Member Typedef Documentation

Allocator

template<class Derived >

typedef hidden::Traits<Derived>::Allocator STK::StructuredCAllocator< Derived, 1, 1 >::Allocator

Definition at line 814 of file STK_CAllocator.h.

Base

template<class Derived >

typedef OrientedCAllocator<Derived, orient_> STK::StructuredCAllocator< Derived, 1, 1 >::Base

Definition at line 812 of file STK_CAllocator.h.

Col

template<class Derived >

typedef hidden::Traits<Derived>::Col STK::StructuredCAllocator< Derived, 1, 1 >::Col

Definition at line 799 of file STK_CAllocator.h.

ColRange

template<class Derived >

typedef TRange<sizeCols_> STK::StructuredCAllocator< Derived, 1, 1 >::ColRange

Type of the Range for the columns.

Definition at line 819 of file STK_CAllocator.h.

LowBase

template<class Derived >

typedef IContainer2D<sizeRows_, sizeCols_> STK::StructuredCAllocator< Derived, 1, 1 >::LowBase

Definition at line 813 of file STK_CAllocator.h.

Row

template<class Derived >

typedef hidden::Traits<Derived>::Row STK::StructuredCAllocator< Derived, 1, 1 >::Row

Definition at line 798 of file STK_CAllocator.h.

RowRange

template<class Derived >

typedef TRange<sizeRows_> STK::StructuredCAllocator< Derived, 1, 1 >::RowRange

Type of the Range for the rows.

Definition at line 817 of file STK_CAllocator.h.

Type

template<class Derived >

typedef hidden::Traits<Derived>::Type STK::StructuredCAllocator< Derived, 1, 1 >::Type

Definition at line 800 of file STK_CAllocator.h.

TypeConst

template<class Derived >

typedef hidden::Traits<Derived>::TypeConst STK::StructuredCAllocator< Derived, 1, 1 >::TypeConst

Definition at line 801 of file STK_CAllocator.h.

Member Enumeration Documentation

anonymous enum

template<class Derived >

anonymous enum

Enumerator
structure_
orient_
sizeRows_
sizeCols_
sizeProd_
storage_

Definition at line 803 of file STK_CAllocator.h.

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

Constructor & Destructor Documentation

StructuredCAllocator() [1/4]

template<class Derived >

STK::StructuredCAllocator< Derived, 1, 1 >::StructuredCAllocator ( RowRange const &  I, ColRange const &  J  )

inlineprotected

Default constructor.

Definition at line 823 of file STK_CAllocator.h.

                        : Base(I, J), row_(I.begin()), col_(J.begin())
    {}

StructuredCAllocator() [2/4]

template<class Derived >

STK::StructuredCAllocator< Derived, 1, 1 >::StructuredCAllocator ( StructuredCAllocator< Derived, 1, 1 > const &  A, bool  ref  )

inlineprotected

copy constructor

Definition at line 827 of file STK_CAllocator.h.

                        : Base(A, ref), row_(A.row_), col_(A.col_)
    {}

StructuredCAllocator() [3/4]

template<class Derived >

template<class OtherDerived , int OtherRows_, int OtherCols_>

STK::StructuredCAllocator< Derived, 1, 1 >::StructuredCAllocator ( StructuredCAllocator< OtherDerived, OtherRows_, OtherCols_ > const &  A, RowRange const &  I, ColRange const &  J  )

inlineprotected

Reference constructor.

Definition at line 832 of file STK_CAllocator.h.

                               : Base(A, I, J)
                               , row_(I.begin()), col_(J.begin())
    {}

StructuredCAllocator() [4/4]

template<class Derived >

STK::StructuredCAllocator< Derived, 1, 1 >::StructuredCAllocator ( Type *const &  q, int  , int    )

inlineprotected

wrapper constructor for 0 based C-Array

Definition at line 838 of file STK_CAllocator.h.

: Base(q, 1, 1), row_(0), col_(0) {}

~StructuredCAllocator()

template<class Derived >

STK::StructuredCAllocator< Derived, 1, 1 >::~StructuredCAllocator ( )

inlineprotected

destructor

Definition at line 840 of file STK_CAllocator.h.

{}

Member Function Documentation

elt0Impl() [1/2]

template<class Derived >

Type & STK::StructuredCAllocator< Derived, 1, 1 >::elt0Impl ( )

inline

Returns

a reference on the element of the Allocator.

Definition at line 862 of file STK_CAllocator.h.

{ return this->elt2Impl(row_, col_);}

elt0Impl() [2/2]

template<class Derived >

TypeConst STK::StructuredCAllocator< Derived, 1, 1 >::elt0Impl ( ) const

inline

Returns

a constant reference on the element of the Allocator.

Definition at line 860 of file STK_CAllocator.h.

{ return this->elt2Impl(row_, col_);}

elt1Impl() [1/2]

template<class Derived >

Type & STK::StructuredCAllocator< Derived, 1, 1 >::elt1Impl ( int  )

inline

Returns

a reference on the element of the Allocator.

Definition at line 866 of file STK_CAllocator.h.

{ return this->elt2Impl(row_, col_);}

elt1Impl() [2/2]

template<class Derived >

TypeConst STK::StructuredCAllocator< Derived, 1, 1 >::elt1Impl ( int  ) const

inline

Returns

a constant reference on the element of the Allocator.

Definition at line 864 of file STK_CAllocator.h.

{ return this->elt2Impl(row_, col_);}

exchange()

template<class Derived >

void STK::StructuredCAllocator< Derived, 1, 1 >::exchange ( StructuredCAllocator< Derived, 1, 1 > &  T )

inline

exchange T with this.

Parameters

T	the container to exchange

Definition at line 851 of file STK_CAllocator.h.

    { Base::exchange(T);
      std::swap(row_, T.row_);
      std::swap(col_, T.col_);
    }

move()

template<class Derived >

StructuredCAllocator & STK::StructuredCAllocator< Derived, 1, 1 >::move ( StructuredCAllocator< Derived, 1, 1 > const &  T )

inlineprotected

move T to this.

Parameters

T	the container to move

Definition at line 844 of file STK_CAllocator.h.

    { row_ = T.row_; col_ = T.col_; return *this;}

moveImpl()

template<class Derived >

void STK::StructuredCAllocator< Derived, 1, 1 >::moveImpl ( StructuredCAllocator< Derived, 1, 1 > const &  T )

inline

move T to this.

Parameters

T	the container to move

Definition at line 892 of file STK_CAllocator.h.

{ row_ = T.row_; col_ = T.col_;}

resize1Impl()

template<class Derived >

Derived & STK::StructuredCAllocator< Derived, 1, 1 >::resize1Impl ( int  )

inline

resize the allocator (for square and diagonal matrices).

Definition at line 888 of file STK_CAllocator.h.

{ return this->asDerived().resize2Impl(1, 1);}

shift1Impl()

template<class Derived >

void STK::StructuredCAllocator< Derived, 1, 1 >::shift1Impl ( int  begin )

inline

shift the first indexes of the allocator.

Parameters

begin

the index of the first row and column

Definition at line 882 of file STK_CAllocator.h.

    {
      this->shift2Impl(begin, begin);
      row_ = begin; col_ = begin;
    }

shift2Impl()

template<class Derived >

void STK::StructuredCAllocator< Derived, 1, 1 >::shift2Impl ( int  beginRows, int  beginCols  )

inline

shift the first indexes of the allocator

Parameters

beginRows,beginCols

indexes to set

Definition at line 871 of file STK_CAllocator.h.

    {
      if ((beginRows == this->beginRows())&&(beginCols == this->beginCols())) return;
      LowBase::shift(beginRows, beginCols);
      this->allocator_.shift(this->shiftInc(beginRows, beginCols));
      row_ = beginRows;
      col_ = beginCols;
   }

size()

template<class Derived >

int STK::StructuredCAllocator< Derived, 1, 1 >::size ( ) const

inline

Returns

the size of the allocator

Definition at line 857 of file STK_CAllocator.h.

{ return 1;}

Member Data Documentation

col_

template<class Derived >

int STK::StructuredCAllocator< Derived, 1, 1 >::col_

private

Definition at line 896 of file STK_CAllocator.h.

row_

template<class Derived >

int STK::StructuredCAllocator< Derived, 1, 1 >::row_

private

Definition at line 895 of file STK_CAllocator.h.

---

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

• STK_CAllocator.h