civita::ITensor Class Reference

#include <tensorInterface.h>

Inheritance diagram for civita::ITensor:

Collaboration diagram for civita::ITensor:

Classes
struct	Args
	arguments relevant for tensor expressions, not always meaningful. Exception thrown if not. More...

Public Types
using	Timestamp = std::chrono::time_point< std::chrono::high_resolution_clock >

Public Member Functions
	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
	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 double	operator[] (std::size_t) const =0
	return or compute data at a location 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 Timestamp	timestamp () const =0
	timestamp indicating how old the dependendent data might be. Used in CachedTensorOp to determine when to invalidate the cache More...
virtual void	setArgument (const TensorPtr &, const ITensor::Args &args={"", 0})
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})

Protected Member Functions
void	notImpl () const

Protected Attributes
Hypercube	m_hypercube
Index	m_index

Detailed Description

Definition at line 36 of file tensorInterface.h.

Member Typedef Documentation

Timestamp

using civita::ITensor::Timestamp = std::chrono::time_point<std::chrono::high_resolution_clock>

Definition at line 103 of file tensorInterface.h.

Constructor & Destructor Documentation

ITensor() [1/6]

civita::ITensor::ITensor ( )

inline

Definition at line 40 of file tensorInterface.h.

{}

ITensor() [2/6]

civita::ITensor::ITensor ( const Hypercube &  hc )

inline

Definition at line 41 of file tensorInterface.h.

: m_hypercube(hc) {}

ITensor() [3/6]

civita::ITensor::ITensor ( Hypercube &&  hc )

inline

Definition at line 42 of file tensorInterface.h.

: m_hypercube(std::move(hc)) {}

ITensor() [4/6]

civita::ITensor::ITensor ( const std::vector< unsigned > &  dims )

inline

Definition at line 43 of file tensorInterface.h.

References m_hypercube.

{m_hypercube.dims(dims);}

ITensor() [5/6]

civita::ITensor::ITensor ( const ITensor &  )

default

ITensor() [6/6]

civita::ITensor::ITensor ( ITensor &&  )

default

~ITensor()

virtual civita::ITensor::~ITensor ( )

inlinevirtual

Definition at line 48 of file tensorInterface.h.

{}

Member Function Documentation

atHCIndex()

double civita::ITensor::atHCIndex ( std::size_t  hcIdx ) const

inline

returns the data value at hypercube index hcIdx, or NaN if

Definition at line 82 of file tensorInterface.h.

References index(), and size().

Referenced by operator()().

                                            {
      auto& idx=index();
      if (idx.empty()) {// this is dense
        if (hcIdx<size())
          return (*this)[hcIdx]; 
      } else {
        auto i=idx.linealOffset(hcIdx);
        if (i<idx.size())
          return (*this)[i];
      }
      return nan(""); //element not found
    }

Here is the call graph for this function:

Here is the caller graph for this function:

CLASSDESC_ACCESS()

civita::ITensor::CLASSDESC_ACCESS

(

ITensor

)

hcIndex()

template<class T >

std::size_t civita::ITensor::hcIndex ( const std::initializer_list< T > &  indices ) const

inline

Definition at line 96 of file tensorInterface.h.

References hypercube().

Referenced by operator()(), civita::BinOp::operator[](), and civita::InterpolateHC::splitAndRotate().

    {return hypercube().linealIndex(indices);}

Here is the call graph for this function:

Here is the caller graph for this function:

hypercube() [1/3]

virtual const Hypercube& civita::ITensor::hypercube ( ) const

inlinevirtual

information describing the axes, types and labels of this tensor

Reimplemented in minsky::RavelTensor, civita::SortByValue, civita::CachedTensorOp, and civita::ElementWiseOp.

Definition at line 50 of file tensorInterface.h.

References m_hypercube.

Referenced by hcIndex(), imposeDimensions(), minsky::TensorVarVal::operator=(), minsky::VariableValue::operator=(), rank(), civita::InterpolateHC::setArgument(), minsky::GeneralTensorOp< OperationType::linearRegression >::setArguments(), shape(), size(), and civita::InterpolateHC::splitAndRotate().

{return m_hypercube;}

Here is the caller graph for this function:

hypercube() [2/3]

virtual const Hypercube& civita::ITensor::hypercube ( const Hypercube &  hc )

inlinevirtual

Reimplemented in civita::CachedTensorOp.

Definition at line 51 of file tensorInterface.h.

References m_hypercube.

{return m_hypercube=hc;}

hypercube() [3/3]

virtual const Hypercube& civita::ITensor::hypercube ( Hypercube &&  hc )

inlinevirtual

Reimplemented in civita::CachedTensorOp.

Definition at line 52 of file tensorInterface.h.

References m_hypercube.

{return m_hypercube=std::move(hc);}

imposeDimensions()

void civita::ITensor::imposeDimensions ( const Dimensions &  dimensions )

inline

impose dimensions according to dimension map dimensions

Definition at line 57 of file tensorInterface.h.

References hypercube().

                                                        {
      auto hc=hypercube();
      for (auto& xv: hc.xvectors)
        {
          auto dim=dimensions.find(xv.name);
          if (dim!=dimensions.end())
            {
              xv.dimension=dim->second;
              xv.imposeDimension();
            }
        }
      hypercube(std::move(hc));
    }

Here is the call graph for this function:

index()

virtual const Index& civita::ITensor::index ( ) const

inlinevirtual

the index vector - assumed to be ordered and unique

Reimplemented in minsky::RavelTensor, civita::CachedTensorOp, and civita::ElementWiseOp.

Definition at line 72 of file tensorInterface.h.

References m_index.

Referenced by atHCIndex(), civita::InterpolateHC::bodyCentredNeighbourhood(), minsky::TensorVarVal::operator=(), minsky::VariableValue::operator=(), civita::BinOp::operator[](), civita::InterpolateHC::setArgument(), minsky::GeneralTensorOp< OperationType::linearRegression >::setArguments(), and size().

{return m_index;}

Here is the caller graph for this function:

notImpl()

void civita::ITensor::notImpl ( ) const

inlineprotected

Definition at line 129 of file tensorInterface.h.

    {throw std::runtime_error("setArgument(s) variant not implemented");}

operator()()

template<class T >

double civita::ITensor::operator() ( const std::initializer_list< T > &  indices ) const

inline

Definition at line 100 of file tensorInterface.h.

References atHCIndex(), and hcIndex().

    {return atHCIndex(hcIndex(indices));}

Here is the call graph for this function:

operator=() [1/2]

ITensor& civita::ITensor::operator= ( const ITensor &  )

default

operator=() [2/2]

ITensor& civita::ITensor::operator= ( ITensor &&  )

default

operator[]()

virtual double civita::ITensor::operator[] ( std::size_t  ) const

pure virtual

return or compute data at a location

Implemented in minsky::GeneralTensorOp< OperationType::shape >, minsky::GeneralTensorOp< OperationType::size >, minsky::GeneralTensorOp< OperationType::differencePlus >, civita::SpreadLast, civita::SpreadFirst, civita::PermuteAxis, civita::Pivot, civita::Slice, civita::StdDeviation, civita::Average, civita::CachedTensorOp, civita::ReductionOp, civita::ReduceAllOp, civita::ReduceArguments, civita::InterpolateHC, civita::BinOp, and civita::ElementWiseOp.

rank()

std::size_t civita::ITensor::rank ( ) const

inline

Definition at line 53 of file tensorInterface.h.

References hypercube().

Referenced by civita::InterpolateHC::bodyCentredNeighbourhood(), civita::InterpolateHC::setArgument(), and civita::InterpolateHC::splitAndRotate().

{return hypercube().rank();}

Here is the call graph for this function:

Here is the caller graph for this function:

setArgument()

virtual void civita::ITensor::setArgument ( const TensorPtr &  , const ITensor::Args &  args = {"",0}  )

inlinevirtual

Reimplemented in minsky::RavelTensor, minsky::GeneralTensorOp< OperationType::slice >, minsky::GeneralTensorOp< OperationType::histogram >, minsky::GeneralTensorOp< OperationType::moment >, minsky::GeneralTensorOp< OperationType::shape >, minsky::GeneralTensorOp< OperationType::size >, minsky::GeneralTensorOp< OperationType::index >, minsky::GeneralTensorOp< OperationType::differencePlus >, minsky::GeneralTensorOp< OperationType::difference >, civita::SpreadBase, civita::SortByValue, civita::PermuteAxis, civita::Pivot, civita::Slice, civita::Scan, civita::DimensionedArgCachedOp, civita::ReductionOp, civita::ReduceAllOp, civita::InterpolateHC, and civita::ElementWiseOp.

Definition at line 115 of file tensorInterface.h.

Referenced by minsky::TensorEval::TensorEval().

{"",0})  {notImpl();}

Here is the caller graph for this function:

setArguments() [1/3]

virtual void civita::ITensor::setArguments ( const TensorPtr &  , const TensorPtr &  , const ITensor::Args &  args = {}  )

inlinevirtual

Reimplemented in minsky::GeneralTensorOp< OperationType::linearRegression >, minsky::Correlation, minsky::GeneralTensorOp< OperationType::gather >, minsky::GeneralTensorOp< OperationType::outerProduct >, minsky::GeneralTensorOp< OperationType::innerProduct >, minsky::TensorBinOp< op >, minsky::TensorBinOp< OperationType::add >, and civita::BinOp.

Definition at line 116 of file tensorInterface.h.

                                                      {}) {notImpl();}

setArguments() [2/3]

virtual void civita::ITensor::setArguments ( const std::vector< TensorPtr > &  a, const ITensor::Args &  args = {"",0}  )

inlinevirtual

Reimplemented in minsky::SwitchTensor, civita::ReduceArguments, and minsky::MinskyTensorOp< op >.

Definition at line 118 of file tensorInterface.h.

                                                      {"",0}) 
    {if (a.size()) setArgument(a[0], args);}

setArguments() [3/3]

virtual void civita::ITensor::setArguments ( const std::vector< TensorPtr > &  a1, const std::vector< TensorPtr > &  a2, const ITensor::Args &  args = {"",0}  )

inlinevirtual

Reimplemented in minsky::MultiWireBinOp< op >.

Definition at line 121 of file tensorInterface.h.

                                                      {"",0})
    {setArguments(a1.empty()? TensorPtr(): a1[0], a2.empty()? TensorPtr(): a2[0], args);}

shape()

std::vector<unsigned> civita::ITensor::shape ( ) const

inline

Definition at line 54 of file tensorInterface.h.

References hypercube().

{return hypercube().dims();}

Here is the call graph for this function:

size()

virtual std::size_t civita::ITensor::size ( ) const

inlinevirtual

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

Reimplemented in minsky::RavelTensor, minsky::SwitchTensor, civita::SortByValue, civita::CachedTensorOp, minsky::TimeOp, and civita::ElementWiseOp.

Definition at line 76 of file tensorInterface.h.

References hypercube(), and index().

Referenced by atHCIndex(), minsky::VariableValue::operator=(), civita::BinOp::operator[](), and civita::InterpolateHC::setArgument().

                                   {
      std::size_t s=index().size();
      return s? s: hypercube().numElements();
    }        

Here is the call graph for this function:

Here is the caller graph for this function:

timestamp()

virtual Timestamp civita::ITensor::timestamp ( ) const

pure virtual

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

Implemented in minsky::RavelTensor, minsky::SwitchTensor, minsky::GeneralTensorOp< OperationType::linearRegression >, minsky::Correlation, minsky::GeneralTensorOp< OperationType::shape >, minsky::GeneralTensorOp< OperationType::size >, minsky::GeneralTensorOp< OperationType::gather >, minsky::GeneralTensorOp< OperationType::index >, minsky::GeneralTensorOp< OperationType::outerProduct >, minsky::GeneralTensorOp< OperationType::innerProduct >, civita::SpreadBase, civita::SortByValue, civita::PermuteAxis, civita::Pivot, civita::Slice, civita::DimensionedArgCachedOp, civita::ReduceAllOp, civita::ReduceArguments, civita::BinOp, civita::InterpolateHC, minsky::TimeOp, and civita::ElementWiseOp.

Member Data Documentation

m_hypercube

Hypercube civita::ITensor::m_hypercube

protected

Definition at line 127 of file tensorInterface.h.

Referenced by civita::ElementWiseOp::hypercube(), hypercube(), ITensor(), civita::SpreadFirst::setSpreadDimensions(), and civita::SpreadLast::setSpreadDimensions().

m_index

Index civita::ITensor::m_index

protected

Definition at line 128 of file tensorInterface.h.

Referenced by civita::ElementWiseOp::index(), index(), civita::SpreadFirst::setSpreadDimensions(), and civita::SpreadLast::setSpreadDimensions().

---

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

• tensor/tensorInterface.h