Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class param_type

boost::random::uniform_on_sphere::param_type

Synopsis

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



class param_type {
public:
  // types
  typedef uniform_on_sphere ;

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

  // public member functions
  int () ;

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

Description

param_type public construct/copy/destruct

  1. (int dim = );

    Constructs the parameters of a uniform_on_sphere distribution, given the dimension of the sphere.

param_type public member functions

  1. int () ;

    Returns the dimension of the sphere.

param_type friend functions

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

    Writes the parameters to a std::ostream.

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

    Reads the parameters from a std::istream.

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

    Returns true if the two sets of parameters are equal.

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

    Returns true if the two sets of parameters are different.


PrevUpHomeNext