Formats an floating point for further printing use. More...

#include <OStream.hpp>

Inheritance diagram for fiber::FormatFloat:

Public Types
using	value_type = float

Public Member Functions
constexpr	FormatFloat ()=default

constexpr	FormatFloat (const FormatFloat &)=default

constexpr FormatFloat &	operator= (const FormatFloat &)=default

template<typename Float, typename std::enable_if< std::is_floating_point< Float >::value, int >::type = 0>
constexpr	FormatFloat (Float value)

constexpr FormatFloat &	use_thousands (bool b=true)
	enables thousand characters

constexpr FormatFloat &	thousands (char c=',')
	enable thousands seperator

constexpr FormatFloat &	comma (char c)
	sets the comma value (default: '.')

constexpr FormatFloat &	fsign (bool b=true)
	forces the printing of the sign, even if it is positive

constexpr FormatFloat &	mwidth (int mw)
	sets the minimum width the the number should occupy in text - the rest will be filled with padding/fill characters

constexpr FormatFloat &	fill (char c)
	sets the padding/fill character

constexpr FormatFloat &	pad_sign (bool b=true)
	enables padding for the sign character

constexpr FormatFloat &	right ()
	flushright: sets the alignment to right - padding will be applied to the left

constexpr FormatFloat &	left ()
	flushleft: sets the alignment to left - padding will be applied to the right

constexpr FormatFloat &	center ()
	center: sets the alignment to center - padding will be applied to both sides

constexpr FormatFloat &	sci ()
	formats the number in scientific notation: exponent so that there is always one digit before the comma.

constexpr FormatFloat &	eng ()
	formats the number in engineering notation: exponent in magnitudes of three

constexpr FormatFloat &	full ()
	formats the number so that it is shown in its full length without the use of exponents

constexpr FormatFloat &	decimals (int d)
	sets the precision, aka. the number of total digits that will be printed before and after the comma

constexpr FormatFloat &	fcomma (bool b=true)
	force a comma in every print, even if it is not needed to display the number

constexpr FormatFloat &	fdeci (bool b=true)
	force the printing of all decimals, even if they are zero

constexpr FormatFloat &	fexp (bool b=true)
	force the printing of the exponent, even if it is zero

constexpr FormatFloat &	fexpsign (bool b=true)
	force the sign of the exponent, even if it is positive

Public Member Functions inherited from fiber::FormatFloatParams
constexpr	FormatFloatParams ()=default

constexpr	FormatFloatParams (const FormatFloatParams &)=default

constexpr FormatFloatParams &	operator= (const FormatFloatParams &)=default

constexpr	FormatFloatParams (const FormatStrParams &params)

constexpr FormatFloatParams &	operator= (const FormatStrParams &params)

constexpr	FormatFloatParams (const FormatIntParams &params)

constexpr FormatFloatParams &	operator= (const FormatIntParams &params)

Public Member Functions inherited from fiber::FormatIntParams
constexpr	FormatIntParams ()=default

constexpr	FormatIntParams (const FormatIntParams &)=default

constexpr FormatIntParams &	operator= (const FormatIntParams &)=default

constexpr	FormatIntParams (const FormatStrParams &params)

constexpr FormatIntParams &	operator= (const FormatStrParams &params)

Static Public Member Functions
template<typename Float, typename std::enable_if< std::is_floating_point< Float >::value, int >::type = 0>
static constexpr FormatFloat	like (Float value, const FormatFloatParams &params)

template<typename Float, typename std::enable_if< std::is_floating_point< Float >::value, int >::type = 0>
static constexpr FormatFloat	like (Float value, const FormatIntParams &params)

template<typename Float, typename std::enable_if< std::is_floating_point< Float >::value, int >::type = 0>
static constexpr FormatFloat	like (Float value, const FormatStrParams &params)

Public Attributes
value_type	_value = 0

Public Attributes inherited from fiber::FormatFloatParams
FloatRepresentation	_representation = FloatRepresentation::Engineering

char	_comma = '.'

unsigned int	_decimals = 3

bool	_force_comma = false

bool	_force_decimals = false

bool	_force_exponent = false

bool	_force_exponent_sign = false

Public Attributes inherited from fiber::FormatIntParams
bool	_force_sign = false

bool	_pad_sign = false

Public Attributes inherited from fiber::FormatStrParams
AlignmentLRC	_alignment = AlignmentLRC::Right

int	_mwidth = 0

char	_fill = ' '

Public Attributes inherited from fiber::_FormatUIntParams
char	_thousands_char = ','

bool	_use_thousands = false

Detailed Description

Formats an floating point for further printing use.

Member Typedef Documentation

◆ value_type

using fiber::FormatFloat::value_type = float

Constructor & Destructor Documentation

◆ FormatFloat() [1/3]

fiber::FormatFloat::FormatFloat ( )

constexprdefault

◆ FormatFloat() [2/3]

fiber::FormatFloat::FormatFloat ( const FormatFloat & )

constexprdefault

◆ FormatFloat() [3/3]

template<typename Float, typename std::enable_if< std::is_floating_point< Float >::value, int >::type = 0>

fiber::FormatFloat::FormatFloat ( Float value )

inlineexplicitconstexpr

Member Function Documentation

◆ center()

FormatFloat & fiber::FormatFloat::center ( )

inlineconstexpr

center: sets the alignment to center - padding will be applied to both sides

◆ comma()

FormatFloat & fiber::FormatFloat::comma ( char c )

inlineconstexpr

sets the comma value (default: '.')

◆ decimals()

FormatFloat & fiber::FormatFloat::decimals ( int d )

inlineconstexpr

sets the precision, aka. the number of total digits that will be printed before and after the comma

◆ eng()

FormatFloat & fiber::FormatFloat::eng ( )

inlineconstexpr

formats the number in engineering notation: exponent in magnitudes of three

◆ fcomma()

FormatFloat & fiber::FormatFloat::fcomma ( bool b = true )

inlineconstexpr

force a comma in every print, even if it is not needed to display the number

◆ fdeci()

FormatFloat & fiber::FormatFloat::fdeci ( bool b = true )

inlineconstexpr

force the printing of all decimals, even if they are zero

◆ fexp()

FormatFloat & fiber::FormatFloat::fexp ( bool b = true )

inlineconstexpr

force the printing of the exponent, even if it is zero

◆ fexpsign()

FormatFloat & fiber::FormatFloat::fexpsign ( bool b = true )

inlineconstexpr

force the sign of the exponent, even if it is positive

◆ fill()

FormatFloat & fiber::FormatFloat::fill ( char c )

inlineconstexpr

sets the padding/fill character

◆ fsign()

FormatFloat & fiber::FormatFloat::fsign ( bool b = true )

inlineconstexpr

forces the printing of the sign, even if it is positive

◆ full()

FormatFloat & fiber::FormatFloat::full ( )

inlineconstexpr

formats the number so that it is shown in its full length without the use of exponents

◆ left()

FormatFloat & fiber::FormatFloat::left ( )

inlineconstexpr

flushleft: sets the alignment to left - padding will be applied to the right

◆ like() [1/3]

template<typename Float, typename std::enable_if< std::is_floating_point< Float >::value, int >::type = 0>

static constexpr FormatFloat fiber::FormatFloat::like	(	Float	value,
		const FormatFloatParams &	params )

inlinestaticconstexpr

◆ like() [2/3]

template<typename Float, typename std::enable_if< std::is_floating_point< Float >::value, int >::type = 0>

static constexpr FormatFloat fiber::FormatFloat::like	(	Float	value,
		const FormatIntParams &	params )

inlinestaticconstexpr

◆ like() [3/3]

template<typename Float, typename std::enable_if< std::is_floating_point< Float >::value, int >::type = 0>

static constexpr FormatFloat fiber::FormatFloat::like	(	Float	value,
		const FormatStrParams &	params )

inlinestaticconstexpr

◆ mwidth()

FormatFloat & fiber::FormatFloat::mwidth ( int mw )

inlineconstexpr

sets the minimum width the the number should occupy in text - the rest will be filled with padding/fill characters

◆ operator=()

FormatFloat & fiber::FormatFloat::operator= ( const FormatFloat & )

constexprdefault

◆ pad_sign()

FormatFloat & fiber::FormatFloat::pad_sign ( bool b = true )

inlineconstexpr

enables padding for the sign character

◆ right()

FormatFloat & fiber::FormatFloat::right ( )

inlineconstexpr

flushright: sets the alignment to right - padding will be applied to the left

◆ sci()

FormatFloat & fiber::FormatFloat::sci ( )

inlineconstexpr

formats the number in scientific notation: exponent so that there is always one digit before the comma.

◆ thousands()

FormatFloat & fiber::FormatFloat::thousands ( char c = ',' )

inlineconstexpr

enable thousands seperator

Parameters

c	the character to be used for thousands seperator (default: ',')

◆ use_thousands()

FormatFloat & fiber::FormatFloat::use_thousands ( bool b = true )

inlineconstexpr

enables thousand characters

Member Data Documentation

◆ _value

value_type fiber::FormatFloat::_value = 0

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

fiber/OStream/OStream.hpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ value_type

Constructor & Destructor Documentation

◆ FormatFloat() [1/3]

◆ FormatFloat() [2/3]

◆ FormatFloat() [3/3]

Member Function Documentation

◆ center()

◆ comma()

◆ decimals()

◆ eng()

◆ fcomma()

◆ fdeci()

◆ fexp()

◆ fexpsign()

◆ fill()

◆ fsign()

◆ full()

◆ left()

◆ like() [1/3]

◆ like() [2/3]

◆ like() [3/3]

◆ mwidth()

◆ operator=()

◆ pad_sign()

◆ right()

◆ sci()

◆ thousands()

◆ use_thousands()

Member Data Documentation

◆ _value