Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Types | Public Member Functions | List of all members
boost::random::laplace_distribution< RealType > Class Template Reference

The laplace distribution is a real-valued distribution with two parameters, mean and beta. More...

#include <laplace_distribution.hpp>

Classes

class  param_type
 

Public Types

typedef RealType result_type
 
typedef RealType input_type
 

Public Member Functions

 laplace_distribution (RealType mean_arg=RealType(0.0), RealType beta_arg=RealType(1.0))
 Constructs an laplace_distribution from its "mean" and "beta" parameters. More...
 
 laplace_distribution (const param_type &parm)
 Constructs an laplace_distribution from its parameters. More...
 
template<class URNG >
RealType operator() (URNG &urng) const
 Returns a random variate distributed according to the laplace distribution. More...
 
template<class URNG >
RealType operator() (URNG &urng, const param_type &parm) const
 Returns a random variate distributed accordint to the laplace distribution with parameters specified by param. More...
 
RealType mean () const
 Returns the "mean" parameter of the distribution. More...
 
RealType beta () const
 Returns the "beta" parameter of the distribution. More...
 
RealType min BOOST_PREVENT_MACRO_SUBSTITUTION () const
 Returns the smallest value that the distribution can produce. More...
 
RealType max BOOST_PREVENT_MACRO_SUBSTITUTION () const
 Returns the largest value that the distribution can produce. More...
 
param_type param () const
 Returns the parameters of the distribution. More...
 
void param (const param_type &parm)
 Sets the parameters of the distribution. More...
 
void reset ()
 Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. More...
 
 BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR (os, laplace_distribution, wd)
 Writes an laplace_distribution to a std::ostream. More...
 
 BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR (is, laplace_distribution, wd)
 Reads an laplace_distribution from a std::istream. More...
 
 BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR (laplace_distribution, lhs, rhs)
 Returns true if the two instances of laplace_distribution will return identical sequences of values given equal generators. More...
 

Detailed Description

template<class RealType = double>
class boost::random::laplace_distribution< RealType >

The laplace distribution is a real-valued distribution with two parameters, mean and beta.

It has $\displaystyle p(x) = \frac{e^-{\frac{|x-\mu|}{\beta}}}{2\beta}$.

Member Typedef Documentation

template<class RealType = double>
typedef RealType boost::random::laplace_distribution< RealType >::input_type
template<class RealType = double>
typedef RealType boost::random::laplace_distribution< RealType >::result_type

Constructor & Destructor Documentation

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

Constructs an laplace_distribution from its "mean" and "beta" parameters.

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

template<class RealType = double>
boost::random::laplace_distribution< RealType >::laplace_distribution ( const param_type &  parm)
inlineexplicit

Constructs an laplace_distribution from its parameters.

Member Function Documentation

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

Returns the "beta" parameter of the distribution.

template<class RealType = double>
RealType min boost::random::laplace_distribution< RealType >::BOOST_PREVENT_MACRO_SUBSTITUTION ( ) const
inline

Returns the smallest value that the distribution can produce.

template<class RealType = double>
RealType max boost::random::laplace_distribution< RealType >::BOOST_PREVENT_MACRO_SUBSTITUTION ( ) const
inline

Returns the largest value that the distribution can produce.

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

Returns true if the two instances of laplace_distribution will return identical sequences of values given equal generators.

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

Reads an laplace_distribution from a std::istream.

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

Writes an laplace_distribution to a std::ostream.

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

Returns the "mean" parameter of the distribution.

template<class RealType = double>
template<class URNG >
RealType boost::random::laplace_distribution< RealType >::operator() ( URNG &  urng) const
inline

Returns a random variate distributed according to the laplace distribution.

template<class RealType = double>
template<class URNG >
RealType boost::random::laplace_distribution< RealType >::operator() ( URNG &  urng,
const param_type &  parm 
) const
inline

Returns a random variate distributed accordint to the laplace distribution with parameters specified by param.

References boost::random::laplace_distribution< RealType >::laplace_distribution().

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

Returns the parameters of the distribution.

References boost::random::laplace_distribution< RealType >::param_type::param_type().

template<class RealType = double>
void boost::random::laplace_distribution< RealType >::param ( const param_type &  parm)
inline

Sets the parameters of the distribution.

References boost::random::laplace_distribution< RealType >::param_type::beta(), and boost::random::laplace_distribution< RealType >::param_type::mean().

template<class RealType = double>
void boost::random::laplace_distribution< RealType >::reset ( void  )
inline

Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.

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