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 = double> 
class triangle_distribution {
public:
  // types
  typedef RealType ; 
  typedef RealType ;

  // member classes/structs/unions

  class param_type {
  public:
    // types
    typedef triangle_distribution ;

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

    // public member functions
    RealType () ;
    RealType () ;
    RealType () ;

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

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

  // public member functions
  result_type () ;
  result_type () ;
  result_type () ;
  RealType () ;
  RealType () ;
  param_type () ;
  void (const param_type &);
  void ();
  template<typename Engine> result_type (Engine &);
  template<typename Engine> 
    result_type (Engine &, const param_type &);

  // friend functions
  template<typename CharT, typename Traits> 
    CharT, Traits > & 
    (CharT, Traits > &, 
               const triangle_distribution &);
  template<typename CharT, typename Traits> 
    CharT, Traits > & 
    (CharT, Traits > &, 
               const triangle_distribution &);
  bool (const triangle_distribution &, 
                  const triangle_distribution &);
  bool (const triangle_distribution &, 
                  const 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. (RealType a = , RealType b = , RealType c = );

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

    Preconditions: a <= b <= c.

  2. (const param_type & param);

    Constructs a triangle_distribution from its parameters.

triangle_distribution public member functions

  1. result_type () ;

    Returns the a parameter of the distribution

  2. result_type () ;

    Returns the b parameter of the distribution

  3. result_type () ;

    Returns the c parameter of the distribution

  4. RealType () ;

    Returns the smallest value that the distribution can produce.

  5. RealType () ;

    Returns the largest value that the distribution can produce.

  6. param_type () ;

    Returns the parameters of the distribution.

  7. void (const param_type & param);

    Sets the parameters of the distribution.

  8. void ();

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

  9. template<typename Engine> result_type (Engine & eng);

    Returns a random variate distributed according to the triangle distribution.

  10. template<typename Engine> 
      result_type (Engine & eng, const 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> 
      CharT, Traits > & 
      (CharT, Traits > & os, 
                 const triangle_distribution & td);

    Writes the distribution to a std::ostream.

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

    Reads the distribution from a std::istream.

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

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

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

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


PrevUpHomeNext