4.4.1
Freundlich's C++ toolkit
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions
fcppt::random::distribution::parameters::normal< FloatType > Class Template Reference

Detailed Description

template<typename FloatType>
class fcppt::random::distribution::parameters::normal< FloatType >

Parameters class for normal distributions.

This class can be used as fcppt::random::distribution::basic's template parameter and is also used to initialize an object of it. It uses strong typedefs for the mean and stddev parameters.

Public Types

using result_type = FloatType
 
using base_type = fcppt::random::distribution::base_type< result_type >
 
using distribution = std::normal_distribution< base_type >
 
using wrapped_param_type = typename distribution::param_type
 
using mean = fcppt::strong_typedef< FloatType,_ >
 
using stddev = fcppt::strong_typedef< FloatType,_ >
 

Public Member Functions

 normal (mean _mean, stddev _stddev)
 Constructs parameters for a normal distribution.
 
wrapped_param_type convert_from () const
 

Static Public Member Functions

static normal convert_to (distribution const &)
 

Member Typedef Documentation

◆ base_type

template<typename FloatType >
using fcppt::random::distribution::parameters::normal< FloatType >::base_type = fcppt::random::distribution::base_type<result_type>

◆ distribution

template<typename FloatType >
using fcppt::random::distribution::parameters::normal< FloatType >::distribution = std::normal_distribution<base_type>

◆ mean

template<typename FloatType >
using fcppt::random::distribution::parameters::normal< FloatType >::mean = fcppt::strong_typedef< FloatType ,_>

◆ result_type

template<typename FloatType >
using fcppt::random::distribution::parameters::normal< FloatType >::result_type = FloatType

◆ stddev

template<typename FloatType >
using fcppt::random::distribution::parameters::normal< FloatType >::stddev = fcppt::strong_typedef< FloatType ,_>

◆ wrapped_param_type

template<typename FloatType >
using fcppt::random::distribution::parameters::normal< FloatType >::wrapped_param_type = typename distribution::param_type

Constructor & Destructor Documentation

◆ normal()

template<typename FloatType >
fcppt::random::distribution::parameters::normal< FloatType >::normal ( mean  _mean,
stddev  _stddev 
)

Constructs parameters for a normal distribution.

Constructs parameters for a normal distribution that uses _mean and _stddev as its parameters.

Parameters
_meanThe mean value
_stddevThe standard deviation value

Member Function Documentation

◆ convert_from()

template<typename FloatType >
wrapped_param_type fcppt::random::distribution::parameters::normal< FloatType >::convert_from ( ) const

◆ convert_to()

template<typename FloatType >
static normal fcppt::random::distribution::parameters::normal< FloatType >::convert_to ( distribution const &  )
static