Minsky
civita::Average Struct Reference

calculates the average along an axis or whole tensor More...

#include <tensorOp.h>

Inheritance diagram for civita::Average:
Inheritance graph
Collaboration diagram for civita::Average:
Collaboration graph

Public Member Functions

 Average ()
 
double operator[] (std::size_t i) const override
 return or compute data at a location More...
 
- Public Member Functions inherited from civita::ReductionOp
template<class F >
 ReductionOp (F f, double init, const TensorPtr &arg={}, const std::string &dimName="")
 
void setArgument (const TensorPtr &a, const ITensor::Args &) override
 
- Public Member Functions inherited from civita::ReduceAllOp
template<class F >
 ReduceAllOp (F f, double init, const std::shared_ptr< ITensor > &arg={})
 
Timestamp timestamp () const override
 timestamp indicating how old the dependendent data might be. Used in CachedTensorOp to determine when to invalidate the cache More...
 
- Public Member Functions inherited from civita::ITensor
 CLASSDESC_ACCESS (ITensor)
 
 ITensor ()
 
 ITensor (const Hypercube &hc)
 
 ITensor (Hypercube &&hc)
 
 ITensor (const std::vector< unsigned > &dims)
 
 ITensor (const ITensor &)=default
 
 ITensor (ITensor &&)=default
 
ITensoroperator= (const ITensor &)=default
 
ITensoroperator= (ITensor &&)=default
 
virtual ~ITensor ()
 
virtual const Hypercube & hypercube () const
 information describing the axes, types and labels of this tensor More...
 
virtual const Hypercube & hypercube (const Hypercube &hc)
 
virtual const Hypercube & hypercube (Hypercube &&hc)
 
std::size_t rank () const
 
std::vector< unsigned > shape () const
 
void imposeDimensions (const Dimensions &dimensions)
 impose dimensions according to dimension map dimensions More...
 
virtual const Index & index () const
 the index vector - assumed to be ordered and unique More...
 
virtual std::size_t size () const
 return number of elements in tensor - maybe less than hypercube.numElements if sparse More...
 
double atHCIndex (std::size_t hcIdx) const
 returns the data value at hypercube index hcIdx, or NaN if More...
 
template<class T >
std::size_t hcIndex (const std::initializer_list< T > &indices) const
 
template<class T >
double operator() (const std::initializer_list< T > &indices) const
 
virtual void setArguments (const TensorPtr &, const TensorPtr &, const ITensor::Args &args={})
 
virtual void setArguments (const std::vector< TensorPtr > &a, const ITensor::Args &args={"", 0})
 
virtual void setArguments (const std::vector< TensorPtr > &a1, const std::vector< TensorPtr > &a2, const ITensor::Args &args={"", 0})
 

Public Attributes

std::size_t count
 
- Public Attributes inherited from civita::ReduceAllOp
std::function< void(double &, double, std::size_t)> f
 
double init
 
std::shared_ptr< ITensorarg
 

Additional Inherited Members

- Public Types inherited from civita::ITensor
using Timestamp = std::chrono::time_point< std::chrono::high_resolution_clock >
 
- Protected Member Functions inherited from civita::ITensor
void notImpl () const
 
- Protected Attributes inherited from civita::ITensor
Hypercube m_hypercube
 
Index m_index
 

Detailed Description

calculates the average along an axis or whole tensor

Definition at line 174 of file tensorOp.h.

Constructor & Destructor Documentation

◆ Average()

civita::Average::Average ( )
inline

Definition at line 178 of file tensorOp.h.

References count.

178 : ReductionOp([this](double& x, double y,std::size_t){x+=y; ++count;},0) {}
ReductionOp(F f, double init, const TensorPtr &arg={}, const std::string &dimName="")
Definition: tensorOp.h:121
std::size_t count
Definition: tensorOp.h:176

Member Function Documentation

◆ operator[]()

double civita::Average::operator[] ( std::size_t  ) const
inlineoverridevirtual

return or compute data at a location

Reimplemented from civita::ReductionOp.

Definition at line 179 of file tensorOp.h.

References count, and civita::ReductionOp::operator[]().

180  {count=0; return ReductionOp::operator[](i)/count;}
double operator[](std::size_t i) const override
return or compute data at a location
Definition: tensorOp.cc:137
std::size_t count
Definition: tensorOp.h:176
Here is the call graph for this function:

Member Data Documentation

◆ count

std::size_t civita::Average::count
mutable

Definition at line 176 of file tensorOp.h.

Referenced by Average(), and operator[]().


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