Eigen::TensorRef< PlainObjectType > Class Template Reference

A reference to a tensor expression The expression will be evaluated lazily (as much as possible). More...

Inheritance diagram for Eigen::TensorRef< PlainObjectType >:

Public Types
enum	{   IsAligned ,   PacketAccess ,   BlockAccess ,   PreferBlockAccess ,   CoordAccess ,   RawAccess }
typedef PlainObjectType::Base	Base
typedef Base::CoeffReturnType	CoeffReturnType
typedef PlainObjectType::Dimensions	Dimensions
typedef internal::traits< PlainObjectType >::Index	Index
typedef Eigen::internal::nested< Self >::type	Nested
typedef PointerType	PointerArgType
typedef Scalar *	PointerType
typedef NumTraits< Scalar >::Real	RealScalar
typedef internal::traits< PlainObjectType >::Scalar	Scalar
typedef TensorRef< PlainObjectType >	Self
typedef internal::traits< PlainObjectType >::StorageKind	StorageKind
typedef internal::TensorBlockNotImplemented	TensorBlock

Public Member Functions
template<std::size_t NumIndices>
const Scalar	coeff (const array< Index, NumIndices > &indices) const
const Scalar	coeff (Index index) const
template<std::size_t NumIndices>
Scalar &	coeffRef (const array< Index, NumIndices > &indices)
template<typename... IndexTypes>
Scalar &	coeffRef (Index firstIndex, IndexTypes... otherIndices)
Scalar &	coeffRef (Index index)
const Scalar *	data () const
Index	dimension (Index n) const
const Dimensions &	dimensions () const
template<typename... IndexTypes>
const Scalar	operator() (Index firstIndex, IndexTypes... otherIndices) const
const Scalar	operator() (Index index) const
template<typename Expression >
TensorRef &	operator= (const Expression &expr)
TensorRef &	operator= (const TensorRef &other)
Index	rank () const
Index	size () const
	TensorRef ()
template<typename Expression >
	TensorRef (const Expression &expr)
	TensorRef (const TensorRef &other)
	~TensorRef ()

Static Public Attributes
static constexpr int	Layout
static constexpr Index	NumIndices

Private Member Functions
void	unrefEvaluator ()

Private Attributes
internal::TensorLazyBaseEvaluator< Dimensions, Scalar > *	m_evaluator

Detailed Description

template<typename PlainObjectType>
class Eigen::TensorRef< PlainObjectType >

A reference to a tensor expression The expression will be evaluated lazily (as much as possible).

Definition at line 126 of file TensorRef.h.

Member Typedef Documentation

Base

template<typename PlainObjectType >

typedef PlainObjectType::Base Eigen::TensorRef< PlainObjectType >::Base

Definition at line 130 of file TensorRef.h.

CoeffReturnType

template<typename PlainObjectType >

typedef Base::CoeffReturnType Eigen::TensorRef< PlainObjectType >::CoeffReturnType

Definition at line 136 of file TensorRef.h.

Dimensions

template<typename PlainObjectType >

typedef PlainObjectType::Dimensions Eigen::TensorRef< PlainObjectType >::Dimensions

Definition at line 141 of file TensorRef.h.

Index

template<typename PlainObjectType >

typedef internal::traits<PlainObjectType>::Index Eigen::TensorRef< PlainObjectType >::Index

Definition at line 133 of file TensorRef.h.

Nested

template<typename PlainObjectType >

typedef Eigen::internal::nested<Self>::type Eigen::TensorRef< PlainObjectType >::Nested

Definition at line 131 of file TensorRef.h.

PointerArgType

template<typename PlainObjectType >

typedef PointerType Eigen::TensorRef< PlainObjectType >::PointerArgType

Definition at line 138 of file TensorRef.h.

PointerType

template<typename PlainObjectType >

typedef Scalar* Eigen::TensorRef< PlainObjectType >::PointerType

Definition at line 137 of file TensorRef.h.

RealScalar

template<typename PlainObjectType >

typedef NumTraits<Scalar>::Real Eigen::TensorRef< PlainObjectType >::RealScalar

Definition at line 135 of file TensorRef.h.

Scalar

template<typename PlainObjectType >

typedef internal::traits<PlainObjectType>::Scalar Eigen::TensorRef< PlainObjectType >::Scalar

Definition at line 134 of file TensorRef.h.

Self

template<typename PlainObjectType >

typedef TensorRef<PlainObjectType> Eigen::TensorRef< PlainObjectType >::Self

Definition at line 129 of file TensorRef.h.

StorageKind

template<typename PlainObjectType >

typedef internal::traits<PlainObjectType>::StorageKind Eigen::TensorRef< PlainObjectType >::StorageKind

Definition at line 132 of file TensorRef.h.

TensorBlock

template<typename PlainObjectType >

typedef internal::TensorBlockNotImplemented Eigen::TensorRef< PlainObjectType >::TensorBlock

Definition at line 154 of file TensorRef.h.

Member Enumeration Documentation

anonymous enum

template<typename PlainObjectType >

anonymous enum

Enumerator
IsAligned
PacketAccess
BlockAccess
PreferBlockAccess
CoordAccess
RawAccess

Definition at line 144 of file TensorRef.h.

         {
      IsAligned = false,
      PacketAccess = false,
      BlockAccess = false,
      PreferBlockAccess = false,
      CoordAccess = false,  // to be implemented
      RawAccess = false
    };

Constructor & Destructor Documentation

TensorRef() [1/3]

template<typename PlainObjectType >

Eigen::TensorRef< PlainObjectType >::TensorRef ( )

inline

Definition at line 157 of file TensorRef.h.

                                    : m_evaluator(NULL) {
    }

TensorRef() [2/3]

template<typename PlainObjectType >

template<typename Expression >

Eigen::TensorRef< PlainObjectType >::TensorRef ( const Expression &  expr )

inline

Definition at line 161 of file TensorRef.h.

                                                          : m_evaluator(new internal::TensorLazyEvaluator<Dimensions, Expression, DefaultDevice>(expr, DefaultDevice())) {
      m_evaluator->incrRefCount();
    }

~TensorRef()

template<typename PlainObjectType >

Eigen::TensorRef< PlainObjectType >::~TensorRef ( )

inline

Definition at line 173 of file TensorRef.h.

                 {
      unrefEvaluator();
    }

TensorRef() [3/3]

template<typename PlainObjectType >

Eigen::TensorRef< PlainObjectType >::TensorRef ( const TensorRef< PlainObjectType > &  other )

inline

Definition at line 177 of file TensorRef.h.

                                      : TensorBase<TensorRef<PlainObjectType> >(other), m_evaluator(other.m_evaluator) {
      eigen_assert(m_evaluator->refCount() > 0);
      m_evaluator->incrRefCount();
    }

Member Function Documentation

coeff() [1/2]

template<typename PlainObjectType >

template<std::size_t NumIndices>

const Scalar Eigen::TensorRef< PlainObjectType >::coeff ( const array< Index, NumIndices > &  indices ) const

inline

Definition at line 225 of file TensorRef.h.

    {
      const Dimensions& dims = this->dimensions();
      Index index = 0;
      if (PlainObjectType::Options & RowMajor) {
        index += indices[0];
        for (size_t i = 1; i < NumIndices; ++i) {
          index = index * dims[i] + indices[i];
        }
      } else {
        index += indices[NumIndices-1];
        for (int i = NumIndices-2; i >= 0; --i) {
          index = index * dims[i] + indices[i];
        }
      }
      return m_evaluator->coeff(index);
    }

coeff() [2/2]

template<typename PlainObjectType >

const Scalar Eigen::TensorRef< PlainObjectType >::coeff ( Index  index ) const

inline

Definition at line 262 of file TensorRef.h.

    {
      return m_evaluator->coeff(index);
    }

coeffRef() [1/3]

template<typename PlainObjectType >

template<std::size_t NumIndices>

Scalar& Eigen::TensorRef< PlainObjectType >::coeffRef ( const array< Index, NumIndices > &  indices )

inline

Definition at line 243 of file TensorRef.h.

    {
      const Dimensions& dims = this->dimensions();
      Index index = 0;
      if (PlainObjectType::Options & RowMajor) {
        index += indices[0];
        for (size_t i = 1; i < NumIndices; ++i) {
          index = index * dims[i] + indices[i];
        }
      } else {
        index += indices[NumIndices-1];
        for (int i = NumIndices-2; i >= 0; --i) {
          index = index * dims[i] + indices[i];
        }
      }
      return m_evaluator->coeffRef(index);
    }

coeffRef() [2/3]

template<typename PlainObjectType >

template<typename... IndexTypes>

Scalar& Eigen::TensorRef< PlainObjectType >::coeffRef ( Index  firstIndex, IndexTypes...  otherIndices  )

inline

Definition at line 217 of file TensorRef.h.

    {
      const std::size_t num_indices = (sizeof...(otherIndices) + 1);
      const array<Index, num_indices> indices{{firstIndex, otherIndices...}};
      return coeffRef(indices);
    }

coeffRef() [3/3]

template<typename PlainObjectType >

Scalar& Eigen::TensorRef< PlainObjectType >::coeffRef ( Index  index )

inline

Definition at line 268 of file TensorRef.h.

    {
      return m_evaluator->coeffRef(index);
    }

data()

template<typename PlainObjectType >

const Scalar* Eigen::TensorRef< PlainObjectType >::data ( ) const

inline

Definition at line 201 of file TensorRef.h.

{ return m_evaluator->data(); }

dimension()

template<typename PlainObjectType >

Index Eigen::TensorRef< PlainObjectType >::dimension ( Index  n ) const

inline

Definition at line 195 of file TensorRef.h.

{ return m_evaluator->dimensions()[n]; }

dimensions()

template<typename PlainObjectType >

const Dimensions& Eigen::TensorRef< PlainObjectType >::dimensions ( ) const

inline

Definition at line 197 of file TensorRef.h.

{ return m_evaluator->dimensions(); }

operator()() [1/2]

template<typename PlainObjectType >

template<typename... IndexTypes>

const Scalar Eigen::TensorRef< PlainObjectType >::operator() ( Index  firstIndex, IndexTypes...  otherIndices  ) const

inline

Definition at line 210 of file TensorRef.h.

    {
      const std::size_t num_indices = (sizeof...(otherIndices) + 1);
      const array<Index, num_indices> indices{{firstIndex, otherIndices...}};
      return coeff(indices);
    }

operator()() [2/2]

template<typename PlainObjectType >

const Scalar Eigen::TensorRef< PlainObjectType >::operator() ( Index  index ) const

inline

Definition at line 204 of file TensorRef.h.

    {
      return m_evaluator->coeff(index);
    }

operator=() [1/2]

template<typename PlainObjectType >

template<typename Expression >

TensorRef& Eigen::TensorRef< PlainObjectType >::operator= ( const Expression &  expr )

inline

Definition at line 166 of file TensorRef.h.

                                                                       {
      unrefEvaluator();
      m_evaluator = new internal::TensorLazyEvaluator<Dimensions, Expression, DefaultDevice>(expr, DefaultDevice());
      m_evaluator->incrRefCount();
      return *this;
    }

operator=() [2/2]

template<typename PlainObjectType >

TensorRef& Eigen::TensorRef< PlainObjectType >::operator= ( const TensorRef< PlainObjectType > &  other )

inline

Definition at line 182 of file TensorRef.h.

                                                   {
      if (this != &other) {
        unrefEvaluator();
        m_evaluator = other.m_evaluator;
        eigen_assert(m_evaluator->refCount() > 0);
        m_evaluator->incrRefCount();
      }
      return *this;
    }

rank()

template<typename PlainObjectType >

Index Eigen::TensorRef< PlainObjectType >::rank ( ) const

inline

Definition at line 193 of file TensorRef.h.

{ return m_evaluator->dimensions().size(); }

size()

template<typename PlainObjectType >

Index Eigen::TensorRef< PlainObjectType >::size ( ) const

inline

Definition at line 199 of file TensorRef.h.

{ return m_evaluator->dimensions().TotalSize(); }

unrefEvaluator()

template<typename PlainObjectType >

void Eigen::TensorRef< PlainObjectType >::unrefEvaluator ( )

inlineprivate

Definition at line 274 of file TensorRef.h.

                                              {
      if (m_evaluator) {
        m_evaluator->decrRefCount();
        if (m_evaluator->refCount() == 0) {
          delete m_evaluator;
        }
      }
    }

Member Data Documentation

Layout

template<typename PlainObjectType >

constexpr int Eigen::TensorRef< PlainObjectType >::Layout

staticconstexpr

Definition at line 143 of file TensorRef.h.

m_evaluator

template<typename PlainObjectType >

internal::TensorLazyBaseEvaluator<Dimensions, Scalar>* Eigen::TensorRef< PlainObjectType >::m_evaluator

private

Definition at line 283 of file TensorRef.h.

NumIndices

template<typename PlainObjectType >

constexpr Index Eigen::TensorRef< PlainObjectType >::NumIndices

staticconstexpr

Definition at line 140 of file TensorRef.h.

---

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

• TensorForwardDeclarations.h
• TensorRef.h