WithFormat< ExpressionType > Class Template Reference

Pseudo expression providing matrix output with given format. More...

List of all members.

Public Member Functions

 WithFormat (const ExpressionType &matrix, const IOFormat &format)

Protected Attributes

IOFormat m_format
const ExpressionType::Nested m_matrix

Friends

std::ostream & operator<< (std::ostream &s, const WithFormat &wf)

Detailed Description

template<typename ExpressionType>
class Eigen::WithFormat< ExpressionType >

Pseudo expression providing matrix output with given format.

Parameters:
ExpressionType the type of the object on which IO stream operations are performed

This class represents an expression with stream operators controlled by a given IOFormat. It is the return type of MatrixBase::format() and most of the time this is the only way it is used.

See class IOFormat for some examples.

See also:
MatrixBase::format(), class IOFormat

Friends And Related Function Documentation

std::ostream & operator<< ( std::ostream &  s,
const WithFormat< ExpressionType > &  wf 
) [friend]

Outputs the matrix, to the given stream.

If you wish to print the matrix with a format different than the default, use MatrixBase::format().

It is also possible to change the default format by defining EIGEN_DEFAULT_IO_FORMAT before including Eigen headers. If not defined, this will automatically be defined to Eigen::IOFormat(), that is the Eigen::IOFormat with default parameters.

See also:
MatrixBase::format()

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

Generated on Mon Aug 31 17:48:42 2009 for Eigen by  doxygen 1.6.1