Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Friends | List of all members
Eigen::TensorBase< Derived, AccessLevel > Class Template Reference

The tensor base class. More...

#include <TensorBase.h>

Public Types

typedef TensorBase< Derived, ReadOnlyAccessors > Base
 
typedef Scalar CoeffReturnType
 
typedef internal::traits< Derived > DerivedTraits
 
typedef DerivedTraits::Index Index
 
typedef DerivedTraits::Scalar Scalar
 

Public Member Functions

template<Index DimId>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorChippingOp< DimId, Derived > chip (const Index offset)
 
template<DenseIndex DimId>
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE TensorChippingOp< DimId, const Derived > chip (const Index offset) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorChippingOp< Dynamic, Derived > chip (const Index offset, const Index dim)
 
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE TensorChippingOp< Dynamic, const Derived > chip (const Index offset, const Index dim) const
 
template<typename Axis , typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorConcatenationOp< const Axis, Derived, OtherDerived > concatenate (const OtherDerived &other, const Axis &axis)
 
template<typename Axis , typename OtherDerived >
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE TensorConcatenationOp< const Axis, const Derived, const OtherDerived > concatenate (const OtherDerived &other, const Axis &axis) const
 
template<typename DeviceType >
TensorDevice< Derived, DeviceType > device (const DeviceType &dev)
 
template<typename DeviceType , typename DoneCallback >
TensorAsyncDevice< Derived, DeviceType, DoneCallback > device (const DeviceType &dev, DoneCallback done)
 
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & operator*= (const OtherDerived &other)
 
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & operator+= (const OtherDerived &other)
 
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & operator-= (const OtherDerived &other)
 
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & operator/= (const OtherDerived &other)
 
template<typename NewDimensions >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorReshapingOp< const NewDimensions, Derived > reshape (const NewDimensions &newDimensions)
 
template<typename NewDimensions >
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE TensorReshapingOp< const NewDimensions, const Derived > reshape (const NewDimensions &newDimensions) const
 
template<typename ReverseDimensions >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorReverseOp< const ReverseDimensions, Derived > reverse (const ReverseDimensions &rev)
 
template<typename ReverseDimensions >
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE TensorReverseOp< const ReverseDimensions, const Derived > reverse (const ReverseDimensions &rev) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & setConstant (const Scalar &val)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & setRandom ()
 
template<typename RandomGenerator >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & setRandom ()
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & setZero ()
 
template<typename Shuffle >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorShufflingOp< const Shuffle, Derived > shuffle (const Shuffle &shfl)
 
template<typename Shuffle >
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE TensorShufflingOp< const Shuffle, const Derived > shuffle (const Shuffle &shfl) const
 
template<typename StartIndices , typename Sizes >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorSlicingOp< const StartIndices, const Sizes, Derived > slice (const StartIndices &startIndices, const Sizes &sizes)
 
template<typename StartIndices , typename Sizes >
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE TensorSlicingOp< const StartIndices, const Sizes, const Derived > slice (const StartIndices &startIndices, const Sizes &sizes) const
 
template<typename Strides >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorStridingOp< const Strides, Derived > stride (const Strides &strides)
 
template<typename Strides >
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE TensorStridingOp< const Strides, const Derived > stride (const Strides &strides) const
 
template<typename StartIndices , typename StopIndices , typename Strides >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorStridingSlicingOp< const StartIndices, const StopIndices, const Strides, Derived > stridedSlice (const StartIndices &startIndices, const StopIndices &stopIndices, const Strides &strides)
 
template<typename StartIndices , typename StopIndices , typename Strides >
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE TensorStridingSlicingOp< const StartIndices, const StopIndices, const Strides, const Derived > stridedSlice (const StartIndices &startIndices, const StopIndices &stopIndices, const Strides &strides) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorLayoutSwapOp< Derived > swap_layout ()
 
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE TensorLayoutSwapOp< const Derived > swap_layout () const
 

Static Public Attributes

static const int NumDimensions = DerivedTraits::NumDimensions
 

Protected Member Functions

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & derived ()
 
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Derived & derived () const
 
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & operator= (const OtherDerived &other)
 

Friends

template<typename OtherDerived , int OtherAccessLevel>
class Eigen::TensorBase
 
template<typename Scalar , int NumIndices, int Options, typename IndexType >
class Tensor
 
template<typename Scalar , typename Dimensions , int Option, typename IndexTypes >
class TensorFixedSize
 

Detailed Description

template<typename Derived, int AccessLevel = internal::accessors_level<Derived>::value>
class Eigen::TensorBase< Derived, AccessLevel >

The tensor base class.

This class is the common parent of the Tensor and TensorMap class, thus making it possible to use either class interchangeably in expressions.

Definition at line 973 of file TensorBase.h.

Member Typedef Documentation

◆ Base

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
typedef TensorBase<Derived, ReadOnlyAccessors> Eigen::TensorBase< Derived, AccessLevel >::Base

Definition at line 975 of file TensorBase.h.

◆ CoeffReturnType

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
typedef Scalar Eigen::TensorBase< Derived, AccessLevel >::CoeffReturnType

Definition at line 979 of file TensorBase.h.

◆ DerivedTraits

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
typedef internal::traits<Derived> Eigen::TensorBase< Derived, AccessLevel >::DerivedTraits

Definition at line 976 of file TensorBase.h.

◆ Index

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
typedef DerivedTraits::Index Eigen::TensorBase< Derived, AccessLevel >::Index

Definition at line 978 of file TensorBase.h.

◆ Scalar

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
typedef DerivedTraits::Scalar Eigen::TensorBase< Derived, AccessLevel >::Scalar

Definition at line 977 of file TensorBase.h.

Member Function Documentation

◆ chip() [1/4]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<Index DimId>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorChippingOp<DimId, Derived> Eigen::TensorBase< Derived, AccessLevel >::chip ( const Index  offset)
inline

Definition at line 1095 of file TensorBase.h.

◆ chip() [2/4]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<DenseIndex DimId>
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE TensorChippingOp<DimId, const Derived> Eigen::TensorBase< Derived, AccessLevel >::chip ( const Index  offset) const
inline

Definition at line 1090 of file TensorBase.h.

◆ chip() [3/4]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorChippingOp<Dynamic, Derived> Eigen::TensorBase< Derived, AccessLevel >::chip ( const Index  offset,
const Index  dim 
)
inline

Definition at line 1106 of file TensorBase.h.

◆ chip() [4/4]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE TensorChippingOp<Dynamic, const Derived> Eigen::TensorBase< Derived, AccessLevel >::chip ( const Index  offset,
const Index  dim 
) const
inline

Definition at line 1101 of file TensorBase.h.

◆ concatenate() [1/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename Axis , typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorConcatenationOp<const Axis, Derived, OtherDerived> Eigen::TensorBase< Derived, AccessLevel >::concatenate ( const OtherDerived &  other,
const Axis &  axis 
)
inline

Definition at line 1049 of file TensorBase.h.

◆ concatenate() [2/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename Axis , typename OtherDerived >
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE TensorConcatenationOp<const Axis, const Derived, const OtherDerived> Eigen::TensorBase< Derived, AccessLevel >::concatenate ( const OtherDerived &  other,
const Axis &  axis 
) const
inline

Definition at line 1044 of file TensorBase.h.

◆ derived() [1/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& Eigen::TensorBase< Derived, AccessLevel >::derived ( )
inlineprotected

Definition at line 1169 of file TensorBase.h.

◆ derived() [2/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Derived& Eigen::TensorBase< Derived, AccessLevel >::derived ( ) const
inlineprotected

Definition at line 1171 of file TensorBase.h.

◆ device() [1/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename DeviceType >
TensorDevice<Derived, DeviceType> Eigen::TensorBase< Derived, AccessLevel >::device ( const DeviceType &  dev)
inline

Definition at line 1145 of file TensorBase.h.

◆ device() [2/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename DeviceType , typename DoneCallback >
TensorAsyncDevice<Derived, DeviceType, DoneCallback> Eigen::TensorBase< Derived, AccessLevel >::device ( const DeviceType &  dev,
DoneCallback  done 
)
inline

Definition at line 1151 of file TensorBase.h.

◆ operator*=()

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& Eigen::TensorBase< Derived, AccessLevel >::operator*= ( const OtherDerived &  other)
inline

Definition at line 1023 of file TensorBase.h.

◆ operator+=()

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& Eigen::TensorBase< Derived, AccessLevel >::operator+= ( const OtherDerived &  other)
inline

Definition at line 1015 of file TensorBase.h.

◆ operator-=()

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& Eigen::TensorBase< Derived, AccessLevel >::operator-= ( const OtherDerived &  other)
inline

Definition at line 1019 of file TensorBase.h.

◆ operator/=()

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& Eigen::TensorBase< Derived, AccessLevel >::operator/= ( const OtherDerived &  other)
inline

Definition at line 1027 of file TensorBase.h.

◆ operator=()

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& Eigen::TensorBase< Derived, AccessLevel >::operator= ( const OtherDerived &  other)
inlineprotected

Definition at line 1160 of file TensorBase.h.

◆ reshape() [1/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename NewDimensions >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorReshapingOp<const NewDimensions, Derived> Eigen::TensorBase< Derived, AccessLevel >::reshape ( const NewDimensions &  newDimensions)
inline

Definition at line 1060 of file TensorBase.h.

◆ reshape() [2/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename NewDimensions >
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE TensorReshapingOp<const NewDimensions, const Derived> Eigen::TensorBase< Derived, AccessLevel >::reshape ( const NewDimensions &  newDimensions) const
inline

Definition at line 1055 of file TensorBase.h.

◆ reverse() [1/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename ReverseDimensions >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorReverseOp<const ReverseDimensions, Derived> Eigen::TensorBase< Derived, AccessLevel >::reverse ( const ReverseDimensions &  rev)
inline

Definition at line 1117 of file TensorBase.h.

◆ reverse() [2/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename ReverseDimensions >
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE TensorReverseOp<const ReverseDimensions, const Derived> Eigen::TensorBase< Derived, AccessLevel >::reverse ( const ReverseDimensions &  rev) const
inline

Definition at line 1112 of file TensorBase.h.

◆ setConstant()

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& Eigen::TensorBase< Derived, AccessLevel >::setConstant ( const Scalar &  val)
inline

Definition at line 992 of file TensorBase.h.

◆ setRandom() [1/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& Eigen::TensorBase< Derived, AccessLevel >::setRandom ( )
inline

Definition at line 996 of file TensorBase.h.

◆ setRandom() [2/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename RandomGenerator >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& Eigen::TensorBase< Derived, AccessLevel >::setRandom ( )
inline

Definition at line 1000 of file TensorBase.h.

◆ setZero()

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& Eigen::TensorBase< Derived, AccessLevel >::setZero ( )
inline

Definition at line 988 of file TensorBase.h.

◆ shuffle() [1/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename Shuffle >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorShufflingOp<const Shuffle, Derived> Eigen::TensorBase< Derived, AccessLevel >::shuffle ( const Shuffle &  shfl)
inline

Definition at line 1128 of file TensorBase.h.

◆ shuffle() [2/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename Shuffle >
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE TensorShufflingOp<const Shuffle, const Derived> Eigen::TensorBase< Derived, AccessLevel >::shuffle ( const Shuffle &  shfl) const
inline

Definition at line 1123 of file TensorBase.h.

◆ slice() [1/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename StartIndices , typename Sizes >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorSlicingOp<const StartIndices, const Sizes, Derived> Eigen::TensorBase< Derived, AccessLevel >::slice ( const StartIndices &  startIndices,
const Sizes &  sizes 
)
inline

Definition at line 1071 of file TensorBase.h.

◆ slice() [2/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename StartIndices , typename Sizes >
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE TensorSlicingOp<const StartIndices, const Sizes, const Derived> Eigen::TensorBase< Derived, AccessLevel >::slice ( const StartIndices &  startIndices,
const Sizes &  sizes 
) const
inline

Definition at line 1066 of file TensorBase.h.

◆ stride() [1/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename Strides >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorStridingOp<const Strides, Derived> Eigen::TensorBase< Derived, AccessLevel >::stride ( const Strides &  strides)
inline

Definition at line 1139 of file TensorBase.h.

◆ stride() [2/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename Strides >
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE TensorStridingOp<const Strides, const Derived> Eigen::TensorBase< Derived, AccessLevel >::stride ( const Strides &  strides) const
inline

Definition at line 1134 of file TensorBase.h.

◆ stridedSlice() [1/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename StartIndices , typename StopIndices , typename Strides >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorStridingSlicingOp<const StartIndices, const StopIndices, const Strides, Derived> Eigen::TensorBase< Derived, AccessLevel >::stridedSlice ( const StartIndices &  startIndices,
const StopIndices &  stopIndices,
const Strides &  strides 
)
inline

Definition at line 1083 of file TensorBase.h.

◆ stridedSlice() [2/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename StartIndices , typename StopIndices , typename Strides >
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE TensorStridingSlicingOp<const StartIndices, const StopIndices, const Strides, const Derived> Eigen::TensorBase< Derived, AccessLevel >::stridedSlice ( const StartIndices &  startIndices,
const StopIndices &  stopIndices,
const Strides &  strides 
) const
inline

Definition at line 1077 of file TensorBase.h.

◆ swap_layout() [1/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorLayoutSwapOp<Derived> Eigen::TensorBase< Derived, AccessLevel >::swap_layout ( )
inline

Definition at line 1038 of file TensorBase.h.

◆ swap_layout() [2/2]

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE TensorLayoutSwapOp<const Derived> Eigen::TensorBase< Derived, AccessLevel >::swap_layout ( ) const
inline

Definition at line 1033 of file TensorBase.h.

Friends And Related Function Documentation

◆ Eigen::TensorBase

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename OtherDerived , int OtherAccessLevel>
friend class Eigen::TensorBase
friend

Definition at line 985 of file TensorBase.h.

◆ Tensor

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename Scalar , int NumIndices, int Options, typename IndexType >
friend class Tensor
friend

Definition at line 982 of file TensorBase.h.

◆ TensorFixedSize

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
template<typename Scalar , typename Dimensions , int Option, typename IndexTypes >
friend class TensorFixedSize
friend

Definition at line 983 of file TensorBase.h.

Member Data Documentation

◆ NumDimensions

template<typename Derived , int AccessLevel = internal::accessors_level<Derived>::value>
const int Eigen::TensorBase< Derived, AccessLevel >::NumDimensions = DerivedTraits::NumDimensions
static

Definition at line 980 of file TensorBase.h.

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

gtsam
Author(s):
autogenerated on Wed Mar 19 2025 03:11:42