Class template uniform_on_sphere . Boost , The Boost C++ Libraries BoostBook Documentation Subset , Reference

Class template uniform_on_sphere

boost::random::uniform_on_sphere

Synopsis

// In header: <boost/random/uniform_on_sphere.hpp>
template<typename RealType = double, typename Cont = std::vector<RealType> > 
class uniform_on_sphere {
public:
  // types
  typedef RealType input_type; 
  typedef Cont     result_type;
  // member classes/structs/unions
  class param_type {
  public:
    // types
    typedef uniform_on_sphere distribution_type;
    // construct/copy/destruct
    explicit param_type(int = 2);
    // public member functions
    int dim() const;
    // friend functions
    template<typename CharT, typename Traits> 
      friend std::basic_ostream< CharT, Traits > & 
      operator<<(std::basic_ostream< CharT, Traits > &, const param_type &);
    template<typename CharT, typename Traits> 
      friend std::basic_istream< CharT, Traits > & 
      operator>>(std::basic_istream< CharT, Traits > &, const param_type &);
    friend bool operator==(const param_type &, const param_type &);
    friend bool operator!=(const param_type &, const param_type &);
  };
  // construct/copy/destruct
  explicit uniform_on_sphere(int = 2);
  explicit uniform_on_sphere(const param_type &);
  // public member functions
  int dim() const;
  param_type param() const;
  void param(const param_type &);
  result_type min() const;
  result_type max() const;
  void reset();
  template<typename Engine> const result_type & operator()(Engine &);
  template<typename Engine> 
    result_type operator()(Engine &, const param_type &) const;
  // friend functions
  template<typename CharT, typename Traits> 
    friend std::basic_ostream< CharT, Traits > & 
    operator<<(std::basic_ostream< CharT, Traits > &, 
               const uniform_on_sphere &);
  template<typename CharT, typename Traits> 
    friend std::basic_istream< CharT, Traits > & 
    operator>>(std::basic_istream< CharT, Traits > &, 
               const uniform_on_sphere &);
  friend bool operator==(const uniform_on_sphere &, const uniform_on_sphere &);
  friend bool operator!=(const uniform_on_sphere &, const uniform_on_sphere &);
};

Description

Обоснование шаблона классаUniform_on_sphereмодельслучайное распределение. Такое распределение производит случайные числа, равномерно распределенные на единичной сфере произвольного измерения<dim>. Параметр шаблона<Cont>должен быть типом контейнера типа STL с начальными и конечными операциями, возвращающими неконстовые передатчики типа<Cont::iterator>.

`uniform_on_sphere` public construct/copy/destruct

<
```
explicituniform_on_sphere(intdim=2);
```
>
Построение распределения<uniform_on_sphere>.<dim>— размерность сферы.
Требуется: dim >= 0
<
```
explicituniform_on_sphere(constparam_type&param);
```
>
Построение распределения<uniform_on_sphere>из его параметров.

`uniform_on_sphere` public member functions

<
```
intdim()const;
```
>
Возвращает размерность сферы.
<
```
param_typeparam()const;
```
>
Возвращает параметры распределения.
<
```
voidparam(constparam_type&param);
```
>
Устанавливает параметры распределения.
<
```
result_typemin()const;
```
>
Возвращает наименьшее значение, которое может произвести распределение. Обратите внимание, что это необходимо для приближения к требованиям стандартной библиотеки. Поведение определяется в соответствии с лексикографическим сравнением так, что для контейнерного типа std::vector, dist.min()<= x<= dist.max(), где x - любое значение, произведенное распределением.
<
```
result_typemax()const;
```
>
Возвращает наибольшую ценность, которую может произвести распределение. Обратите внимание, что это необходимо для приближения к требованиям стандартной библиотеки. Поведение определяется в соответствии с лексикографическим сравнением так, что для контейнерного типа std::vector, dist.min()<= x<= dist.max(), где x - любое значение, произведенное распределением.
<
```
voidreset();
```
>
Эффекты: Последующее использование распределения не зависит от значений, произведенных каким-либо двигателем до вызова сброса.
<
```
template<typenameEngine>constresult_type&operator()(Engine&eng);
```
>
Возвращает точку, равномерно распределенную по поверхности сферы размерности тусклой ().
<
```
template<typenameEngine>
 result_typeoperator()(Engine&eng,constparam_type&param)const;
```
>
Возвращает точку, равномерно распределенную по поверхности сферы измерения param.dim().

`uniform_on_sphere` friend functions

template<typenameCharT,typenameTraits>
 friendstd::basic_ostream<CharT,Traits>&
 operator<<(std::basic_ostream<CharT,Traits>&os,
            constuniform_on_sphere&sd);

Пишет распределение<std::ostream>

template<typenameCharT,typenameTraits>
 friendstd::basic_istream<CharT,Traits>&
 operator>>(std::basic_istream<CharT,Traits>&is,
            constuniform_on_sphere&sd);

Читает распределение от<std::istream>

<
```
friendbooloperator==(constuniform_on_sphere&lhs,
                      constuniform_on_sphere&rhs);
```
>
Возвращается истинно, если два распределения производят одинаковые последовательности значений, заданные равными генераторами.
<
```
friendbooloperator!=(constuniform_on_sphere&lhs,
                      constuniform_on_sphere&rhs);
```
>
Возвращается истинно, если два распределения могут производить различные последовательности значений, заданные равными генераторами.

Статья Class template uniform_on_sphere раздела The Boost C++ Libraries BoostBook Documentation Subset Reference может быть полезна для разработчиков на c++ и boost.

Class template uniform_on_sphere

Boost , The Boost C++ Libraries BoostBook Documentation Subset , Reference

Boost C++ Libraries

Class template uniform_on_sphere

Synopsis

Description

uniform_on_sphere public construct/copy/destruct

uniform_on_sphere public member functions

uniform_on_sphere friend functions

`uniform_on_sphere` public construct/copy/destruct

`uniform_on_sphere` public member functions

`uniform_on_sphere` friend functions