NDArray< DataType > Struct Template Reference

#include <NCFile.H>

Collaboration diagram for NDArray< DataType >:

Public Types
using	DType = typename std::remove_const< DataType >::type

Public Member Functions
	NDArray (const std::string vname, const std::vector< size_t > &vshape)
	NDArray ()
	NDArray (const NDArray &array)
NDArray &	operator= (const NDArray &array)
	~NDArray ()
decltype(auto)	get_data ()
std::string	get_vname ()
std::vector< size_t >	get_vshape ()
size_t	ndim ()
void	set_vshape (std::vector< size_t > vshape)

Private Attributes
std::string	name
std::vector< size_t >	shape
std::atomic< size_t >	ref_counted
bool	owned
DType *	data

Member Typedef Documentation

DType

template<typename DataType >

using NDArray< DataType >::DType = typename std::remove_const<DataType>::type

Constructor & Destructor Documentation

NDArray() [1/3]

template<typename DataType >

NDArray< DataType >::NDArray ( const std::string  vname, const std::vector< size_t > &  vshape  )

inlineexplicit

                    : name{vname}, shape{vshape}, ref_counted{1}, owned{true} {
      data = new DType [this->ndim()];
   }

Here is the call graph for this function:

NDArray() [2/3]

template<typename DataType >

NDArray< DataType >::NDArray ( )

inline

: name{"null"}, ref_counted{1}, owned{false}, data{nullptr} {}

NDArray() [3/3]

template<typename DataType >

NDArray< DataType >::NDArray ( const NDArray< DataType > &  array )

inline

                                  {
     name  = array.name;
     shape = array.shape;
     data  = array.data;
     owned = false;
     ref_counted.fetch_add(1, std::memory_order_relaxed);
   }

~NDArray()

template<typename DataType >

NDArray< DataType >::~NDArray ( )

inline

               {
     ref_counted.fetch_sub(1, std::memory_order_acq_rel);
     if (ref_counted == 1 && owned) delete[] data;
   }

Member Function Documentation

get_data()

template<typename DataType >

decltype(auto) NDArray< DataType >::get_data ( )

inline

                              {
     ref_counted.fetch_add(1, std::memory_order_relaxed);
     return data;
   }

get_vname()

template<typename DataType >

std::string NDArray< DataType >::get_vname ( )

inline

                          {
     return name;
   }

get_vshape()

template<typename DataType >

std::vector<size_t> NDArray< DataType >::get_vshape ( )

inline

                                   {
     return shape;
   }

ndim()

template<typename DataType >

size_t NDArray< DataType >::ndim ( )

inline

                  {
     size_t num = 1;
     int isize = static_cast<int>(shape.size());
     for (auto i=0; i<isize; ++i) num *= shape[i];
     return num;
   }

Referenced by NDArray< DataType >::NDArray().

Here is the caller graph for this function:

operator=()

template<typename DataType >

NDArray& NDArray< DataType >::operator= ( const NDArray< DataType > &  array )

inline

                                            {
      name  = array.name;
      shape = array.shape;
      data  = array.data;
      owned = false;
      ref_counted.fetch_add(1, std::memory_order_relaxed);
      return *this;
    }

set_vshape()

template<typename DataType >

void NDArray< DataType >::set_vshape ( std::vector< size_t >  vshape )

inline

                                              {
     shape = vshape;
    }

Member Data Documentation

data

template<typename DataType >

DType* NDArray< DataType >::data

private

Referenced by NDArray< DataType >::get_data(), NDArray< DataType >::NDArray(), NDArray< DataType >::operator=(), and NDArray< DataType >::~NDArray().

name

template<typename DataType >

std::string NDArray< DataType >::name

private

Referenced by NDArray< DataType >::get_vname(), NDArray< DataType >::NDArray(), and NDArray< DataType >::operator=().

owned

template<typename DataType >

bool NDArray< DataType >::owned

private

Referenced by NDArray< DataType >::NDArray(), NDArray< DataType >::operator=(), and NDArray< DataType >::~NDArray().

ref_counted

template<typename DataType >

std::atomic<size_t> NDArray< DataType >::ref_counted

mutableprivate

Referenced by NDArray< DataType >::get_data(), NDArray< DataType >::NDArray(), NDArray< DataType >::operator=(), and NDArray< DataType >::~NDArray().

shape

template<typename DataType >

std::vector<size_t> NDArray< DataType >::shape

private

Referenced by NDArray< DataType >::get_vshape(), NDArray< DataType >::NDArray(), NDArray< DataType >::ndim(), NDArray< DataType >::operator=(), and NDArray< DataType >::set_vshape().

---

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

• /home/runner/work/REMORA/REMORA/Source/IO/NCFile.H