Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template triangle_distribution

boost::random::triangle_distribution

Synopsis

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

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

  // member classes/structs/unions

  class param_type {
  public:
    // types
    typedef triangle_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> 
     
    (, 
               triangle_distribution &);
  template<typename CharT, typename Traits> 
     
    (, 
               triangle_distribution &);
   (triangle_distribution &, 
                  triangle_distribution &);
   (triangle_distribution &, 
                  triangle_distribution &);
};

Description

Instantiations of triangle_distribution model a random distribution . A triangle_distribution has three parameters, a, b, and c, which are the smallest, the most probable and the largest values of the distribution respectively.

triangle_distribution public construct/copy/destruct

  1. ( a = ,  b = ,  c = );

    Constructs a triangle_distribution with the parameters a, b, and c.

    Preconditions: a <= b <= c.

  2. (param_type & param);

    Constructs a triangle_distribution from its parameters.

triangle_distribution public member functions

  1.  () ;

    Returns the a parameter of the distribution

  2.  () ;

    Returns the b parameter of the distribution

  3.  () ;

    Returns the c parameter of the distribution

  4.  () ;

    Returns the smallest value that the distribution can produce.

  5.  () ;

    Returns the largest value that the distribution can produce.

  6. param_type () ;

    Returns the parameters of the distribution.

  7.  (param_type & param);

    Sets the parameters of the distribution.

  8.  ();

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

  9. template<typename Engine>  ( eng);

    Returns a random variate distributed according to the triangle distribution.

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

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

triangle_distribution friend functions

  1. template<typename CharT, typename Traits> 
       
      ( os, 
                 triangle_distribution & td);

    Writes the distribution to a std::ostream.

  2. template<typename CharT, typename Traits> 
       
      ( is, 
                 triangle_distribution & td);

    Reads the distribution from a std::istream.

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

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

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

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


PrevUpHomeNext