STK::MemSAllocator1D< Type_, NzMax_ > Class Template Reference

memory allocator for sparse vectors classes. More...

#include <STK_MemSAllocator1D.h>

Inheritance diagram for STK::MemSAllocator1D< Type_, NzMax_ >:

Public Types
enum	{ nzmax_ = (NzMax_< (UnknownSize-2)) ? NzMax_+2 : UnknownSize }
typedef Type_	Type
typedef hidden::RemoveConst< Type_ >::Type const &	TypeConst
typedef Array1D< int, nzmax_ >	Indexes
	Type of the array storing indexes.
typedef Array1D< Type, nzmax_ >	Values
	Type of the array storing data.
typedef TRange< UnknownSize >	AllocatorRange
	Type of the range of the data.

Public Member Functions
	MemSAllocator1D ()
	default constructor
	MemSAllocator1D (AllocatorRange const &I)
	constructor with specified dimension
	MemSAllocator1D (AllocatorRange const &I, int nzmax)
	constructor with specified dimensions
	MemSAllocator1D (MemSAllocator1D const &A, bool ref=false)
	copy constructor
template<int OtherNzMax_>
	MemSAllocator1D (MemSAllocator1D< Type, OtherNzMax_ > const &A)
	Copy constructor.
template<int OtherNzMax_>
	MemSAllocator1D (MemSAllocator1D< Type, OtherNzMax_ > const &A, AllocatorRange const &I, bool ref=true)
	Copy constructor.
	~MemSAllocator1D ()
	destructor.
AllocatorRange const &	range () const
int	begin () const
int	end () const
int	size () const
int	beginIdx () const
int	endIdx () const
int	sizeIdx () const
Indexes const &	idx () const
Values const &	val () const
TypeConst	elt (int pos) const
	This method allows to get the jth value.
void	setValue (int pos, Type const &value)
	This method allows to overwrite or insert an element to the given position.
void	setZero (int pos)
	This method allows to write zero to the given position.
template<int OtherSize>
MemSAllocator1D &	malloc (TRange< OtherSize > const &I)
	main method for memory allocation.
template<int OtherSize>
MemSAllocator1D &	realloc (TRange< OtherSize > const &I)
	function for main ptr memory reallocation.
void	free ()
	function releasing all stored values.
template<int OtherSize_, int RangeSize_>
MemSAllocator1D &	memcpy (int pos, MemSAllocator1D< Type, OtherSize_ > const &T, TRange< RangeSize_ > const &range)
	function copying a part of allocator T in this.
void	memmove (int pos, Range const &range)
	function moving a part of the allocator.
MemSAllocator1D &	exchange (MemSAllocator1D &T)
	exchange this with T.
MemSAllocator1D &	assign (MemSAllocator1D const &T)
	copy the Allocator T by value.
template<int OtherSize_>
MemSAllocator1D &	assign (TRange< OtherSize_ > const &I, Type const &value)
	assign a value to allocator.
MemSAllocator1D &	move (MemSAllocator1D const &T)
	move the Allocator T to this.
MemSAllocator1D &	shift (int first)
	shift the first index of the data to first.
template<int OtherSize>
MemSAllocator1D< Type_, NzMax_ > &	malloc (TRange< OtherSize > const &I)
template<int OtherSize>
MemSAllocator1D< Type_, NzMax_ > &	realloc (TRange< OtherSize > const &I)
template<int OtherSize_, int RangeSize_>
MemSAllocator1D< Type_, NzMax_ > &	memcpy (int pos, MemSAllocator1D< Type, OtherSize_ > const &T, TRange< RangeSize_ > const &range)
template<int OtherSize_>
MemSAllocator1D< Type, NzMax_ > &	assign (TRange< OtherSize_ > const &I, Type const &value)
bool	isRef () const
void	setRef (bool ref) const
	Modify the container : can become a reference or the owner of the data.
Public Member Functions inherited from STK::TRef<-1 >
bool	isRef () const
bool	ref () const
void	exchange (TRef const &T)
	swap this with the container T.
void	setRef (bool ref) const
	Modify the container : can become a reference or the owner of the data.

Protected Attributes
Indexes *	p_idx_
	array of indexes
Values *	p_val_
	array of values

Private Member Functions
void	writeValue (int pos, Type_ const &value)
	Write a value at the given position.
void	setValue1 (int pos, TypeConst value)
	Write a value at position idx1_.
void	findIdx1 (int pos) const
	find first position in p_idx_ less or equal to pos
void	findIdx1Next (int pos) const
	find first position in p_idx_ less or equal to pos
void	findIdx1Prev (int pos) const
	find idx1_ previous position in p_idx_ greater than pos
void	findIdx2 (int pos) const
	find first position in p_idx_ less or equal to pos
void	findIdx2Next (int pos) const
	find idx2_ next position in p_idx_ less or equal to pos
void	findIdx2Prev (int pos) const
	find idx2_ previous position in p_idx_ greater than pos
void	setZero1 (int pos)
	Set zero at position idx1_.
void	setValue1 (int pos)
	Set value idx2_ at position idx1_ when idx1 < idx2.
void	setValue2 (int pos)
	Set value idx2_ at position idx1_ when idx1 > idx2.

Private Attributes
AllocatorRange	range_
	Range of the data.
const Type	zero_
	zero value
int	idx1_
	Current indexes used for internal lookup.
int	idx2_

Additional Inherited Members
Protected Member Functions inherited from STK::TRef<-1 >
	TRef (bool ref)
	Default constructor We have to specify the member ref_.
	~TRef ()
	destructor.

Detailed Description

template<typename Type_, int NzMax_>
class STK::MemSAllocator1D< Type_, NzMax_ >

memory allocator for sparse vectors classes.

Template Parameters

Type_	type of elements stored in this allocator
NzMax_	maximal number of element in sparse vector

Definition at line 53 of file STK_MemSAllocator1D.h.

Member Typedef Documentation

AllocatorRange

template<typename Type_ , int NzMax_>

typedef TRange<UnknownSize> STK::MemSAllocator1D< Type_, NzMax_ >::AllocatorRange

Type of the range of the data.

Definition at line 68 of file STK_MemSAllocator1D.h.

Indexes

template<typename Type_ , int NzMax_>

typedef Array1D<int, nzmax_> STK::MemSAllocator1D< Type_, NzMax_ >::Indexes

Type of the array storing indexes.

Definition at line 64 of file STK_MemSAllocator1D.h.

Type

template<typename Type_ , int NzMax_>

typedef Type_ STK::MemSAllocator1D< Type_, NzMax_ >::Type

Definition at line 60 of file STK_MemSAllocator1D.h.

TypeConst

template<typename Type_ , int NzMax_>

typedef hidden::RemoveConst<Type_>::Type const& STK::MemSAllocator1D< Type_, NzMax_ >::TypeConst

Definition at line 61 of file STK_MemSAllocator1D.h.

Values

template<typename Type_ , int NzMax_>

typedef Array1D<Type, nzmax_> STK::MemSAllocator1D< Type_, NzMax_ >::Values

Type of the array storing data.

Definition at line 66 of file STK_MemSAllocator1D.h.

Member Enumeration Documentation

anonymous enum

template<typename Type_ , int NzMax_>

anonymous enum

Enumerator
nzmax_

Definition at line 56 of file STK_MemSAllocator1D.h.

    {
      nzmax_ = (NzMax_< (UnknownSize-2)) ? NzMax_+2 : UnknownSize
    };

Constructor & Destructor Documentation

MemSAllocator1D() [1/6]

template<typename Type_ , int NzMax_>

STK::MemSAllocator1D< Type_, NzMax_ >::MemSAllocator1D

(

)

default constructor

Definition at line 285 of file STK_MemSAllocator1D.h.

                                                : IContainerRef(false)
                                                  , p_idx_(new Indexes(2))
                                                  , p_val_(new Values(2))
                                                  , range_()
                                                  , zero_(0)
{
  p_idx_->setValue(Arithmetic<int>::max());
  p_idx_->front() = -Arithmetic<int>::max();
  p_val_->setValue(Arithmetic<Type>::NA());
}

References STK::MemSAllocator1D< Type_, NzMax_ >::p_idx_, and STK::MemSAllocator1D< Type_, NzMax_ >::p_val_.

MemSAllocator1D() [2/6]

template<typename Type_ , int NzMax_>

STK::MemSAllocator1D< Type_, NzMax_ >::MemSAllocator1D

(

AllocatorRange const &

I

)

constructor with specified dimension

Parameters

I	range of the rows

Definition at line 300 of file STK_MemSAllocator1D.h.

                                               : IContainerRef(false)
                                               , p_idx_(new Indexes(2))
                                               , p_val_(new Values(2))
                                               , range_(I)
                                               , zero_(0)
{
  p_idx_->setValue(Arithmetic<int>::max());
  p_idx_->front() = -Arithmetic<int>::max();
  p_val_->setValue(Arithmetic<Type>::NA());
}

References STK::MemSAllocator1D< Type_, NzMax_ >::p_idx_, and STK::MemSAllocator1D< Type_, NzMax_ >::p_val_.

MemSAllocator1D() [3/6]

template<typename Type_ , int NzMax_>

STK::MemSAllocator1D< Type_, NzMax_ >::MemSAllocator1D	(	AllocatorRange const &	I,
		int	nzmax
	)

constructor with specified dimensions

Parameters

I	range of the rows
nzmax	maximal number of data

Definition at line 317 of file STK_MemSAllocator1D.h.

                                               : IContainerRef(false)
                                               , p_idx_( new Indexes(2) )
                                               , p_val_( new Values(2) )
                                               , range_(I)
                                               , zero_(0)
{
  p_idx_->reserve(nzmax);
  p_val_->reserve(nzmax);
  p_idx_->setValue(Arithmetic<int>::max());
  p_idx_->front() = -Arithmetic<int>::max();
  p_val_->setValue(Arithmetic<Type>::NA());
}

References STK::MemSAllocator1D< Type_, NzMax_ >::p_idx_, and STK::MemSAllocator1D< Type_, NzMax_ >::p_val_.

MemSAllocator1D() [4/6]

template<typename Type_ , int NzMax_>

STK::MemSAllocator1D< Type_, NzMax_ >::MemSAllocator1D	(	MemSAllocator1D< Type_, NzMax_ > const &	A,
		bool	ref = false
	)

copy constructor

Parameters

A	allocator to copy
ref	true if this copy is just a reference, false otherwise

Definition at line 336 of file STK_MemSAllocator1D.h.

                                               : IContainerRef(ref)
                                               , p_idx_(ref ? A.p_idx_ : new Indexes(A.idx()))
                                               , p_val_(ref ? A.p_val_ : new Values(A.val()))
                                               , range_(A.range_)
                                               , zero_(A.zero_)
{}

MemSAllocator1D() [5/6]

template<typename Type_ , int NzMax_>

template<int OtherNzMax_>

STK::MemSAllocator1D< Type_, NzMax_ >::MemSAllocator1D

(

MemSAllocator1D< Type, OtherNzMax_ > const &

A

)

Copy constructor.

Parameters

A	allocator to copy

Definition at line 348 of file STK_MemSAllocator1D.h.

                                               : IContainerRef(false)
                                               , p_idx_(new Indexes(A.idx()))
                                               , p_val_(new Values(A.val()))
                                               , range_(A.range_)
                                               , zero_(A.zero_)
{}

MemSAllocator1D() [6/6]

template<typename Type_ , int NzMax_>

template<int OtherNzMax_>

STK::MemSAllocator1D< Type_, NzMax_ >::MemSAllocator1D	(	MemSAllocator1D< Type, OtherNzMax_ > const &	A,
		AllocatorRange const &	I,
		bool	ref = true
	)

Copy constructor.

Map a range of A.

Parameters

A,I	the allocator and range to reference
ref	is this a wrapper of A ? (true by default)

Definition at line 361 of file STK_MemSAllocator1D.h.

                                               : IContainerRef(ref)
                                               , p_idx_(ref ? A.p_idx_ : new Indexes(A.idx()))
                                               , p_val_(ref ? A.p_val_ : new Values(A.val()))
                                               , range_(I)
                                               , zero_(A.zero_)
{}

~MemSAllocator1D()

template<typename Type_ , int NzMax_>

STK::MemSAllocator1D< Type_, NzMax_ >::~MemSAllocator1D

(

)

destructor.

Release memory.

Definition at line 374 of file STK_MemSAllocator1D.h.

{
  if (!isRef())
  {
    delete p_idx_;
    delete p_val_;
  }
}

Member Function Documentation

assign() [1/3]

template<typename Type_ , int NzMax_>

MemSAllocator1D< Type_, NzMax_ > & STK::MemSAllocator1D< Type_, NzMax_ >::assign

(

MemSAllocator1D< Type_, NzMax_ > const &

T

)

copy the Allocator T by value.

The memory is free and the Allocator T is physically copied in this.

Parameters

T	the allocator to copy by value

Returns

a copy of T

Definition at line 576 of file STK_MemSAllocator1D.h.

{
  *p_idx_ = T.idx();
  *p_val_ = T.val();
  range_  = T.range();
  return *this;
}

References STK::MemSAllocator1D< Type_, NzMax_ >::idx(), STK::MemSAllocator1D< Type_, NzMax_ >::range(), and STK::MemSAllocator1D< Type_, NzMax_ >::val().

assign() [2/3]

template<typename Type_ , int NzMax_>

template<int OtherSize_>

MemSAllocator1D & STK::MemSAllocator1D< Type_, NzMax_ >::assign	(	TRange< OtherSize_ > const &	I,
		Type const &	value
	)

assign a value to allocator.

Parameters

I,value

range and value to assign to the allocator

Returns

this

Note

allocator is no more sparse !

assign() [3/3]

template<typename Type_ , int NzMax_>

template<int OtherSize_>

MemSAllocator1D< Type, NzMax_ > & STK::MemSAllocator1D< Type_, NzMax_ >::assign	(	TRange< OtherSize_ > const &	I,
		Type const &	value
	)

Definition at line 587 of file STK_MemSAllocator1D.h.

{
  // reserve first if not zero_ using upper-bound current size + range size
  findIdx1(I.begin());
  if (value!=zero_)
  {
    p_idx_->reserve(I.size()+p_idx_->size());
    p_val_->reserve(I.size()+p_val_->size());
    for (int pos= I.begin(); pos < I.end(); ++pos)
    {
      findIdx1Next(pos);
      setValue1(pos, value);
    }
  }
  else
  {
    for (int pos= I.begin(); pos < I.end(); ++pos)
    {
      findIdx1Next(pos);
      setZero1(pos);
    }
  }
  return *this;
}

References STK::zero_.

begin()

template<typename Type_ , int NzMax_>

int STK::MemSAllocator1D< Type_, NzMax_ >::begin ( ) const

inline

Returns

the first index of the data.

Definition at line 108 of file STK_MemSAllocator1D.h.

{ return range_.begin();}

References STK::RangeBase< Derived >::begin(), and STK::MemSAllocator1D< Type_, NzMax_ >::range_.

Referenced by STK::MemSAllocator1D< Type_, NzMax_ >::elt(), STK::MemSAllocator1D< Type_, NzMax_ >::setValue(), and STK::MemSAllocator1D< Type_, NzMax_ >::setZero().

beginIdx()

template<typename Type_ , int NzMax_>

int STK::MemSAllocator1D< Type_, NzMax_ >::beginIdx ( ) const

inline

Returns

the first index of the index array

Definition at line 115 of file STK_MemSAllocator1D.h.

{ return p_idx_->begin();}

References STK::MemSAllocator1D< Type_, NzMax_ >::p_idx_.

Referenced by STK::MemSAllocator1D< Type_, NzMax_ >::findIdx1(), and STK::MemSAllocator1D< Type_, NzMax_ >::findIdx2().

elt()

template<typename Type_ , int NzMax_>

MemSAllocator1D< Type_, NzMax_ >::TypeConst STK::MemSAllocator1D< Type_, NzMax_ >::elt

(

int

pos

)

const

This method allows to get the jth value.

Parameters

pos	position of the element

Returns

0 if the element is not stored, the value of the element otherwise

Definition at line 390 of file STK_MemSAllocator1D.h.

{
#ifdef STK_BOUNDS_CHECK
  if (pos < begin())
  { STKOUT_OF_RANGE_1ARG(MemSAllocator1D::elt,pos,MemSAllocator1D::begin() > pos);}
  if (pos >= end())
  { STKOUT_OF_RANGE_1ARG(MemSAllocator1D::elt,pos,MemSAllocator1D::end() <= pos);}
#endif
  findIdx1(pos);
  return (p_idx_->elt(idx1_) == pos) ? p_val_->elt(idx1_) : zero_;
}

References STK::MemSAllocator1D< Type_, NzMax_ >::begin(), STK::MemSAllocator1D< Type_, NzMax_ >::elt(), STK::MemSAllocator1D< Type_, NzMax_ >::end(), STKOUT_OF_RANGE_1ARG, and STK::zero_.

Referenced by STK::MemSAllocator1D< Type_, NzMax_ >::elt().

end()

template<typename Type_ , int NzMax_>

int STK::MemSAllocator1D< Type_, NzMax_ >::end ( ) const

inline

Returns

the ending index of the data

Definition at line 110 of file STK_MemSAllocator1D.h.

{ return range_.end();}

References STK::TRange< UnknownSize >::end(), and STK::MemSAllocator1D< Type_, NzMax_ >::range_.

Referenced by STK::MemSAllocator1D< Type_, NzMax_ >::elt(), STK::MemSAllocator1D< Type_, NzMax_ >::setValue(), and STK::MemSAllocator1D< Type_, NzMax_ >::setZero().

endIdx()

template<typename Type_ , int NzMax_>

int STK::MemSAllocator1D< Type_, NzMax_ >::endIdx ( ) const

inline

Returns

the ending index of the index array

Definition at line 117 of file STK_MemSAllocator1D.h.

{ return p_idx_->end();}

References STK::MemSAllocator1D< Type_, NzMax_ >::p_idx_.

exchange()

template<typename Type_ , int NzMax_>

MemSAllocator1D< Type_, NzMax_ > & STK::MemSAllocator1D< Type_, NzMax_ >::exchange

(

MemSAllocator1D< Type_, NzMax_ > &

T

)

exchange this with T.

Parameters

T	the container to exchange with T

Definition at line 560 of file STK_MemSAllocator1D.h.

{
  std::swap(p_idx_, T.p_idx_);
  std::swap(p_val_, T.p_val_);
  std::swap(range_, T.range_);
  IContainerRef::exchange(T);
  return *this;
}

References STK::TRef<-1 >::exchange(), STK::MemSAllocator1D< Type_, NzMax_ >::p_idx_, STK::MemSAllocator1D< Type_, NzMax_ >::p_val_, and STK::MemSAllocator1D< Type_, NzMax_ >::range_.

findIdx1()

template<typename Type_ , int NzMax_>

void STK::MemSAllocator1D< Type_, NzMax_ >::findIdx1 ( int  pos ) const

inlineprivate

find first position in p_idx_ less or equal to pos

Parameters

pos	position to find

Definition at line 236 of file STK_MemSAllocator1D.h.

    { for ( idx1_ = beginIdx(); p_idx_->elt(idx1_+1) <= pos; ++idx1_) {} }

References STK::MemSAllocator1D< Type_, NzMax_ >::beginIdx(), STK::MemSAllocator1D< Type_, NzMax_ >::idx1_, and STK::MemSAllocator1D< Type_, NzMax_ >::p_idx_.

findIdx1Next()

template<typename Type_ , int NzMax_>

void STK::MemSAllocator1D< Type_, NzMax_ >::findIdx1Next ( int  pos ) const

inlineprivate

find first position in p_idx_ less or equal to pos

Parameters

pos	position to find

Definition at line 241 of file STK_MemSAllocator1D.h.

    { if (p_idx_->elt(idx1_) == Arithmetic<int>::max()) return;
      for ( ; p_idx_->elt(idx1_+1) <= pos; ++idx1_) {}
    }

References STK::MemSAllocator1D< Type_, NzMax_ >::idx1_, and STK::MemSAllocator1D< Type_, NzMax_ >::p_idx_.

findIdx1Prev()

template<typename Type_ , int NzMax_>

void STK::MemSAllocator1D< Type_, NzMax_ >::findIdx1Prev ( int  pos ) const

inlineprivate

find idx1_ previous position in p_idx_ greater than pos

Parameters

pos	position to find

Definition at line 248 of file STK_MemSAllocator1D.h.

    { for ( ; p_idx_->elt(idx1_) >= pos; --idx1_) {}}

References STK::MemSAllocator1D< Type_, NzMax_ >::idx1_, and STK::MemSAllocator1D< Type_, NzMax_ >::p_idx_.

findIdx2()

template<typename Type_ , int NzMax_>

void STK::MemSAllocator1D< Type_, NzMax_ >::findIdx2 ( int  pos ) const

inlineprivate

find first position in p_idx_ less or equal to pos

Parameters

pos	position to find

Definition at line 254 of file STK_MemSAllocator1D.h.

    { for ( idx2_ = beginIdx(); p_idx_->elt(idx2_+1) <= pos; ++idx2_) {} }

References STK::MemSAllocator1D< Type_, NzMax_ >::beginIdx(), STK::MemSAllocator1D< Type_, NzMax_ >::idx2_, and STK::MemSAllocator1D< Type_, NzMax_ >::p_idx_.

findIdx2Next()

template<typename Type_ , int NzMax_>

void STK::MemSAllocator1D< Type_, NzMax_ >::findIdx2Next ( int  pos ) const

inlineprivate

find idx2_ next position in p_idx_ less or equal to pos

Parameters

pos	position to find

Definition at line 259 of file STK_MemSAllocator1D.h.

    { if (p_idx_->elt(idx2_) == Arithmetic<int>::max()) return;
      for ( ; p_idx_->elt(idx2_+1) <= pos; ++idx2_) {}
    }

References STK::MemSAllocator1D< Type_, NzMax_ >::idx2_, and STK::MemSAllocator1D< Type_, NzMax_ >::p_idx_.

findIdx2Prev()

template<typename Type_ , int NzMax_>

void STK::MemSAllocator1D< Type_, NzMax_ >::findIdx2Prev ( int  pos ) const

inlineprivate

find idx2_ previous position in p_idx_ greater than pos

Parameters

pos	position to find

Definition at line 266 of file STK_MemSAllocator1D.h.

    { for ( ; p_idx_->elt(idx2_) >= pos; --idx2_) {}}

References STK::MemSAllocator1D< Type_, NzMax_ >::idx2_, and STK::MemSAllocator1D< Type_, NzMax_ >::p_idx_.

free()

template<typename Type_ , int NzMax_>

void STK::MemSAllocator1D< Type_, NzMax_ >::free

(

)

function releasing all stored values.

Definition at line 480 of file STK_MemSAllocator1D.h.

{
  p_idx_->clear();
  p_val_->clear();
  range_ = AllocatorRange();
  return;
}

idx()

template<typename Type_ , int NzMax_>

Indexes const & STK::MemSAllocator1D< Type_, NzMax_ >::idx ( ) const

inline

Returns

the vector with the indexes

Definition at line 122 of file STK_MemSAllocator1D.h.

{ return *p_idx_;}

References STK::MemSAllocator1D< Type_, NzMax_ >::p_idx_.

Referenced by STK::MemSAllocator1D< Type_, NzMax_ >::assign().

isRef()

template<typename Type_ , int NzMax_>

bool STK::TRef<-1 >::isRef ( ) const

inline

Returns

true if *this is reference container, false otherwise

Definition at line 81 of file STK_IContainerRef.h.

{ return ref_;}

malloc() [1/2]

template<typename Type_ , int NzMax_>

template<int OtherSize>

MemSAllocator1D & STK::MemSAllocator1D< Type_, NzMax_ >::malloc

(

TRange< OtherSize > const &

I

)

main method for memory allocation.

Note

do nothing for sparse arrays.

Parameters

I	range of the data allocated

Referenced by STK::MemSAllocator1D< Type_, NzMax_ >::malloc().

malloc() [2/2]

template<typename Type_ , int NzMax_>

template<int OtherSize>

MemSAllocator1D< Type_, NzMax_ > & STK::MemSAllocator1D< Type_, NzMax_ >::malloc

(

TRange< OtherSize > const &

I

)

Definition at line 443 of file STK_MemSAllocator1D.h.

{
  // there is no necessity to allocate if range_ is the same
  if (range_ == I) return *this;
  if (isRef()) { STKRUNTIME_ERROR_1ARG(MemSAllocator1D::malloc,I,cannot operate on references);}
  p_idx_->resize( Range(I.begin(),2) );
  p_val_->resize( Range(I.begin(),2) );
  p_idx_->setValue(Arithmetic<int>::max());
  p_idx_->front() = -Arithmetic<int>::max();
  p_val_->setValue(Arithmetic<Type>::NA());
  range_ = I;
  return *this;
}

References STK::MemSAllocator1D< Type_, NzMax_ >::malloc(), and STKRUNTIME_ERROR_1ARG.

memcpy() [1/2]

template<typename Type_ , int NzMax_>

template<int OtherSize_, int RangeSize_>

MemSAllocator1D & STK::MemSAllocator1D< Type_, NzMax_ >::memcpy	(	int	pos,
		MemSAllocator1D< Type, OtherSize_ > const &	T,
		TRange< RangeSize_ > const &	range
	)

function copying a part of allocator T in this.

Parameters

pos	position where will be copied data
T,range	the array of data and the range of the data to copy

Note

only which are not zero are copied

Referenced by STK::MemSAllocator1D< Type_, NzMax_ >::memcpy().

memcpy() [2/2]

template<typename Type_ , int NzMax_>

template<int OtherSize_, int RangeSize_>

MemSAllocator1D< Type_, NzMax_ > & STK::MemSAllocator1D< Type_, NzMax_ >::memcpy	(	int	pos,
		MemSAllocator1D< Type, OtherSize_ > const &	T,
		TRange< RangeSize_ > const &	range
	)

Definition at line 495 of file STK_MemSAllocator1D.h.

{
  if (range.size() <= 0) return *this;
#ifdef STK_BOUNDS_CHECK
  if (pos < begin()) { STKOUT_OF_RANGE_1ARG(MemSAllocator1D::memcpy,pos,begin() > pos);}
  if (pos >= end())  { STKOUT_OF_RANGE_1ARG(MemSAllocator1D::memcpy,pos,end() <= pos);}
  if (!T.range().isContaining(range))
  { STKOUT_OF_RANGE_1ARG(MemSAllocator::memcopy,range,range not in T.range());}
#endif
  for (int k=range.begin(); k<range.end(); ++k, ++pos)
  { setValue(pos, T.elt(k));}
  return *this;
}

References STK::MemSAllocator1D< Type_, NzMax_ >::memcpy(), and STKOUT_OF_RANGE_1ARG.

memmove()

template<typename Type_ , int NzMax_>

void STK::MemSAllocator1D< Type_, NzMax_ >::memmove	(	int	pos,
		Range const &	range
	)

function moving a part of the allocator.

Parameters

pos,range

position and range in form [begin,end) to move

Definition at line 513 of file STK_MemSAllocator1D.h.

{
  if ((range.size() <= 0)||(range.begin() == pos)) return;
#ifdef STK_BOUNDS_CHECK
  if (pos < begin())
  { STKOUT_OF_RANGE_1ARG(MemSAllocator1D::memmove,pos,begin() > pos);}
  if (pos >= end())
  { STKOUT_OF_RANGE_1ARG(MemSAllocator1D::memmove,pos,end() <= pos);}
  if (!range_.isContaining(range))
  { STKOUT_OF_RANGE_1ARG(MemSAllocator1D::memmove,range,range not in range_);}
#endif
  if (pos < range.begin()) // ==> idx1 < idx2
  {
    // initialize idx1_ and idx2_
    findIdx1(pos);
    findIdx2(range.begin());
    // start loop over range
    for (int k= range.begin(); k<range.end(); ++k, ++pos)
    {
      // update idx1_ and idx2 (do nothing at the beginning)
      findIdx1Next(pos);
      findIdx2Next(k);
      if (p_idx_->elt(idx2_) != k)  { setZero1(pos);}
      else                          { setValue1(pos);}
    }
  }
  else // ==> idx2 < idx1
  {
    // initialize idx1_ and idx2_
    findIdx2(range.lastIdx());
    pos += range.size();
    findIdx1(pos);
    for (int k= range.lastIdx(); k>=range.begin(); --k, --pos)
    {
      // update idx1_ and idx2 (do nothing at the beginning)
      findIdx1Prev(pos);
      findIdx2Prev(k);
      if (p_idx_->elt(idx2_) != k) { setZero1(pos);}
      else                         { setValue2(pos);}
    }
  }
}

References STK::RangeBase< Derived >::begin(), STK::TRange< UnknownSize >::end(), STK::TRange< UnknownSize >::lastIdx(), STK::MemSAllocator1D< Type_, NzMax_ >::memmove(), STK::TRange< UnknownSize >::size(), and STKOUT_OF_RANGE_1ARG.

Referenced by STK::MemSAllocator1D< Type_, NzMax_ >::memmove().

move()

template<typename Type_ , int NzMax_>

MemSAllocator1D< Type_, NzMax_ > & STK::MemSAllocator1D< Type_, NzMax_ >::move

(

MemSAllocator1D< Type_, NzMax_ > const &

T

)

move the Allocator T to this.

The memory of this is freed and T becomes a reference of this. This method allow to move the data of T to this without using physical copy.

Parameters

T	the allocator to move to this

Returns

this object.

Note

the data member ref_ is mutable so that T can be passed as a constant reference.

Definition at line 622 of file STK_MemSAllocator1D.h.

{
  p_idx_->move(T.p_idx_);
  p_val_->move(T.p_val_);
  range_ = T.range_;
  setRef(T.ref());
  return *this;
}

References STK::MemSAllocator1D< Type_, NzMax_ >::move(), STK::MemSAllocator1D< Type_, NzMax_ >::p_idx_, STK::MemSAllocator1D< Type_, NzMax_ >::p_val_, STK::MemSAllocator1D< Type_, NzMax_ >::range_, and STK::TRef<-1 >::ref().

Referenced by STK::MemSAllocator1D< Type_, NzMax_ >::move().

range()

template<typename Type_ , int NzMax_>

AllocatorRange const & STK::MemSAllocator1D< Type_, NzMax_ >::range ( ) const

inline

Returns

the range of the data

Definition at line 106 of file STK_MemSAllocator1D.h.

{ return range_;}

References STK::MemSAllocator1D< Type_, NzMax_ >::range_.

Referenced by STK::MemSAllocator1D< Type_, NzMax_ >::assign().

realloc() [1/2]

template<typename Type_ , int NzMax_>

template<int OtherSize>

MemSAllocator1D & STK::MemSAllocator1D< Type_, NzMax_ >::realloc

(

TRange< OtherSize > const &

I

)

function for main ptr memory reallocation.

If the size requested is greater than the allocated size, the Type stored are saved and copied using the operator=. the Type class have to provide this operator.

If the size requested is lesser than the allocated size, only the first elements fitting in the container are copied.

Parameters

I	range of the data to reserve

Referenced by STK::MemSAllocator1D< Type_, NzMax_ >::realloc().

realloc() [2/2]

template<typename Type_ , int NzMax_>

template<int OtherSize>

MemSAllocator1D< Type_, NzMax_ > & STK::MemSAllocator1D< Type_, NzMax_ >::realloc

(

TRange< OtherSize > const &

I

)

Definition at line 468 of file STK_MemSAllocator1D.h.

{
  // there is no necessity to allocate if range_ is the same
  if (range_ == I) return *this;
  if (isRef()) { STKRUNTIME_ERROR_1ARG(MemSAllocator1D::realloc,I,cannot operate on references);}
  p_idx_->resize(I);
  p_val_->resize(I);
  range_ = I;
  return this;
}

References STK::MemSAllocator1D< Type_, NzMax_ >::realloc(), and STKRUNTIME_ERROR_1ARG.

setRef()

template<typename Type_ , int NzMax_>

void STK::TRef<-1 >::setRef ( bool  ref ) const

inline

Modify the container : can become a reference or the owner of the data.

To use with care if we want to avoid memory leak.

Parameters

ref	: false if this own its own data.

Definition at line 92 of file STK_IContainerRef.h.

{ ref_ = ref;}

setValue()

template<typename Type_ , int NzMax_>

void STK::MemSAllocator1D< Type_, NzMax_ >::setValue	(	int	pos,
		Type const &	value
	)

This method allows to overwrite or insert an element to the given position.

Parameters

pos,value

index and value to set

Definition at line 408 of file STK_MemSAllocator1D.h.

{
#ifdef STK_BOUNDS_CHECK
  if (pos < begin())
  { STKOUT_OF_RANGE_2ARG(MemSAllocator1D::setValue,pos, value,MemSAllocator1D::begin() > pos);}
  if (pos >= end())
  { STKOUT_OF_RANGE_2ARG(MemSAllocator1D::setValue,pos, value,MemSAllocator1D::end() <= pos);}
#endif
  if (value == zero_) { setZero(pos);}
  else                { writeValue(pos, value);}
}

References STK::MemSAllocator1D< Type_, NzMax_ >::begin(), STK::MemSAllocator1D< Type_, NzMax_ >::end(), STK::MemSAllocator1D< Type_, NzMax_ >::setValue(), STKOUT_OF_RANGE_2ARG, and STK::zero_.

Referenced by STK::MemSAllocator1D< Type_, NzMax_ >::setValue().

setValue1() [1/2]

template<typename Type_ , int NzMax_>

void STK::MemSAllocator1D< Type_, NzMax_ >::setValue1 ( int  pos )

private

Set value idx2_ at position idx1_ when idx1 < idx2.

Parameters

pos	position to overwrite

Definition at line 693 of file STK_MemSAllocator1D.h.

{
  // there is an existing stored value for this entry
  if (p_idx_->elt(idx1_) == pos)
  { p_val_->elt(idx1_) = p_val_->elt(idx2_);}
  else // value is not yet an entry, so add it
  {
    idx1_++;
    p_idx_->insert(idx1_, pos);
    p_val_->insertElt(idx1_, 1);
    p_val_->elt(idx1_) = p_val_->elt(idx2_+1); // take care that elt1 and elt2 are shifted
  }
}

setValue1() [2/2]

template<typename Type_ , int NzMax_>

void STK::MemSAllocator1D< Type_, NzMax_ >::setValue1 ( int  pos, TypeConst  value  )

private

Write a value at position idx1_.

If p_idx_->elt(pos) != idx1_ value is inserted at this position, otherwise exiting value is overwritten.

Parameters

pos,value

position and value to write

Definition at line 663 of file STK_MemSAllocator1D.h.

{
  // there is an existing stored value for this entry
  if (p_idx_->elt(idx1_) == pos) { p_val_->elt(idx1_) =value;}
  else // value is not yet an entry, so add it
  {
    // Otherwise insert it
    p_idx_->insert(idx1_+1, pos);
    p_val_->insert(idx1_+1, value);
  }
}

setValue2()

template<typename Type_ , int NzMax_>

void STK::MemSAllocator1D< Type_, NzMax_ >::setValue2 ( int  pos )

private

Set value idx2_ at position idx1_ when idx1 > idx2.

Parameters

pos	position to overwrite

Definition at line 712 of file STK_MemSAllocator1D.h.

{
  // there is an existing stored value for this entry
  if (p_idx_->elt(idx1_) == pos)
  { p_val_->elt(idx1_) = p_val_->elt(idx2_);}
  else // value is not yet an entry, so add it
  {
    idx1_++;
    p_idx_->insert(idx1_, pos);
    p_val_->insertElt(idx1_, 1);
    p_val_->elt(idx1_) = p_val_->elt(idx2_);
 
  }
}

setZero()

template<typename Type_ , int NzMax_>

void STK::MemSAllocator1D< Type_, NzMax_ >::setZero

(

int

pos

)

This method allows to write zero to the given position.

Parameters

pos

index

Definition at line 421 of file STK_MemSAllocator1D.h.

{
#ifdef STK_BOUNDS_CHECK
  if (pos < begin())
  { STKOUT_OF_RANGE_1ARG(MemSAllocator1D::setZero,pos,MemSAllocator1D::begin() > pos);}
  if (pos >= end())
  { STKOUT_OF_RANGE_1ARG(MemSAllocator1D::setZero,pos,MemSAllocator1D::end() <= pos);}
#endif
  findIdx1(pos);
  if (p_idx_->elt(idx1_) == pos)
  {
    p_idx_->erase(idx1_);
    p_val_->erase(idx1_);
  }
}

References STK::MemSAllocator1D< Type_, NzMax_ >::begin(), STK::MemSAllocator1D< Type_, NzMax_ >::end(), STK::MemSAllocator1D< Type_, NzMax_ >::setZero(), and STKOUT_OF_RANGE_1ARG.

Referenced by STK::MemSAllocator1D< Type_, NzMax_ >::setZero().

setZero1()

template<typename Type_ , int NzMax_>

void STK::MemSAllocator1D< Type_, NzMax_ >::setZero1 ( int  pos )

private

Set zero at position idx1_.

Parameters

pos	position of the zero to set

Definition at line 677 of file STK_MemSAllocator1D.h.

{
  // there is an existing stored value for this entry
  if (p_idx_->elt(idx1_) == pos)
  {
    p_idx_->erase(idx1_);
    p_val_->erase(idx1_);
  }
}

shift()

template<typename Type_ , int NzMax_>

MemSAllocator1D< Type_, NzMax_ > & STK::MemSAllocator1D< Type_, NzMax_ >::shift

(

int

first

)

shift the first index of the data to first.

Parameters

first

the index of the first data to set

Definition at line 635 of file STK_MemSAllocator1D.h.

{
  int inc = first - begin();
  for (int t=p_idx_->begin()+1; p_idx_->elt(t) != Arithmetic<int>::max(); ++t)
  { p_idx_->elt(t) += inc;}
  range_.shift(first);
  return *this;
}

size()

template<typename Type_ , int NzMax_>

int STK::MemSAllocator1D< Type_, NzMax_ >::size ( ) const

inline

Returns

the size of the data

Definition at line 112 of file STK_MemSAllocator1D.h.

{ return range_.size();}

References STK::MemSAllocator1D< Type_, NzMax_ >::range_, and STK::TRange< UnknownSize >::size().

sizeIdx()

template<typename Type_ , int NzMax_>

int STK::MemSAllocator1D< Type_, NzMax_ >::sizeIdx ( ) const

inline

Returns

the size of the index array

Definition at line 119 of file STK_MemSAllocator1D.h.

{ return p_idx_->size();}

References STK::MemSAllocator1D< Type_, NzMax_ >::p_idx_.

val()

template<typename Type_ , int NzMax_>

Values const & STK::MemSAllocator1D< Type_, NzMax_ >::val ( ) const

inline

Returns

the vector with the values

Definition at line 124 of file STK_MemSAllocator1D.h.

{ return *p_val_;}

References STK::MemSAllocator1D< Type_, NzMax_ >::p_val_.

Referenced by STK::MemSAllocator1D< Type_, NzMax_ >::assign().

writeValue()

template<typename Type_ , int NzMax_>

void STK::MemSAllocator1D< Type_, NzMax_ >::writeValue ( int  pos, Type_ const &  value  )

private

Write a value at the given position.

If p_idx_->elt(pos) != idx value is inserted at this position, otherwise exiting value is overwritten.

Parameters

pos,value

position and value to write

Definition at line 651 of file STK_MemSAllocator1D.h.

{
  findIdx1(pos);
  setValue1(pos, value);
}

Member Data Documentation

idx1_

template<typename Type_ , int NzMax_>

int STK::MemSAllocator1D< Type_, NzMax_ >::idx1_

mutableprivate

Current indexes used for internal lookup.

Definition at line 218 of file STK_MemSAllocator1D.h.

Referenced by STK::MemSAllocator1D< Type_, NzMax_ >::findIdx1(), STK::MemSAllocator1D< Type_, NzMax_ >::findIdx1Next(), and STK::MemSAllocator1D< Type_, NzMax_ >::findIdx1Prev().

idx2_

template<typename Type_ , int NzMax_>

int STK::MemSAllocator1D< Type_, NzMax_ >::idx2_

private

Definition at line 218 of file STK_MemSAllocator1D.h.

Referenced by STK::MemSAllocator1D< Type_, NzMax_ >::findIdx2(), STK::MemSAllocator1D< Type_, NzMax_ >::findIdx2Next(), and STK::MemSAllocator1D< Type_, NzMax_ >::findIdx2Prev().

p_idx_

template<typename Type_ , int NzMax_>

Indexes* STK::MemSAllocator1D< Type_, NzMax_ >::p_idx_

protected

array of indexes

Definition at line 208 of file STK_MemSAllocator1D.h.

Referenced by STK::MemSAllocator1D< Type_, NzMax_ >::beginIdx(), STK::MemSAllocator1D< Type_, NzMax_ >::endIdx(), STK::MemSAllocator1D< Type_, NzMax_ >::exchange(), STK::MemSAllocator1D< Type_, NzMax_ >::findIdx1(), STK::MemSAllocator1D< Type_, NzMax_ >::findIdx1Next(), STK::MemSAllocator1D< Type_, NzMax_ >::findIdx1Prev(), STK::MemSAllocator1D< Type_, NzMax_ >::findIdx2(), STK::MemSAllocator1D< Type_, NzMax_ >::findIdx2Next(), STK::MemSAllocator1D< Type_, NzMax_ >::findIdx2Prev(), STK::MemSAllocator1D< Type_, NzMax_ >::idx(), STK::MemSAllocator1D< Type_, NzMax_ >::MemSAllocator1D(), STK::MemSAllocator1D< Type_, NzMax_ >::MemSAllocator1D(), STK::MemSAllocator1D< Type_, NzMax_ >::MemSAllocator1D(), STK::MemSAllocator1D< Type_, NzMax_ >::move(), and STK::MemSAllocator1D< Type_, NzMax_ >::sizeIdx().

p_val_

template<typename Type_ , int NzMax_>

Values* STK::MemSAllocator1D< Type_, NzMax_ >::p_val_

protected

array of values

Definition at line 210 of file STK_MemSAllocator1D.h.

Referenced by STK::MemSAllocator1D< Type_, NzMax_ >::exchange(), STK::MemSAllocator1D< Type_, NzMax_ >::MemSAllocator1D(), STK::MemSAllocator1D< Type_, NzMax_ >::MemSAllocator1D(), STK::MemSAllocator1D< Type_, NzMax_ >::MemSAllocator1D(), STK::MemSAllocator1D< Type_, NzMax_ >::move(), and STK::MemSAllocator1D< Type_, NzMax_ >::val().

range_

template<typename Type_ , int NzMax_>

AllocatorRange STK::MemSAllocator1D< Type_, NzMax_ >::range_

private

Range of the data.

Definition at line 214 of file STK_MemSAllocator1D.h.

Referenced by STK::MemSAllocator1D< Type_, NzMax_ >::begin(), STK::MemSAllocator1D< Type_, NzMax_ >::end(), STK::MemSAllocator1D< Type_, NzMax_ >::exchange(), STK::MemSAllocator1D< Type_, NzMax_ >::move(), STK::MemSAllocator1D< Type_, NzMax_ >::range(), and STK::MemSAllocator1D< Type_, NzMax_ >::size().

zero_

template<typename Type_ , int NzMax_>

const Type STK::MemSAllocator1D< Type_, NzMax_ >::zero_

private

zero value

Definition at line 216 of file STK_MemSAllocator1D.h.

---

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

• STK_MemSAllocator1D.h