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

#include <laplace_distribution.hpp>

Public Types

typedef laplace_distribution distribution_type
 

Public Member Functions

 param_type (RealType mean_arg=RealType(0.0), RealType beta_arg=RealType(1.0))
 Constructs a param_type from the "mean" and "beta" parameters of the distribution. More...
 
RealType mean () const
 Returns the "mean" parameter of the distribtuion. More...
 
RealType beta () const
 Returns the "beta" parameter of the distribution. More...
 
 BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR (os, param_type, parm)
 Writes a param_type to a std::ostream. More...
 
 BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR (is, param_type, parm)
 Reads a param_type from a std::istream. More...
 
 BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR (param_type, lhs, rhs)
 Returns true if the two sets of parameters are the same. More...
 

Member Typedef Documentation

template<class RealType = double>
typedef laplace_distribution boost::random::laplace_distribution< RealType >::param_type::distribution_type

Constructor & Destructor Documentation

template<class RealType = double>
boost::random::laplace_distribution< RealType >::param_type::param_type ( RealType  mean_arg = RealType(0.0),
RealType  beta_arg = RealType(1.0) 
)
inlineexplicit

Constructs a param_type from the "mean" and "beta" parameters of the distribution.

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

Member Function Documentation

template<class RealType = double>
RealType boost::random::laplace_distribution< RealType >::param_type::beta ( ) const
inline

Returns the "beta" parameter of the distribution.

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

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

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

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

Reads a param_type from a std::istream.

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

Writes a param_type to a std::ostream.

template<class RealType = double>
RealType boost::random::laplace_distribution< RealType >::param_type::mean ( ) const
inline

Returns the "mean" parameter of the distribtuion.

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


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