Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class param_type

boost::random::discrete_distribution::param_type

Synopsis

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



class param_type {
public:
  // types
  typedef discrete_distribution ;

  // construct/copy/destruct
  ();
  template<typename Iter> (, );
  ();
  template<typename Range> ();
  template<typename Func> (, , , );

  // 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 &);
};

Description

param_type public construct/copy/destruct

  1. ();

    Constructs a param_type object, representing a distribution with and .

  2. template<typename Iter> ( first,  last);

    If first == last, equivalent to the default constructor. Otherwise, the values of the range represent weights for the possible values of the distribution.

  3. ( wl);

    If wl.size() == 0, equivalent to the default constructor. Otherwise, the values of the initializer_list represent weights for the possible values of the distribution.

  4. template<typename Range> ( range);

    If the range is empty, equivalent to the default constructor. Otherwise, the elements of the range represent weights for the possible values of the distribution.

  5. template<typename Func> 
      ( nw,  xmin,  xmax,  fw);

    If nw is zero, equivalent to the default constructor. Otherwise, the range of the distribution is [0, nw), and the weights are found by calling fw with values evenly distributed between and , where .

param_type public member functions

  1.  () ;

    Returns a vector containing the probabilities of each possible value of the distribution.

param_type friend functions

  1. template<typename CharT, typename Traits> 
       
      ( os, 
                 param_type & param);

    Writes the parameters to a std::ostream.

  2. template<typename CharT, typename Traits> 
       
      ( is, 
                 param_type & param);

    Reads the parameters from a std::istream.

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

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

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

    Returns true if the two sets of parameters are different.


PrevUpHomeNext