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

#include <gamma_distribution.hpp>

Public Types

typedef gamma_distribution distribution_type
 

Public Member Functions

 param_type (const RealType &alpha_arg=RealType(1.0), const RealType &beta_arg=RealType(1.0))
 Constructs a param_type object from the "alpha" and "beta" parameters. More...
 
RealType alpha () const
 Returns the "alpha" parameter of the distribution. More...
 
RealType beta () const
 Returns the "beta" parameter of the distribution. More...
 

Friends

template<class CharT , class Traits >
std::basic_ostream< CharT,
Traits > & 		operator<< (std::basic_ostream< CharT, Traits > &os, const param_type &parm)
 Writes the parameters to a std::ostream. More...
 
template<class CharT , class Traits >
std::basic_istream< CharT,
Traits > & 		operator>> (std::basic_istream< CharT, Traits > &is, param_type &parm)
 Reads the parameters from a std::istream. More...
 
bool operator== (const param_type &lhs, const param_type &rhs)
 Returns true if the two sets of parameters are the same. More...
 
bool operator!= (const param_type &lhs, const param_type &rhs)
 Returns true if the two sets fo parameters are different. More...
 

Member Typedef Documentation

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

Constructor & Destructor Documentation

template<class RealType = double>
boost::random::gamma_distribution< RealType >::param_type::param_type ( const RealType &  alpha_arg = RealType(1.0),
const RealType &  beta_arg = RealType(1.0) 
)
inline

Constructs a param_type object from the "alpha" and "beta" parameters.

Requires: alpha > 0 && beta > 0

Member Function Documentation

template<class RealType = double>
RealType boost::random::gamma_distribution< RealType >::param_type::alpha ( ) const
inline

Returns the "alpha" parameter of the distribution.

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

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

Returns the "beta" parameter of the distribution.

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

Friends And Related Function Documentation

template<class RealType = double>
bool operator!= ( const param_type &  lhs,
const param_type &  rhs 
)
friend

Returns true if the two sets fo parameters are different.

template<class RealType = double>
template<class CharT , class Traits >
std::basic_ostream<CharT, Traits>& operator<< ( std::basic_ostream< CharT, Traits > &  os,
const param_type &  parm 
)
friend

Writes the parameters to a std::ostream.

template<class RealType = double>
bool operator== ( const param_type &  lhs,
const param_type &  rhs 
)
friend

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

template<class RealType = double>
template<class CharT , class Traits >
std::basic_istream<CharT, Traits>& operator>> ( std::basic_istream< CharT, Traits > &  is,
param_type &  parm 
)
friend

Reads the parameters from a std::istream.

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