The tensor class. More...

#include <Tensor.h>

Inheritance diagram for Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >:

Public Types
enum	{ IsAligned = bool(EIGEN_MAX_ALIGN_BYTES>0) & !(Options_&DontAlign), Layout = Options_ & RowMajor ? RowMajor : ColMajor, CoordAccess = true, RawAccess = true }

typedef TensorBase< Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >	Base

typedef Base::CoeffReturnType	CoeffReturnType

typedef DSizes< Index, NumIndices_ >	Dimensions

typedef internal::traits< Self >::Index	Index

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

typedef NumTraits< Scalar >::Real	RealScalar

typedef Scalar_	Scalar

typedef Tensor< Scalar_, NumIndices_, Options_, IndexType_ >	Self

typedef internal::traits< Self >::StorageKind	StorageKind

Public Types inherited from Eigen::TensorBase< Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >
typedef Scalar	CoeffReturnType

typedef internal::traits< Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >	DerivedTraits

typedef DerivedTraits::Index	Index

typedef DerivedTraits::Scalar	Scalar

Public Member Functions
Self &	base ()

const Self &	base () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar &	coeff (const array< Index, NumIndices > &indices) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar &	coeff () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar &	coeff (Index index) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	coeffRef (const array< Index, NumIndices > &indices)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	coeffRef ()

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	coeffRef (Index index)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar *	data ()

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar *	data () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index	dimension (std::size_t n) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Dimensions &	dimensions () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar &	operator() (Index i0, Index i1) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar &	operator() (Index i0, Index i1, Index i2) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar &	operator() (Index i0, Index i1, Index i2, Index i3) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar &	operator() (Index i0, Index i1, Index i2, Index i3, Index i4) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar &	operator() (const array< Index, NumIndices > &indices) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar &	operator() (Index index) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar &	operator() () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	operator() (Index i0, Index i1)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	operator() (Index i0, Index i1, Index i2)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	operator() (Index i0, Index i1, Index i2, Index i3)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	operator() (Index i0, Index i1, Index i2, Index i3, Index i4)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	operator() (const array< Index, NumIndices > &indices)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	operator() (Index index)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	operator() ()

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Tensor &	operator= (const Tensor &other)

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

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar &	operator[] (Index index) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	operator[] (Index index)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index	rank () const

EIGEN_DEVICE_FUNC void	resize (const array< Index, NumIndices > &dimensions)

EIGEN_DEVICE_FUNC void	resize (const DSizes< Index, NumIndices > &dimensions)

EIGEN_DEVICE_FUNC void	resize ()

template<typename std::ptrdiff_t... Indices>
EIGEN_DEVICE_FUNC void	resize (const Sizes< Indices... > &dimensions)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index	size () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Tensor ()

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Tensor (const Self &other)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Tensor (Index dim1)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Tensor (Index dim1, Index dim2)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Tensor (Index dim1, Index dim2, Index dim3)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Tensor (Index dim1, Index dim2, Index dim3, Index dim4)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Tensor (Index dim1, Index dim2, Index dim3, Index dim4, Index dim5)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Tensor (const array< Index, NumIndices > &dimensions)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Tensor (const TensorBase< OtherDerived, ReadOnlyAccessors > &other)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Tensor (const TensorBase< OtherDerived, WriteAccessors > &other)

Public Member Functions inherited from Eigen::TensorBase< Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const TensorChippingOp< DimId, const Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >	chip (const Index offset) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorChippingOp< DimId, Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >	chip (const Index offset)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const TensorChippingOp< Dynamic, const Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >	chip (const Index offset, const Index dim) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorChippingOp< Dynamic, Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >	chip (const Index offset, const Index dim)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const TensorConcatenationOp< const Axis, const Tensor< Scalar_, NumIndices_, Options_, IndexType_ >, const OtherDerived >	concatenate (const OtherDerived &other, const Axis &axis) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorConcatenationOp< const Axis, Tensor< Scalar_, NumIndices_, Options_, IndexType_ >, OtherDerived >	concatenate (const OtherDerived &other, const Axis &axis)

TensorDevice< Tensor< Scalar_, NumIndices_, Options_, IndexType_ >, DeviceType >	device (const DeviceType &device)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Tensor< Scalar_, NumIndices_, Options_, IndexType_ > &	operator*= (const OtherDerived &other)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Tensor< Scalar_, NumIndices_, Options_, IndexType_ > &	operator+= (const OtherDerived &other)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Tensor< Scalar_, NumIndices_, Options_, IndexType_ > &	operator-= (const OtherDerived &other)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Tensor< Scalar_, NumIndices_, Options_, IndexType_ > &	operator/= (const OtherDerived &other)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const TensorReshapingOp< const NewDimensions, const Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >	reshape (const NewDimensions &newDimensions) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorReshapingOp< const NewDimensions, Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >	reshape (const NewDimensions &newDimensions)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const TensorReverseOp< const ReverseDimensions, const Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >	reverse (const ReverseDimensions &rev) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorReverseOp< const ReverseDimensions, Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >	reverse (const ReverseDimensions &rev)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Tensor< Scalar_, NumIndices_, Options_, IndexType_ > &	setConstant (const Scalar &val)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Tensor< Scalar_, NumIndices_, Options_, IndexType_ > &	setRandom ()

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Tensor< Scalar_, NumIndices_, Options_, IndexType_ > &	setRandom ()

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Tensor< Scalar_, NumIndices_, Options_, IndexType_ > &	setZero ()

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const TensorShufflingOp< const Shuffle, const Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >	shuffle (const Shuffle &shuffle) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorShufflingOp< const Shuffle, Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >	shuffle (const Shuffle &shuffle)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const TensorSlicingOp< const StartIndices, const Sizes, const Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >	slice (const StartIndices &startIndices, const Sizes &sizes) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorSlicingOp< const StartIndices, const Sizes, Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >	slice (const StartIndices &startIndices, const Sizes &sizes)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const TensorStridingOp< const Strides, const Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >	stride (const Strides &strides) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorStridingOp< const Strides, Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >	stride (const Strides &strides)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const TensorStridingSlicingOp< const StartIndices, const StopIndices, const Strides, const Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >	stridedSlice (const StartIndices &startIndices, const StopIndices &stopIndices, const Strides &strides) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorStridingSlicingOp< const StartIndices, const StopIndices, const Strides, Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >	stridedSlice (const StartIndices &startIndices, const StopIndices &stopIndices, const Strides &strides)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const TensorLayoutSwapOp< const Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >	swap_layout () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TensorLayoutSwapOp< Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >	swap_layout ()

Static Public Attributes
static const int	NumIndices = NumIndices_

static const int	Options = Options_

Static Public Attributes inherited from Eigen::TensorBase< Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >
static const int	NumDimensions

Protected Member Functions
bool	checkIndexRange (const array< Index, NumIndices > &indices) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index	linearizedIndex (const array< Index, NumIndices > &indices) const

Protected Member Functions inherited from Eigen::TensorBase< Tensor< Scalar_, NumIndices_, Options_, IndexType_ > >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Tensor< Scalar_, NumIndices_, Options_, IndexType_ > &	derived ()

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Tensor< Scalar_, NumIndices_, Options_, IndexType_ > &	derived () const

Protected Attributes
TensorStorage< Scalar, Dimensions, Options >	m_storage

Detailed Description

template<typename Scalar_, int NumIndices_, int Options_, typename IndexType_>
class Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >

The tensor class.

The Tensor class is the work-horse for all dense tensors within Eigen.

The Tensor class encompasses only dynamic-size objects so far.

The first two template parameters are required:

Template Parameters

Scalar_	Numeric type, e.g. float, double, int or `std::complex<float>`. User defined scalar types are supported as well (see here).
NumIndices_	Number of indices (i.e. rank of the tensor)

The remaining template parameters are optional – in most cases you don't have to worry about them.

Template Parameters

Options_ A combination of either RowMajor or ColMajor, and of either AutoAlign or DontAlign. The former controls storage order, and defaults to column-major. The latter controls alignment, which is required for vectorization. It defaults to aligning tensors. Note that tensors currently do not support any operations that profit from vectorization. Support for such operations (i.e. adding two tensors etc.) is planned.

You can access elements of tensors using normal subscripting:

Eigen::Tensor<double, 4> t(10, 10, 10, 10);

t(0, 1, 2, 3) = 42.0;

This class can be extended with the help of the plugin mechanism described on the page Extending MatrixBase (and other classes) by defining the preprocessor symbol EIGEN_TENSOR_PLUGIN.

Some notes:

Relation to other parts of Eigen:: The midterm development goal for this class is to have a similar hierarchy as Eigen uses for matrices, so that taking blocks or using tensors in expressions is easily possible, including an interface with the vector/matrix code by providing .asMatrix() and .asVector() (or similar) methods for rank 2 and 1 tensors. However, currently, the Tensor class does not provide any of these features and is only available as a stand-alone class that just allows for coefficient access. Also, when fixed-size tensors are implemented, the number of template arguments is likely to change dramatically.

TopicStorageOrders

Definition at line 63 of file Tensor.h.