CommaInitializer< MatrixType > Class Template Reference

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

#include <CommaInitializer.h>

List of all members.

Public Types
typedef ei_traits< MatrixType > ::Scalar	Scalar
Public Member Functions
template<typename OtherDerived >
	CommaInitializer (MatrixType &mat, const MatrixBase< OtherDerived > &other)
	CommaInitializer (MatrixType &mat, const Scalar &s)
MatrixType &	finished ()
template<typename OtherDerived >
CommaInitializer &	operator, (const MatrixBase< OtherDerived > &other)
CommaInitializer &	operator, (const Scalar &s)
	~CommaInitializer ()
Public Attributes
int	m_col
int	m_currentBlockRows
MatrixType &	m_matrix
int	m_row
Private Member Functions
CommaInitializer &	operator= (const CommaInitializer &)

---

Detailed Description

template<typename MatrixType>
class CommaInitializer< MatrixType >

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

---

Member Typedef Documentation

template<typename MatrixType>

typedef ei_traits<MatrixType>::Scalar CommaInitializer< MatrixType >::Scalar

Definition at line 42 of file CommaInitializer.h.

---

Constructor & Destructor Documentation

template<typename MatrixType>

CommaInitializer< MatrixType >::CommaInitializer	(	MatrixType &	mat,
		const Scalar &	s
	)			[inline]

Definition at line 43 of file CommaInitializer.h.

template<typename MatrixType>

template<typename OtherDerived >

CommaInitializer< MatrixType >::CommaInitializer	(	MatrixType &	mat,
		const MatrixBase< OtherDerived > &	other
	)			[inline]

Definition at line 50 of file CommaInitializer.h.

template<typename MatrixType>

CommaInitializer< MatrixType >::~CommaInitializer

(

)

[inline]

Definition at line 99 of file CommaInitializer.h.

---

Member Function Documentation

template<typename MatrixType>

MatrixType& CommaInitializer< MatrixType >::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 113 of file CommaInitializer.h.

template<typename MatrixType>

template<typename OtherDerived >

CommaInitializer& CommaInitializer< MatrixType >::operator,

(

const MatrixBase< OtherDerived > &

other

)

[inline]

Definition at line 76 of file CommaInitializer.h.

template<typename MatrixType>

CommaInitializer& CommaInitializer< MatrixType >::operator,

(

const Scalar &

s

)

[inline]

Definition at line 57 of file CommaInitializer.h.

template<typename MatrixType>

CommaInitializer& CommaInitializer< MatrixType >::operator=

(

const CommaInitializer< MatrixType > &

)

[private]

---

Member Data Documentation

template<typename MatrixType>

int CommaInitializer< MatrixType >::m_col

Definition at line 117 of file CommaInitializer.h.

template<typename MatrixType>

int CommaInitializer< MatrixType >::m_currentBlockRows

Definition at line 118 of file CommaInitializer.h.

template<typename MatrixType>

MatrixType& CommaInitializer< MatrixType >::m_matrix

Definition at line 115 of file CommaInitializer.h.

template<typename MatrixType>

int CommaInitializer< MatrixType >::m_row

Definition at line 116 of file CommaInitializer.h.

---

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

• CommaInitializer.h