A cost model used to limit the number of threads used for evaluating tensor expression. More...

Public Types
enum	{ IsAligned , PacketAccess }

typedef Derived::Scalar	CoeffReturnType

typedef Derived::Dimensions	Dimensions

typedef Storage::Type	EvaluatorPointerType

typedef Derived::Index	Index

typedef PacketType< CoeffReturnType, Device >::type	PacketReturnType

typedef Derived::Scalar	Scalar

typedef std::remove_const_t< Scalar >	ScalarNoConst

typedef StorageMemory< Scalar, Device >	Storage

typedef internal::TensorMaterializedBlock< ScalarNoConst, NumCoords, Layout, Index >	TensorBlock

typedef internal::TensorBlockDescriptor< NumCoords, Index >	TensorBlockDesc

typedef internal::TensorBlockScratchAllocator< Device >	TensorBlockScratch

typedef internal::traits< Derived >::template MakePointer< Scalar >::Type	TensorPointerType

typedef Derived	XprType

Public Member Functions
TensorBlock	block (TensorBlockDesc &desc, TensorBlockScratch &scratch, bool=false) const

void	cleanup ()

CoeffReturnType	coeff (const array< DenseIndex, NumCoords > &coords) const

CoeffReturnType	coeff (Index index) const

CoeffReturnType &	coeffRef (const array< DenseIndex, NumCoords > &coords) const

CoeffReturnType &	coeffRef (Index index) const

TensorOpCost	costPerCoeff (bool vectorized) const

EvaluatorPointerType	data () const

const Dimensions &	dimensions () const

bool	evalSubExprsIfNeeded (EvaluatorPointerType dest)

internal::TensorBlockResourceRequirements	getResourceRequirements () const

template<int LoadMode>
PacketReturnType	packet (Index index) const

template<typename PacketReturnTypeT >
std::enable_if_t< internal::unpacket_traits< PacketReturnTypeT >::masked_load_available, PacketReturnTypeT >	partialPacket (Index index, typename internal::unpacket_traits< PacketReturnTypeT >::mask_t umask) const

	TensorEvaluator (const Derived &m, const Device &device)

template<typename TensorBlock >
void	writeBlock (const TensorBlockDesc &desc, const TensorBlock &block)

template<int StoreMode>
void	writePacket (Index index, const PacketReturnType &x) const

Static Public Attributes
static constexpr int	Layout

static constexpr int	NumCoords

static constexpr int	PacketSize

Protected Attributes
EvaluatorPointerType	m_data

const Device EIGEN_DEVICE_REF	m_device

Dimensions	m_dims

Detailed Description

template<typename Derived, typename Device>
class Eigen::TensorEvaluator< Derived, Device >

A cost model used to limit the number of threads used for evaluating tensor expression.

The tensor evaluator classes.

These classes are responsible for the evaluation of the tensor expression.

TODO: add support for more types of expressions, in particular expressions leading to lvalues (slicing, reshaping, etc...)

Definition at line 30 of file TensorEvaluator.h.

Member Typedef Documentation

◆ CoeffReturnType

template<typename Derived , typename Device >

typedef Derived::Scalar Eigen::TensorEvaluator< Derived, Device >::CoeffReturnType

Examples: /home/runner/work/eigen/eigen/unsupported/Eigen/CXX11/src/Tensor/TensorLayoutSwap.h.

Definition at line 34 of file TensorEvaluator.h.

◆ Dimensions

template<typename Derived , typename Device >

typedef Derived::Dimensions Eigen::TensorEvaluator< Derived, Device >::Dimensions

Examples: /home/runner/work/eigen/eigen/unsupported/Eigen/CXX11/src/Tensor/TensorLayoutSwap.h.

Definition at line 36 of file TensorEvaluator.h.

◆ EvaluatorPointerType

template<typename Derived , typename Device >

typedef Storage::Type Eigen::TensorEvaluator< Derived, Device >::EvaluatorPointerType

Examples: /home/runner/work/eigen/eigen/unsupported/Eigen/CXX11/src/Tensor/TensorLayoutSwap.h.

Definition at line 41 of file TensorEvaluator.h.

◆ Index

template<typename Derived , typename Device >

typedef Derived::Index Eigen::TensorEvaluator< Derived, Device >::Index

Examples: /home/runner/work/eigen/eigen/unsupported/Eigen/CXX11/src/Tensor/TensorLayoutSwap.h.

Definition at line 32 of file TensorEvaluator.h.

◆ PacketReturnType

template<typename Derived , typename Device >

typedef PacketType<CoeffReturnType, Device>::type Eigen::TensorEvaluator< Derived, Device >::PacketReturnType

Examples: /home/runner/work/eigen/eigen/unsupported/Eigen/CXX11/src/Tensor/TensorLayoutSwap.h.

Definition at line 35 of file TensorEvaluator.h.

◆ Scalar

template<typename Derived , typename Device >

typedef Derived::Scalar Eigen::TensorEvaluator< Derived, Device >::Scalar

Examples: /home/runner/work/eigen/eigen/unsupported/Eigen/CXX11/src/Tensor/TensorLayoutSwap.h.

Definition at line 33 of file TensorEvaluator.h.

◆ ScalarNoConst

template<typename Derived , typename Device >

typedef std::remove_const_t<Scalar> Eigen::TensorEvaluator< Derived, Device >::ScalarNoConst

Definition at line 57 of file TensorEvaluator.h.

◆ Storage

template<typename Derived , typename Device >

typedef StorageMemory<Scalar, Device> Eigen::TensorEvaluator< Derived, Device >::Storage

Examples: /home/runner/work/eigen/eigen/unsupported/Eigen/CXX11/src/Tensor/TensorLayoutSwap.h.

Definition at line 40 of file TensorEvaluator.h.

◆ TensorBlock

template<typename Derived , typename Device >

typedef internal::TensorMaterializedBlock<ScalarNoConst, NumCoords, Layout, Index> Eigen::TensorEvaluator< Derived, Device >::TensorBlock

Examples: /home/runner/work/eigen/eigen/unsupported/Eigen/CXX11/src/Tensor/TensorLayoutSwap.h.

Definition at line 65 of file TensorEvaluator.h.

◆ TensorBlockDesc

template<typename Derived , typename Device >

typedef internal::TensorBlockDescriptor<NumCoords, Index> Eigen::TensorEvaluator< Derived, Device >::TensorBlockDesc

Definition at line 60 of file TensorEvaluator.h.

◆ TensorBlockScratch

template<typename Derived , typename Device >

typedef internal::TensorBlockScratchAllocator<Device> Eigen::TensorEvaluator< Derived, Device >::TensorBlockScratch

Definition at line 61 of file TensorEvaluator.h.

◆ TensorPointerType

template<typename Derived , typename Device >

typedef internal::traits<Derived>::template MakePointer<Scalar>::Type Eigen::TensorEvaluator< Derived, Device >::TensorPointerType

Definition at line 39 of file TensorEvaluator.h.

◆ XprType

template<typename Derived , typename Device >

typedef Derived Eigen::TensorEvaluator< Derived, Device >::XprType

Examples: /home/runner/work/eigen/eigen/unsupported/Eigen/CXX11/src/Tensor/TensorLayoutSwap.h.

Definition at line 37 of file TensorEvaluator.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename Derived , typename Device >

anonymous enum

Enumerator
IsAligned
PacketAccess

Definition at line 48 of file TensorEvaluator.h.

        {
     IsAligned          = Derived::IsAligned,
     PacketAccess       = (PacketType<CoeffReturnType, Device>::size > 1),
     BlockAccess        = internal::is_arithmetic<std::remove_const_t<Scalar>>::value,
     PreferBlockAccess  = false,
     CoordAccess        = NumCoords > 0,
     RawAccess          = true
   };

Constructor & Destructor Documentation

◆ TensorEvaluator()

template<typename Derived , typename Device >

Eigen::TensorEvaluator< Derived, Device >::TensorEvaluator	(	const Derived &	m,
		const Device &	device
	)

inline

Examples: /home/runner/work/eigen/eigen/unsupported/Eigen/CXX11/src/Tensor/TensorLayoutSwap.h.

Definition at line 69 of file TensorEvaluator.h.

       : m_data(device.get((const_cast<TensorPointerType>(m.data())))),
         m_dims(m.dimensions()),
         m_device(device)
   { }

Member Function Documentation

◆ block()

template<typename Derived , typename Device >

TensorBlock Eigen::TensorEvaluator< Derived, Device >::block	(	TensorBlockDesc &	desc,
		TensorBlockScratch &	scratch,
		bool	= `false`
	)		const

inline

Definition at line 161 of file TensorEvaluator.h.

                                 {
     eigen_assert(m_data != NULL);
     return TensorBlock::materialize(m_data, m_dims, desc, scratch);
   }

◆ cleanup()

template<typename Derived , typename Device >

void Eigen::TensorEvaluator< Derived, Device >::cleanup ( )

inline

Examples: /home/runner/work/eigen/eigen/unsupported/Eigen/CXX11/src/Tensor/TensorLayoutSwap.h.

Definition at line 95 of file TensorEvaluator.h.

95 {}

◆ coeff() [1/2]

template<typename Derived , typename Device >

CoeffReturnType Eigen::TensorEvaluator< Derived, Device >::coeff ( const array< DenseIndex, NumCoords > & coords ) const

inline

Definition at line 131 of file TensorEvaluator.h.

                                                                                                                 {
     eigen_assert(m_data != NULL);
     if (static_cast<int>(Layout) == static_cast<int>(ColMajor)) {
       return m_data[m_dims.IndexOfColMajor(coords)];
     } else {
       return m_data[m_dims.IndexOfRowMajor(coords)];
     }
   }

◆ coeff() [2/2]

template<typename Derived , typename Device >

CoeffReturnType Eigen::TensorEvaluator< Derived, Device >::coeff ( Index index ) const

inline

Examples: /home/runner/work/eigen/eigen/unsupported/Eigen/CXX11/src/Tensor/TensorLayoutSwap.h.

Definition at line 97 of file TensorEvaluator.h.

                                                                                  {
     eigen_assert(m_data != NULL);
     return m_data[index];
   }

◆ coeffRef() [1/2]

template<typename Derived , typename Device >

CoeffReturnType& Eigen::TensorEvaluator< Derived, Device >::coeffRef ( const array< DenseIndex, NumCoords > & coords ) const

inline

Definition at line 141 of file TensorEvaluator.h.

                                                              {
     eigen_assert(m_data != NULL);
     if (static_cast<int>(Layout) == static_cast<int>(ColMajor)) {
       return m_data[m_dims.IndexOfColMajor(coords)];
     } else {
       return m_data[m_dims.IndexOfRowMajor(coords)];
     }
   }

◆ coeffRef() [2/2]

template<typename Derived , typename Device >

CoeffReturnType& Eigen::TensorEvaluator< Derived, Device >::coeffRef ( Index index ) const

inline

Examples: /home/runner/work/eigen/eigen/unsupported/Eigen/CXX11/src/Tensor/TensorLayoutSwap.h.

Definition at line 102 of file TensorEvaluator.h.

                                                                                     {
     eigen_assert(m_data != NULL);
     return m_data[index];
   }

◆ costPerCoeff()

template<typename Derived , typename Device >

TensorOpCost Eigen::TensorEvaluator< Derived, Device >::costPerCoeff ( bool vectorized ) const

inline

Examples: /home/runner/work/eigen/eigen/unsupported/Eigen/CXX11/src/Tensor/TensorLayoutSwap.h.

Definition at line 150 of file TensorEvaluator.h.

                                                                                          {
     return TensorOpCost(sizeof(CoeffReturnType), 0, 0, vectorized,
                         PacketType<CoeffReturnType, Device>::size);
   }

◆ data()

template<typename Derived , typename Device >

EvaluatorPointerType Eigen::TensorEvaluator< Derived, Device >::data ( ) const

inline

Examples: /home/runner/work/eigen/eigen/unsupported/Eigen/CXX11/src/Tensor/TensorLayoutSwap.h.

Definition at line 184 of file TensorEvaluator.h.

184 { return m_data; }

◆ dimensions()

template<typename Derived , typename Device >

const Dimensions& Eigen::TensorEvaluator< Derived, Device >::dimensions ( ) const

inline

Examples: /home/runner/work/eigen/eigen/unsupported/Eigen/CXX11/src/Tensor/TensorLayoutSwap.h.

Definition at line 76 of file TensorEvaluator.h.

76 { return m_dims; }

◆ evalSubExprsIfNeeded()

template<typename Derived , typename Device >

bool Eigen::TensorEvaluator< Derived, Device >::evalSubExprsIfNeeded ( EvaluatorPointerType dest )

inline

Examples: /home/runner/work/eigen/eigen/unsupported/Eigen/CXX11/src/Tensor/TensorLayoutSwap.h.

Definition at line 78 of file TensorEvaluator.h.

                                                                            {
     if (!NumTraits<std::remove_const_t<Scalar>>::RequireInitialization && dest) {
       m_device.memcpy((void*)(m_device.get(dest)), m_device.get(m_data), m_dims.TotalSize() * sizeof(Scalar));
       return false;
     }
     return true;
   }

◆ getResourceRequirements()

template<typename Derived , typename Device >

internal::TensorBlockResourceRequirements Eigen::TensorEvaluator< Derived, Device >::getResourceRequirements ( ) const

inline

Definition at line 156 of file TensorEvaluator.h.

                                                                           {
     return internal::TensorBlockResourceRequirements::any();
   }

◆ packet()

template<typename Derived , typename Device >

template<int LoadMode>

PacketReturnType Eigen::TensorEvaluator< Derived, Device >::packet ( Index index ) const

inline

Examples: /home/runner/work/eigen/eigen/unsupported/Eigen/CXX11/src/Tensor/TensorLayoutSwap.h.

Definition at line 108 of file TensorEvaluator.h.

   {
     return internal::ploadt<PacketReturnType, LoadMode>(m_data + index);
   }

◆ partialPacket()

template<typename Derived , typename Device >

template<typename PacketReturnTypeT >

std::enable_if_t<internal::unpacket_traits<PacketReturnTypeT>::masked_load_available, PacketReturnTypeT> Eigen::TensorEvaluator< Derived, Device >::partialPacket	(	Index	index,
		typename internal::unpacket_traits< PacketReturnTypeT >::mask_t	umask
	)		const

inline

Definition at line 120 of file TensorEvaluator.h.

   {
     return internal::ploadu<PacketReturnTypeT>(m_data + index, umask);
   }

◆ writeBlock()

template<typename Derived , typename Device >

template<typename TensorBlock >

void Eigen::TensorEvaluator< Derived, Device >::writeBlock	(	const TensorBlockDesc &	desc,
		const TensorBlock &	block
	)

inline

Definition at line 168 of file TensorEvaluator.h.

                                                              {
     eigen_assert(m_data != NULL);
  
     typedef typename TensorBlock::XprType TensorBlockExpr;
     typedef internal::TensorBlockAssignment<Scalar, NumCoords, TensorBlockExpr,
                                             Index>
         TensorBlockAssign;
  
     TensorBlockAssign::Run(
         TensorBlockAssign::target(desc.dimensions(),
                                   internal::strides<Layout>(m_dims), m_data,
                                   desc.offset()),
         block.expr());
   }

◆ writePacket()

template<typename Derived , typename Device >

template<int StoreMode>

void Eigen::TensorEvaluator< Derived, Device >::writePacket	(	Index	index,
		const PacketReturnType &	x
	)		const

inline

Examples: /home/runner/work/eigen/eigen/unsupported/Eigen/CXX11/src/Tensor/TensorLayoutSwap.h.

Definition at line 126 of file TensorEvaluator.h.

   {
     return internal::pstoret<Scalar, PacketReturnType, StoreMode>(m_data + index, x);
   }

Member Data Documentation

◆ Layout

template<typename Derived , typename Device >

constexpr int Eigen::TensorEvaluator< Derived, Device >::Layout

staticconstexpr

Examples: /home/runner/work/eigen/eigen/unsupported/Eigen/CXX11/src/Tensor/TensorLayoutSwap.h.

Definition at line 46 of file TensorEvaluator.h.

◆ m_data

template<typename Derived , typename Device >

EvaluatorPointerType Eigen::TensorEvaluator< Derived, Device >::m_data

protected

Definition at line 187 of file TensorEvaluator.h.

◆ m_device

template<typename Derived , typename Device >

const Device EIGEN_DEVICE_REF Eigen::TensorEvaluator< Derived, Device >::m_device

protected

Definition at line 189 of file TensorEvaluator.h.

◆ m_dims

template<typename Derived , typename Device >

Dimensions Eigen::TensorEvaluator< Derived, Device >::m_dims

protected

Definition at line 188 of file TensorEvaluator.h.

◆ NumCoords

template<typename Derived , typename Device >

constexpr int Eigen::TensorEvaluator< Derived, Device >::NumCoords

staticconstexpr

Definition at line 44 of file TensorEvaluator.h.

◆ PacketSize

template<typename Derived , typename Device >

constexpr int Eigen::TensorEvaluator< Derived, Device >::PacketSize

staticconstexpr

Definition at line 38 of file TensorEvaluator.h.

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

TensorEvaluator.h

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

template<typename Derived, typename Device> class Eigen::TensorEvaluator< Derived, Device >

Member Typedef Documentation

◆ CoeffReturnType

◆ Dimensions

◆ EvaluatorPointerType

◆ Index

◆ PacketReturnType

◆ Scalar

◆ ScalarNoConst

◆ Storage

◆ TensorBlock

◆ TensorBlockDesc

◆ TensorBlockScratch

◆ TensorPointerType

◆ XprType

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ TensorEvaluator()

Member Function Documentation

◆ block()

◆ cleanup()

◆ coeff() [1/2]

◆ coeff() [2/2]

◆ coeffRef() [1/2]

◆ coeffRef() [2/2]

◆ costPerCoeff()

◆ data()

◆ dimensions()

◆ evalSubExprsIfNeeded()

◆ getResourceRequirements()

◆ packet()

◆ partialPacket()

◆ writeBlock()

◆ writePacket()

Member Data Documentation

◆ Layout

◆ m_data

◆ m_device

◆ m_dims

◆ NumCoords

◆ PacketSize

template<typename Derived, typename Device>
class Eigen::TensorEvaluator< Derived, Device >