Spec-Zone.ru › Ruby 2.7

класс Random

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

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

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

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

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

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

Константы

DEFAULT

По умолчанию псевдослучайный генератор чисел. Используется методами класса Random.

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

bytes(size) → string Показать исходный код
static VALUE
random_s_bytes(VALUE obj, VALUE len)
{
    rb_random_t *rnd = rand_start(&default_rand);
    return genrand_bytes(rnd, NUM2LONG(rb_to_int(len)));
}

Возвращает случайную двоичную строку. Аргумент size указывает длину возвращаемой строки.

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 (rb_check_arity(argc, 0, 1) == 0) {
        rb_check_frozen(obj);
        vseed = random_seed(obj);
    }
    else {
        vseed = argv[0];
        rb_check_copyable(obj, vseed);
        vseed = rb_to_int(vseed);
    }
    rnd->seed = rand_init(&rnd->mt, vseed);
    return obj;
}

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

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

new_seed → integer Показать исходный код
static VALUE
random_seed(VALUE _)
{
    VALUE v;
    uint32_t buf[DEFAULT_SEED_CNT+1];
    fill_random_seed(buf, DEFAULT_SEED_CNT);
    v = make_seed_value(buf, DEFAULT_SEED_CNT);
    explicit_bzero(buf, DEFAULT_SEED_LEN);
    return v;
}

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

Random.new_seed  #=> 115032730400174366788466674494640623225
rand → float Показать исходный код
rand(max) → number
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.

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 (rb_check_arity(argc, 0, 1) == 0) {
        seed = random_seed(obj);
    }
    else {
        seed = rb_to_int(argv[0]);
    }
    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]
urandom(size) → string Показать исходный код
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, TRUE))
        rb_raise(rb_eRuntimeError, "failed to get urandom");
    return buf;
}

Возвращает строку, используя возможности платформы. Ожидается, что возвращаемое значение будет криптографически безопасным псевдослучайным числом в двоичном формате. Этот метод генерирует исключение RuntimeError, если платформа не смогла подготовить результат.

В 2017 году в man-странице Linux random(7) было написано, что «ни один криптографический примитив, доступный сегодня, не может надеяться на обещание больше, чем 256 бит безопасности». Поэтому может быть сомнительно передавать значение size > 32 в этот метод.

Random.urandom(8)  #=> "\x78\x41\xBA\xAF\x7D\xEA\xD8\xEA"

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

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 (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 rb_equal(r1->seed, r2->seed);
}

Возвращает 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) → string Показать исходный код
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 → float Показать исходный код
rand(max) → number
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 является Integer, rand возвращает случайное целое число, большее или равное нулю и меньшее max. В отличие от Kernel.rand, когда max является отрицательным целым числом или нулем, rand генерирует исключение ArgumentError.

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

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

prng.rand(1.5)       # => 1.4600282860034115

Когда max является Range, 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 → integer Показать исходный код
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