Eigen::CommaInitializer< XprType > Class Template Reference

Helper class used by the comma initializer operator. More...

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

Public Types
typedef XprType::Scalar	Scalar

Public Member Functions
EIGEN_DEVICE_FUNC	CommaInitializer (XprType &xpr, const Scalar &s)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC	CommaInitializer (XprType &xpr, const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC	CommaInitializer (const CommaInitializer &o)
EIGEN_DEVICE_FUNC CommaInitializer &	operator, (const Scalar &s)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC CommaInitializer &	operator, (const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC	~CommaInitializer ()
EIGEN_DEVICE_FUNC XprType &	finished ()

Public Attributes
XprType &	m_xpr
Index	m_row
Index	m_col
Index	m_currentBlockRows

Detailed Description

template<typename XprType>
class Eigen::CommaInitializer< XprType >

Helper class used by the comma initializer operator.

This class is internally used to implement the comma initializer feature. It is the return type of MatrixBase::operator<<, and most of the time this is the only way it is used.

See also

\blank MatrixBase::operator<<, CommaInitializer::finished()

Member Typedef Documentation

Scalar

template<typename XprType >

typedef XprType::Scalar Eigen::CommaInitializer< XprType >::Scalar

Constructor & Destructor Documentation

CommaInitializer() [1/3]

template<typename XprType >

EIGEN_DEVICE_FUNC Eigen::CommaInitializer< XprType >::CommaInitializer ( XprType &  xpr, const Scalar &  s  )

inline

CommaInitializer() [2/3]

template<typename XprType >

template<typename OtherDerived >

EIGEN_DEVICE_FUNC Eigen::CommaInitializer< XprType >::CommaInitializer ( XprType &  xpr, const DenseBase< OtherDerived > &  other  )

inline

CommaInitializer() [3/3]

template<typename XprType >

EIGEN_DEVICE_FUNC Eigen::CommaInitializer< XprType >::CommaInitializer ( const CommaInitializer< XprType > &  o )

inline

~CommaInitializer()

template<typename XprType >

EIGEN_DEVICE_FUNC Eigen::CommaInitializer< XprType >::~CommaInitializer ( )

inline

Member Function Documentation

finished()

template<typename XprType >

EIGEN_DEVICE_FUNC XprType & Eigen::CommaInitializer< XprType >::finished ( )

inline

Returns

the built matrix once all its coefficients have been set. Calling finished is 100% optional. Its purpose is to write expressions like this:

quaternion.fromRotationMatrix((Matrix3f() << axis0, axis1, axis2).finished());

operator,() [1/2]

template<typename XprType >

template<typename OtherDerived >

EIGEN_DEVICE_FUNC CommaInitializer & Eigen::CommaInitializer< XprType >::operator, ( const DenseBase< OtherDerived > &  other )

inline

operator,() [2/2]

template<typename XprType >

EIGEN_DEVICE_FUNC CommaInitializer & Eigen::CommaInitializer< XprType >::operator, ( const Scalar &  s )

inline

Member Data Documentation

m_col

template<typename XprType >

Index Eigen::CommaInitializer< XprType >::m_col

m_currentBlockRows

template<typename XprType >

Index Eigen::CommaInitializer< XprType >::m_currentBlockRows

m_row

template<typename XprType >

Index Eigen::CommaInitializer< XprType >::m_row

m_xpr

template<typename XprType >

XprType& Eigen::CommaInitializer< XprType >::m_xpr

---

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

• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/util/ForwardDeclarations.h
• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/CommaInitializer.h