Eigen::CommaInitializer Class Reference

---

Detailed Description

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

List of all members.

Public Types
typedef XprType::Scalar	Scalar
typedef XprType::Index	Index
Public Member Functions
	CommaInitializer (XprType &xpr, const Scalar &s)
template<typename OtherDerived >
	CommaInitializer (XprType &xpr, const DenseBase< OtherDerived > &other)
CommaInitializer &	operator, (const Scalar &s)
template<typename OtherDerived >
CommaInitializer &	operator, (const DenseBase< OtherDerived > &other)
	~CommaInitializer ()
XprType &	finished ()
Public Attributes
XprType &	m_xpr
Index	m_row
Index	m_col
Index	m_currentBlockRows

---

Member Typedef Documentation

typedef XprType::Index Eigen::CommaInitializer::Index

Definition at line 45 of file Core.

typedef XprType::Scalar Eigen::CommaInitializer::Scalar

Definition at line 44 of file Core.

---

Constructor & Destructor Documentation

Eigen::CommaInitializer::CommaInitializer	(	XprType &	xpr,
		const Scalar &	s
	)		[inline]

Definition at line 47 of file Core.

template<typename OtherDerived >

Eigen::CommaInitializer::CommaInitializer	(	XprType &	xpr,
		const DenseBase< OtherDerived > &	other
	)		[inline]

Definition at line 54 of file Core.

Eigen::CommaInitializer::~CommaInitializer

(

)

[inline]

Definition at line 103 of file Core.

---

Member Function Documentation

XprType& Eigen::CommaInitializer::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 117 of file Core.

CommaInitializer& Eigen::CommaInitializer::operator,

(

const Scalar &

s

)

[inline]

Definition at line 61 of file Core.

template<typename OtherDerived >

CommaInitializer& Eigen::CommaInitializer::operator,

(

const DenseBase< OtherDerived > &

other

)

[inline]

Definition at line 80 of file Core.

---

Member Data Documentation

Index Eigen::CommaInitializer::m_col

Definition at line 121 of file Core.

Index Eigen::CommaInitializer::m_currentBlockRows

Definition at line 122 of file Core.

Index Eigen::CommaInitializer::m_row

Definition at line 120 of file Core.

XprType& Eigen::CommaInitializer::m_xpr

Definition at line 119 of file Core.