Eigen::CommaInitializer< XprType > Class Template Reference

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

#include <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 XprType &	finished ()
EIGEN_DEVICE_FUNC CommaInitializer &	operator, (const Scalar &s)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC CommaInitializer &	operator, (const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC	~CommaInitializer ()

Public Attributes
Index	m_col
Index	m_currentBlockRows
Index	m_row
XprType &	m_xpr

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

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

Definition at line 28 of file CommaInitializer.h.

Member Typedef Documentation

Scalar

template<typename XprType>

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

Definition at line 30 of file CommaInitializer.h.

Constructor & Destructor Documentation

CommaInitializer() [1/3]

template<typename XprType>

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

inline

Definition at line 33 of file CommaInitializer.h.

CommaInitializer() [2/3]

template<typename XprType>

template<typename OtherDerived >

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

inline

Definition at line 43 of file CommaInitializer.h.

CommaInitializer() [3/3]

template<typename XprType>

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

inline

Definition at line 55 of file CommaInitializer.h.

~CommaInitializer()

template<typename XprType>

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

inline

Definition at line 105 of file CommaInitializer.h.

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());

Definition at line 121 of file CommaInitializer.h.

operator,() [1/2]

template<typename XprType>

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

inline

Definition at line 65 of file CommaInitializer.h.

operator,() [2/2]

template<typename XprType>

template<typename OtherDerived >

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

inline

Definition at line 85 of file CommaInitializer.h.

Member Data Documentation

m_col

template<typename XprType>

Index Eigen::CommaInitializer< XprType >::m_col

Definition at line 130 of file CommaInitializer.h.

m_currentBlockRows

template<typename XprType>

Index Eigen::CommaInitializer< XprType >::m_currentBlockRows

Definition at line 131 of file CommaInitializer.h.

m_row

template<typename XprType>

Index Eigen::CommaInitializer< XprType >::m_row

Definition at line 129 of file CommaInitializer.h.

m_xpr

template<typename XprType>

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

Definition at line 128 of file CommaInitializer.h.

---

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

• CommaInitializer.h