Formatter for float types. More...

#include <floats.hpp>

Public Member Functions
FormatFloat< Number > &	align (const ecl::Alignment a)
	Sets the alignment format parameter. More...

FormatFloat< Number > &	base (const ecl::FloatBase b)
	Sets the base notation to use. More...

	FormatFloat (const int w=-1, const unsigned int p=4, const ecl::Alignment a=NoAlign, const ecl::FloatBase b=Fixed)

FormatFloat< Number > &	operator() (unsigned int p, const int w)

FormatFloat< Number > &	operator() (const unsigned int p, const int w, const ecl::Alignment align, const ecl::FloatBase b)

FormatFloat< Number > &	operator() (const Number n)

FormatFloat< Number > &	operator() (const Number n, const unsigned int p, const int w)

FormatFloat< Number > &	operator() (const Number n, const unsigned int p, const int w, const ecl::Alignment align, const ecl::FloatBase b)

FormatFloat< Number > &	precision (const unsigned int p)
	Sets the precision format parameter. More...

int	precision ()
	Returns the current precision setting. More...

FormatFloat< Number > &	width (const int w)
	Sets the width format parameter. More...

int	width ()
	Returns the current precision setting. More...

virtual	~FormatFloat ()

Protected Member Functions
template<typename OutputStream >
void	formatFixed (OutputStream &ostream) const

template<typename OutputStream >
void	formatSci (OutputStream &ostream) const

template<typename OutputStream >
void	pad (int n, OutputStream &ostream) const

template<typename OutputStream >
void	postPad (int n, OutputStream &ostream) const

template<typename OutputStream >
void	prePad (int n, OutputStream &ostream) const

Protected Attributes
ecl::Alignment *	alignment_

ecl::FloatBase *	base_

int *	precision_

ecl::Alignment	prm_alignment

ecl::FloatBase	prm_base

int	prm_precision

int	prm_width

bool	ready_to_format

ecl::Alignment	tmp_alignment

ecl::FloatBase	tmp_base

int	tmp_precision

int	tmp_width

Number	value_

int *	width_

Friends
template<typename OutputStream , typename N >
OutputStream &	operator<< (OutputStream &ostream, FormatFloat< N > &formatter) ecl_assert_throw_decl(StandardException)

Detailed Description

template<typename Number>
class ecl::interfaces::FormatFloat< Number >

Formatter for float types.

Default formatter for float types. For convenience, use the individual Format<float|double> classes that inherit this one instead.

Definition at line 61 of file floats.hpp.

Constructor & Destructor Documentation

template<typename Number>

ecl::interfaces::FormatFloat< Number >::FormatFloat	(	const int	w = `-1`,
		const unsigned int	p = `4`,
		const ecl::Alignment	a = `NoAlign`,
		const ecl::FloatBase	b = `Fixed`
	)

inline

Default constructor. Initialises the format tags for width, precision, alignment and base.

Parameters

w	: width (default - no width constraints)
p	: the number of decimal places of precision (default - 4)
a	: the textual alignment (default - no alignment constraints)
b	: the base format for the floating point representation (default - fixed)

Definition at line 73 of file floats.hpp.

template<typename Number>

virtual ecl::interfaces::FormatFloat< Number >::~FormatFloat ( )

inlinevirtual

Definition at line 84 of file floats.hpp.

Member Function Documentation

template<typename Number >

FormatFloat< Number > & ecl::interfaces::FormatFloat< Number >::align ( const ecl::Alignment a )

Sets the alignment format parameter.

Parameters

a	: the textual alignment.

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

Sets the alignment format parameter. This aligns the text output in the text window which has a width specified by the width parameter.

Parameters

a	: the aligning property for the output text.

See also: Alignment

Definition at line 274 of file floats.hpp.

template<typename Number >

FormatFloat< Number > & ecl::interfaces::FormatFloat< Number >::base ( const ecl::FloatBase b )

Sets the base notation to use.

Sets the base notation to use (fixed or scientific).

Parameters

b	: the base format for the floating point representation.

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

Sets the base format. For floating point values, this can be fixed, exponential or scientific.

Parameters

b	: the base representation used for the output.

See also: FloatBase

Definition at line 248 of file floats.hpp.

template<typename Number >

template<typename OutputStream >

void ecl::interfaces::FormatFloat< Number >::formatFixed ( OutputStream & ostream ) const

protected

Definition at line 365 of file floats.hpp.

template<typename Number >

template<typename OutputStream >

void ecl::interfaces::FormatFloat< Number >::formatSci ( OutputStream & ostream ) const

protected

Definition at line 397 of file floats.hpp.

template<typename Number >

FormatFloat< Number > & ecl::interfaces::FormatFloat< Number >::operator()	(	unsigned int	p,
		const int	w
	)

Convenient stream format parameter setter. This one permanently configures the width and precision as specified.

Parameters

p	: the number of decimal places of precision.
w	: the total width of the text output.

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

Definition at line 289 of file floats.hpp.

template<typename Number >

FormatFloat< Number > & ecl::interfaces::FormatFloat< Number >::operator()	(	const unsigned int	p,
		const int	w,
		const ecl::Alignment	align,
		const ecl::FloatBase	b
	)

Convenient stream format parameter setter. This one permanently configures all parameters.

Parameters

p	: the number of decimal places of precision.
w	: the total width of the text output.
align	: the aligning property for the output text.
b	: the base representation used for the output.

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

Definition at line 297 of file floats.hpp.

template<typename Number>

FormatFloat< Number > & ecl::interfaces::FormatFloat< Number >::operator() ( const Number n )

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

Format<float> format;

cout << format(3,4)(3.5215233) << endl;

Parameters

n	: the input value to be formatted.

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

Definition at line 310 of file floats.hpp.

template<typename Number>

FormatFloat< Number > & ecl::interfaces::FormatFloat< Number >::operator()	(	const Number	n,
		const unsigned int	p,
		const int	w
	)

Convenient stream formatter. This member directly formats the specified input value with the supplied/temporary parameters.

Parameters

n	: the input value to be formatted.
p	: the number of decimal places of precision.
w	: the total width of the text output.

Definition at line 320 of file floats.hpp.

template<typename Number>

FormatFloat< Number > & ecl::interfaces::FormatFloat< Number >::operator()	(	const Number	n,
		const unsigned int	p,
		const int	w,
		const ecl::Alignment	align,
		const ecl::FloatBase	b
	)

Convenient stream formatter. This member directly formats the specified input value with the supplied/temporary parameters.

Parameters

n	: the input value to be formatted.
p	: the number of decimal places of precision.
w	: the total width of the text output.
align	: the aligning property for the output text.
b	: the base representation used for the output.

Definition at line 340 of file floats.hpp.

template<typename Number >

template<typename OutputStream >

void ecl::interfaces::FormatFloat< Number >::pad	(	int	n,
		OutputStream &	ostream
	)		const

protected

Definition at line 435 of file floats.hpp.

template<typename Number >

template<typename OutputStream >

void ecl::interfaces::FormatFloat< Number >::postPad	(	int	n,
		OutputStream &	ostream
	)		const

protected

Definition at line 420 of file floats.hpp.

template<typename Number>

FormatFloat<Number>& ecl::interfaces::FormatFloat< Number >::precision ( const unsigned int p )

inline

Sets the precision format parameter.

Parameters

p	: the number of decimal places of precision.

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

Definition at line 97 of file floats.hpp.

template<typename Number>

int ecl::interfaces::FormatFloat< Number >::precision ( )

inline

Returns the current precision setting.

Returns: int : the precision value.

Definition at line 133 of file floats.hpp.

template<typename Number >

template<typename OutputStream >

void ecl::interfaces::FormatFloat< Number >::prePad	(	int	n,
		OutputStream &	ostream
	)		const

protected

Definition at line 405 of file floats.hpp.

template<typename Number >

FormatFloat< Number > & ecl::interfaces::FormatFloat< Number >::width ( const int w )

Sets the width format parameter.

Parameters

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

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

Sets the width format parameter. Setting this to -1 will turn off width formatting constraints.

Parameters

w	: the total width of the text output.

Definition at line 258 of file floats.hpp.

template<typename Number>

int ecl::interfaces::FormatFloat< Number >::width ( )

inline

Returns the current precision setting.

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

Definition at line 140 of file floats.hpp.

Friends And Related Function Documentation

template<typename Number>

template<typename OutputStream , typename N >

OutputStream& operator<<	(	OutputStream &	ostream,
		FormatFloat< N > &	formatter
	)

friend

Friend function which allows a stream to act on the formatter to produce the formatted result. This works on normal c++ streams as well as TextStreams.

Parameters