fcppt::random::distribution Namespace Reference

The namespace for the basic distribution and helper functions. More...

Namespaces
namespace	parameters
	The namespace for all distribution parameters.

Classes
class	basic
	A wrapper for distributions. More...

Typedefs
template<typename Type >
using	base_type = fcppt::type_iso::undecorated_type< Type >
	Calculates the base type.

Functions
template<typename Type >
fcppt::random::distribution::base_type< Type >	base_value (Type const &_value)
	Calculates the base value.
template<typename Parameters >
bool	operator== (fcppt::random::distribution::basic< Parameters > const &left, fcppt::random::distribution::basic< Parameters > const &right)
	Compares two distribution for equality.
template<typename Parameters >
bool	operator!= (fcppt::random::distribution::basic< Parameters > const &left, fcppt::random::distribution::basic< Parameters > const &right)
	Compares two distribution for inequality.
template<typename Ch , typename Traits , typename Parameters >
std::basic_ostream< Ch, Traits > &	operator<< (std::basic_ostream< Ch, Traits > &stream, fcppt::random::distribution::basic< Parameters > const &dist)
	Outputs a distribution.
template<typename Ch , typename Traits , typename Parameters >
std::basic_istream< Ch, Traits > &	operator>> (std::basic_istream< Ch, Traits > &stream, fcppt::random::distribution::basic< Parameters > &dist)
	Inputs into a distribution.
template<typename Result , typename Type >
Result	decorated_value (Type const &_value)
	Calculates the decorated value.
template<typename Parameters >
fcppt::random::distribution::basic< Parameters >	make_basic (Parameters const &_parameters)

Detailed Description

The namespace for the basic distribution and helper functions.

Typedef Documentation

base_type

template<typename Type >

using fcppt::random::distribution::base_type = typedef fcppt::type_iso::undecorated_type<Type>

Calculates the base type.

See also

fcppt::type_iso::undecorated_type

Function Documentation

base_value()

template<typename Type >

fcppt::random::distribution::base_type< Type > fcppt::random::distribution::base_value ( Type const &  _value )

inline

Calculates the base value.

See also

fcppt::type_iso::undecorate

decorated_value()

template<typename Result , typename Type >

Result fcppt::random::distribution::decorated_value ( Type const &  _value )

inline

Calculates the decorated value.

See also

fcppt::type_iso::decorate

make_basic()

template<typename Parameters >

fcppt::random::distribution::basic< Parameters > fcppt::random::distribution::make_basic

(

Parameters const &

_parameters

)

operator!=()

template<typename Parameters >

bool fcppt::random::distribution::operator!=	(	fcppt::random::distribution::basic< Parameters > const &	left,
		fcppt::random::distribution::basic< Parameters > const &	right
	)

Compares two distribution for inequality.

Compares distributions left and right for inequality, calling the inequality operator of the underlying distributions.

Parameters

left	The first distribution
right	The second distribution

operator<<()

template<typename Ch , typename Traits , typename Parameters >

std::basic_ostream< Ch, Traits > & fcppt::random::distribution::operator<<	(	std::basic_ostream< Ch, Traits > &	stream,
		fcppt::random::distribution::basic< Parameters > const &	dist
	)

Outputs a distribution.

Outputs the underlying distribution of dist to stream.

Parameters

stream	The stream to output to
dist	The distribution to output

operator==()

template<typename Parameters >

bool fcppt::random::distribution::operator==	(	fcppt::random::distribution::basic< Parameters > const &	left,
		fcppt::random::distribution::basic< Parameters > const &	right
	)

Compares two distribution for equality.

Compares distributions left and right for equality, calling the equality operator of the underlying distributions.

Parameters

left	The first distribution
right	The second distribution

operator>>()

template<typename Ch , typename Traits , typename Parameters >

std::basic_istream< Ch, Traits > & fcppt::random::distribution::operator>>	(	std::basic_istream< Ch, Traits > &	stream,
		fcppt::random::distribution::basic< Parameters > &	dist
	)

Inputs into a distribution.

Inputs into the underlying distribution of dist from stream.

Parameters

stream	The stream to input from
dist	The distribution to input to