Eigen::CommaInitializer< XprType > Class Template Reference

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

#include <CommaInitializer.h>

List of all members.

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

Definition at line 28 of file CommaInitializer.h.

---

Member Typedef Documentation

template<typename XprType>

typedef XprType::Index Eigen::CommaInitializer< XprType >::Index

Definition at line 31 of file CommaInitializer.h.

template<typename XprType>

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

Definition at line 30 of file CommaInitializer.h.

---

Constructor & Destructor Documentation

template<typename XprType>

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

Definition at line 33 of file CommaInitializer.h.

template<typename XprType>

template<typename OtherDerived >

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

Definition at line 40 of file CommaInitializer.h.

template<typename XprType>

Eigen::CommaInitializer< XprType >::~CommaInitializer

(

)

[inline]

Definition at line 91 of file CommaInitializer.h.

---

Member Function Documentation

template<typename XprType>

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 105 of file CommaInitializer.h.

template<typename XprType>

CommaInitializer& Eigen::CommaInitializer< XprType >::operator,

(

const Scalar &

s

)

[inline]

Definition at line 47 of file CommaInitializer.h.

template<typename XprType>

template<typename OtherDerived >

CommaInitializer& Eigen::CommaInitializer< XprType >::operator,

(

const DenseBase< OtherDerived > &

other

)

[inline]

Definition at line 66 of file CommaInitializer.h.

---

Member Data Documentation

template<typename XprType>

Index Eigen::CommaInitializer< XprType >::m_col

Definition at line 109 of file CommaInitializer.h.

template<typename XprType>

Index Eigen::CommaInitializer< XprType >::m_currentBlockRows

Definition at line 110 of file CommaInitializer.h.

template<typename XprType>

Index Eigen::CommaInitializer< XprType >::m_row

Definition at line 108 of file CommaInitializer.h.

template<typename XprType>

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

Definition at line 107 of file CommaInitializer.h.

---

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

• CommaInitializer.h