STK::IArray1D< Derived > Class Template Reference

template one dimensional Array. More...

#include <STK_IArray1D.h>

Inheritance diagram for STK::IArray1D< Derived >:

Public Types
enum	{   structure_ = hidden::Traits< Derived >::structure_ , orient_ = hidden::Traits< Derived >::orient_ , sizeCols_ = hidden::Traits< Derived >::sizeCols_ , sizeRows_ = hidden::Traits< Derived >::sizeRows_ ,   size_ = hidden::Traits< Derived >::size_ , storage_ = hidden::Traits< Derived >::storage_ , isFixedSize_ = (size_ != UnknownSize) }
typedef ITContainer1D< Derived >	Base
typedef hidden::Traits< Derived >::Allocator	Allocator
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 >::Iterator	Iterator
typedef hidden::Traits< Derived >::ConstIterator	ConstIterator
typedef hidden::Traits< Derived >::ReverseIterator	ReverseIterator
typedef hidden::Traits< Derived >::ConstReverseIterator	ConstReverseIterator
Public Types inherited from STK::ITContainer1D< Derived >
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
bool	isRef () const
void	setRef (bool ref) const
	Modify the state of the container: this become a reference (if ref is true) or the owner of the data (if ref is false).
Allocator const &	allocator () const
RowRange const &	rows () const
int	beginRows () const
int	endRows () const
int	sizeRows () const
ColRange	cols () const
int	beginCols () const
int	endCols () const
int	sizeCols () const
int	lastIdxRows () const
int	lastIdxCols () const
int	capacity () const
Type &	elt1Impl (int pos)
	access to an element
TypeConst	elt1Impl (int pos) const
	access to a constant element
Derived &	setValue (Type const &value)
	set a value to this container.
void	setValue (int pos, TypeConst value)
	Write a value at a given position.
void	shiftImpl (int beg=baseIdx)
	New beginning index for the object.
Derived &	resizeImpl (Range const &I)
	Resize the container.
void	reserve (int size)
	reserve internal memory for at least size elements.
void	clear ()
	Clear the object.
void	move (Derived const &T)
	move T to this.
Derived &	pushBack (int n=1)
	Add n Elements to the end of the container.
Derived &	popBack (int n=1)
	Delete last elts of the container.
Derived &	erase (int pos, int n=1)
	Delete n elements at the pos index to the container.
Derived &	insertElt (int pos, int n=1)
	Insert n elements at the position pos of the container.
Derived &	insert (int pos, Type const &v)
	STL compatibility: Insert element v at position pos of the Array.
Derived &	insert (Range const &I, Type const &v)
	STL compatibility: Insert element v in the range I of the Array.
Derived &	push_front (Type const &v)
	STL compatibility: push front an element.
Derived &	push_back (Type const &v)
	STL compatibility: append an element v.
void	swap (int pos1, int pos2)
	Swapping the pos1 elt and the pos2 elt.
void	exchange (IArray1D &T)
	exchange this Container with T.
Derived &	assign (IArray1D const &src)
	overwrite this with src.
void	memmove (int pos1, int pos2, int n)
	Copy n elements from pos2 to pos1, guaranteeing correct behavior for overlapping.
RowRange const &	range () const
int	begin () const
int	end () const
int	size () const
int	lastIdx () const
void	decLast (int n=1)
	decrement the end of the container.
void	incLast (int n=1)
	increment the end of the container (can be negative).
void	incRange (int n=1)
	increment the range of the container (can be negative).
void	setRange (RowRange const &I=RowRange())
	Set range of the rows of the container.
Type &	elt (int i)
TypeConst	elt (int i) const
Public Member Functions inherited from STK::ITContainer1D< Derived >
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
	IArray1D ()
	Default constructor.
	IArray1D (Range const &I)
	constructor with a specified Range.
	IArray1D (Range const &I, Type const &v)
	Misc constructor with first and last, initialization with a constant.
	IArray1D (IArray1D const &T, bool ref)
	Copy constructor.
template<class OtherDerived >
	IArray1D (IArray1D< OtherDerived > const &T, bool ref)
	Copy constructor.
template<class OtherDerived >
	IArray1D (IArray1D< OtherDerived > const &T, RowRange const &I, bool ref)
	copy constructor.
	IArray1D (Allocator const &A, Range const &I, bool ref)
	Wrapper constructor.
	~IArray1D ()
	destructor: allocated memory is liberated by MemAllocator class.
Allocator &	allocator ()
void	initialize (RowRange const &I)
	function for memory allocation and initialization.
void	allocate (RowRange const &I)
	function for memory allocation.
void	freeMem ()
	Method for memory deallocation.
Protected Member Functions inherited from STK::ITContainer1D< Derived >
	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
Allocator	allocator_

Detailed Description

template<class Derived>
class STK::IArray1D< Derived >

template one dimensional Array.

An IArray1D is a template one column container implementing the interface base class ITContainer1D.

Definition at line 94 of file STK_IArray1D.h.

Member Typedef Documentation

Allocator

template<class Derived >

typedef hidden::Traits<Derived>::Allocator STK::IArray1D< Derived >::Allocator

Definition at line 99 of file STK_IArray1D.h.

Base

template<class Derived >

typedef ITContainer1D< Derived > STK::IArray1D< Derived >::Base

Definition at line 98 of file STK_IArray1D.h.

ColRange

template<class Derived >

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

Definition at line 116 of file STK_IArray1D.h.

ConstIterator

template<class Derived >

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

Definition at line 119 of file STK_IArray1D.h.

ConstReverseIterator

template<class Derived >

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

Definition at line 121 of file STK_IArray1D.h.

Iterator

template<class Derived >

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

Definition at line 118 of file STK_IArray1D.h.

ReverseIterator

template<class Derived >

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

Definition at line 120 of file STK_IArray1D.h.

RowRange

template<class Derived >

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

Definition at line 115 of file STK_IArray1D.h.

Type

template<class Derived >

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

Definition at line 112 of file STK_IArray1D.h.

TypeConst

template<class Derived >

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

Definition at line 113 of file STK_IArray1D.h.

Member Enumeration Documentation

anonymous enum

template<class Derived >

anonymous enum

Enumerator
structure_
orient_
sizeCols_
sizeRows_
size_
storage_
isFixedSize_

Definition at line 101 of file STK_IArray1D.h.

    {
      structure_ = hidden::Traits< Derived >::structure_,
      orient_    = hidden::Traits< Derived >::orient_,
      sizeCols_  = hidden::Traits< Derived >::sizeCols_,
      sizeRows_  = hidden::Traits< Derived >::sizeRows_,
      size_      = hidden::Traits< Derived >::size_,
      storage_   = hidden::Traits< Derived >::storage_,
      isFixedSize_ = (size_ != UnknownSize)
    };

Constructor & Destructor Documentation

IArray1D() [1/7]

template<class Derived >

STK::IArray1D< Derived >::IArray1D ( )

protected

Default constructor.

Definition at line 339 of file STK_IArray1D.h.

: Base(), allocator_(Arrays::evalRangeCapacity(range())) {}

IArray1D() [2/7]

template<class Derived >

STK::IArray1D< Derived >::IArray1D ( Range const &  I )

protected

constructor with a specified Range.

Parameters

I	range of the container

Definition at line 342 of file STK_IArray1D.h.

                           : Base(I), allocator_(Arrays::evalRangeCapacity(I)) {}

IArray1D() [3/7]

template<class Derived >

STK::IArray1D< Derived >::IArray1D ( Range const &  I, Type const &  v  )

protected

Misc constructor with first and last, initialization with a constant.

Parameters

I	range of the container
v	initial value of the container

Definition at line 346 of file STK_IArray1D.h.

                           : Base(I)
                           , allocator_(Arrays::evalRangeCapacity(I))
{ allocator_.assign(I,v);}

References STK::IArray1D< Derived >::allocator_.

IArray1D() [4/7]

template<class Derived >

STK::IArray1D< Derived >::IArray1D ( IArray1D< Derived > const &  T, bool  ref  )

protected

Copy constructor.

Parameters

T	the container to copy
ref	true if T is wrapped

Definition at line 356 of file STK_IArray1D.h.

                           : Base(T.range())
                           , allocator_(T.allocator(), ref)
{}

IArray1D() [5/7]

template<class Derived >

template<class OtherDerived >

STK::IArray1D< Derived >::IArray1D ( IArray1D< OtherDerived > const &  T, bool  ref  )

protected

Copy constructor.

Parameters

T	the container to copy
ref	true if T is wrapped

Definition at line 366 of file STK_IArray1D.h.

                           : Base(T.range())
                           , allocator_(T.allocator(), ref)
{}

IArray1D() [6/7]

template<class Derived >

template<class OtherDerived >

STK::IArray1D< Derived >::IArray1D ( IArray1D< OtherDerived > const &  T, RowRange const &  I, bool  ref  )

protected

copy constructor.

Parameters

T,I	the container and the range of data to wrap
ref	true if T is wrapped (the default)

Definition at line 377 of file STK_IArray1D.h.

                           : Base(I)
                           , allocator_(T.allocator(), I, ref)
{}

IArray1D() [7/7]

template<class Derived >

STK::IArray1D< Derived >::IArray1D ( Allocator const &  A, Range const &  I, bool  ref  )

protected

Wrapper constructor.

Parameters

A,I	range and allocator to wrap
ref	true if A is wrapped

Definition at line 387 of file STK_IArray1D.h.

                           : Base(I)
                           , allocator_(A, I, ref)
{}

~IArray1D()

template<class Derived >

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

protected

destructor: allocated memory is liberated by MemAllocator class.

Definition at line 393 of file STK_IArray1D.h.

{}

Member Function Documentation

allocate()

template<class Derived >

void STK::IArray1D< Derived >::allocate ( RowRange const &  I )

protected

function for memory allocation.

The range is not set in this method. If a bad_alloc occur, we set the range of the container to default before throwing it.

Parameters

I	range of the container

Definition at line 655 of file STK_IArray1D.h.

{
  try
  {
    allocator_.malloc(Arrays::evalRangeCapacity(I));
  }
  catch (Exception const& error)
  {
    setRange(); // if an error occur set default range
    throw error;
  }
}

References STK::IRunnerBase::error(), and STK::Arrays::evalRangeCapacity().

allocator() [1/2]

template<class Derived >

Allocator & STK::IArray1D< Derived >::allocator ( )

inlineprotected

Returns

a reference on the allocator

Definition at line 316 of file STK_IArray1D.h.

{ return allocator_;}

References STK::IArray1D< Derived >::allocator_.

allocator() [2/2]

template<class Derived >

Allocator const & STK::IArray1D< Derived >::allocator ( ) const

inline

Returns

a constant reference on the allocator

Definition at line 184 of file STK_IArray1D.h.

{ return allocator_;}

References STK::IArray1D< Derived >::allocator_.

assign()

template<class Derived >

Derived & STK::IArray1D< Derived >::assign

(

IArray1D< Derived > const &

src

)

overwrite this with src.

Note

If the size match, this is not resized, and in this case, the method take care of the possibility of overlapping.

Parameters

src	the container to assign

Definition at line 609 of file STK_IArray1D.h.

{
  // cannot assign same data
  if (&allocator_ == &(src.allocator())) { return this->asDerived();}
  // Resize if necessary.
  if ( size() != src.size() ) { this->resize(src.range());}
  allocator_.memcpy(begin(), src.allocator_, src.range());
  return this->asDerived();
}

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

Referenced by STK::MemSAllocator< Type_, NzMax_, Size_ >::begin(), and STK::IArray1D< Derived >::beginRows().

beginCols()

template<class Derived >

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

inline

Returns

the index of the first column

Definition at line 198 of file STK_IArray1D.h.

{ return baseIdx;}

References STK::baseIdx.

beginRows()

template<class Derived >

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

inline

Returns

the index of the first element

Definition at line 189 of file STK_IArray1D.h.

{ return begin();}

References STK::IArray1D< Derived >::begin().

capacity()

template<class Derived >

int STK::IArray1D< Derived >::capacity ( ) const

inline

Returns

the maximum possible number of elements without reallocation

Definition at line 210 of file STK_IArray1D.h.

{ return allocator_.size();}

References STK::IArray1D< Derived >::allocator_.

clear()

template<class Derived >

void STK::IArray1D< Derived >::clear

(

)

Clear the object.

Memory is liberated and the range of the Container is set to 0:-1 or 1:0 (

See also

baseIdx).

Definition at line 436 of file STK_IArray1D.h.

{
  if (isRef()) return;   // Nothing to do for ref
  freeMem();  // Free Mem
}

cols()

template<class Derived >

ColRange STK::IArray1D< Derived >::cols ( ) const

inline

Returns

the Horizontal range (1 column)

Definition at line 196 of file STK_IArray1D.h.

{ return ColRange(1);}

decLast()

template<class Derived >

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

inline

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);}

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);
    }

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);
    }

elt1Impl() [1/2]

template<class Derived >

Type & STK::IArray1D< Derived >::elt1Impl ( int  pos )

inline

access to an element

Parameters

pos	index of the element

Returns

a reference on the element to modify

Definition at line 216 of file STK_IArray1D.h.

{ return allocator_.elt(pos);}

References STK::IArray1D< Derived >::allocator_.

elt1Impl() [2/2]

template<class Derived >

TypeConst STK::IArray1D< Derived >::elt1Impl ( int  pos ) const

inline

access to a constant element

Parameters

pos	index of the const element

Returns

a constant reference on the element

Definition at line 221 of file STK_IArray1D.h.

{ return allocator_.elt(pos);}

References STK::IArray1D< Derived >::allocator_.

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

Referenced by STK::MemSAllocator< Type_, NzMax_, Size_ >::end(), STK::IArray1D< Array1D< Type_, Size_ > >::end(), and STK::IArray1D< Derived >::endRows().

endCols()

template<class Derived >

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

inline

Returns

the index of the ending column

Definition at line 200 of file STK_IArray1D.h.

{ return baseIdx+1;}

References STK::baseIdx.

endRows()

template<class Derived >

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

inline

Returns

the ending index of the elements

Definition at line 191 of file STK_IArray1D.h.

{ return end();}

References STK::IArray1D< Derived >::end().

erase()

template<class Derived >

Derived & STK::IArray1D< Derived >::erase	(	int	pos,
		int	n = 1
	)

Delete n elements at the pos index to the container.

Parameters

pos	index where to delete elements
n	number of elements to delete (default 1)

Definition at line 479 of file STK_IArray1D.h.

{
#ifdef STK_DEBUG_ARRAY2D
      stk_cout << _T("Entering IArray1D::erase\n");
      stk_cout << _T("Deleting pos=") << pos <<_T(", n=") << n <<_T("\n");
#endif
 
//  STK_STATIC_ASSERT_DENSE_ONLY(Derived)
  // checks
  if (n<=0) return this->asDerived();
  if (isRef())
  { STKRUNTIME_ERROR_2ARG(IArray1D::erase,pos, n,cannot operate on reference);}
#ifdef STK_BOUNDS_CHECK
  if (begin() > pos)
  { STKOUT_OF_RANGE_2ARG(IArray1D::erase,pos, n,begin() > pos);}
  if (end() <= pos)
  { STKOUT_OF_RANGE_2ARG(IArray1D::erase,pos, n,end() <= pos);}
  if (end() < pos+n)
  { STKOUT_OF_RANGE_2ARG(IArray1D::erase,pos, n,end() < pos+n);}
#endif
 
  // translate remaining elements and update dimensions
  allocator_.memmove(pos, _R(pos+n, end()-1));
 
  decLast(n);
  if (size() <= 0) this->freeMem(); // if empty release allocated memory
  return this->asDerived();
}

References _R, _T, STK::decLast(), STK::IArray1D< Derived >::erase(), stk_cout, STKOUT_OF_RANGE_2ARG, and STKRUNTIME_ERROR_2ARG.

Referenced by STK::IArray1D< Derived >::erase(), and STK::KernelHandler::removeKernel().

exchange()

template<class Derived >

void STK::IArray1D< Derived >::exchange

(

IArray1D< Derived > &

T

)

exchange this Container with T.

Parameters

T	the Array to exchange with this

Definition at line 602 of file STK_IArray1D.h.

{
  allocator_.exchange(T.allocator_);
  Base::exchange(T);
}

References STK::IArray1D< Derived >::allocator_.

freeMem()

template<class Derived >

void STK::IArray1D< Derived >::freeMem ( )

protected

Method for memory deallocation.

Memory is liberated and the range of the Container is set to begin:begin-1.

Definition at line 669 of file STK_IArray1D.h.

{
  if (isRef()) return;  // Nothing to do for ref
  allocator_.free();
  setRange(RowRange(begin(),0));          // set range to default (Base)
}

incLast()

template<class Derived >

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

inline

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);}

incRange()

template<class Derived >

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

inline

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);}

initialize()

template<class Derived >

void STK::IArray1D< Derived >::initialize ( RowRange const &  I )

protected

function for memory allocation and initialization.

This method will free all allocated memory owned by this container before initialization.

Parameters

I	range of the container

Definition at line 647 of file STK_IArray1D.h.

{
  allocate(I);
  allocator_.setRef(false);
  setRange(I);
}

insert() [1/2]

template<class Derived >

Derived & STK::IArray1D< Derived >::insert	(	int	pos,
		Type const &	v
	)

STL compatibility: Insert element v at position pos of the Array.

Parameters

pos	position to insert elements
v	value to insert

Definition at line 559 of file STK_IArray1D.h.

{
  insertElt(pos, 1);
  allocator_.setValue(pos,v);
  return this->asDerived();
}

insert() [2/2]

template<class Derived >

Derived & STK::IArray1D< Derived >::insert	(	Range const &	I,
		Type const &	v
	)

STL compatibility: Insert element v in the range I of the Array.

Parameters

I	range of the index where to insert elements
v	value to insert

Definition at line 567 of file STK_IArray1D.h.

{
  insertElt(I.begin(), I.size());
  for (int i=I.begin(); i<I.end(); i++) allocator_.setValue(i,v);
  return this->asDerived();
}

insertElt()

template<class Derived >

Derived & STK::IArray1D< Derived >::insertElt	(	int	pos,
		int	n = 1
	)

Insert n elements at the position pos of the container.

Parameters

pos,n

index where to insert the n elements (default is 1)

Definition at line 509 of file STK_IArray1D.h.

{
  // checks
  if (n <= 0 ) return this->asDerived();
  if (isRef()) { STKRUNTIME_ERROR_2ARG(IArray1D::insertElt,pos,n,cannot operate on references);}
#ifdef STK_BOUNDS_CHECK
  if (begin() > pos)
  { STKOUT_OF_RANGE_2ARG(IArray1D::insertElt,pos, n,begin() > pos);}
  if (end() < pos)
  { STKOUT_OF_RANGE_2ARG(IArray1D::insertElt,pos, n,end() < pos);}
#endif
 
  // allocate, if necessary, memory for the elements
  if ( (capacity() < size()+n) && !isFixedSize_ )
  {
    // temporary container
    IArray1D Taux;
    exchange(Taux);
    // compute range of the container after insertion
    RowRange range(Taux.range());
    range.incLast(n);
    // allocate
    try { allocate(range);}
    catch (Exception const& error)   // if an error occur
    {
      exchange(Taux); // restore this
      throw error;    // and send again the Exception
    }
    // set range
    setRange(Taux.range());
    // copy original elements
    allocator_.memcpy(Taux.begin(), Taux.allocator_, Range(Taux.begin(), pos - begin()) );
    allocator_.memcpy(pos+n, Taux.allocator_, Range(pos, end()-pos) );
  }
  else // enough space -> shift the last elements
  {
    if (!isFixedSize_)
    { allocator_.memmove(pos+n, Range(pos, end() - pos));}
    else
    { allocator_.memmove(pos+n, Range(pos, end() - pos - n));}
  }
  incLast(n);
  return this->asDerived();
}

References STK::IRunnerBase::error(), STK::incLast(), STK::IArray1D< Derived >::insertElt(), STKOUT_OF_RANGE_2ARG, and STKRUNTIME_ERROR_2ARG.

Referenced by STK::IArray1D< Derived >::insertElt().

isRef()

template<class Derived >

bool STK::IArray1D< Derived >::isRef ( ) const

inline

Returns

true if *this is reference container, false otherwise

Definition at line 175 of file STK_IArray1D.h.

{ return allocator_.isRef();}

References STK::IArray1D< Derived >::allocator_.

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

Referenced by STK::IArray1D< Derived >::lastIdxRows().

lastIdxCols()

template<class Derived >

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

inline

Returns

the index of the last element

Definition at line 207 of file STK_IArray1D.h.

{ return baseIdx;}

References STK::baseIdx.

lastIdxRows()

template<class Derived >

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

inline

Returns

the index of the last element

Definition at line 205 of file STK_IArray1D.h.

{ return this->lastIdx();}

References STK::IArray1D< Derived >::lastIdx().

memmove()

template<class Derived >

void STK::IArray1D< Derived >::memmove	(	int	pos1,
		int	pos2,
		int	n
	)

Copy n elements from pos2 to pos1, guaranteeing correct behavior for overlapping.

Parameters

pos1,pos2	positions of the elements to move
n	number of elements to move

Definition at line 624 of file STK_IArray1D.h.

{
#ifdef STK_BOUNDS_CHECK
  if (begin() > pos1) { STKOUT_OF_RANGE_2ARG(IArray1D::memmove,pos1,pos2,begin()>pos1);}
  if (end() <= pos1)  { STKOUT_OF_RANGE_2ARG(IArray1D::memmove,pos1,pos2,end()<=pos1);}
  if (begin() > pos2) { STKOUT_OF_RANGE_2ARG(IArray1D::memmove,pos1,pos2,begin()>pos2);}
  if (end() < pos2+n)  { STKOUT_OF_RANGE_2ARG(IArray1D::memmove,pos1,pos2,end()<pos2+n);}
#endif
  allocator_.memmove(pos1, Range(pos2, n));
}

References STK::IArray1D< Derived >::memmove(), and STKOUT_OF_RANGE_2ARG.

Referenced by STK::IArray1D< Derived >::memmove().

move()

template<class Derived >

void STK::IArray1D< Derived >::move

(

Derived const &

T

)

move T to this.

Note

: T is not modified but just set as a reference of the data it was owner.

Parameters

T	the container to move to this.

Definition at line 443 of file STK_IArray1D.h.

{
  if (this->asPtrDerived() == &T) return; // avoid move on itself
  if (!isRef()) { freeMem();}
  allocator_.move(T.allocator_);  // move Allocator part
  setRange(T.range());            // Set ITContainer1D part
}

popBack()

template<class Derived >

Derived & STK::IArray1D< Derived >::popBack

(

int

n = 1

)

Delete last elts of the container.

Parameters

n	number of elts to delete

Definition at line 467 of file STK_IArray1D.h.

{
  // checks
  if (n <= 0 || isFixedSize_) return this->asDerived();
  if (isRef())
  { STKRUNTIME_ERROR_1ARG(IArray1D::popBack,n,cannot operate on reference);}
  decLast(n);
  if (size() <= 0) this->freeMem(); // release mem if there's no more elts
  return this->asDerived();
}

References STK::decLast(), STK::IArray1D< Derived >::popBack(), and STKRUNTIME_ERROR_1ARG.

Referenced by STK::IArray1D< Derived >::popBack().

push_back()

template<class Derived >

Derived & STK::IArray1D< Derived >::push_back

(

Type const &

v

)

STL compatibility: append an element v.

Parameters

v	value to append

Definition at line 582 of file STK_IArray1D.h.

{
  pushBack();
  allocator_.setValue(this->lastIdx(),v);
  return this->asDerived();
}

Referenced by STK::KernelHandler::addKernel(), and STK::KernelHandler::addKernel().

push_front()

template<class Derived >

Derived & STK::IArray1D< Derived >::push_front

(

Type const &

v

)

STL compatibility: push front an element.

Parameters

v	value to append

Definition at line 575 of file STK_IArray1D.h.

{
  insert(Range(begin(), 1), v);
  return this->asDerived();
}

pushBack()

template<class Derived >

Derived & STK::IArray1D< Derived >::pushBack

(

int

n = 1

)

Add n Elements to the end of the container.

Parameters

n	number of elements to add

Definition at line 452 of file STK_IArray1D.h.

{
#ifdef STK_ARRAYS_VERY_VERBOSE
    stk_cout << _T("Entering IArray1D<Derived>::pushBack(") << n << _T(")\n");
#endif
  // checks
  if (n <= 0) return this->asDerived();
  if (isRef()) { STKRUNTIME_ERROR_1ARG(IArray1D::pushBack,n,cannot operate on references);}
  // If container is empty : create it, otherwise add element from end() position
  if (this->empty()) { initialize(RowRange(begin(), n));}
  else               { insertElt(end(), n);}
  return this->asDerived();
}

References _T, STK::IArray1D< Derived >::pushBack(), stk_cout, and STKRUNTIME_ERROR_1ARG.

Referenced by STK::IArray1D< Derived >::pushBack().

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_;}

Referenced by STK::MultiLaw::JointProbability< RowVector, Law >::lpdf(), STK::MultiLaw::JointProbability< RowVector, Law >::rand(), and STK::IArray1D< Derived >::rows().

reserve()

template<class Derived >

void STK::IArray1D< Derived >::reserve

(

int

size

)

reserve internal memory for at least size elements.

Parameters

size	number of elements to reserve

Definition at line 426 of file STK_IArray1D.h.

{
  // nothing to do
  if (size < this->capacity() || isFixedSize_) return;
  // is this structure a ptr ?
  if (isRef()) { STKRUNTIME_ERROR_1ARG(IArray1D::reserve,size,cannot operate on references);}
  allocator_.realloc(Range(begin(), size));
}

References STK::IArray1D< Derived >::reserve(), and STKRUNTIME_ERROR_1ARG.

Referenced by STK::IArray1D< Derived >::reserve().

resizeImpl()

template<class Derived >

Derived & STK::IArray1D< Derived >::resizeImpl

(

Range const &

I

)

Resize the container.

• call shift
• call pushBack if there will be more elements
• call popBack if three will be less elements

  Parameters

  I	the range to set to the Array1D

Definition at line 410 of file STK_IArray1D.h.

{
  // check if there is something to do
  if ( range() == I) return this->asDerived();
  if (isRef()) { STKRUNTIME_ERROR_1ARG(IArray1D::resizeImpl,I,cannot operate on references);}
  // translate
  shiftImpl(I.begin());
  // compute number of elements to delete or add
  const int inc = I.end() - end();
  // adjust size of the container
  if (inc > 0) pushBack(inc);  // more elements
  else         popBack(-inc);  // less elements
  return this->asDerived();
}

References STK::IArray1D< Derived >::resizeImpl(), and STKRUNTIME_ERROR_1ARG.

Referenced by STK::IArray1D< Derived >::resizeImpl().

rows()

template<class Derived >

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

inline

Returns

the range of the rows of the container

Definition at line 187 of file STK_IArray1D.h.

{ return range();}

References STK::IArray1D< Derived >::range().

setRange()

template<class Derived >

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

inline

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;}

setRef()

template<class Derived >

void STK::IArray1D< Derived >::setRef ( bool  ref ) const

inline

Modify the state of the container: this become a reference (if ref is true) or the owner of the data (if ref is false).

Note

To use with care in order to avoid memory leak

Parameters

ref	: has top be false if this own its own data

Definition at line 181 of file STK_IArray1D.h.

{ allocator_.setRef(ref);}

References STK::IArray1D< Derived >::allocator_.

setValue() [1/2]

template<class Derived >

void STK::IArray1D< Derived >::setValue ( int  pos, TypeConst  value  )

inline

Write a value at a given position.

Parameters

pos,value

index of the element

Returns

a reference on the element to modify

Definition at line 231 of file STK_IArray1D.h.

    { allocator_.setValue(pos, value);}

References STK::IArray1D< Derived >::allocator_.

setValue() [2/2]

template<class Derived >

Derived & STK::IArray1D< Derived >::setValue

(

Type const &

value

)

set a value to this container.

Parameters

value

the value to set

Definition at line 640 of file STK_IArray1D.h.

{
  allocator_.assign(range(), value);
  return this->asDerived();
}

shiftImpl()

template<class Derived >

void STK::IArray1D< Derived >::shiftImpl

(

int

beg = baseIdx

)

New beginning index for the object.

Parameters

beg	the index of the first column to set

Definition at line 397 of file STK_IArray1D.h.

{
  // compute increment
  int inc = beg - begin();
  if (inc == 0) return;
  if (isRef())  // is this structure just a pointer ?
  { STKRUNTIME_ERROR_1ARG(IArray1D::shiftImpl,beg,cannot operate on references);}
  // translate range and data
  incRange(inc);
  allocator_.shift(beg);
}

References STK::IArray1D< Derived >::shiftImpl(), and STKRUNTIME_ERROR_1ARG.

Referenced by STK::IArray1D< Derived >::shiftImpl().

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

Referenced by STK::MemSAllocator< Type_, NzMax_, Size_ >::size(), and STK::IArray1D< Derived >::sizeRows().

sizeCols()

template<class Derived >

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

inline

Returns

the number of columns

Definition at line 202 of file STK_IArray1D.h.

{ return 1;};

sizeRows()

template<class Derived >

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

inline

Returns

the size of the container

Definition at line 193 of file STK_IArray1D.h.

{ return size();}

References STK::IArray1D< Derived >::size().

swap()

template<class Derived >

void STK::IArray1D< Derived >::swap	(	int	pos1,
		int	pos2
	)

Swapping the pos1 elt and the pos2 elt.

Parameters

pos1,pos2

positions of the elements to swap

Definition at line 590 of file STK_IArray1D.h.

{
#ifdef STK_BOUNDS_CHECK
  if (begin() > pos1) { STKOUT_OF_RANGE_2ARG(IArray1D::swap,pos1,pos2,begin()>pos1);}
  if (end() <= pos1)  { STKOUT_OF_RANGE_2ARG(IArray1D::swap,pos1,pos2,end()<=pos1);}
  if (begin() > pos2) { STKOUT_OF_RANGE_2ARG(IArray1D::swap,pos1,pos2,begin()>pos2);}
  if (end() <= pos2)  { STKOUT_OF_RANGE_2ARG(IArray1D::swap,pos1,pos2,end()<=pos2);}
#endif
  std::swap(elt(pos1), elt(pos2));
}

References STKOUT_OF_RANGE_2ARG, and STK::IArray1D< Derived >::swap().

Referenced by STK::IArray1D< Derived >::swap().

Member Data Documentation

allocator_

template<class Derived >

Allocator STK::IArray1D< Derived >::allocator_

private

Definition at line 335 of file STK_IArray1D.h.

Referenced by STK::IArray1D< Derived >::allocator(), STK::IArray1D< Derived >::allocator(), STK::IArray1D< Derived >::capacity(), STK::IArray1D< Derived >::elt1Impl(), STK::IArray1D< Derived >::elt1Impl(), STK::IArray1D< Derived >::exchange(), STK::IArray1D< Derived >::IArray1D(), STK::IArray1D< Derived >::isRef(), STK::IArray1D< Derived >::setRef(), and STK::IArray1D< Derived >::setValue().

---

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

• STK_IArray1D.h