The tensor class. More...

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

Classes
struct	isOfNormalIndex

Public Types
enum	{ IsAligned , CoordAccess , RawAccess }

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 Member Functions
Self &	base ()

const Self &	base () const

const Scalar &	coeff () const

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

template<typename CustomIndices >
const Scalar &	coeff (CustomIndices &indices) const

template<typename... IndexTypes>
const Scalar &	coeff (Index firstIndex, Index secondIndex, IndexTypes... otherIndices) const

const Scalar &	coeff (Index index) const

Scalar &	coeffRef ()

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

template<typename CustomIndices >
Scalar &	coeffRef (CustomIndices &indices)

template<typename... IndexTypes>
Scalar &	coeffRef (Index firstIndex, Index secondIndex, IndexTypes... otherIndices)

Scalar &	coeffRef (Index index)

Scalar *	data ()

const Scalar *	data () const

Index	dimension (std::size_t n) const

const Dimensions &	dimensions () const

Scalar &	operator() ()

const Scalar &	operator() () const

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

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

template<typename CustomIndices >
Scalar &	operator() (CustomIndices &indices)

template<typename CustomIndices >
const Scalar &	operator() (CustomIndices &indices) const

template<typename... IndexTypes>
Scalar &	operator() (Index firstIndex, Index secondIndex, IndexTypes... otherIndices)

template<typename... IndexTypes>
const Scalar &	operator() (Index firstIndex, Index secondIndex, IndexTypes... otherIndices) const

Scalar &	operator() (Index index)

const Scalar &	operator() (Index index) const

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

Tensor &	operator= (const Tensor &other)

Tensor &	operator= (Self &&other)

Scalar &	operator[] (Index index)

const Scalar &	operator[] (Index index) const

Index	rank () const

void	resize ()

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

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

template<typename FirstType , typename... OtherTypes>
void	resize (const Eigen::IndexList< FirstType, OtherTypes... > &dimensions)

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

template<typename CustomDimension >
void	resize (CustomDimension &dimensions)

template<typename... IndexTypes>
void	resize (Index firstDimension, IndexTypes... otherDimensions)

Index	size () const

	Tensor ()

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

	Tensor (const Self &other)

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

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

template<typename... IndexTypes>
	Tensor (Index firstDimension, IndexTypes... otherDimensions)

	Tensor (Self &&other)

Static Public Attributes
static constexpr int	Layout

static constexpr int	NumIndices

static constexpr int	Options

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

Index	linearizedIndex (const array< Index, NumIndices > &indices) 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;

Eigen::Tensor

The tensor class.

Definition: Tensor.h:67

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, EIGEN_TENSORBASE_PLUGIN, and EIGEN_READONLY_TENSORBASE_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.

Storage orders

Definition at line 66 of file Tensor.h.

Member Typedef Documentation

◆ Base

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

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

Definition at line 70 of file Tensor.h.

◆ CoeffReturnType

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

typedef Base::CoeffReturnType Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::CoeffReturnType

Definition at line 76 of file Tensor.h.

◆ Dimensions

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

typedef DSizes<Index, NumIndices_> Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::Dimensions

Definition at line 87 of file Tensor.h.

◆ Index

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

typedef internal::traits<Self>::Index Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::Index

Definition at line 73 of file Tensor.h.

◆ Nested

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

typedef Eigen::internal::nested<Self>::type Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::Nested

Definition at line 71 of file Tensor.h.

◆ RealScalar

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

typedef NumTraits<Scalar>::Real Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::RealScalar

Definition at line 75 of file Tensor.h.

◆ Scalar

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

typedef Scalar_ Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::Scalar

Definition at line 74 of file Tensor.h.

◆ Self

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

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

Definition at line 69 of file Tensor.h.

◆ StorageKind

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

typedef internal::traits<Self>::StorageKind Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::StorageKind

Definition at line 72 of file Tensor.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

anonymous enum

Enumerator
IsAligned
CoordAccess
RawAccess

Definition at line 78 of file Tensor.h.

          {
       IsAligned = (EIGEN_MAX_ALIGN_BYTES>0) && !(Options_&DontAlign),
       CoordAccess = true,
       RawAccess = true
     };

Constructor & Destructor Documentation

◆ Tensor() [1/7]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::Tensor ( )

inline

Definition at line 271 of file Tensor.h.

       : m_storage()
     {
     }

◆ Tensor() [2/7]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::Tensor ( const Self & other )

inline

Definition at line 277 of file Tensor.h.

       : Base(other), m_storage(other.m_storage)
     {
     }

◆ Tensor() [3/7]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

template<typename... IndexTypes>

Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::Tensor	(	Index	firstDimension,
		IndexTypes...	otherDimensions
	)

inline

Definition at line 283 of file Tensor.h.

         : m_storage(firstDimension, otherDimensions...)
     {
       // The number of dimensions used to construct a tensor must be equal to the rank of the tensor.
       EIGEN_STATIC_ASSERT(sizeof...(otherDimensions) + 1 == NumIndices, YOU_MADE_A_PROGRAMMING_MISTAKE)
     }

◆ Tensor() [4/7]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::Tensor ( const array< Index, NumIndices > & dimensions )

inlineexplicit

Normal Dimension

Definition at line 291 of file Tensor.h.

         : m_storage(internal::array_prod(dimensions), dimensions)
     {
       EIGEN_INITIALIZE_COEFFS_IF_THAT_OPTION_IS_ENABLED
     }

◆ Tensor() [5/7]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

template<typename OtherDerived >

Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::Tensor ( const TensorBase< OtherDerived, ReadOnlyAccessors > & other )

inline

Definition at line 299 of file Tensor.h.

     {
       typedef TensorAssignOp<Tensor, const OtherDerived> Assign;
       Assign assign(*this, other.derived());
       resize(TensorEvaluator<const Assign, DefaultDevice>(assign, DefaultDevice()).dimensions());
       internal::TensorExecutor<const Assign, DefaultDevice>::run(assign, DefaultDevice());
     }

◆ Tensor() [6/7]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

template<typename OtherDerived >

Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::Tensor ( const TensorBase< OtherDerived, WriteAccessors > & other )

inline

Definition at line 309 of file Tensor.h.

     {
       typedef TensorAssignOp<Tensor, const OtherDerived> Assign;
       Assign assign(*this, other.derived());
       resize(TensorEvaluator<const Assign, DefaultDevice>(assign, DefaultDevice()).dimensions());
       internal::TensorExecutor<const Assign, DefaultDevice>::run(assign, DefaultDevice());
     }

◆ Tensor() [7/7]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::Tensor ( Self && other )

inline

Definition at line 318 of file Tensor.h.

       : m_storage(std::move(other.m_storage))
     {
     }

Member Function Documentation

◆ base() [1/2]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

Self& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::base ( )

inline

Definition at line 111 of file Tensor.h.

111 { return *this; }

◆ base() [2/2]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

const Self& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::base ( ) const

inline

Definition at line 112 of file Tensor.h.

112 { return *this; }

◆ checkIndexRange()

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

bool Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::checkIndexRange ( const array< Index, NumIndices > & indices ) const

inlineprotected

Definition at line 438 of file Tensor.h.

     {
       using internal::array_apply_and_reduce;
       using internal::array_zip_and_reduce;
       using internal::greater_equal_zero_op;
       using internal::logical_and_op;
       using internal::lesser_op;
  
       return
         // check whether the indices are all >= 0
         array_apply_and_reduce<logical_and_op, greater_equal_zero_op>(indices) &&
         // check whether the indices fit in the dimensions
         array_zip_and_reduce<logical_and_op, lesser_op>(indices, m_storage.dimensions());
     }

◆ coeff() [1/5]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

const Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::coeff ( ) const

inline

Definition at line 138 of file Tensor.h.

     {
       EIGEN_STATIC_ASSERT(NumIndices == 0, YOU_MADE_A_PROGRAMMING_MISTAKE);
       return m_storage.data()[0];
     }

◆ coeff() [2/5]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

const Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::coeff ( const array< Index, NumIndices > & indices ) const

inline

Definition at line 123 of file Tensor.h.

     {
       eigen_internal_assert(checkIndexRange(indices));
       return m_storage.data()[linearizedIndex(indices)];
     }

◆ coeff() [3/5]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

template<typename CustomIndices >

const Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::coeff ( CustomIndices & indices ) const

inline

Definition at line 133 of file Tensor.h.

     {
         return coeff(internal::customIndices2Array<Index,NumIndices>(indices));
     }

◆ coeff() [4/5]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

template<typename... IndexTypes>

const Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::coeff	(	Index	firstIndex,
		Index	secondIndex,
		IndexTypes...	otherIndices
	)		const

inline

Definition at line 115 of file Tensor.h.

     {
       // The number of indices used to access a tensor coefficient must be equal to the rank of the tensor.
       EIGEN_STATIC_ASSERT(sizeof...(otherIndices) + 2 == NumIndices, YOU_MADE_A_PROGRAMMING_MISTAKE)
       return coeff(array<Index, NumIndices>{{firstIndex, secondIndex, otherIndices...}});
     }

◆ coeff() [5/5]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

const Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::coeff ( Index index ) const

inline

Definition at line 144 of file Tensor.h.

     {
       eigen_internal_assert(index >= 0 && index < size());
       return m_storage.data()[index];
     }

◆ coeffRef() [1/5]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::coeffRef ( )

inline

Definition at line 174 of file Tensor.h.

     {
       EIGEN_STATIC_ASSERT(NumIndices == 0, YOU_MADE_A_PROGRAMMING_MISTAKE);
       return m_storage.data()[0];
     }

◆ coeffRef() [2/5]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::coeffRef ( const array< Index, NumIndices > & indices )

inline

Definition at line 159 of file Tensor.h.

     {
       eigen_internal_assert(checkIndexRange(indices));
       return m_storage.data()[linearizedIndex(indices)];
     }

◆ coeffRef() [3/5]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

template<typename CustomIndices >

Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::coeffRef ( CustomIndices & indices )

inline

Definition at line 169 of file Tensor.h.

     {
         return coeffRef(internal::customIndices2Array<Index,NumIndices>(indices));
     }

◆ coeffRef() [4/5]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

template<typename... IndexTypes>

Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::coeffRef	(	Index	firstIndex,
		Index	secondIndex,
		IndexTypes...	otherIndices
	)

inline

Definition at line 151 of file Tensor.h.

     {
       // The number of indices used to access a tensor coefficient must be equal to the rank of the tensor.
       EIGEN_STATIC_ASSERT(sizeof...(otherIndices) + 2 == NumIndices, YOU_MADE_A_PROGRAMMING_MISTAKE)
       return coeffRef(array<Index, NumIndices>{{firstIndex, secondIndex, otherIndices...}});
     }

◆ coeffRef() [5/5]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::coeffRef ( Index index )

inline

Definition at line 180 of file Tensor.h.

     {
       eigen_internal_assert(index >= 0 && index < size());
       return m_storage.data()[index];
     }

◆ data() [1/2]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

Scalar* Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::data ( )

inline

Definition at line 105 of file Tensor.h.

105 { return m_storage.data(); }

◆ data() [2/2]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

const Scalar* Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::data ( ) const

inline

Definition at line 106 of file Tensor.h.

106 { return m_storage.data(); }

◆ dimension()

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

Index Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::dimension ( std::size_t n ) const

inline

Definition at line 102 of file Tensor.h.

102 { return m_storage.dimensions()[n]; }

n

int n

◆ dimensions()

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

const Dimensions& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::dimensions ( ) const

inline

Definition at line 103 of file Tensor.h.

103 { return m_storage.dimensions(); }

◆ linearizedIndex()

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

Index Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::linearizedIndex ( const array< Index, NumIndices > & indices ) const

inlineprotected

Definition at line 453 of file Tensor.h.

     {
       if (Options&RowMajor) {
         return m_storage.dimensions().IndexOfRowMajor(indices);
       } else {
         return m_storage.dimensions().IndexOfColMajor(indices);
       }
     }

◆ operator()() [1/10]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::operator() ( )

inline

Definition at line 257 of file Tensor.h.

     {
       EIGEN_STATIC_ASSERT(NumIndices == 0, YOU_MADE_A_PROGRAMMING_MISTAKE);
       return coeffRef();
     }

◆ operator()() [2/10]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

const Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::operator() ( ) const

inline

Definition at line 215 of file Tensor.h.

     {
       EIGEN_STATIC_ASSERT(NumIndices == 0, YOU_MADE_A_PROGRAMMING_MISTAKE);
       return coeff();
     }

◆ operator()() [3/10]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::operator() ( const array< Index, NumIndices > & indices )

inline

Definition at line 237 of file Tensor.h.

     {
       return coeffRef(indices);
     }

◆ operator()() [4/10]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

const Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::operator() ( const array< Index, NumIndices > & indices ) const

inline

Definition at line 204 of file Tensor.h.

     {
       return coeff(indices);
     }

◆ operator()() [5/10]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

template<typename CustomIndices >

Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::operator() ( CustomIndices & indices )

inline

Definition at line 246 of file Tensor.h.

     {
       return coeffRef(internal::customIndices2Array<Index,NumIndices>(indices));
     }

◆ operator()() [6/10]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

template<typename CustomIndices >

const Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::operator() ( CustomIndices & indices ) const

inline

Definition at line 198 of file Tensor.h.

     {
         return coeff(internal::customIndices2Array<Index,NumIndices>(indices));
     }

◆ operator()() [7/10]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

template<typename... IndexTypes>

Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::operator()	(	Index	firstIndex,
		Index	secondIndex,
		IndexTypes...	otherIndices
	)

inline

Definition at line 229 of file Tensor.h.

     {
       // The number of indices used to access a tensor coefficient must be equal to the rank of the tensor.
       EIGEN_STATIC_ASSERT(sizeof...(otherIndices) + 2 == NumIndices, YOU_MADE_A_PROGRAMMING_MISTAKE)
       return operator()(array<Index, NumIndices>{{firstIndex, secondIndex, otherIndices...}});
     }

◆ operator()() [8/10]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

template<typename... IndexTypes>

const Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::operator()	(	Index	firstIndex,
		Index	secondIndex,
		IndexTypes...	otherIndices
	)		const

inline

Definition at line 187 of file Tensor.h.

     {
       // The number of indices used to access a tensor coefficient must be equal to the rank of the tensor.
       EIGEN_STATIC_ASSERT(sizeof...(otherIndices) + 2 == NumIndices, YOU_MADE_A_PROGRAMMING_MISTAKE)
       return this->operator()(array<Index, NumIndices>{{firstIndex, secondIndex, otherIndices...}});
     }

◆ operator()() [9/10]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::operator() ( Index index )

inline

Definition at line 251 of file Tensor.h.

     {
       eigen_assert(index >= 0 && index < size());
       return coeffRef(index);
     }

◆ operator()() [10/10]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

const Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::operator() ( Index index ) const

inline

Definition at line 209 of file Tensor.h.

     {
       eigen_internal_assert(index >= 0 && index < size());
       return coeff(index);
     }

◆ operator=() [1/3]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

template<typename OtherDerived >

Tensor& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::operator= ( const OtherDerived & other )

inline

Definition at line 340 of file Tensor.h.

     {
       typedef TensorAssignOp<Tensor, const OtherDerived> Assign;
       Assign assign(*this, other);
       resize(TensorEvaluator<const Assign, DefaultDevice>(assign, DefaultDevice()).dimensions());
       internal::TensorExecutor<const Assign, DefaultDevice>::run(assign, DefaultDevice());
       return *this;
     }

◆ operator=() [2/3]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

Tensor& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::operator= ( const Tensor< Scalar_, NumIndices_, Options_, IndexType_ > & other )

inline

Definition at line 330 of file Tensor.h.

     {
       typedef TensorAssignOp<Tensor, const Tensor> Assign;
       Assign assign(*this, other);
       resize(TensorEvaluator<const Assign, DefaultDevice>(assign, DefaultDevice()).dimensions());
       internal::TensorExecutor<const Assign, DefaultDevice>::run(assign, DefaultDevice());
       return *this;
     }

◆ operator=() [3/3]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

Tensor& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::operator= ( Self && other )

inline

Definition at line 323 of file Tensor.h.

     {
       m_storage = std::move(other.m_storage);
       return *this;
     }

◆ operator[]() [1/2]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::operator[] ( Index index )

inline

Definition at line 263 of file Tensor.h.

     {
       // The bracket operator is only for vectors, use the parenthesis operator instead
       EIGEN_STATIC_ASSERT(NumIndices == 1, YOU_MADE_A_PROGRAMMING_MISTAKE)
       return coeffRef(index);
     }

◆ operator[]() [2/2]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

const Scalar& Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::operator[] ( Index index ) const

inline

Definition at line 221 of file Tensor.h.

     {
       // The bracket operator is only for vectors, use the parenthesis operator instead.
       EIGEN_STATIC_ASSERT(NumIndices == 1, YOU_MADE_A_PROGRAMMING_MISTAKE);
       return coeff(index);
     }

◆ rank()

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

Index Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::rank ( ) const

inline

Definition at line 101 of file Tensor.h.

101 { return NumIndices; }

◆ resize() [1/7]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

void Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::resize ( )

inline

Definition at line 385 of file Tensor.h.

     {
       EIGEN_STATIC_ASSERT(NumIndices == 0, YOU_MADE_A_PROGRAMMING_MISTAKE);
       // Nothing to do: rank 0 tensors have fixed size
     }

◆ resize() [2/7]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

void Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::resize ( const array< Index, NumIndices > & dimensions )

inline

Normal Dimension

Definition at line 358 of file Tensor.h.

     {
       int i;
       Index size = Index(1);
       for (i = 0; i < NumIndices; i++) {
         internal::check_rows_cols_for_overflow<Dynamic, Dynamic, Dynamic>::run(size, dimensions[i]);
         size *= dimensions[i];
       }
       #ifdef EIGEN_INITIALIZE_COEFFS
         bool size_changed = size != this->size();
         m_storage.resize(size, dimensions);
         if(size_changed) EIGEN_INITIALIZE_COEFFS_IF_THAT_OPTION_IS_ENABLED
       #else
         m_storage.resize(size, dimensions);
       #endif
     }

◆ resize() [3/7]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

void Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::resize ( const DSizes< Index, NumIndices > & dimensions )

inline

Definition at line 376 of file Tensor.h.

                                                                                {
       array<Index, NumIndices> dims;
       for (int i = 0; i < NumIndices; ++i) {
         dims[i] = dimensions[i];
       }
       resize(dims);
     }

◆ resize() [4/7]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

template<typename FirstType , typename... OtherTypes>

void Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::resize ( const Eigen::IndexList< FirstType, OtherTypes... > & dimensions )

inline

Definition at line 393 of file Tensor.h.

                                                                             {
       array<Index, NumIndices> dims;
       for (int i = 0; i < NumIndices; ++i) {
         dims[i] = static_cast<Index>(dimensions[i]);
       }
       resize(dims);
     }

◆ resize() [5/7]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

template<typename std::ptrdiff_t... Indices>

void Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::resize ( const Sizes< Indices... > & dimensions )

inline

Definition at line 413 of file Tensor.h.

                                                      {
       array<Index, NumIndices> dims;
       for (int i = 0; i < NumIndices; ++i) {
         dims[i] = static_cast<Index>(dimensions[i]);
       }
       resize(dims);
     }

◆ resize() [6/7]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

template<typename CustomDimension >

void Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::resize ( CustomDimension & dimensions )

inline

Custom Dimension

Definition at line 405 of file Tensor.h.

     {
       resize(internal::customIndices2Array<Index,NumIndices>(dimensions));
     }

◆ resize() [7/7]

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

template<typename... IndexTypes>

void Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::resize	(	Index	firstDimension,
		IndexTypes...	otherDimensions
	)

inline

Definition at line 350 of file Tensor.h.

     {
       // The number of dimensions used to resize a tensor must be equal to the rank of the tensor.
       EIGEN_STATIC_ASSERT(sizeof...(otherDimensions) + 1 == NumIndices, YOU_MADE_A_PROGRAMMING_MISTAKE)
       resize(array<Index, NumIndices>{{firstDimension, otherDimensions...}});
     }

◆ size()

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

Index Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::size ( ) const

inline

Definition at line 104 of file Tensor.h.

104 { return m_storage.size(); }

Eigen::TensorStorage::size

DenseIndex size() const

Definition: TensorStorage.h:64

Member Data Documentation

◆ Layout

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

constexpr int Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::Layout

staticconstexpr

Definition at line 84 of file Tensor.h.

◆ m_storage

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

TensorStorage<Scalar, Dimensions, Options> Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::m_storage

protected

Definition at line 90 of file Tensor.h.

◆ NumIndices

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

constexpr int Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::NumIndices

staticconstexpr

Definition at line 86 of file Tensor.h.

◆ Options

template<typename Scalar_ , int NumIndices_, int Options_, typename IndexType_ >

constexpr int Eigen::Tensor< Scalar_, NumIndices_, Options_, IndexType_ >::Options

staticconstexpr

Definition at line 85 of file Tensor.h.

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

Tensor.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

◆ Base

◆ CoeffReturnType

◆ Dimensions

◆ Index

◆ Nested

◆ RealScalar

◆ Scalar

◆ Self

◆ StorageKind

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ Tensor() [1/7]

◆ Tensor() [2/7]

◆ Tensor() [3/7]

◆ Tensor() [4/7]

◆ Tensor() [5/7]

◆ Tensor() [6/7]

◆ Tensor() [7/7]

Member Function Documentation

◆ base() [1/2]

◆ base() [2/2]

◆ checkIndexRange()

◆ coeff() [1/5]

◆ coeff() [2/5]

◆ coeff() [3/5]

◆ coeff() [4/5]

◆ coeff() [5/5]

◆ coeffRef() [1/5]

◆ coeffRef() [2/5]

◆ coeffRef() [3/5]

◆ coeffRef() [4/5]

◆ coeffRef() [5/5]

◆ data() [1/2]

◆ data() [2/2]

◆ dimension()

◆ dimensions()

◆ linearizedIndex()

◆ operator()() [1/10]

◆ operator()() [2/10]

◆ operator()() [3/10]

◆ operator()() [4/10]

◆ operator()() [5/10]

◆ operator()() [6/10]

◆ operator()() [7/10]

◆ operator()() [8/10]

◆ operator()() [9/10]

◆ operator()() [10/10]

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ rank()

◆ resize() [1/7]

◆ resize() [2/7]

◆ resize() [3/7]

◆ resize() [4/7]

◆ resize() [5/7]

◆ resize() [6/7]

◆ resize() [7/7]

◆ size()

Member Data Documentation

◆ Layout

◆ m_storage

◆ NumIndices

◆ Options

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