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

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]
CommaInitializer& operator, ( const DenseBase< OtherDerived > &  other) [inline]

Member Data Documentation

XprType& m_xpr

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