Formatter for Eigen matrix type. More...

#include <formatters.hpp>

Inheritance diagram for Eigen::FloatMatrixFormatter< Derived >:

Public Member Functions
	FloatMatrixFormatter (const int &w=-1, const unsigned int &p=2)
	Default constructor.
FloatMatrixFormatter< Derived > &	operator() (const Derived &matrix)
	Format a matrix with permanently stored precision/width.
FloatMatrixFormatter< Derived > &	operator() (const Derived &matrix, const int &w, const unsigned int &p)
	Format a matrix with temporarily specified precision/width.
FloatMatrixFormatter< Derived > &	precision (const unsigned int &p)
	Sets the precision format parameter.
unsigned int	precision ()
	Returns the current precision setting.
FloatMatrixFormatter< Derived > &	width (const int &w)
	Sets the width format parameter.
int	width ()
	Returns the current width setting.
virtual	~FloatMatrixFormatter ()
Private Attributes
const Derived *	_matrix
ecl::Format< typename Derived::Scalar >	format
	Stream the formatter.
bool	ready_to_format
bool	tmp_formatting
unsigned int	tmp_precision
int	tmp_width

Detailed Description

template<typename Derived>
class Eigen::FloatMatrixFormatter< Derived >

Formatter for Eigen matrix type.

I want make it formatting any types of eigen

Template Parameters:

Derived : MatrixBase's type which specify the matrix as vector, matrix with any storage type

Todo:: specialise the formatting; now it just support the float type only.

Definition at line 61 of file eigen/formatters.hpp.

Constructor & Destructor Documentation

template<typename Derived >

Eigen::FloatMatrixFormatter< Derived >::FloatMatrixFormatter	(	const int &	w = `-1`,
		const unsigned int &	p = `2`
	)		`[inline]`

Default constructor.

Initialises the format tags for width, and precision.

Parameters:

w	: width (default - no width constraints)
p	: the number of decimal places of precision (default - 4)

Definition at line 73 of file eigen/formatters.hpp.

template<typename Derived >

virtual Eigen::FloatMatrixFormatter< Derived >::~FloatMatrixFormatter ( ) [inline, virtual]

Definition at line 81 of file eigen/formatters.hpp.

Member Function Documentation

template<typename Derived >

FloatMatrixFormatter< Derived >& Eigen::FloatMatrixFormatter< Derived >::operator() ( const Derived & matrix ) [inline]

Format a matrix with permanently stored precision/width.

This function directly formats the specified input value with the stored settings.

 Vector2d v; v << 1.0, 2.0;
 Format<Vector2d> format;
 cout << format(v) << endl;

Parameters:

matrix : the matrix to be formatted (gets temporarily stored as a pointer).

Returns:: FloatMatrixFormatter& : this formatter readied for use with a stream.

Definition at line 140 of file eigen/formatters.hpp.

template<typename Derived >

FloatMatrixFormatter< Derived >& Eigen::FloatMatrixFormatter< Derived >::operator()	(	const Derived &	matrix,
		const int &	w,
		const unsigned int &	p
	)		`[inline]`

Format a matrix with temporarily specified precision/width.

This function directly formats the specified input value and temporary settings.

 Vector2d v; v << 1.0, 2.0;
 Format<Vector2d> format;
 cout << format(v,3,-1) << endl; // precision of 3 and no width constraint

Parameters:

matrix	: the matrix to be formatted (gets temporarily stored as a pointer).
w	: the width to use for inserted floats (-1 is no width constraint).
p	: the number of decimal places of precision.

Returns:: FloatMatrixFormatter& : this formatter readied for use with a stream.

Definition at line 162 of file eigen/formatters.hpp.

template<typename Derived >

FloatMatrixFormatter<Derived>& Eigen::FloatMatrixFormatter< Derived >::precision ( const unsigned int & p ) [inline]

Sets the precision format parameter.

Parameters:

p	: the number of decimal places of precision.

Returns:: FloatMatrixFormatter& : this formatter readied for use with a stream.

Definition at line 94 of file eigen/formatters.hpp.

template<typename Derived >

unsigned int Eigen::FloatMatrixFormatter< Derived >::precision ( ) [inline]

Returns the current precision setting.

Returns:: unsigned int : the precision value.

Definition at line 116 of file eigen/formatters.hpp.

template<typename Derived >

FloatMatrixFormatter<Derived>& Eigen::FloatMatrixFormatter< Derived >::width ( const int & w ) [inline]

Sets the width format parameter.

Parameters:

w	: the width to use for inserted floats (-1 is no width constraint).

Returns:: FloatMatrixFormatter& : this formatter readied for use with a stream.

Definition at line 107 of file eigen/formatters.hpp.

template<typename Derived >

int Eigen::FloatMatrixFormatter< Derived >::width ( ) [inline]

Returns the current width setting.

Returns:: int : the witdh value (-1 for no width constraint).

Definition at line 122 of file eigen/formatters.hpp.

Member Data Documentation

template<typename Derived >

const Derived* Eigen::FloatMatrixFormatter< Derived >::_matrix [private]

Definition at line 193 of file eigen/formatters.hpp.

template<typename Derived >

ecl::Format<typename Derived::Scalar> Eigen::FloatMatrixFormatter< Derived >::format [private]

Stream the formatter.

Insertion operator for sending the formatter to an output stream.

Parameters:

ostream	: the output stream.
formatter	: the formatter to be inserted.

Template Parameters:

OutputStream	: the type of the output stream to be inserted into.
Derived	: matrix type.

Returns:: OutputStream : continue streaming with the updated output stream.

Exceptions:

StandardException : throws if the formatter has un-specified _matrix [debug mode only]

Definition at line 185 of file eigen/formatters.hpp.

template<typename Derived >

bool Eigen::FloatMatrixFormatter< Derived >::ready_to_format [private]

Definition at line 192 of file eigen/formatters.hpp.

template<typename Derived >

bool Eigen::FloatMatrixFormatter< Derived >::tmp_formatting [private]

Definition at line 191 of file eigen/formatters.hpp.

template<typename Derived >

unsigned int Eigen::FloatMatrixFormatter< Derived >::tmp_precision [private]

Definition at line 190 of file eigen/formatters.hpp.

template<typename Derived >

int Eigen::FloatMatrixFormatter< Derived >::tmp_width [private]

Definition at line 189 of file eigen/formatters.hpp.

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

eigen/formatters.hpp

Public Member Functions

Private Attributes

Detailed Description

template<typename Derived> class Eigen::FloatMatrixFormatter< Derived >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename Derived>
class Eigen::FloatMatrixFormatter< Derived >