Public Types | Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | List of all members
Eigen::TensorRef Class Reference

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

#include <TensorForwardDeclarations.h>

Public Types

enum  {
  IsAligned = false, PacketAccess = false, Layout = PlainObjectType::Layout, CoordAccess = false,
  RawAccess = false
}
 
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
 

Public Member Functions

template<std::size_t NumIndices>
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar coeff (const array< Index, NumIndices > &indices) const
 
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar coeff (Index index) const
 
template<std::size_t NumIndices>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & coeffRef (const array< Index, NumIndices > &indices)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & coeffRef (Index i0, Index i1)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & coeffRef (Index i0, Index i1, Index i2)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & coeffRef (Index i0, Index i1, Index i2, Index i3, Index i4)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & coeffRef (Index index)
 
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar * data () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index dimension (Index n) const
 
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Dimensions & dimensions () const
 
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar operator() (Index i0, Index i1) const
 
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar operator() (Index i0, Index i1, Index i2) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & operator() (Index i0, Index i1, Index i2, Index i3)
 
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar operator() (Index i0, Index i1, Index i2, Index i3) const
 
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar operator() (Index i0, Index i1, Index i2, Index i3, Index i4) const
 
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar operator() (Index index) const
 
template<typename Expression >
EIGEN_STRONG_INLINE TensorRef & operator= (const Expression &expr)
 
TensorRef & operator= (const TensorRef &other)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index rank () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index size () const
 
EIGEN_STRONG_INLINE TensorRef ()
 
template<typename Expression >
EIGEN_STRONG_INLINE TensorRef (const Expression &expr)
 
 TensorRef (const TensorRef &other)
 
 ~TensorRef ()
 

Static Public Attributes

static const Index NumIndices = PlainObjectType::NumIndices
 

Private Member Functions

EIGEN_STRONG_INLINE void unrefEvaluator ()
 

Private Attributes

internal::TensorLazyBaseEvaluator< Dimensions, Scalar > * m_evaluator
 

Detailed Description

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

Definition at line 28 of file TensorForwardDeclarations.h.

Member Typedef Documentation

◆ Base

typedef PlainObjectType::Base Eigen::TensorRef::Base

Definition at line 123 of file TensorRef.h.

◆ CoeffReturnType

typedef Base::CoeffReturnType Eigen::TensorRef::CoeffReturnType

Definition at line 129 of file TensorRef.h.

◆ Dimensions

typedef PlainObjectType::Dimensions Eigen::TensorRef::Dimensions

Definition at line 134 of file TensorRef.h.

◆ Index

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

Definition at line 126 of file TensorRef.h.

◆ Nested

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

Definition at line 124 of file TensorRef.h.

◆ PointerArgType

typedef PointerType Eigen::TensorRef::PointerArgType

Definition at line 131 of file TensorRef.h.

◆ PointerType

typedef Scalar* Eigen::TensorRef::PointerType

Definition at line 130 of file TensorRef.h.

◆ RealScalar

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

Definition at line 128 of file TensorRef.h.

◆ Scalar

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

Definition at line 127 of file TensorRef.h.

◆ Self

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

Definition at line 122 of file TensorRef.h.

◆ StorageKind

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

Definition at line 125 of file TensorRef.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
IsAligned 
PacketAccess 
Layout 
CoordAccess 
RawAccess 

Definition at line 136 of file TensorRef.h.

Constructor & Destructor Documentation

◆ TensorRef() [1/3]

EIGEN_STRONG_INLINE Eigen::TensorRef::TensorRef ( )
inline

Definition at line 144 of file TensorRef.h.

◆ TensorRef() [2/3]

template<typename Expression >
EIGEN_STRONG_INLINE Eigen::TensorRef::TensorRef ( const Expression &  expr)
inline

Definition at line 148 of file TensorRef.h.

◆ ~TensorRef()

Eigen::TensorRef::~TensorRef ( )
inline

Definition at line 160 of file TensorRef.h.

◆ TensorRef() [3/3]

Eigen::TensorRef::TensorRef ( const TensorRef &  other)
inline

Definition at line 164 of file TensorRef.h.

Member Function Documentation

◆ coeff() [1/2]

template<std::size_t NumIndices>
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar Eigen::TensorRef::coeff ( const array< Index, NumIndices > &  indices) const
inline

Definition at line 292 of file TensorRef.h.

◆ coeff() [2/2]

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar Eigen::TensorRef::coeff ( Index  index) const
inline

Definition at line 329 of file TensorRef.h.

◆ coeffRef() [1/5]

template<std::size_t NumIndices>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::TensorRef::coeffRef ( const array< Index, NumIndices > &  indices)
inline

Definition at line 310 of file TensorRef.h.

◆ coeffRef() [2/5]

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::TensorRef::coeffRef ( Index  i0,
Index  i1 
)
inline

Definition at line 252 of file TensorRef.h.

◆ coeffRef() [3/5]

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::TensorRef::coeffRef ( Index  i0,
Index  i1,
Index  i2 
)
inline

Definition at line 260 of file TensorRef.h.

◆ coeffRef() [4/5]

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::TensorRef::coeffRef ( Index  i0,
Index  i1,
Index  i2,
Index  i3,
Index  i4 
)
inline

Definition at line 279 of file TensorRef.h.

◆ coeffRef() [5/5]

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::TensorRef::coeffRef ( Index  index)
inline

Definition at line 335 of file TensorRef.h.

◆ data()

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar* Eigen::TensorRef::data ( ) const
inline

Definition at line 188 of file TensorRef.h.

◆ dimension()

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index Eigen::TensorRef::dimension ( Index  n) const
inline

Definition at line 182 of file TensorRef.h.

◆ dimensions()

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Dimensions& Eigen::TensorRef::dimensions ( ) const
inline

Definition at line 184 of file TensorRef.h.

◆ operator()() [1/6]

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar Eigen::TensorRef::operator() ( Index  i0,
Index  i1 
) const
inline

Definition at line 214 of file TensorRef.h.

◆ operator()() [2/6]

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar Eigen::TensorRef::operator() ( Index  i0,
Index  i1,
Index  i2 
) const
inline

Definition at line 222 of file TensorRef.h.

◆ operator()() [3/6]

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::TensorRef::operator() ( Index  i0,
Index  i1,
Index  i2,
Index  i3 
)
inline

Definition at line 269 of file TensorRef.h.

◆ operator()() [4/6]

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar Eigen::TensorRef::operator() ( Index  i0,
Index  i1,
Index  i2,
Index  i3 
) const
inline

Definition at line 231 of file TensorRef.h.

◆ operator()() [5/6]

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar Eigen::TensorRef::operator() ( Index  i0,
Index  i1,
Index  i2,
Index  i3,
Index  i4 
) const
inline

Definition at line 241 of file TensorRef.h.

◆ operator()() [6/6]

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar Eigen::TensorRef::operator() ( Index  index) const
inline

Definition at line 191 of file TensorRef.h.

◆ operator=() [1/2]

template<typename Expression >
EIGEN_STRONG_INLINE TensorRef& Eigen::TensorRef::operator= ( const Expression &  expr)
inline

Definition at line 153 of file TensorRef.h.

◆ operator=() [2/2]

TensorRef& Eigen::TensorRef::operator= ( const TensorRef &  other)
inline

Definition at line 169 of file TensorRef.h.

◆ rank()

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index Eigen::TensorRef::rank ( ) const
inline

Definition at line 180 of file TensorRef.h.

◆ size()

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index Eigen::TensorRef::size ( ) const
inline

Definition at line 186 of file TensorRef.h.

◆ unrefEvaluator()

EIGEN_STRONG_INLINE void Eigen::TensorRef::unrefEvaluator ( )
inlineprivate

Definition at line 341 of file TensorRef.h.

Member Data Documentation

◆ m_evaluator

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

Definition at line 350 of file TensorRef.h.

◆ NumIndices

const Index Eigen::TensorRef::NumIndices = PlainObjectType::NumIndices
static

Definition at line 133 of file TensorRef.h.

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

control_box_rst
Author(s): Christoph Rösmann
autogenerated on Wed Mar 2 2022 00:07:46