Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::random::exponential_distribution< RealType >::param_type Class Reference

#include <exponential_distribution.hpp>

Public Types

typedef exponential_distribution distribution_type
 

Public Member Functions

 param_type (RealType lambda_arg=RealType(1.0))
 Constructs parameters with a given lambda. More...
 
RealType lambda () const
 Returns the lambda parameter of the distribution. More...
 
 BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR (os, param_type, parm)
 Writes the parameters to a std::ostream. More...
 
 BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR (is, param_type, parm)
 Reads the parameters from a std::istream. More...
 
 BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR (param_type, lhs, rhs)
 Returns true if the two sets of parameters are equal. More...
 

Member Typedef Documentation

Constructor & Destructor Documentation

template<class RealType = double>
boost::random::exponential_distribution< RealType >::param_type::param_type ( RealType  lambda_arg = RealType(1.0))
inline

Constructs parameters with a given lambda.

Requires: lambda > 0

References BOOST_ASSERT.

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

Member Function Documentation

template<class RealType = double>
boost::random::exponential_distribution< RealType >::param_type::BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR ( param_type  ,
lhs  ,
rhs   
)
inline

Returns true if the two sets of parameters are equal.

template<class RealType = double>
boost::random::exponential_distribution< RealType >::param_type::BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR ( is  ,
param_type  ,
parm   
)
inline

Reads the parameters from a std::istream.

template<class RealType = double>
boost::random::exponential_distribution< RealType >::param_type::BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR ( os  ,
param_type  ,
parm   
)
inline

Writes the parameters to a std::ostream.

template<class RealType = double>
RealType boost::random::exponential_distribution< RealType >::param_type::lambda ( ) const
inline

Returns the lambda parameter of the distribution.

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


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