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

#include <CommaInitializer.h>

Public Types
typedef XprType::Index	Index
typedef XprType::Scalar	Scalar

Public Member Functions
	CommaInitializer (XprType &xpr, const Scalar &s)
template<typename OtherDerived >
	CommaInitializer (XprType &xpr, const DenseBase< OtherDerived > &other)
XprType &	finished ()
CommaInitializer &	operator, (const Scalar &s)
template<typename OtherDerived >
CommaInitializer &	operator, (const DenseBase< OtherDerived > &other)
	~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()

Member Typedef Documentation

typedef XprType::Index Index

typedef XprType::Scalar Scalar

Constructor & Destructor Documentation

CommaInitializer	(	XprType &	xpr,
		const Scalar &	s
	)

inline

References CommaInitializer< XprType >::m_xpr.

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

inline

References CommaInitializer< XprType >::m_xpr.

~CommaInitializer ( )

inline

References eigen_assert, CommaInitializer< XprType >::m_col, CommaInitializer< XprType >::m_currentBlockRows, CommaInitializer< XprType >::m_row, and CommaInitializer< XprType >::m_xpr.

Member Function Documentation

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

References CommaInitializer< XprType >::m_xpr.

CommaInitializer& operator, ( const Scalar & s )

inline

References eigen_assert, CommaInitializer< XprType >::m_col, CommaInitializer< XprType >::m_currentBlockRows, CommaInitializer< XprType >::m_row, and CommaInitializer< XprType >::m_xpr.

CommaInitializer& operator, ( const DenseBase< OtherDerived > & other )

inline

References block(), Eigen::Dynamic, eigen_assert, CommaInitializer< XprType >::m_col, CommaInitializer< XprType >::m_currentBlockRows, CommaInitializer< XprType >::m_row, and CommaInitializer< XprType >::m_xpr.