memory allocator for sparse Array classes. More...

#include <STK_MemSAllocator.h>

Inheritance diagram for STK::MemSAllocator< Type_, NzMax_, Size_ >:

Public Types
enum	{ nzmax_ = NzMax_ , size_ = (Size_< (UnknownSize-1)) ? Size_+1 : UnknownSize }

typedef Type_	Type

typedef hidden::RemoveConst< Type_ >::Type const &	TypeConst

typedef std::pair< int, Type >	IndexedValue
	values stored by pair (row/column index, value)

typedef Array1D< IndexedValue, NzMax_ >	Allocator
	Type of the base allocator allocating data.

typedef Array1D< int, size_ >	PtrIdx
	Type of the base allocator allocating index pointer.

typedef TRange< Size_ >	AllocatorRange

Public Member Functions
	MemSAllocator ()
	default constructor

	MemSAllocator (AllocatorRange const &I)
	constructor with specified dimension

	MemSAllocator (MemSAllocator const &A, bool ref=false)
	copy constructor

	MemSAllocator (MemSAllocator const &A, Range const &I)
	reference constructor

int	begin () const

int	end () const

int	size () const

PtrIdx const &	ptr () const

Allocator const &	idx () const

void	setPtr (PtrIdx const &ptr)

void	setIdx (Allocator const &idx)

void	set (PtrIdx const &ptr, Allocator const &idx)

TypeConst	getValue (int p_idx, int s_idx) const
	This method allows to get the element (p_idx, s_idx)

void	addValue (int p_idx, int s_idx, Type const &value)
	This method allows to overwrite or insert an element to the position (p_idx, s_idx)

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
PtrIdx	ptr_
	array of pointer

Allocator	idx_
	array of pair(idx, value)

Private Attributes
const Type	zero_
	zero value

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_, int Size_>
class STK::MemSAllocator< Type_, NzMax_, Size_ >

memory allocator for sparse Array classes.

The data are stored either in the compressed sparse row (CSR) format or compressed sparse column (CSC) format. This Allocator does not assume any orientation and can be used for both kind of storage.

Template Parameters

Type_	type of elements stored in this allocator
NzMax_	maximal number of element in sparse matrix
Size_	size (if known): number of rows (columns)

Definition at line 60 of file STK_MemSAllocator.h.

Member Typedef Documentation

◆ Allocator

template<typename Type_ , int NzMax_, int Size_>

typedef Array1D<IndexedValue, NzMax_> STK::MemSAllocator< Type_, NzMax_, Size_ >::Allocator

Type of the base allocator allocating data.

Can be of fixed size NzMax_

Definition at line 78 of file STK_MemSAllocator.h.

◆ AllocatorRange

template<typename Type_ , int NzMax_, int Size_>

typedef TRange<Size_> STK::MemSAllocator< Type_, NzMax_, Size_ >::AllocatorRange

Definition at line 83 of file STK_MemSAllocator.h.

◆ IndexedValue

template<typename Type_ , int NzMax_, int Size_>

typedef std::pair<int, Type> STK::MemSAllocator< Type_, NzMax_, Size_ >::IndexedValue

values stored by pair (row/column index, value)

Definition at line 72 of file STK_MemSAllocator.h.

◆ PtrIdx

template<typename Type_ , int NzMax_, int Size_>

typedef Array1D<int, size_> STK::MemSAllocator< Type_, NzMax_, Size_ >::PtrIdx

Type of the base allocator allocating index pointer.

Can be of fixed size Size_

Definition at line 80 of file STK_MemSAllocator.h.

◆ Type

template<typename Type_ , int NzMax_, int Size_>

typedef Type_ STK::MemSAllocator< Type_, NzMax_, Size_ >::Type

Definition at line 69 of file STK_MemSAllocator.h.

◆ TypeConst

template<typename Type_ , int NzMax_, int Size_>

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

Definition at line 70 of file STK_MemSAllocator.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename Type_ , int NzMax_, int Size_>

anonymous enum

Enumerator
nzmax_
size_

Definition at line 63 of file STK_MemSAllocator.h.

    {
      nzmax_ = NzMax_,
      size_  = (Size_< (UnknownSize-1)) ? Size_+1 : UnknownSize
    };

Constructor & Destructor Documentation

◆ MemSAllocator() [1/4]

template<typename Type_ , int NzMax_, int Size_>

STK::MemSAllocator< Type_, NzMax_, Size_ >::MemSAllocator ( )

inline

default constructor

Definition at line 86 of file STK_MemSAllocator.h.

                   : IContainerRef(false)
                   , ptr_(incLast(Range()))
                   , idx_()
                   , zero_(0)
    {
      ptr_ = baseIdx;
      idx_ = IndexedValue(Arithmetic<int>::NA(), zero_);
    }

References STK::baseIdx, STK::MemSAllocator< Type_, NzMax_, Size_ >::idx_, STK::MemSAllocator< Type_, NzMax_, Size_ >::ptr_, and STK::MemSAllocator< Type_, NzMax_, Size_ >::zero_.

◆ MemSAllocator() [2/4]

template<typename Type_ , int NzMax_, int Size_>

STK::MemSAllocator< Type_, NzMax_, Size_ >::MemSAllocator ( AllocatorRange const & I )

inline

constructor with specified dimension

Parameters

I	range of the rows (or columns)

Definition at line 97 of file STK_MemSAllocator.h.

                                           : IContainerRef(false)
                                           , ptr_(incLast(I))
                                           , idx_()
                                           , zero_(0)
    {
      ptr_ = baseIdx;
      idx_ = IndexedValue(Arithmetic<int>::NA(), zero_);
    }

References STK::baseIdx, STK::MemSAllocator< Type_, NzMax_, Size_ >::idx_, STK::MemSAllocator< Type_, NzMax_, Size_ >::ptr_, and STK::MemSAllocator< Type_, NzMax_, Size_ >::zero_.

◆ MemSAllocator() [3/4]

template<typename Type_ , int NzMax_, int Size_>

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

inline

copy constructor

Parameters

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

Definition at line 109 of file STK_MemSAllocator.h.

                 : IContainerRef(ref)
                 , ptr_(A.ptr_, ref)
                 , idx_(A.idx_, ref)
                 , zero_(A.zero_)
    {}

◆ MemSAllocator() [4/4]

template<typename Type_ , int NzMax_, int Size_>

STK::MemSAllocator< Type_, NzMax_, Size_ >::MemSAllocator	(	MemSAllocator< Type_, NzMax_, Size_ > const &	A,
		Range const &	I
	)

inline

reference constructor

Parameters

A	allocator to copy
I	range of the rows/columns to reference

Definition at line 119 of file STK_MemSAllocator.h.

                 : IContainerRef(true)
                 , ptr_(A.ptr_, I, true)
                 , idx_(A.idx_, true)
                 , zero_(A.zero_)
    {}

Member Function Documentation

◆ addValue()

template<typename Type_ , int NzMax_, int Size_>

void STK::MemSAllocator< Type_, NzMax_, Size_ >::addValue	(	int	p_idx,
		int	s_idx,
		Type const &	value
	)

This method allows to overwrite or insert an element to the position (p_idx, s_idx)

Parameters

p_idx	index of the row (respectively column)
s_idx	index of the column (respectively row)
value	value to set

Definition at line 195 of file STK_MemSAllocator.h.

{
  // loop over already entries in this row/column
  for (int t=ptr_[p_idx]; t<ptr_[p_idx+1]; ++t)
  {
    if (idx_[t].first == s_idx) // there is an existing stored value for this entry
    {
      if (value != zero_) { idx_[t].second = value;}
      else // value to enter is zero
      {
        idx_.erase(t);
        for (int pt = p_idx+1; pt<ptr_.end(); ++pt) { --ptr_[pt];}
      }
      return;
    }
    else if (idx_[t].first > s_idx) // value is not yet an entry, so add it
    {
      if (value == zero_) return; // value is zero, there is nothing to do
      // Otherwise insert it
      idx_.insert(t, IndexedValue(s_idx, value));
      for (int pt = p_idx+1; pt<ptr_.end(); ++pt) { ++ptr_[pt];}
      return;
    }
  }
  // No entry in this row/column, if value is zero there is nothing to do
  if (value == zero_) return;
  // otherwise add it taking care of empty rows/columns
  idx_.insert( (ptr_[p_idx] == ptr_[p_idx+1]) ? ptr_[p_idx] : ptr_[p_idx]+1, IndexedValue(s_idx, value));
  for (int pt = p_idx+1; pt<ptr_.end(); ++pt) { ++ptr_[pt];}
}

References STK::zero_.

◆ begin()

template<typename Type_ , int NzMax_, int Size_>

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

inline

Returns: the first index of the data.

Definition at line 128 of file STK_MemSAllocator.h.

128{ return ptr_.begin();}

STK::IArray1D::begin

int begin() const

Definition STK_ITContainer1D.h:113

References STK::IArray1D< Derived >::begin(), and STK::MemSAllocator< Type_, NzMax_, Size_ >::ptr_.

◆ end()

template<typename Type_ , int NzMax_, int Size_>

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

inline

Returns: the ending index of the data

Definition at line 130 of file STK_MemSAllocator.h.

130{ return ptr_.end()-1;}

References STK::IArray1D< Derived >::end(), and STK::MemSAllocator< Type_, NzMax_, Size_ >::ptr_.

◆ getValue()

template<typename Type_ , int NzMax_, int Size_>

MemSAllocator< Type_, NzMax_, Size_ >::TypeConst STK::MemSAllocator< Type_, NzMax_, Size_ >::getValue	(	int	p_idx,
		int	s_idx
	)		const

This method allows to get the element (p_idx, s_idx)

Parameters

p_idx	the index of the row (or column)
s_idx	the index of the column (or row)

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

Definition at line 182 of file STK_MemSAllocator.h.

{
  for (int t=ptr_[p_idx]; t<ptr_[p_idx+1]; ++t)
  { if (idx_[t].first == s_idx) return idx_[t].second;}
  return zero_;
}

References STK::zero_.

◆ idx()

template<typename Type_ , int NzMax_, int Size_>

Allocator const & STK::MemSAllocator< Type_, NzMax_, Size_ >::idx ( ) const

inline

Returns: the vector with the (index,value) pairs columns (or rows)

Definition at line 137 of file STK_MemSAllocator.h.

137{ return idx_;}

References STK::MemSAllocator< Type_, NzMax_, Size_ >::idx_.

Referenced by STK::MemSAllocator< Type_, NzMax_, Size_ >::set(), and STK::MemSAllocator< Type_, NzMax_, Size_ >::setIdx().

◆ isRef()

template<typename Type_ , int NzMax_, int Size_>

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.

81{ return ref_;}

STK::TRef<-1 >::ref_

bool ref_

Is it a "true" container or a wrapper ? ref_ should be false if this own its own data,...

Definition STK_IContainerRef.h:98

◆ ptr()

template<typename Type_ , int NzMax_, int Size_>

PtrIdx const & STK::MemSAllocator< Type_, NzMax_, Size_ >::ptr ( ) const

inline

Returns: the vector with the pointers on rows (or columns)

Definition at line 135 of file STK_MemSAllocator.h.

135{ return ptr_;}

References STK::MemSAllocator< Type_, NzMax_, Size_ >::ptr_.

Referenced by STK::MemSAllocator< Type_, NzMax_, Size_ >::set(), and STK::MemSAllocator< Type_, NzMax_, Size_ >::setPtr().

◆ set()

template<typename Type_ , int NzMax_, int Size_>

void STK::MemSAllocator< Type_, NzMax_, Size_ >::set	(	PtrIdx const &	ptr,
		Allocator const &	idx
	)

inline

Parameters

ptr	vector with the pointers on rows (or columns)
idx	vector with the (index,value) pairs in columns (or rows)

Definition at line 147 of file STK_MemSAllocator.h.

148 { ptr_ = ptr; idx_ = idx;}

STK::MemSAllocator::idx

Allocator const & idx() const

Definition STK_MemSAllocator.h:137

STK::MemSAllocator::ptr

PtrIdx const & ptr() const

Definition STK_MemSAllocator.h:135

References STK::MemSAllocator< Type_, NzMax_, Size_ >::idx(), STK::MemSAllocator< Type_, NzMax_, Size_ >::idx_, STK::MemSAllocator< Type_, NzMax_, Size_ >::ptr(), and STK::MemSAllocator< Type_, NzMax_, Size_ >::ptr_.

◆ setIdx()

template<typename Type_ , int NzMax_, int Size_>

void STK::MemSAllocator< Type_, NzMax_, Size_ >::setIdx ( Allocator const & idx )

inline

Parameters

idx	vector with the (index,value) pairs in columns (or rows)

Definition at line 143 of file STK_MemSAllocator.h.

143{ idx_ = idx;}

References STK::MemSAllocator< Type_, NzMax_, Size_ >::idx(), and STK::MemSAllocator< Type_, NzMax_, Size_ >::idx_.

◆ setPtr()

template<typename Type_ , int NzMax_, int Size_>

void STK::MemSAllocator< Type_, NzMax_, Size_ >::setPtr ( PtrIdx const & ptr )

inline

Parameters

ptr	vector with the pointers on rows (or columns)

Definition at line 141 of file STK_MemSAllocator.h.

141{ ptr_ = ptr;}

References STK::MemSAllocator< Type_, NzMax_, Size_ >::ptr(), and STK::MemSAllocator< Type_, NzMax_, Size_ >::ptr_.

◆ setRef()

template<typename Type_ , int NzMax_, int Size_>

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.

92{ ref_ = ref;}

◆ size()

template<typename Type_ , int NzMax_, int Size_>

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

inline

Returns: the size of the data

Definition at line 132 of file STK_MemSAllocator.h.

132{ return ptr_.size()-1;}

STK::IArray1D::size

int size() const

Definition STK_ITContainer1D.h:117

References STK::MemSAllocator< Type_, NzMax_, Size_ >::ptr_, and STK::IArray1D< Derived >::size().

Member Data Documentation

◆ idx_

template<typename Type_ , int NzMax_, int Size_>

Allocator STK::MemSAllocator< Type_, NzMax_, Size_ >::idx_

protected

array of pair(idx, value)

Definition at line 168 of file STK_MemSAllocator.h.

Referenced by STK::MemSAllocator< Type_, NzMax_, Size_ >::idx(), STK::MemSAllocator< Type_, NzMax_, Size_ >::MemSAllocator(), STK::MemSAllocator< Type_, NzMax_, Size_ >::MemSAllocator(), STK::MemSAllocator< Type_, NzMax_, Size_ >::set(), and STK::MemSAllocator< Type_, NzMax_, Size_ >::setIdx().

◆ ptr_

template<typename Type_ , int NzMax_, int Size_>

PtrIdx STK::MemSAllocator< Type_, NzMax_, Size_ >::ptr_

protected

array of pointer

Definition at line 166 of file STK_MemSAllocator.h.

Referenced by STK::MemSAllocator< Type_, NzMax_, Size_ >::begin(), STK::MemSAllocator< Type_, NzMax_, Size_ >::end(), STK::MemSAllocator< Type_, NzMax_, Size_ >::MemSAllocator(), STK::MemSAllocator< Type_, NzMax_, Size_ >::MemSAllocator(), STK::MemSAllocator< Type_, NzMax_, Size_ >::ptr(), STK::MemSAllocator< Type_, NzMax_, Size_ >::set(), STK::MemSAllocator< Type_, NzMax_, Size_ >::setPtr(), and STK::MemSAllocator< Type_, NzMax_, Size_ >::size().

◆ zero_

template<typename Type_ , int NzMax_, int Size_>

const Type STK::MemSAllocator< Type_, NzMax_, Size_ >::zero_

private

zero value

Definition at line 172 of file STK_MemSAllocator.h.

Referenced by STK::MemSAllocator< Type_, NzMax_, Size_ >::MemSAllocator(), and STK::MemSAllocator< Type_, NzMax_, Size_ >::MemSAllocator().

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

STK_MemSAllocator.h

Public Types

Public Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Allocator

◆ AllocatorRange

◆ IndexedValue

◆ PtrIdx

◆ Type

◆ TypeConst

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ MemSAllocator() [1/4]

◆ MemSAllocator() [2/4]

◆ MemSAllocator() [3/4]

◆ MemSAllocator() [4/4]

Member Function Documentation

◆ addValue()

◆ begin()

◆ end()

◆ getValue()

◆ idx()

◆ isRef()

◆ ptr()

◆ set()

◆ setIdx()

◆ setPtr()

◆ setRef()

◆ size()

Member Data Documentation

◆ idx_

◆ ptr_

◆ zero_