civita::ElementWiseOp Struct Reference

perform an operation elementwise over a tensor valued argument More...

#include <tensorOp.h>

Inheritance diagram for civita::ElementWiseOp:

Collaboration diagram for civita::ElementWiseOp:

Public Member Functions
template<class F >
	ElementWiseOp (F f, const std::shared_ptr< ITensor > &arg={})
void	setArgument (const TensorPtr &a, const ITensor::Args &) override
const Hypercube &	hypercube () const override
	information describing the axes, types and labels of this tensor More...
const Index &	index () const override
	the index vector - assumed to be ordered and unique More...
double	operator[] (std::size_t i) const override
	return or compute data at a location More...
std::size_t	size () const override
	return number of elements in tensor - maybe less than hypercube.numElements if sparse More...
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
ITensor &	operator= (const ITensor &)=default
ITensor &	operator= (ITensor &&)=default
virtual	~ITensor ()
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...
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::function< double(double)>	f
std::shared_ptr< ITensor >	arg

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

perform an operation elementwise over a tensor valued argument

Definition at line 33 of file tensorOp.h.

Constructor & Destructor Documentation

ElementWiseOp()

template<class F >

civita::ElementWiseOp::ElementWiseOp ( F  f, const std::shared_ptr< ITensor > &  arg = {}  )

inline

Definition at line 38 of file tensorOp.h.

{}): f(f), arg(arg) {}

Member Function Documentation

hypercube()

const Hypercube& civita::ElementWiseOp::hypercube ( ) const

inlineoverridevirtual

information describing the axes, types and labels of this tensor

Reimplemented from civita::ITensor.

Definition at line 40 of file tensorOp.h.

References arg, and civita::ITensor::m_hypercube.

{return arg? arg->hypercube(): m_hypercube;}

index()

const Index& civita::ElementWiseOp::index ( ) const

inlineoverridevirtual

the index vector - assumed to be ordered and unique

Reimplemented from civita::ITensor.

Definition at line 41 of file tensorOp.h.

References arg, and civita::ITensor::m_index.

{return arg? arg->index(): m_index;}

operator[]()

double civita::ElementWiseOp::operator[] ( std::size_t  ) const

inlineoverridevirtual

return or compute data at a location

Implements civita::ITensor.

Definition at line 42 of file tensorOp.h.

References arg, and f.

{return arg? f((*arg)[i]): 0;}

setArgument()

void civita::ElementWiseOp::setArgument ( const TensorPtr &  a, const ITensor::Args &    )

inlineoverridevirtual

Reimplemented from civita::ITensor.

Definition at line 39 of file tensorOp.h.

References arg.

{arg=a;}

size()

std::size_t civita::ElementWiseOp::size ( ) const

inlineoverridevirtual

return number of elements in tensor - maybe less than hypercube.numElements if sparse

Reimplemented from civita::ITensor.

Definition at line 43 of file tensorOp.h.

References arg.

{return arg? arg->size(): 1;}

timestamp()

Timestamp civita::ElementWiseOp::timestamp ( ) const

inlineoverridevirtual

timestamp indicating how old the dependendent data might be. Used in CachedTensorOp to determine when to invalidate the cache

Implements civita::ITensor.

Definition at line 44 of file tensorOp.h.

References arg.

{return arg? arg->timestamp(): Timestamp();}

Member Data Documentation

arg

std::shared_ptr<ITensor> civita::ElementWiseOp::arg

Definition at line 36 of file tensorOp.h.

Referenced by hypercube(), index(), operator[](), setArgument(), size(), and timestamp().

f

std::function<double(double)> civita::ElementWiseOp::f

Definition at line 35 of file tensorOp.h.

Referenced by operator[]().

---

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

• tensor/tensorOp.h