ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
NDArray< DataType > Struct Template Reference

#include <ERF_NCWpsFile.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)
 
NDArrayoperator= (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
 
DTypedata
 

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
57  : name{vname}, shape{vshape}, ref_counted{1}, owned{true} {
58  data = new DType [this->ndim()];
59  }
bool owned
Definition: ERF_NCWpsFile.H:122
std::string name
Definition: ERF_NCWpsFile.H:119
size_t ndim()
Definition: ERF_NCWpsFile.H:106
std::atomic< size_t > ref_counted
Definition: ERF_NCWpsFile.H:121
typename std::remove_const< DataType >::type DType
Definition: ERF_NCWpsFile.H:53
std::vector< size_t > shape
Definition: ERF_NCWpsFile.H:120
DType * data
Definition: ERF_NCWpsFile.H:123
Here is the call graph for this function:

◆ NDArray() [2/3]

template<typename DataType >
NDArray< DataType >::NDArray ( )
inline
62 : name{"null"}, ref_counted{1}, owned{false}, data{nullptr} {}

◆ NDArray() [3/3]

template<typename DataType >
NDArray< DataType >::NDArray ( const NDArray< DataType > &  array)
inline
65  {
66  name = array.name;
67  shape = array.shape;
68  data = array.data;
69  owned = false;
70  ref_counted.fetch_add(1, std::memory_order_relaxed);
71  }

◆ ~NDArray()

template<typename DataType >
NDArray< DataType >::~NDArray ( )
inline
84  {
85  ref_counted.fetch_sub(1, std::memory_order_acq_rel);
86  if (ref_counted == 1 && owned) delete[] data;
87  }

Member Function Documentation

◆ get_data()

template<typename DataType >
decltype(auto) NDArray< DataType >::get_data ( )
inline
90  {
91  ref_counted.fetch_add(1, std::memory_order_relaxed);
92  return data;
93  }

◆ get_vname()

template<typename DataType >
std::string NDArray< DataType >::get_vname ( )
inline
96  {
97  return name;
98  }

◆ get_vshape()

template<typename DataType >
std::vector<size_t> NDArray< DataType >::get_vshape ( )
inline
101  {
102  return shape;
103  }

◆ ndim()

template<typename DataType >
size_t NDArray< DataType >::ndim ( )
inline
106  {
107  size_t num = 1;
108  int isize = static_cast<int>(shape.size());
109  for (auto i=0; i<isize; ++i) num *= shape[i];
110  return num;
111  }
@ num
Definition: ERF_DataStruct.H:22

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
74  {
75  name = array.name;
76  shape = array.shape;
77  data = array.data;
78  owned = false;
79  ref_counted.fetch_add(1, std::memory_order_relaxed);
80  return *this;
81  }

◆ set_vshape()

template<typename DataType >
void NDArray< DataType >::set_vshape ( std::vector< size_t >  vshape)
inline
114  {
115  shape = vshape;
116  }

Member Data Documentation

◆ data

◆ name

template<typename DataType >
std::string NDArray< DataType >::name
private

◆ owned

template<typename DataType >
bool NDArray< DataType >::owned
private

◆ ref_counted

template<typename DataType >
std::atomic<size_t> NDArray< DataType >::ref_counted
mutableprivate

◆ shape


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