Public Types | Public Member Functions | Public Attributes

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

Public Attributes

XprType & m_xpr
Index m_row
Index m_col
Index m_currentBlockRows

Detailed Description

template<typename XprType>
class 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

template<typename XprType>
typedef XprType::Index CommaInitializer< XprType >::Index
template<typename XprType>
typedef XprType::Scalar CommaInitializer< XprType >::Scalar

Constructor & Destructor Documentation

template<typename XprType>
CommaInitializer< XprType >::CommaInitializer ( XprType &  xpr,
const Scalar s 
) [inline]
template<typename XprType>
template<typename OtherDerived >
CommaInitializer< XprType >::CommaInitializer ( XprType &  xpr,
const DenseBase< OtherDerived > &  other 
) [inline]
template<typename XprType>
CommaInitializer< XprType >::~CommaInitializer (  )  [inline]

Member Function Documentation

template<typename XprType>
XprType& 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());
template<typename XprType>
CommaInitializer& CommaInitializer< XprType >::operator, ( const Scalar s  )  [inline]
template<typename XprType>
template<typename OtherDerived >
CommaInitializer& CommaInitializer< XprType >::operator, ( const DenseBase< OtherDerived > &  other  )  [inline]

Member Data Documentation

template<typename XprType>
Index CommaInitializer< XprType >::m_col
template<typename XprType>
Index CommaInitializer< XprType >::m_currentBlockRows
template<typename XprType>
Index CommaInitializer< XprType >::m_row
template<typename XprType>
XprType& CommaInitializer< XprType >::m_xpr

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