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

Class template shuffle_order_engine

boost::random::shuffle_order_engine

Synopsis

// In header: <boost/random/shuffle_order.hpp>
template<typename UniformRandomNumberGenerator, std::size_t k> 
class shuffle_order_engine {
public:
  // types
  typedef UniformRandomNumberGenerator base_type;  
  typedef base_type::result_type       result_type;
  // construct/copy/destruct
  shuffle_order_engine();
  explicit shuffle_order_engine(result_type);
  template<typename SeedSeq> explicit shuffle_order_engine(SeedSeq &);
  explicit shuffle_order_engine(const base_type &);
  explicit shuffle_order_engine(base_type &&);
  template<typename It> shuffle_order_engine(It &, It);
  // public member functions
  void seed();
  void seed(result_type);
  template<typename SeedSeq> void seed(SeedSeq &);
  template<typename It> void seed(It &, It);
  const base_type & base() const;
  result_type operator()();
  void discard(boost::uintmax_t);
  template<typename Iter> void generate(Iter, Iter);
  // public static functions
  static result_type min();
  static result_type max();
  // friend functions
  template<typename CharT, typename Traits> 
    friend std::basic_ostream< CharT, Traits > & 
    operator<<(std::basic_ostream< CharT, Traits > &, 
               const shuffle_order_engine &);
  template<typename CharT, typename Traits> 
    friend std::basic_istream< CharT, Traits > & 
    operator>>(std::basic_istream< CharT, Traits > &, 
               const shuffle_order_engine &);
  friend bool operator==(const shuffle_order_engine &, 
                         const shuffle_order_engine &);
  friend bool operator!=(const shuffle_order_engine &, 
                         const shuffle_order_engine &);
  // public data members
  static const bool has_fixed_range;
  static const std::size_t buffer_size;
  static const std::size_t table_size;
};

Description

Введение шаблона класса shuffle_order_engine модели pseudo-случайного генератора чисел. Он смешивает выход некоторых (обычно линейный_конгруэнциальный_двигатель ) однородный генератор случайных чисел , чтобы получить лучшие статистические свойства. Алгоритм описывается в

"Improving a poor random number generator", Carter Bays and S.D. Durham, ACM Transactions on Mathematical Software, Vol 2, No. 1, March 1976, pp. http://doi.acm.org/10.1145/355666.355670<1

Выход генератора базы буферизуется в массиве длины k. Каждый вывод X(n) имеет вторую роль: Он дает индекс в массив, где будет извлечен X(n+1). Используемые элементы массива заменяются свежим выходом из базового генератора.

Параметрами шаблона являются базовый генератор и длина матрицы k, которая должна быть около 100.

`shuffle_order_engine` public construct/copy/destruct

```
shuffle_order_engine;
```
Создает shuffle_order_engine, вызывая по умолчанию конструктор базового генератора.

Сложность: ровно k+1 вызовы базового генератора.
```
explicit shuffle_order_engine(result_type s);
```
Создает конструктор shuffle_output_engine, используя семенной параметр.

Сложность: ровно k+1 вызовов базового генератора.

template<typename SeedSeq> explicitshuffle_order_engine

```
explicit shuffle_order_engine(const base_type & rng);
```
Создает shuffle_output_engine с помощью копии предоставленного генератора.

Предпосылка: Аргумент шаблона UniformRandomNumberGenerator должен обозначать тип CopyConstructible.

Сложность: точно k+1 вызовы базового генератора.

explicit shuffle_order_engine(base_type&& rng;

template<typenameIt>shuffle_order_engine(It , Last;

`shuffle_order_engine` public member functions

```
void seed();
```
```
void seed(result_type seed);
```
Взывает метод одноаргументного семени базового генератора с параметром seed и повторно инициирует внутренний буферный массив.

Комплексность: ровно k+1 вызовов базового генератора.
```
templatetypename SeedSeq> voidseedSeedSeq & seq;
```
Взывает метод одноаргументного семени базового генератора с параметром seq и повторно инициирует внутренний буферный массив.

Комплексность: Ровно k+1 вызовы базового генератора.

template<typenameIt>voidseed(It ,It Last;

```
const base_type & base const;
```
```
result_type оператор();
```
```
voiddiscard(boost::uintmax_t z);
```
Передвигает генератор по шагам z.
```
template<typename Iter> voidgenerate(Iter first, Iter last);
```
Заполняет диапазон псевдослучайными значениями.

`shuffle_order_engine` public static functions

```
static result_typemin();
```
Возвращает наименьшее значение, которое может произвести генератор.
```
static result_typemax();
```
Возвращает наибольшее значение, которое может произвести генератор.

`shuffle_order_engine` friend functions

templatetypename CharT,Traitsbasic_ostream>,>операторbasic_ostream<,>  os, const&>;2>shuffle_order_engineWrites a  to std::ostream


templatetypename CharT,TraitsBasic_istream> > операторBasic_istream<>>>constshuffle_order_engineЧитает  из std::istream:8>

friend boolоператорconst shuffle_order_engine , constshuffle_order_engine  &;
 Возвращается верно, если два генератора будут производить идентичные последовательности. 

friendboolоператор!=constshuffle_order_engine, constshuffle_order_engine,  shuffle_order_engine& rhs;
 Вернется верно, если два генератора будут производить разные последовательности.

Class template shuffle_order_engine

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

Boost C++ Libraries

Class template shuffle_order_engine

Synopsis

Description

shuffle_order_engine public construct/copy/destruct

shuffle_order_engine public member functions

shuffle_order_engine public static functions

shuffle_order_engine friend functions

`shuffle_order_engine` public construct/copy/destruct

`shuffle_order_engine` public member functions

`shuffle_order_engine` public static functions

`shuffle_order_engine` friend functions