Spec-Zone.ru › Ruby 2.3

класс Random

Родитель:
Объект
Включенные модули:
Random::Formatter

Random предоставляет интерфейс к псевдослучайному генератору чисел Ruby, или PRNG. PRNG генерирует детерминированную последовательность битов, приближающуюся к истинному случайному выбору. Последовательность может быть представлена целыми числами, числами с плавающей точкой или бинарными строками.

Генератор можно инициализировать значением начального состояния, сгенерированным системой или заданным пользователем, используя ::srand.

Метод класса #rand предоставляет базовые возможности Kernel#rand вместе с лучшей обработкой чисел с плавающей точкой. Оба метода являются интерфейсами к Random::DEFAULT, системному PRNG Ruby.

::new создаст новый PRNG со состоянием, независимым от Random::DEFAULT, что позволяет одновременно существовать нескольким генераторам с различными значениями начального состояния или позициями в последовательности. Объекты Random могут быть сериализованы, что позволяет сохранять и возобновлять последовательности.

PRNG в настоящее время реализован как модифицированный генератор Мерсенна-Твистера с периодом 219937-1.

Публичные методы класса

new(seed = Random.new_seed) → prng Показать исходный код
static VALUE
random_init(int argc, VALUE *argv, VALUE obj)
{
    VALUE vseed;
    rb_random_t *rnd = get_rnd(obj);

    if (argc == 0) {
        rb_check_frozen(obj);
        vseed = random_seed();
    }
    else {
        rb_scan_args(argc, argv, "01", &vseed);
        rb_check_copyable(obj, vseed);
    }
    rnd->seed = rand_init(&rnd->mt, vseed);
    return obj;
}

Создаёт новый PRNG, используя seed для установки начального состояния. Если seed опущено, генератор инициализируется с помощью ::new_seed.

См. ::srand для получения дополнительной информации об использовании значений начального состояния.

new_seed → целое Показать исходный код
static VALUE
random_seed(void)
{
    uint32_t buf[DEFAULT_SEED_CNT];
    fill_random_seed(buf);
    return make_seed_value(buf);
}

Возвращает произвольное значение начального состояния. Оно используется методом ::new, когда значение начального состояния не указано в качестве аргумента.

Random.new_seed  #=> 115032730400174366788466674494640623225
rand → вещественное Показать исходный код
rand(max) → число
static VALUE
random_s_rand(int argc, VALUE *argv, VALUE obj)
{
    VALUE v = rand_random(argc, argv, Qnil, rand_start(&default_rand));
    check_random_number(v, argv);
    return v;
}

Псевдоним для Random::DEFAULT.rand.

raw_seed(size) → строка Показать исходный код
static VALUE
random_raw_seed(VALUE self, VALUE size)
{
    long n = NUM2ULONG(size);
    VALUE buf = rb_str_new(0, n);
    if (n == 0) return buf;
    if (fill_random_bytes(RSTRING_PTR(buf), n, FALSE)) return Qnil;
    return buf;
}

Возвращает строку-начальное состояние в сыром виде, используя платформенные возможности.

Random.raw_seed(8)  #=> "\x78\x41\xBA\xAF\x7D\xEA\xD8\xEA"
srand(number = Random.new_seed) → old_seed Показать исходный код
static VALUE
rb_f_srand(int argc, VALUE *argv, VALUE obj)
{
    VALUE seed, old;
    rb_random_t *r = &default_rand;

    if (argc == 0) {
        seed = random_seed();
    }
    else {
        rb_scan_args(argc, argv, "01", &seed);
    }
    old = r->seed;
    r->seed = rand_init(&r->mt, seed);

    return old;
}

Устанавливает начальное состояние системного псевдослучайного генератора чисел, Random::DEFAULT, с помощью number. Возвращает предыдущее значение начального состояния.

Если number опущено, то генератор инициализируется с помощью источника энтропии, предоставленного операционной системой (если доступен /dev/urandom на Unix-системах или криптографический провайдер RSA на Windows), который затем комбинируется со временем, идентификатором процесса и номером последовательности.

srand может быть использован для обеспечения воспроизводимых последовательностей псевдослучайных чисел между разными запусками программы. Установив начальное состояние в известное значение, программы могут быть сделаны детерминированными во время тестирования.

srand 1234               # => 268519324636777531569100071560086917274
[ rand, rand ]           # => [0.1915194503788923, 0.6221087710398319]
[ rand(10), rand(1000) ] # => [4, 664]
srand 1234               # => 1234
[ rand, rand ]           # => [0.1915194503788923, 0.6221087710398319]

Публичные методы экземпляра

prng1 == prng2 → true или false Показать исходный код
static VALUE
random_equal(VALUE self, VALUE other)
{
    rb_random_t *r1, *r2;
    if (rb_obj_class(self) != rb_obj_class(other)) return Qfalse;
    r1 = get_rnd(self);
    r2 = get_rnd(other);
    if (!RTEST(rb_funcall2(r1->seed, rb_intern("=="), 1, &r2->seed))) return Qfalse;
    if (memcmp(r1->mt.state, r2->mt.state, sizeof(r1->mt.state))) return Qfalse;
    if ((r1->mt.next - r1->mt.state) != (r2->mt.next - r2->mt.state)) return Qfalse;
    if (r1->mt.left != r2->mt.left) return Qfalse;
    return Qtrue;
}

Возвращает true, если два генератора имеют одинаковое внутреннее состояние, иначе false. Эквивалентные генераторы вернут ту же последовательность псевдослучайных чисел. Два генератора, как правило, будут иметь одинаковое состояние только в том случае, если они были инициализированы одним и тем же начальным состоянием.

Random.new == Random.new             # => false
Random.new(1234) == Random.new(1234) # => true

и имеют одинаковую историю вызовов.

prng1 = Random.new(1234)
prng2 = Random.new(1234)
prng1 == prng2 # => true

prng1.rand     # => 0.1915194503788923
prng1 == prng2 # => false

prng2.rand     # => 0.1915194503788923
prng1 == prng2 # => true
bytes(size) → строка Показать исходный код
static VALUE
random_bytes(VALUE obj, VALUE len)
{
    return genrand_bytes(get_rnd(obj), NUM2LONG(rb_to_int(len)));
}

Возвращает случайную бинарную строку, содержащую size байтов.

random_string = Random.new.bytes(10) # => "\xD7:R\xAB?\x83\xCE\xFAkO"
random_string.size                   # => 10
rand → вещественное Показать исходный код
rand(max) → число
static VALUE
random_rand(int argc, VALUE *argv, VALUE obj)
{
    VALUE v = rand_random(argc, argv, obj, get_rnd(obj));
    check_random_number(v, argv);
    return v;
}

Если max — целое число, rand возвращает случайное целое число, большее или равное нулю и меньшее max. В отличие от Kernel#rand, когда max является отрицательным целым числом или нулем, rand вызывает ArgumentError.

prng = Random.new
prng.rand(100)       # => 42

Если max — число с плавающей точкой, rand возвращает случайное число с плавающей точкой между 0.0 и max, включая 0.0 и исключая max.

prng.rand(1.5)       # => 1.4600282860034115

Если max — диапазон, rand возвращает случайное число, где range.member?(number) == true.

prng.rand(5..9)      # => one of [5, 6, 7, 8, 9]
prng.rand(5...9)     # => one of [5, 6, 7, 8]
prng.rand(5.0..9.0)  # => between 5.0 and 9.0, including 9.0
prng.rand(5.0...9.0) # => between 5.0 and 9.0, excluding 9.0

Как начальное, так и конечное значения диапазона должны поддерживать методы вычитания (-) и сложения (+), иначе rand вызовет ArgumentError.

seed → целое Показать исходный код
static VALUE
random_get_seed(VALUE obj)
{
    return get_rnd(obj)->seed;
}

Возвращает значение начального состояния, используемое для инициализации генератора. Его можно использовать для инициализации другого генератора с тем же состоянием в более позднее время, заставляя его генерировать ту же последовательность чисел.

prng1 = Random.new(1234)
prng1.seed       #=> 1234
prng1.rand(100)  #=> 47

prng2 = Random.new(prng1.seed)
prng2.rand(100)  #=> 47

Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API