Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Eigen::internal::mapbase_evaluator< Derived, PlainObjectType > Struct Template Reference

#include <CoreEvaluators.h>

+ Inheritance diagram for Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >:

Public Types

enum  { IsRowMajor = XprType::RowsAtCompileTime , ColsAtCompileTime = XprType::ColsAtCompileTime , CoeffReadCost = NumTraits<Scalar>::ReadCost }
 
typedef Derived XprType
 
typedef XprType::PointerType PointerType
 
typedef XprType::Scalar Scalar
 
typedef XprType::CoeffReturnType CoeffReturnType
 
- Public Types inherited from Eigen::internal::evaluator_base< Derived >
enum  
 
typedef traits< Derived > ExpressionTraits
 

Public Member Functions

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE mapbase_evaluator (const XprType &map)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType coeff (Index row, Index col) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType coeff (Index index) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & coeffRef (Index row, Index col)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & coeffRef (Index index)
 
template<int LoadMode, typename PacketType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE PacketType packet (Index row, Index col) const
 
template<int LoadMode, typename PacketType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE PacketType packet (Index index) const
 
template<int StoreMode, typename PacketType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void writePacket (Index row, Index col, const PacketType &x)
 
template<int StoreMode, typename PacketType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void writePacket (Index index, const PacketType &x)
 
- Public Member Functions inherited from Eigen::internal::evaluator_base< Derived >
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE evaluator_base ()=default
 

Protected Member Functions

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index rowStride () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index colStride () const EIGEN_NOEXCEPT
 

Protected Attributes

PointerType m_data
 
const internal::variable_if_dynamic< Index, XprType::InnerStrideAtCompileTime > m_innerStride
 
const internal::variable_if_dynamic< Index, XprType::OuterStrideAtCompileTime > m_outerStride
 

Member Typedef Documentation

◆ CoeffReturnType

template<typename Derived , typename PlainObjectType >
typedef XprType::CoeffReturnType Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::CoeffReturnType

◆ PointerType

template<typename Derived , typename PlainObjectType >
typedef XprType::PointerType Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::PointerType

◆ Scalar

template<typename Derived , typename PlainObjectType >
typedef XprType::Scalar Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::Scalar

◆ XprType

template<typename Derived , typename PlainObjectType >
typedef Derived Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::XprType

Member Enumeration Documentation

◆ anonymous enum

template<typename Derived , typename PlainObjectType >
anonymous enum
Enumerator
IsRowMajor 
ColsAtCompileTime 
CoeffReadCost 
1005  {
1006  IsRowMajor = XprType::RowsAtCompileTime,
1007  ColsAtCompileTime = XprType::ColsAtCompileTime,
1008  CoeffReadCost = NumTraits<Scalar>::ReadCost
1009  };
Eigen::GenericNumTraits::ReadCost
@ ReadCost
Definition: NumTraits.h:178
Eigen::internal::mapbase_evaluator::IsRowMajor
@ IsRowMajor
Definition: CoreEvaluators.h:1006
Eigen::internal::mapbase_evaluator::CoeffReadCost
@ CoeffReadCost
Definition: CoreEvaluators.h:1008
Eigen::internal::mapbase_evaluator::ColsAtCompileTime
@ ColsAtCompileTime
Definition: CoreEvaluators.h:1007

Constructor & Destructor Documentation

◆ mapbase_evaluator()

template<typename Derived , typename PlainObjectType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::mapbase_evaluator ( const XprType &  map)
inlineexplicit
1012  : m_data(const_cast<PointerType>(map.data())),
1013  m_innerStride(map.innerStride()),
1014  m_outerStride(map.outerStride()) {
1015  EIGEN_STATIC_ASSERT(check_implication((evaluator<Derived>::Flags & PacketAccessBit) != 0,
1016  internal::inner_stride_at_compile_time<Derived>::ret == 1),
1017  PACKET_ACCESS_REQUIRES_TO_HAVE_INNER_STRIDE_FIXED_TO_1);
1018  EIGEN_INTERNAL_CHECK_COST_VALUE(CoeffReadCost);
1019  }
EIGEN_STATIC_ASSERT
#define EIGEN_STATIC_ASSERT(X, MSG)
Definition: StaticAssert.h:26
EIGEN_INTERNAL_CHECK_COST_VALUE
#define EIGEN_INTERNAL_CHECK_COST_VALUE(C)
Definition: StaticAssert.h:101
Eigen::PacketAccessBit
const unsigned int PacketAccessBit
Definition: Constants.h:97
Eigen::internal::check_implication
constexpr bool check_implication(bool a, bool b)
Definition: Meta.h:740
Eigen::internal::inner_stride_at_compile_time::ret
@ ret
Definition: DenseCoeffsBase.h:547
Eigen::internal::mapbase_evaluator::m_data
PointerType m_data
Definition: CoreEvaluators.h:1065
Eigen::internal::mapbase_evaluator::PointerType
XprType::PointerType PointerType
Definition: CoreEvaluators.h:1001
Eigen::internal::mapbase_evaluator::m_innerStride
const internal::variable_if_dynamic< Index, XprType::InnerStrideAtCompileTime > m_innerStride
Definition: CoreEvaluators.h:1066
Eigen::internal::mapbase_evaluator::m_outerStride
const internal::variable_if_dynamic< Index, XprType::OuterStrideAtCompileTime > m_outerStride
Definition: CoreEvaluators.h:1067

References Eigen::internal::check_implication(), Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::CoeffReadCost, EIGEN_INTERNAL_CHECK_COST_VALUE, EIGEN_STATIC_ASSERT, and Eigen::PacketAccessBit.

Member Function Documentation

◆ coeff() [1/2]

template<typename Derived , typename PlainObjectType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::coeff ( Index  index) const
inline
1025  {
1026  return m_data[index * m_innerStride.value()];
1027  }
Eigen::internal::variable_if_dynamic::value
static EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR T value()
Definition: XprHelper.h:161

References Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::m_data, Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::m_innerStride, and Eigen::internal::variable_if_dynamic< T, Value >::value().

◆ coeff() [2/2]

template<typename Derived , typename PlainObjectType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::coeff ( Index  row,
Index  col 
) const
inline
1021  {
1022  return m_data[col * colStride() + row * rowStride()];
1023  }
col
m col(1)
row
m row(1)
Eigen::internal::mapbase_evaluator::rowStride
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index rowStride() const EIGEN_NOEXCEPT
Definition: CoreEvaluators.h:1058
Eigen::internal::mapbase_evaluator::colStride
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index colStride() const EIGEN_NOEXCEPT
Definition: CoreEvaluators.h:1061

References col(), Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::colStride(), Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::m_data, row(), and Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::rowStride().

◆ coeffRef() [1/2]

template<typename Derived , typename PlainObjectType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::coeffRef ( Index  index)
inline
1033 { return m_data[index * m_innerStride.value()]; }

References Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::m_data, Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::m_innerStride, and Eigen::internal::variable_if_dynamic< T, Value >::value().

◆ coeffRef() [2/2]

template<typename Derived , typename PlainObjectType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::coeffRef ( Index  row,
Index  col 
)
inline
1029  {
1030  return m_data[col * colStride() + row * rowStride()];
1031  }

References col(), Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::colStride(), Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::m_data, row(), and Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::rowStride().

◆ colStride()

template<typename Derived , typename PlainObjectType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::colStride ( ) const
inlineprotected
1061  {
1062  return XprType::IsRowMajor ? m_innerStride.value() : m_outerStride.value();
1063  }

References Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::m_innerStride, Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::m_outerStride, and Eigen::internal::variable_if_dynamic< T, Value >::value().

Referenced by Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::coeff(), Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::coeffRef(), Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::packet(), and Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::writePacket().

◆ packet() [1/2]

template<typename Derived , typename PlainObjectType >
template<int LoadMode, typename PacketType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE PacketType Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::packet ( Index  index) const
inline
1042  {
1043  return internal::ploadt<PacketType, LoadMode>(m_data + index * m_innerStride.value());
1044  }

References Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::m_data, Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::m_innerStride, and Eigen::internal::variable_if_dynamic< T, Value >::value().

◆ packet() [2/2]

template<typename Derived , typename PlainObjectType >
template<int LoadMode, typename PacketType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE PacketType Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::packet ( Index  row,
Index  col 
) const
inline
1036  {
1037  PointerType ptr = m_data + row * rowStride() + col * colStride();
1038  return internal::ploadt<PacketType, LoadMode>(ptr);
1039  }

References col(), Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::colStride(), Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::m_data, row(), and Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::rowStride().

◆ rowStride()

template<typename Derived , typename PlainObjectType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::rowStride ( ) const
inlineprotected
1058  {
1059  return XprType::IsRowMajor ? m_outerStride.value() : m_innerStride.value();
1060  }

References Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::m_innerStride, Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::m_outerStride, and Eigen::internal::variable_if_dynamic< T, Value >::value().

Referenced by Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::coeff(), Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::coeffRef(), Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::packet(), and Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::writePacket().

◆ writePacket() [1/2]

template<typename Derived , typename PlainObjectType >
template<int StoreMode, typename PacketType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::writePacket ( Index  index,
const PacketType &  x 
)
inline
1053  {
1054  internal::pstoret<Scalar, PacketType, StoreMode>(m_data + index * m_innerStride.value(), x);
1055  }
plotDoE.x
list x
Definition: plotDoE.py:28

References Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::m_data, Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::m_innerStride, Eigen::internal::variable_if_dynamic< T, Value >::value(), and plotDoE::x.

◆ writePacket() [2/2]

template<typename Derived , typename PlainObjectType >
template<int StoreMode, typename PacketType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::writePacket ( Index  row,
Index  col,
const PacketType &  x 
)
inline
1047  {
1048  PointerType ptr = m_data + row * rowStride() + col * colStride();
1049  return internal::pstoret<Scalar, PacketType, StoreMode>(ptr, x);
1050  }

References col(), Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::colStride(), Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::m_data, row(), Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::rowStride(), and plotDoE::x.

Member Data Documentation

◆ m_data

template<typename Derived , typename PlainObjectType >
PointerType Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::m_data
protected

Referenced by Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::coeff(), Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::coeffRef(), Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::packet(), and Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::writePacket().

◆ m_innerStride

template<typename Derived , typename PlainObjectType >
const internal::variable_if_dynamic<Index, XprType::InnerStrideAtCompileTime> Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::m_innerStride
protected

Referenced by Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::coeff(), Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::coeffRef(), Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::colStride(), Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::packet(), Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::rowStride(), and Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::writePacket().

◆ m_outerStride

template<typename Derived , typename PlainObjectType >
const internal::variable_if_dynamic<Index, XprType::OuterStrideAtCompileTime> Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::m_outerStride
protected

Referenced by Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::colStride(), and Eigen::internal::mapbase_evaluator< Derived, PlainObjectType >::rowStride().

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