Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template lognormal_distribution

boost::random::lognormal_distribution

Synopsis

// In header: <boost/random/lognormal_distribution.hpp>

template<typename RealType> 
class lognormal_distribution {
public:
  // types
  typedef normal_distribution<  ; 
  typedef                                     ;

  // member classes/structs/unions

  class param_type {
  public:
    // types
    typedef lognormal_distribution ;

    // construct/copy/destruct
    ( = ,  = );

    // public member functions
     () ;
     () ;

    // friend functions
    template<typename CharT, typename Traits> 
       
      (, param_type &);
    template<typename CharT, typename Traits> 
       
      (, param_type &);
     (param_type &, param_type &);
     (param_type &, param_type &);
  };

  // construct/copy/destruct
  ( = ,  = );
  (param_type &);

  // public member functions
   () ;
   () ;
   () ;
   () ;
  param_type () ;
   (param_type &);
   ();
  template<typename Engine>  ();
  template<typename Engine> 
     (, param_type &);

  // friend functions
  template<typename CharT, typename Traits> 
     
    (, 
               lognormal_distribution &);
  template<typename CharT, typename Traits> 
     
    (, 
               lognormal_distribution &);
   (lognormal_distribution &, 
                  lognormal_distribution &);
   (lognormal_distribution &, 
                  lognormal_distribution &);
};

Description

Instantiations of class template lognormal_distribution model a random distribution . Such a distribution produces random numbers with for x > 0.

[Warning] Warning

This distribution has been updated to match the C++ standard. Its behavior has changed from the original boost::lognormal_distribution. A backwards compatible version is provided in namespace boost.

lognormal_distribution public construct/copy/destruct

  1. ( m = ,  s = );

    Constructs a lognormal_distribution. m and s are the parameters of the distribution.

  2. (param_type & param);

    Constructs a lognormal_distribution from its parameters.

lognormal_distribution public member functions

  1.  () ;

    Returns the m parameter of the distribution.

  2.  () ;

    Returns the s parameter of the distribution.

  3.  () ;

    Returns the smallest value that the distribution can produce.

  4.  () ;

    Returns the largest value that the distribution can produce.

  5. param_type () ;

    Returns the parameters of the distribution.

  6.  (param_type & param);

    Sets the parameters of the distribution.

  7.  ();

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

  8. template<typename Engine>  ( eng);

    Returns a random variate distributed according to the lognormal distribution.

  9. template<typename Engine> 
       ( eng, param_type & param);

    Returns a random variate distributed according to the lognormal distribution with parameters specified by param.

lognormal_distribution friend functions

  1. template<typename CharT, typename Traits> 
       
      ( os, 
                 lognormal_distribution & ld);

    Writes the distribution to a std::ostream.

  2. template<typename CharT, typename Traits> 
       
      ( is, 
                 lognormal_distribution & ld);

    Reads the distribution from a std::istream.

  3.  (lognormal_distribution & lhs, 
                    lognormal_distribution & rhs);

    Returns true if the two distributions will produce identical sequences of values given equal generators.

  4.  (lognormal_distribution & lhs, 
                    lognormal_distribution & rhs);

    Returns true if the two distributions may produce different sequences of values given equal generators.


PrevUpHomeNext