class Enumerator::Product

Родительский класс:: Enumerator

Enumerator::Product генерирует декартово произведение любого числа перечислимых объектов. Итерация по произведению перечислимых объектов примерно эквивалентна вложенным циклам each_entry, где цикл для самого правого объекта является внутренним.

innings = Enumerator::Product.new(1..9, ['top', 'bottom'])

innings.each do |i, h|
  p [i, h]
end
# [1, "top"]
# [1, "bottom"]
# [2, "top"]
# [2, "bottom"]
# [3, "top"]
# [3, "bottom"]
# ...
# [9, "top"]
# [9, "bottom"]

Для каждого перечислимого объекта используется метод ‘each_entry` вместо `each`, чтобы произведение N перечислимых объектов возвращало массив ровно из N элементов на каждой итерации.

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

Объекты этого типа можно создать с помощью Enumerator.product.

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

Enumerator::Product.new(*enums) → enum Показать исходный код

static VALUE
enum_product_initialize(int argc, VALUE *argv, VALUE obj)
{
    struct enum_product *ptr;
    VALUE enums = Qnil, options = Qnil;

    rb_scan_args(argc, argv, "*:", &enums, &options);

    if (!NIL_P(options) && !RHASH_EMPTY_P(options)) {
        rb_exc_raise(rb_keyword_error_new("unknown", rb_hash_keys(options)));
    }

    rb_check_frozen(obj);
    TypedData_Get_Struct(obj, struct enum_product, &enum_product_data_type, ptr);

    if (!ptr) rb_raise(rb_eArgError, "unallocated product");

    RB_OBJ_WRITE(obj, &ptr->enums, rb_ary_freeze(enums));

    return obj;
}

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

e = Enumerator::Product.new(1..3, [4, 5])
e.to_a #=> [[1, 4], [1, 5], [2, 4], [2, 5], [3, 4], [3, 5]]
e.size #=> 6

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

each { |...| ... } → obj Показать исходный код

each → enumerator

static VALUE
enum_product_each(VALUE obj)
{
    RETURN_SIZED_ENUMERATOR(obj, 0, 0, enum_product_enum_size);

    return enum_product_run(obj, rb_block_proc());
}

Перебирает элементы первого перечислимого объекта, вызывая для него метод “each_entry” с заданными аргументами, затем последовательно переходит к следующим перечислимым объектам, пока не будут исчерпаны все перечислимые объекты.

Если блок не задан, возвращает перечислитель. В противном случае возвращает self.

inspect → string Показать исходный код

static VALUE
enum_product_inspect(VALUE obj)
{
    return rb_exec_recursive(inspect_enum_product, obj, 0);
}

Возвращает строковое представление перечислителя произведения.

rewind → obj Показать исходный код

static VALUE
enum_product_rewind(VALUE obj)
{
    struct enum_product *ptr = enum_product_ptr(obj);
    VALUE enums = ptr->enums;
    long i;

    for (i = 0; i < RARRAY_LEN(enums); i++) {
        rb_check_funcall(RARRAY_AREF(enums, i), id_rewind, 0, 0);
    }

    return obj;
}

Перематывает перечислитель произведения, вызывая метод “rewind” для каждого перечислимого объекта в обратном порядке. Каждый вызов выполняется, только если перечислимый объект поддерживает этот метод.

size → int, Float::INFINITY or nil Показать исходный код

static VALUE
enum_product_size(VALUE obj)
{
    return enum_product_total_size(enum_product_ptr(obj)->enums);
}

Возвращает общий размер произведения перечислителей, вычисленный путем перемножения размеров входящих в него перечислимых объектов. Если размер любого перечислимого объекта равен nil или Float::INFINITY, это значение возвращается в качестве размера.

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