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>

Inheritance diagram for Eigen::TensorBase< Derived, AccessLevel >:
Inheritance graph
[legend]

Public Types

typedef Scalar CoeffReturnType
 
typedef internal::traits< Derived > DerivedTraits
 
typedef DerivedTraits::Index Index
 
typedef DerivedTraits::Scalar Scalar
 

Public Member Functions

template<DenseIndex DimId>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const TensorChippingOp< DimId, const Derived > chip (const Index offset) const
 
template<Index DimId>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorChippingOp< DimId, Derived > chip (const Index offset)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const TensorChippingOp< Dynamic, const Derived > chip (const Index offset, const Index dim) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorChippingOp< Dynamic, Derived > chip (const Index offset, const Index dim)
 
template<typename Axis , typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const TensorConcatenationOp< const Axis, const Derived, const OtherDerived > concatenate (const OtherDerived &other, const Axis &axis) 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 DeviceType >
TensorDevice< Derived, DeviceType > device (const DeviceType &device)
 
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 const TensorReshapingOp< const NewDimensions, const Derived > reshape (const NewDimensions &newDimensions) const
 
template<typename NewDimensions >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorReshapingOp< const NewDimensions, Derived > reshape (const NewDimensions &newDimensions)
 
template<typename ReverseDimensions >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const TensorReverseOp< const ReverseDimensions, const Derived > reverse (const ReverseDimensions &rev) const
 
template<typename ReverseDimensions >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorReverseOp< const ReverseDimensions, Derived > reverse (const ReverseDimensions &rev)
 
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 const TensorShufflingOp< const Shuffle, const Derived > shuffle (const Shuffle &shuffle) const
 
template<typename Shuffle >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorShufflingOp< const Shuffle, Derived > shuffle (const Shuffle &shuffle)
 
template<typename StartIndices , typename Sizes >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const TensorSlicingOp< const StartIndices, const Sizes, const Derived > slice (const StartIndices &startIndices, const Sizes &sizes) 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 Strides >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const TensorStridingOp< const Strides, const Derived > stride (const Strides &strides) const
 
template<typename Strides >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorStridingOp< const Strides, Derived > stride (const Strides &strides)
 
template<typename StartIndices , typename StopIndices , typename Strides >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const TensorStridingSlicingOp< const StartIndices, const StopIndices, const Strides, const Derived > stridedSlice (const StartIndices &startIndices, const StopIndices &stopIndices, 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)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const TensorLayoutSwapOp< const Derived > swap_layout () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorLayoutSwapOp< Derived > swap_layout ()
 

Static Public Attributes

static const int NumDimensions = DerivedTraits::NumDimensions
 

Protected Member Functions

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & derived ()
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Derived & derived () const
 

Friends

template<typename Scalar , int NumIndices, int Options, typename IndexType >
class Tensor
 
template<typename OtherDerived , int OtherAccessLevel>
class TensorBase
 
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 interchangably in expressions.

Definition at line 829 of file TensorBase.h.

Member Typedef Documentation

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

Definition at line 834 of file TensorBase.h.

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

Definition at line 831 of file TensorBase.h.

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

Definition at line 833 of file TensorBase.h.

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

Definition at line 832 of file TensorBase.h.

Member Function Documentation

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

Definition at line 944 of file TensorBase.h.

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 949 of file TensorBase.h.

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

Definition at line 955 of file TensorBase.h.

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 960 of file TensorBase.h.

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

Definition at line 898 of file TensorBase.h.

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 903 of file TensorBase.h.

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 1005 of file TensorBase.h.

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

Definition at line 1007 of file TensorBase.h.

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

Definition at line 999 of file TensorBase.h.

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 877 of file TensorBase.h.

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 869 of file TensorBase.h.

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 873 of file TensorBase.h.

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 881 of file TensorBase.h.

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

Definition at line 909 of file TensorBase.h.

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 914 of file TensorBase.h.

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

Definition at line 966 of file TensorBase.h.

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 971 of file TensorBase.h.

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 846 of file TensorBase.h.

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 850 of file TensorBase.h.

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 854 of file TensorBase.h.

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 842 of file TensorBase.h.

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

Definition at line 977 of file TensorBase.h.

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 &  shuffle)
inline

Definition at line 982 of file TensorBase.h.

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

Definition at line 920 of file TensorBase.h.

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 925 of file TensorBase.h.

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

Definition at line 988 of file TensorBase.h.

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 993 of file TensorBase.h.

template<typename Derived, int AccessLevel = internal::accessors_level<Derived>::value>
template<typename StartIndices , typename StopIndices , typename Strides >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const 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 931 of file TensorBase.h.

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 937 of file TensorBase.h.

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

Definition at line 887 of file TensorBase.h.

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 892 of file TensorBase.h.

Friends And Related Function Documentation

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 837 of file TensorBase.h.

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

Definition at line 839 of file TensorBase.h.

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 838 of file TensorBase.h.

Member Data Documentation

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

Definition at line 835 of file TensorBase.h.

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

gtsam
Author(s):
autogenerated on Sat May 8 2021 02:55:11