numcxx::TArray< T > Class Template Reference

Description

template<typename T>
class numcxx::TArray< T >

TArray is the common template base class for arrays and dense matrices of the numcxx project.

Definition at line 17 of file tarray.hxx.

Inheritance diagram for numcxx::TArray< T >:

Public Types
typedef T	value_type

Public Member Functions
T &	operator() (const index i0)
	Access operator for 1D arrays. More...
const T &	operator() (const index i0) const
T &	operator() (const index i0, const index i1)
	Access operator for 2D arrays. More...
const T &	operator() (const index i0, const index i1) const
index	ndim () const
	Obtain tensor dimension of array. More...
size_t	size () const
	Obtain size of array. More...
index	shape (const index dim) const
	Obtain shape of array for given dimension. More...
template<typename VAL >
void	operator+= (const VAL &a)
	Add value to all elements. More...
template<typename VAL >
void	operator-= (const VAL &a)
	Subtract value from all elements. More...
template<typename VAL >
void	operator*= (const VAL &a)
	Multiply all elements by value. More...
template<typename VAL >
void	operator/= (const VAL &a)
	Divide each element by value. More...
T &	operator[] (const index i)
	Alternative access operator for 1D arrays. More...
const T &	operator[] (const index i) const
	Const reference to entry for use in expression templates. More...
template<typename VAL >
TArray< T > &	operator= (const VAL &expr)
	Expression template compatible assignment operator. More...
T *	data () const
	Obtain C-pointer of data array. More...
void	resize (size_t n)
	Resize array. More...
	TArray (const TArray< T > &A)=delete
	Copy constructor is deleted. More...
void	savetxt (std::ostream &s) const

Static Public Member Functions
static void	operate (std::function< void(T &a, T &b)> f, TArray< T > &A, TArray< T > &B)
	Binary operation on arrays. More...
static void	operate (std::function< void(T &a, T &b, T &c)> f, TArray< T > &A, TArray< T > &B, TArray< T > &C)
	Ternary operation on arrays. More...

Protected Member Functions
void	_assert_square () const
	Check if all shapes are the same. More...
index	_idx (index i0) const
	1D Array index calculation with optional bounds check. More...
index	_idx (index i0, index i1) const
	2D Array index calculation with optional bounds check. More...
index	_idx (index i0, index i1, index i2) const
	3D Array index calculation with optional bounds check. More...
	TArray ()
	Construct an zero length 1D array. More...
void	_nullify ()
	Nullify contents of array (for move constructors) More...
void	_setshape (index shape0)
	Set shape of 1D array (for move constructors) More...
	TArray (index n0)
	Construct an empty 1D array of length n0. More...
	TArray (const std::initializer_list< T > &il)
	Construct 1D Array from std::initializer list. More...
	TArray (index n0, T *data, std::function< void(T *p)> deleter)
	Construct an 1D array from data pointer. More...
	TArray (index n0, T *data, std::shared_ptr< void > datamanager)
	Construct an 1D array from data pointer. More...
	TArray (index n0, index n1)
	Construct an empty 2D array. More...
	TArray (const std::initializer_list< std::initializer_list< T >> &il)
	Construct 2D Array from std::initializer list. More...
	TArray (index n0, index n1, T *data, std::function< void(T *p)> deleter)
	Construct a 2D array from data pointer. More...
	TArray (index n0, index n1, T *data, std::shared_ptr< void > datamanager)
	Construct a 2D array from data pointer. More...
	~TArray ()
	Destructor. More...

Protected Attributes
std::function< void(T *p)>	_deleter =nullptr
	Deleter method. More...
std::shared_ptr< void >	_datamanager =nullptr
	Data manager. More...
T *	_data =nullptr
	Data pointer. More...

Private Member Functions
void	_check_bounds (index acc_dim, index acc_ndim, index acc_idx) const
	Bounds checker. More...

Private Attributes
const index	_ndim
	Tensor dimension. More...
size_t	_size
	Size of array. More...
index	_shape [3] ={0,0,0}
	Shape vector. More...

Friends
std::ostream &	operator (std::ostream &s, TArray< T > &A)
	Print contents of array. More...

Member Typedef Documentation

template<typename T>

typedef T numcxx::TArray< T >::value_type

Definition at line 30 of file tarray.hxx.

Constructor & Destructor Documentation

template<typename T>

numcxx::TArray< T >::TArray ( const TArray< T > &  A )

delete

Copy constructor is deleted.

template<typename T >

numcxx::TArray< T >::TArray ( )

inlineprotected

Construct an zero length 1D array.

Definition at line 245 of file tarray.ixx.

                          :
    _data(0),
    _size(0),
    _ndim(1),
    _shape{0,0},
    _deleter([](T*p){;})
    {};   

template<typename T >

numcxx::TArray< T >::TArray ( index  n0 )

inlineprotected

Construct an empty 1D array of length n0.

Parameters

n0

Size.

Definition at line 195 of file tarray.ixx.

                                  :
    _ndim(1),
    _shape{n0},
    _size(n0),
    _data((T*)malloc(sizeof(T)*_size)),
    _deleter([](T*p){free(p);})
    {if (_data==nullptr)  throw std::runtime_error("numcxx: TArray::TArray(): Memory allocation failed"); };

template<typename T >

numcxx::TArray< T >::TArray ( const std::initializer_list< T > &  il )

inlineprotected

Construct 1D Array from std::initializer list.

Definition at line 12 of file tarray.ixx.

                                                           :TArray(il.size())
  {
    index i=0;
    for (auto x = il.begin() ; x != il.end(); x++,i++) _data[i]= *x;
  }

template<typename T >

numcxx::TArray< T >::TArray ( index  n0, T *  data, std::function< void(T *p)>  deleter  )

inlineprotected

Construct an 1D array from data pointer.

Parameters

n0	Size.
data	Pointer to data.
deleter	Deleter method,

See also

TArray<T>::_deleter

Definition at line 204 of file tarray.ixx.

                                                                         :
    _data(data),
    _ndim(1),
    _shape{n0},
    _size(n0),
    _deleter(deleter)
    {};

template<typename T >

numcxx::TArray< T >::TArray ( index  n0, T *  data, std::shared_ptr< void >  datamanager  )

inlineprotected

Construct an 1D array from data pointer.

Parameters

n0	Size.
data	Pointer to data.
deleter	Deleter method.

See also

TArray<T>::_datamanager

Definition at line 213 of file tarray.ixx.

                                                                          :
    TArray(n0,data,[](T*p){;}){_datamanager=datamanager;};

template<typename T >

numcxx::TArray< T >::TArray ( index  n0, index  n1  )

inlineprotected

Construct an empty 2D array.

Parameters

n0	Number of rows
n1	Number of columns

Definition at line 186 of file tarray.ixx.

                                            :
    _ndim(2),
    _shape{n0,n1},
    _size((size_t)n0*(size_t)n1),
    _data((T*)malloc(sizeof(T)*_size)),
    _deleter([](T*p){free(p);})
    {if (_data==nullptr)  throw std::runtime_error("numcxx: TArray::TArray(): Memory allocation failed"); };

template<typename T >

numcxx::TArray< T >::TArray ( const std::initializer_list< std::initializer_list< T >> &  il )

inlineprotected

Construct 2D Array from std::initializer list.

Definition at line 20 of file tarray.ixx.

                                                                                :
    TArray(il.size(), il.begin()->size())
  {
    index i=0;
        
    for (auto jl = il.begin() ; jl != il.end(); jl++,i++)
    {
      index j=0;
      for (auto x = jl->begin() ; x != jl->end(); x++,j++) 
        _data[_idx(i,j)]= *x;
    }
  }

Here is the call graph for this function:

template<typename T >

numcxx::TArray< T >::TArray ( index  n0, index  n1, T *  data, std::function< void(T *p)>  deleter  )

inlineprotected

Construct a 2D array from data pointer.

Parameters

n0	Number of rows
n1	Number of columns
data	Pointer to data.
deleter	Deleter method,

See also

TArray<T>::_deleter

Definition at line 217 of file tarray.ixx.

                                                                                   :
    _data(data),
    _ndim(2),
    _shape{n0,n1},
    _size(n0*n1),
    _deleter(deleter)
    {};

template<typename T >

numcxx::TArray< T >::TArray ( index  n0, index  n1, T *  data, std::shared_ptr< void >  datamanager  )

inlineprotected

Construct a 2D array from data pointer.

Parameters

n0	Number of rows
n1	Number of columns
data	Pointer to data.
deleter	Deleter method.

See also

TArray<T>::_datamanager

Definition at line 229 of file tarray.ixx.

                                                                                    :
    TArray(n0,n1,data, [](T*p){;})
  {_datamanager=datamanager;};

template<typename T >

numcxx::TArray< T >::~TArray ( )

inlineprotected

Destructor.

Definition at line 234 of file tarray.ixx.

  {
    if (_datamanager==nullptr)
    {
      _deleter(_data);
    }
    // otherwise we assume that datamaager takes care
    // of the data pointer
  };

Member Function Documentation

template<typename T>

T& numcxx::TArray< T >::operator() ( const index  i0 )

inline

Access operator for 1D arrays.

Parameters

i0	Index of element to be accessed.

Returns

Reference to element to be accessed.

Definition at line 36 of file tarray.hxx.

{ return _data[_idx(i0)];};

Here is the call graph for this function:

template<typename T>

const T& numcxx::TArray< T >::operator() ( const index  i0 ) const

inline

Definition at line 37 of file tarray.hxx.

{ return _data[_idx(i0)];};

Here is the call graph for this function:

template<typename T>

T& numcxx::TArray< T >::operator() ( const index  i0, const index  i1  )

inline

Access operator for 2D arrays.

Parameters

i0	Row index of element to be accessed.
i0	Column index of element to be accessed.

Returns

Reference to element to be accessed.

Definition at line 44 of file tarray.hxx.

{ return _data[_idx(i0,i1)];};

Here is the call graph for this function:

template<typename T>

const T& numcxx::TArray< T >::operator() ( const index  i0, const index  i1  ) const

inline

Definition at line 45 of file tarray.hxx.

{ return _data[_idx(i0,i1)];};

Here is the call graph for this function:

template<typename T>

index numcxx::TArray< T >::ndim ( ) const

inline

Obtain tensor dimension of array.

Tensor dimension is 1 for vectors, 2 for matrices.

Returns

Dimension.

Definition at line 52 of file tarray.hxx.

{return _ndim;}

template<typename T>

size_t numcxx::TArray< T >::size ( ) const

inline

Obtain size of array.

This ist the overall number of elements in the array

Returns

Size.

Examples:

11-numcxx-ref.cxx, 12-numcxx-sharedptr.cxx, 44-transient-heat-fe.cxx, and 45-convdiff1d.cxx.

Definition at line 58 of file tarray.hxx.

{ return _size;}

template<typename T>

index numcxx::TArray< T >::shape ( const index  dim ) const

inline

Obtain shape of array for given dimension.

For 1D arrays, shape(0) is equivalent to the size For 2D arrays, shape(0) is the number of rows and shape(1) the number of columns. This corresponds to the "row major" storage format.

Parameters

dim	Tensor dimension.

Returns

Number of elements in given dimension.

Definition at line 68 of file tarray.hxx.

{return _shape[dim];}

template<typename T>

template<typename VAL >

void numcxx::TArray< T >::operator+= ( const VAL &  a )

inline

Add value to all elements.

Parameters

a	Summand for each element.

Definition at line 74 of file tarray.hxx.

{xadd(*this,a);}

Here is the call graph for this function:

template<typename T>

template<typename VAL >

void numcxx::TArray< T >::operator-= ( const VAL &  a )

inline

Subtract value from all elements.

Parameters

a	Value to be subracted from each element.

Definition at line 80 of file tarray.hxx.

{xsub(*this,a);}

Here is the call graph for this function:

template<typename T>

template<typename VAL >

void numcxx::TArray< T >::operator*= ( const VAL &  a )

inline

Multiply all elements by value.

Parameters

a	Multiplicator for each element.

Definition at line 87 of file tarray.hxx.

{xmul(*this,a);}

Here is the call graph for this function:

template<typename T>

template<typename VAL >

void numcxx::TArray< T >::operator/= ( const VAL &  a )

inline

Divide each element by value.

Parameters

a	Divisor for each element.

Definition at line 94 of file tarray.hxx.

{xdiv(*this,a);}

Here is the call graph for this function:

template<typename T >

void numcxx::TArray< T >::operate ( std::function< void(T &a, T &b)>  f, TArray< T > &  A, TArray< T > &  B  )

inlinestatic

Binary operation on arrays.

Parameters

f	Function performing operation for each index.
A	First array argument.
B	Second array argument.

Definition at line 314 of file tarray.ixx.

  { 
    for(index i=0;i<A._size;i++) f(A._data[i],B._data[i]);
  }

template<typename T >

void numcxx::TArray< T >::operate ( std::function< void(T &a, T &b, T &c)>  f, TArray< T > &  A, TArray< T > &  B, TArray< T > &  C  )

inlinestatic

Ternary operation on arrays.

Parameters

f	Function performing operation for each index.
A	First array argument.
B	Second array argument.
C	Third array argument.

Definition at line 320 of file tarray.ixx.

  {
    for(index i=0;i<A._size;i++) f(A._data[i],B._data[i],C._data[i]);
  }

template<typename T>

T& numcxx::TArray< T >::operator[] ( const index  i )

inline

Alternative access operator for 1D arrays.

Definition at line 115 of file tarray.hxx.

{ return _data[i];}

template<typename T>

const T& numcxx::TArray< T >::operator[] ( const index  i ) const

inline

Const reference to entry for use in expression templates.

Definition at line 118 of file tarray.hxx.

{ return _data[i];};

template<typename T>

template<typename VAL >

TArray<T>& numcxx::TArray< T >::operator= ( const VAL &  expr )

inline

Expression template compatible assignment operator.

Definition at line 122 of file tarray.hxx.

{return assign(*this,expr);}

Here is the call graph for this function:

template<typename T>

T* numcxx::TArray< T >::data ( ) const

inline

Obtain C-pointer of data array.

Returns

Address of C-Array managed by the class which holds the data

Definition at line 128 of file tarray.hxx.

{ return _data;}

Here is the call graph for this function:

template<typename T >

void numcxx::TArray< T >::resize ( size_t  n )

inline

Resize array.

Definition at line 282 of file tarray.ixx.

  {
    if (_size==n) return;

    if (_ndim>1)
    {
      char errormsg[80];
      snprintf(errormsg,80,"numcxx::TArray::resize: unable to resize 2D Array to 1D.\n");
      throw std::runtime_error(errormsg);
    }
        
    if (_datamanager==nullptr)
    {
      _deleter(_data);
      _data=(T*)malloc(sizeof(T)*n);
      if (_data==nullptr)  throw std::runtime_error("numcxx: TArray::resize(): Memory allocation failed"); 
      _deleter=[](T*p){free(p);};
      _size=n;
      _shape[0]=n;
      _shape[1]=0;
    }
    else
    {
      char errormsg[80];
      snprintf(errormsg,80,"numcxx::TArray::resize: unable to resize - data managed by different object.\n");
      throw std::runtime_error(errormsg);
    }
  }

template<typename T >

void numcxx::TArray< T >::savetxt ( std::ostream &  s ) const

inline

Definition at line 351 of file tarray.ixx.

  {
    if (ndim()==1)
      for (index i=0;i<size();i++) s << _data[i] << std::endl << std::flush;
    else
    {
      for (index i=0;i<shape(0);i++) 
      {
        for (index j=0;j<shape(1);j++) 
          s << _data[_idx(i,j)] << " ";
        s<< std::endl;
      }
      s << std::flush;
    }
  }

Here is the call graph for this function:

template<typename T >

void numcxx::TArray< T >::_check_bounds ( index  acc_dim, index  acc_ndim, index  acc_idx  ) const

inlineprivate

Bounds checker.

Bounds check is enabled if the code is compiled with -DNUMCXX_CHECK_BOUNDS.

On error it throws std::out_of_range exception.

Parameters

acc_dim	Dimension to be checked.
acc_ndim	Tensor dimension to be checked.
acc_dim	Index in dimension acc_dim to be checked.

Definition at line 128 of file tarray.ixx.

  {
    if (acc_ndim!=_ndim) 
    {
      char errormsg[80];
      snprintf(errormsg,80,"numcxx::TArray::_check_bounds: attempt of %uD access of %uD array",acc_ndim,_ndim);
      throw std::out_of_range(errormsg);
    }
    if ((acc_idx<0) || (acc_idx>=_shape[acc_dim]))
    {
      char errormsg[80];
      snprintf(errormsg,80,"numcxx::TArray::_check_bounds: _shape[%u]=%u but i%u=%u",acc_dim,_shape[acc_dim],acc_dim,acc_idx);
      throw std::out_of_range(errormsg);
    }
  }  

template<typename T >

void numcxx::TArray< T >::_assert_square ( ) const

inlineprotected

Check if all shapes are the same.

Throw an exception on error

Definition at line 145 of file tarray.ixx.

  {
    if (_ndim!=2 || _shape[0]!=_shape[1])
    {
      char errormsg[80];
      snprintf(errormsg,80,"numcxx::TArray::_assert_square: unexpected non-equal array dimensions\n");
      throw std::length_error(errormsg);
    }
  }

template<typename T >

index numcxx::TArray< T >::_idx ( index  i0 ) const

inlineprotected

1D Array index calculation with optional bounds check.

Definition at line 156 of file tarray.ixx.

  {
#ifdef NUMCXX_CHECK_BOUNDS
    _check_bounds(0,1,i0);
#endif
    return i0;
  }

Here is the call graph for this function:

template<typename T >

index numcxx::TArray< T >::_idx ( index  i0, index  i1  ) const

inlineprotected

2D Array index calculation with optional bounds check.

Definition at line 165 of file tarray.ixx.

  { 
#ifdef NUMCXX_CHECK_BOUNDS
    _check_bounds(0,2,i0);
    _check_bounds(1,2,i1);
#endif
    return i0*_shape[1]+i1;
  }

Here is the call graph for this function:

template<typename T >

index numcxx::TArray< T >::_idx ( index  i0, index  i1, index  i2  ) const

inlineprotected

3D Array index calculation with optional bounds check.

Definition at line 175 of file tarray.ixx.

  { 
#ifdef NUMCXX_CHECK_BOUNDS
    _check_bounds(0,3,i0);
    _check_bounds(1,3,i1);
    _check_bounds(2,3,i2);
#endif
    return (i0*_shape[0]+i1)*_shape[1]+i2;
  }

Here is the call graph for this function:

template<typename T >

void numcxx::TArray< T >::_nullify ( )

inlineprotected

Nullify contents of array (for move constructors)

Definition at line 254 of file tarray.ixx.

  {
    _shape[0]=0;     
    _shape[1]=0;     
    _shape[2]=0;     
    _size=0;       
    _deleter=[](T*p){;};     
    _datamanager=nullptr; 
    _data=nullptr;
  }

template<typename T >

void numcxx::TArray< T >::_setshape ( index  shape0 )

inlineprotected

Set shape of 1D array (for move constructors)

Definition at line 266 of file tarray.ixx.

  {
    if (_ndim!=1)
    {
      char errormsg[80];
      snprintf(errormsg,80,"numcxx::TArray::resize: unable to set 1D shape for 2D array.\n");
      throw std::runtime_error(errormsg);
    }
    _shape[0]=shape0;   
    _shape[1]=0;
    _shape[2]=0;
    _size=shape0;       
  }

Friends And Related Function Documentation

template<typename T>

std::ostream& operator ( std::ostream &  s, TArray< T > &  A  )

friend

Print contents of array.

Member Data Documentation

template<typename T>

const index numcxx::TArray< T >::_ndim

private

Tensor dimension.

Definition at line 143 of file tarray.hxx.

template<typename T>

size_t numcxx::TArray< T >::_size

private

Size of array.

Definition at line 146 of file tarray.hxx.

template<typename T>

index numcxx::TArray< T >::_shape[3] ={0,0,0}

private

Shape vector.

Definition at line 149 of file tarray.hxx.

template<typename T>

std::function<void(T*p)> numcxx::TArray< T >::_deleter =nullptr

protected

Deleter method.

This is the proper method to be used to destroy the data pointer in the array if data manager is null. Depending on the way it was constructed, it may do nothing, free the memory, delete[] the memory, or something else.

Definition at line 172 of file tarray.hxx.

template<typename T>

std::shared_ptr<void> numcxx::TArray< T >::_datamanager =nullptr

protected

Data manager.

Smart pointer to some other object managing the data pointer. If it is not nullptr, the deleter is not called and the memory corresponding to the data pointer is freed when the object behind the data manager is destroyed.

An example in case is the use of shared_ptr<vector> v as datamanager and v->data() as data pointer

Definition at line 183 of file tarray.hxx.

template<typename T>

T* numcxx::TArray< T >::_data =nullptr

protected

Data pointer.

Definition at line 186 of file tarray.hxx.

---

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

• tarray.hxx
• tarray.ixx