WPILibC++ 2023.4.3
Public Types | Public Member Functions | Protected Attributes | List of all members
Eigen::ForceAlignedAccess< ExpressionType > Class Template Reference
Core module

Enforce aligned packet loads and stores regardless of what is requested. More...

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/ForceAlignedAccess.h>

Inheritance diagram for Eigen::ForceAlignedAccess< ExpressionType >:

Public Types

typedef internal::dense_xpr_base< ForceAlignedAccess >::type Base
 

Public Member Functions

EIGEN_DEVICE_FUNC ForceAlignedAccess (const ExpressionType &matrix)
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index outerStride () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index innerStride () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC const CoeffReturnType coeff (Index row, Index col) const
 
EIGEN_DEVICE_FUNC Scalar & coeffRef (Index row, Index col)
 
EIGEN_DEVICE_FUNC const CoeffReturnType coeff (Index index) const
 
EIGEN_DEVICE_FUNC Scalar & coeffRef (Index index)
 
template<int LoadMode>
const PacketScalar packet (Index row, Index col) const
 
template<int LoadMode>
void writePacket (Index row, Index col, const PacketScalar &x)
 
template<int LoadMode>
const PacketScalar packet (Index index) const
 
template<int LoadMode>
void writePacket (Index index, const PacketScalar &x)
 
EIGEN_DEVICE_FUNC operator const ExpressionType & () const
 

Protected Attributes

const ExpressionType & m_expression
 

Detailed Description

template<typename ExpressionType>
class Eigen::ForceAlignedAccess< ExpressionType >

Enforce aligned packet loads and stores regardless of what is requested.

Parameters
ExpressionTypethe type of the object of which we are forcing aligned packet access

This class is the return type of MatrixBase::forceAlignedAccess() and most of the time this is the only way it is used.

See also
MatrixBase::forceAlignedAccess()

Member Typedef Documentation

◆ Base

template<typename ExpressionType >
typedef internal::dense_xpr_base<ForceAlignedAccess>::type Eigen::ForceAlignedAccess< ExpressionType >::Base

Constructor & Destructor Documentation

◆ ForceAlignedAccess()

template<typename ExpressionType >
EIGEN_DEVICE_FUNC Eigen::ForceAlignedAccess< ExpressionType >::ForceAlignedAccess ( const ExpressionType &  matrix)
inlineexplicit

Member Function Documentation

◆ coeff() [1/2]

template<typename ExpressionType >
EIGEN_DEVICE_FUNC const CoeffReturnType Eigen::ForceAlignedAccess< ExpressionType >::coeff ( Index  index) const
inline

◆ coeff() [2/2]

template<typename ExpressionType >
EIGEN_DEVICE_FUNC const CoeffReturnType Eigen::ForceAlignedAccess< ExpressionType >::coeff ( Index  row,
Index  col 
) const
inline

◆ coeffRef() [1/2]

template<typename ExpressionType >
EIGEN_DEVICE_FUNC Scalar & Eigen::ForceAlignedAccess< ExpressionType >::coeffRef ( Index  index)
inline

◆ coeffRef() [2/2]

template<typename ExpressionType >
EIGEN_DEVICE_FUNC Scalar & Eigen::ForceAlignedAccess< ExpressionType >::coeffRef ( Index  row,
Index  col 
)
inline

◆ cols()

template<typename ExpressionType >
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::ForceAlignedAccess< ExpressionType >::cols ( void  ) const
inline

◆ innerStride()

template<typename ExpressionType >
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::ForceAlignedAccess< ExpressionType >::innerStride ( ) const
inline

◆ operator const ExpressionType &()

template<typename ExpressionType >
EIGEN_DEVICE_FUNC Eigen::ForceAlignedAccess< ExpressionType >::operator const ExpressionType & ( ) const
inline

◆ outerStride()

template<typename ExpressionType >
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::ForceAlignedAccess< ExpressionType >::outerStride ( ) const
inline

◆ packet() [1/2]

template<typename ExpressionType >
template<int LoadMode>
const PacketScalar Eigen::ForceAlignedAccess< ExpressionType >::packet ( Index  index) const
inline

◆ packet() [2/2]

template<typename ExpressionType >
template<int LoadMode>
const PacketScalar Eigen::ForceAlignedAccess< ExpressionType >::packet ( Index  row,
Index  col 
) const
inline

◆ rows()

template<typename ExpressionType >
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::ForceAlignedAccess< ExpressionType >::rows ( void  ) const
inline

◆ writePacket() [1/2]

template<typename ExpressionType >
template<int LoadMode>
void Eigen::ForceAlignedAccess< ExpressionType >::writePacket ( Index  index,
const PacketScalar &  x 
)
inline

◆ writePacket() [2/2]

template<typename ExpressionType >
template<int LoadMode>
void Eigen::ForceAlignedAccess< ExpressionType >::writePacket ( Index  row,
Index  col,
const PacketScalar &  x 
)
inline

Member Data Documentation

◆ m_expression

template<typename ExpressionType >
const ExpressionType& Eigen::ForceAlignedAccess< ExpressionType >::m_expression
protected
The documentation for this class was generated from the following files: