boost::random::normal_distribution_v165< RealType >::param_type Class Reference

Collaboration diagram for boost::random::normal_distribution_v165< RealType >::param_type:

Public Types
typedef normal_distribution_v165	distribution_type

Public Member Functions
	param_type (RealType mean_arg=RealType(0.0), RealType sigma_arg=RealType(1.0))
RealType	mean () const
RealType	sigma () const
	BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR (os, param_type, parm)
	BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR (is, param_type, parm)
	BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR (param_type, lhs, rhs)

Private Attributes
RealType	_mean
RealType	_sigma

Detailed Description

template<class RealType = double>
class boost::random::normal_distribution_v165< RealType >::param_type

Definition at line 265 of file Boost165NormalDistribution.hpp.

Member Typedef Documentation

distribution_type

template<class RealType = double>

typedef normal_distribution_v165 boost::random::normal_distribution_v165< RealType >::param_type::distribution_type

Definition at line 268 of file Boost165NormalDistribution.hpp.

Constructor & Destructor Documentation

param_type()

template<class RealType = double>

boost::random::normal_distribution_v165< RealType >::param_type::param_type ( RealType  mean_arg = RealType(0.0), RealType  sigma_arg = RealType(1.0)  )

inlineexplicit

Constructs a param_type with a given mean and standard deviation.

Requires: sigma >= 0

Definition at line 276 of file Boost165NormalDistribution.hpp.

Member Function Documentation

BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR()

template<class RealType = double>

boost::random::normal_distribution_v165< RealType >::param_type::BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR ( param_type  , lhs  , rhs    )

inline

Returns true if the two sets of parameters are the same.

Definition at line 304 of file Boost165NormalDistribution.hpp.

BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR()

template<class RealType = double>

boost::random::normal_distribution_v165< RealType >::param_type::BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR ( is  , param_type  , parm    )

inline

Reads a param_type from a std::istream.

Definition at line 297 of file Boost165NormalDistribution.hpp.

BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR()

template<class RealType = double>

boost::random::normal_distribution_v165< RealType >::param_type::BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR ( os  , param_type  , parm    )

inline

Writes a param_type to a std::ostream.

Definition at line 290 of file Boost165NormalDistribution.hpp.

mean()

template<class RealType = double>

RealType boost::random::normal_distribution_v165< RealType >::param_type::mean ( ) const

inline

Returns the mean of the distribution.

Definition at line 284 of file Boost165NormalDistribution.hpp.

References boost::random::normal_distribution_v165< RealType >::param_type::_mean.

Referenced by boost::random::normal_distribution_v165< RealType >::param().

sigma()

template<class RealType = double>

RealType boost::random::normal_distribution_v165< RealType >::param_type::sigma ( ) const

inline

Returns the standand deviation of the distribution.

Definition at line 287 of file Boost165NormalDistribution.hpp.

Referenced by boost::random::normal_distribution_v165< RealType >::param().

Member Data Documentation

_mean

template<class RealType = double>

RealType boost::random::normal_distribution_v165< RealType >::param_type::_mean

private

Returns true if the two sets of parameters are the different.

Definition at line 313 of file Boost165NormalDistribution.hpp.

Referenced by boost::random::normal_distribution_v165< RealType >::param_type::mean().

_sigma

template<class RealType = double>

RealType boost::random::normal_distribution_v165< RealType >::param_type::_sigma

private

Definition at line 314 of file Boost165NormalDistribution.hpp.

---

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

• global/src/random/Boost165NormalDistribution.hpp