Spec-Zone.ru › NumPy 1.17

Интерфейс итератора массивов

Новая версия 1.6.

Итератор массивов

Итератор массивов объединяет многие ключевые функции ufuncs, позволяя коду пользователя поддерживать такие функции, как параметры вывода, сохранение компоновки памяти и буферизацию данных с неправильным выравниванием или типом, без необходимости сложных кодировок.

На этой странице документирован интерфейс итератора. Итератор называется NpyIter, а функции называются NpyIter_*.

Существует вводное руководство по итерации массивов, которое может быть полезным для тех, кто использует этот C API. Во многих случаях полезно сначала протестировать идеи, создав итератор в Python, прежде чем писать код итерации на C.

Пример простой итерации

Лучший способ ознакомиться с итератором — изучить его использование в самом коде NumPy. Например, вот немного изменённая версия кода для PyArray_CountNonzero, который считает количество ненулевых элементов в массиве.

npy_intp PyArray_CountNonzero(PyArrayObject* self)
{
    /* Nonzero boolean function */
    PyArray_NonzeroFunc* nonzero = PyArray_DESCR(self)->f->nonzero;

    NpyIter* iter;
    NpyIter_IterNextFunc *iternext;
    char** dataptr;
    npy_intp nonzero_count;
    npy_intp* strideptr,* innersizeptr;

    /* Handle zero-sized arrays specially */
    if (PyArray_SIZE(self) == 0) {
        return 0;
    }

    /*
     * Create and use an iterator to count the nonzeros.
     *   flag NPY_ITER_READONLY
     *     - The array is never written to.
     *   flag NPY_ITER_EXTERNAL_LOOP
     *     - Inner loop is done outside the iterator for efficiency.
     *   flag NPY_ITER_NPY_ITER_REFS_OK
     *     - Reference types are acceptable.
     *   order NPY_KEEPORDER
     *     - Visit elements in memory order, regardless of strides.
     *       This is good for performance when the specific order
     *       elements are visited is unimportant.
     *   casting NPY_NO_CASTING
     *     - No casting is required for this operation.
     */
    iter = NpyIter_New(self, NPY_ITER_READONLY|
                             NPY_ITER_EXTERNAL_LOOP|
                             NPY_ITER_REFS_OK,
                        NPY_KEEPORDER, NPY_NO_CASTING,
                        NULL);
    if (iter == NULL) {
        return -1;
    }

    /*
     * The iternext function gets stored in a local variable
     * so it can be called repeatedly in an efficient manner.
     */
    iternext = NpyIter_GetIterNext(iter, NULL);
    if (iternext == NULL) {
        NpyIter_Deallocate(iter);
        return -1;
    }
    /* The location of the data pointer which the iterator may update */
    dataptr = NpyIter_GetDataPtrArray(iter);
    /* The location of the stride which the iterator may update */
    strideptr = NpyIter_GetInnerStrideArray(iter);
    /* The location of the inner loop size which the iterator may update */
    innersizeptr = NpyIter_GetInnerLoopSizePtr(iter);

    nonzero_count = 0;
    do {
        /* Get the inner loop data/stride/count values */
        char* data = *dataptr;
        npy_intp stride = *strideptr;
        npy_intp count = *innersizeptr;

        /* This is a typical inner loop for NPY_ITER_EXTERNAL_LOOP */
        while (count--) {
            if (nonzero(data, self)) {
                ++nonzero_count;
            }
            data += stride;
        }

        /* Increment the iterator to the next inner loop */
    } while(iternext(iter));

    NpyIter_Deallocate(iter);

    return nonzero_count;
}

Пример простой многократной итерации

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

PyObject *CopyArray(PyObject *arr, NPY_ORDER order)
{
    NpyIter *iter;
    NpyIter_IterNextFunc *iternext;
    PyObject *op[2], *ret;
    npy_uint32 flags;
    npy_uint32 op_flags[2];
    npy_intp itemsize, *innersizeptr, innerstride;
    char **dataptrarray;

    /*
     * No inner iteration - inner loop is handled by CopyArray code
     */
    flags = NPY_ITER_EXTERNAL_LOOP;
    /*
     * Tell the constructor to automatically allocate the output.
     * The data type of the output will match that of the input.
     */
    op[0] = arr;
    op[1] = NULL;
    op_flags[0] = NPY_ITER_READONLY;
    op_flags[1] = NPY_ITER_WRITEONLY | NPY_ITER_ALLOCATE;

    /* Construct the iterator */
    iter = NpyIter_MultiNew(2, op, flags, order, NPY_NO_CASTING,
                            op_flags, NULL);
    if (iter == NULL) {
        return NULL;
    }

    /*
     * Make a copy of the iternext function pointer and
     * a few other variables the inner loop needs.
     */
    iternext = NpyIter_GetIterNext(iter, NULL);
    innerstride = NpyIter_GetInnerStrideArray(iter)[0];
    itemsize = NpyIter_GetDescrArray(iter)[0]->elsize;
    /*
     * The inner loop size and data pointers may change during the
     * loop, so just cache the addresses.
     */
    innersizeptr = NpyIter_GetInnerLoopSizePtr(iter);
    dataptrarray = NpyIter_GetDataPtrArray(iter);

    /*
     * Note that because the iterator allocated the output,
     * it matches the iteration order and is packed tightly,
     * so we don't need to check it like the input.
     */
    if (innerstride == itemsize) {
        do {
            memcpy(dataptrarray[1], dataptrarray[0],
                                    itemsize * (*innersizeptr));
        } while (iternext(iter));
    } else {
        /* For efficiency, should specialize this based on item size... */
        npy_intp i;
        do {
            npy_intp size = *innersizeptr;
            char *src = dataptrarray[0], *dst = dataptrarray[1];
            for(i = 0; i < size; i++, src += innerstride, dst += itemsize) {
                memcpy(dst, src, itemsize);
            }
        } while (iternext(iter));
    }

    /* Get the result from the iterator object array */
    ret = NpyIter_GetOperandArray(iter)[1];
    Py_INCREF(ret);

    if (NpyIter_Deallocate(iter) != NPY_SUCCEED) {
        Py_DECREF(ret);
        return NULL;
    }

    return ret;
}

Типы данных итератора

Структура итератора — внутренняя деталь, и код пользователя видит только неполную структуру.

NpyIter

Это тип указателя, используемый для итератора. Доступ к его содержимому возможен только через API итератора.

NpyIter_Type

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

NpyIter_IterNextFunc

Это указатель на функцию для цикла итерации, возвращаемый NpyIter_GetIterNext.

NpyIter_GetMultiIndexFunc

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

Создание и уничтожение

NpyIter* NpyIter_New(PyArrayObject* op, npy_uint32 flags, NPY_ORDER order, NPY_CASTING casting, PyArray_Descr* dtype)

Создаёт итератор для данного объекта массива NumPy op.

Флаги, которые могут быть переданы в flags — это любая комбинация глобальных и операционных флагов, документированных в NpyIter_MultiNew, за исключением NPY_ITER_ALLOCATE.

Любое значение перечисления NPY_ORDER можно передать в order. Для эффективной итерации лучше всего использовать NPY_KEEPORDER, а другие порядки обеспечивают определённый порядок итерации.

Любое значение перечисления NPY_CASTING можно передать в casting. Значения включают NPY_NO_CASTING, NPY_EQUIV_CASTING, NPY_SAFE_CASTING, NPY_SAME_KIND_CASTING и NPY_UNSAFE_CASTING. Для возможности преобразований также необходимо включить копирование или буферизацию.

Если dtype не равно NULL, то требуется этот тип данных. Если разрешено копирование, то будет создана временная копия, если данные допускают преобразование. Если включён NPY_ITER_UPDATEIFCOPY, то при уничтожении итератора данные также будут скопированы обратно с другим преобразованием.

Возвращает NULL, если возникла ошибка, в противном случае возвращает выделенный итератор.

Чтобы создать итератор, похожий на старый итератор, это должно сработать.

iter = NpyIter_New(op, NPY_ITER_READWRITE,
                    NPY_CORDER, NPY_NO_CASTING, NULL);

Если вы хотите изменить массив с выровненным double кодом, но порядок не важен, то следует использовать это.

dtype = PyArray_DescrFromType(NPY_DOUBLE);
iter = NpyIter_New(op, NPY_ITER_READWRITE|
                    NPY_ITER_BUFFERED|
                    NPY_ITER_NBO|
                    NPY_ITER_ALIGNED,
                    NPY_KEEPORDER,
                    NPY_SAME_KIND_CASTING,
                    dtype);
Py_DECREF(dtype);
NpyIter* NpyIter_MultiNew(npy_intp nop, PyArrayObject** op, npy_uint32 flags, NPY_ORDER order, NPY_CASTING casting, npy_uint32* op_flags, PyArray_Descr** op_dtypes)

Создает итератор для трансляции массивов объектов nop, предоставленных в op, используя стандартные правила трансляции NumPy.

Любые значения перечисления NPY_ORDER могут быть переданы в order. Для эффективной итерации наилучшим вариантом является NPY_KEEPORDER, а другие порядки обеспечивают определенный порядок итерации. При использовании NPY_KEEPORDER, если вы также хотите гарантировать, что итерация не будет обращена вдоль оси, вы должны передать флаг NPY_ITER_DONT_NEGATE_STRIDES.

Любые значения перечисления NPY_CASTING могут быть переданы в casting. Значения включают NPY_NO_CASTING, NPY_EQUIV_CASTING, NPY_SAFE_CASTING, NPY_SAME_KIND_CASTING и NPY_UNSAFE_CASTING. Для разрешения преобразований также необходимо включить копирование или буферизацию.

Если op_dtypes не NULL, он указывает тип данных или NULL для каждого op[i].

Возвращает NULL в случае ошибки, в противном случае возвращает выделенный итератор.

Флаги, которые могут быть переданы в flags, относятся ко всему итератору:

NPY_ITER_C_INDEX

Приводит к тому, что итератор отслеживает развернутый плоский индекс, соответствующий порядку C. Этот вариант не может быть использован с NPY_ITER_F_INDEX.

NPY_ITER_F_INDEX

Приводит к тому, что итератор отслеживает развернутый плоский индекс, соответствующий порядку Fortran. Этот вариант не может быть использован с NPY_ITER_C_INDEX.

NPY_ITER_MULTI_INDEX

Приводит к тому, что итератор отслеживает многомерный индекс. Это предотвращает слияние осей для создания больших внутренних циклов. Если цикл также не буферизован и не отслеживается индекс (NpyIter_RemoveAxis может быть вызван), то размер итератора может быть -1 для указания того, что итератор слишком большой. Это может произойти из-за сложной трансляции и приведет к ошибкам при установке диапазона итератора, удалении многомерного индекса или получении следующей функции. Однако возможно снова удалить оси и использовать итератор нормально, если размер достаточно мал после удаления.

NPY_ITER_EXTERNAL_LOOP

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

Этот флаг несовместим с NPY_ITER_C_INDEX, NPY_ITER_F_INDEX и NPY_ITER_MULTI_INDEX.

NPY_ITER_DONT_NEGATE_STRIDES

Это влияет только на итератор, когда для параметра порядка указано NPY_KEEPORDER. По умолчанию с NPY_KEEPORDER итератор обращает оси с отрицательными шагами, чтобы память проходилась в прямом направлении. Этот шаг отключается. Используйте этот флаг, если вы хотите использовать порядок хранения памяти осей, но не хотите, чтобы ось была обращена. Такое поведение, например, у numpy.ravel(a, order='K').

NPY_ITER_COMMON_DTYPE

Приводит к тому, что итератор преобразует все операнды в один общий тип данных, рассчитанный на основе правил повышения типа ufunc. Копирование или буферизация должны быть включены.

Если общий тип данных известен заранее, не используйте этот флаг. Вместо этого установите требуемый тип данных для всех операндов.

NPY_ITER_REFS_OK

Указывает, что массивы со ссылками (массивы объектов или структурированные массивы, содержащие тип объекта) могут быть приняты и использованы в итераторе. Если этот флаг включён, вызывающий должен убедиться, что NpyIter_IterationNeedsAPI(iter) истинно, в противном случае он не может освободить GIL во время итерации.

NPY_ITER_ZEROSIZE_OK

Указывает, что массивы с размером ноль должны быть разрешены. Поскольку типичный цикл итерации не работает естественным образом с массивами нулевого размера, вы должны убедиться, что IterSize больше нуля, прежде чем входить в цикл итерации. В настоящее время проверяются только операнды, а не принудительная форма.

NPY_ITER_REDUCE_OK

Разрешает доступные для записи операнды с размером измерения с нулевым шагом и размером больше единицы. Обратите внимание, что такие операнды должны быть доступны для чтения/записи.

При включенной буферизации также переключается на специальный режим буферизации, который уменьшает длину цикла по мере необходимости, чтобы не перезаписывать значения, которые уменьшаются.

Обратите внимание, что если вы хотите выполнить уменьшение на автоматически выделенном выходе, вы должны использовать NpyIter_GetOperandArray для получения его ссылки, а затем установить каждое значение на единицу уменьшения перед выполнением цикла итерации. В случае буферизованного уменьшения это также означает, что вы должны указать флаг NPY_ITER_DELAY_BUFALLOC, а затем перезапустить итератор после инициализации выделенного операнда для подготовки буферов.

NPY_ITER_RANGED

Включает поддержку итерации по поддиапазонам всего диапазона iterindex [0, NpyIter_IterSize(iter)). Используйте функцию NpyIter_ResetToIterIndexRange для указания диапазона итерации.

Этот флаг может использоваться только с NPY_ITER_EXTERNAL_LOOP, когда NPY_ITER_BUFFERED включен. Это связано с тем, что без буферизации внутренний цикл всегда имеет размер наименьшего измерения итерации, а разрешение его разделения потребовало бы специальной обработки, фактически сделав его похожим на буферизованную версию.

NPY_ITER_BUFFERED

Приводит к тому, что итератор сохраняет данные буферизации и использует буферизацию для удовлетворения требований к типу данных, выравниванию и порядку байтов. Чтобы буферизовать операнд, не указывайте флаги NPY_ITER_COPY или NPY_ITER_UPDATEIFCOPY, поскольку они переопределят буферизацию. Буферизация особенно полезна для кода Python, использующего итератор, позволяя обрабатывать большие блоки данных сразу, чтобы амортизировать накладные расходы интерпретатора Python.

При использовании с NPY_ITER_EXTERNAL_LOOP внутренний цикл вызывающего может получить блоки данных большего размера, чем возможно без буферизации, из-за того, как организованы шаги.

Обратите внимание, что если операнду задан флаг NPY_ITER_COPY или NPY_ITER_UPDATEIFCOPY, будет выполнена копия вместо буферизации. Буферизация всё равно произойдёт, если массив был транслирован, поэтому элементы должны быть дублированы для получения постоянного шага.

В обычной буферизации размер каждого внутреннего цикла равен размеру буфера или, возможно, больше, если указан NPY_ITER_GROWINNER. Если включён NPY_ITER_REDUCE_OK и происходит уменьшение, внутренние циклы могут стать меньше в зависимости от структуры уменьшения.

NPY_ITER_GROWINNER

При включенной буферизации это позволяет размеру внутреннего цикла увеличиваться, когда буферизация не требуется. Этот параметр лучше всего использовать при прямом прохождении всех данных, а не при работе с небольшими массивами временных значений для каждого внутреннего цикла.

NPY_ITER_DELAY_BUFALLOC

При включенной буферизации это откладывает выделение буферов до вызова NpyIter_Reset или другой функции сброса. Этот флаг существует для предотвращения нецелесообразного копирования данных буфера при создании нескольких копий буферизованного итератора для многопоточной итерации.

Другое использование этого флага — для настройки операций уменьшения. После создания итератора и автоматического выделения выхода уменьшения итератором (обязательно использовать доступ READWRITE) его значение можно инициализировать до единицы уменьшения. Используйте NpyIter_GetOperandArray для получения объекта. Затем вызовите NpyIter_Reset для выделения и заполнения буферов их начальными значениями.

NPY_ITER_COPY_IF_OVERLAP

Если какой-либо операнд записи перекрывается с каким-либо операндом чтения, все перекрытия устраняются путём создания временных копий (при необходимости включения UPDATEIFCOPY для операндов записи). Пара операндов перекрывается, если существует адрес памяти, содержащий данные, общие для обеих массивов.

Поскольку точное обнаружение перекрытия имеет экспоненциальное время выполнения по количеству измерений, решение принимается на основе эвристик, которые имеют ложные срабатывания (необходимые копии в необычных случаях), но не имеют ложных отрицаний.

Если существует какое-либо перекрытие чтения/записи, этот флаг гарантирует, что результат операции такой же, как если бы все операнды были скопированы. В случаях, когда необходимо создать копии, результат вычисления может быть неопределённым без этого флага!

Флаги, которые могут быть переданы в op_flags[i], где 0 <= i < nop:

NPY_ITER_READWRITE
NPY_ITER_READONLY
NPY_ITER_WRITEONLY

Указывают, как пользователь итератора будет читать или записывать в op[i]. Ровно один из этих флагов должен быть указан для каждого операнда. Использование NPY_ITER_READWRITE или NPY_ITER_WRITEONLY для операнда, предоставленного пользователем, может вызвать семантику WRITEBACKIFCOPY`. Данные будут перезаписаны в исходный массив при вызове NpyIter_Deallocate.

NPY_ITER_COPY

Разрешить копирование op[i] в случае, если он не соответствует требованиям типа данных или выравнивания, как указано в флагах и параметрах конструктора.

NPY_ITER_UPDATEIFCOPY

Вызывает NPY_ITER_COPY, и когда операнд массива помечен для записи и скопирован, данные в копии копируются обратно в op[i] при вызове NpyIter_Deallocate.

Если операнд помечен как только для записи и требуется копия, будет создан неинициализированный временный массив, а затем скопирован обратно в op[i] при вызове NpyIter_Deallocate, вместо ненужной операции копирования.

NPY_ITER_NBO
NPY_ITER_ALIGNED
NPY_ITER_CONTIG

Приводит к тому, что итератор предоставляет данные для op[i] в родном байтовом порядке, выровненные в соответствии с требованиями dtype, непрерывные или любые комбинации.

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

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

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

NPY_ITER_ALLOCATE

Это относится к выходным массивам и требует, чтобы был установлен флаг NPY_ITER_WRITEONLY или NPY_ITER_READWRITE. Если op[i] равен NULL, создаёт новый массив с конечными размерами векторизации и структурой, соответствующей порядку итерации итератора.

Когда op[i] равен NULL, запрашиваемый тип данных op_dtypes[i] также может быть NULL, в этом случае он автоматически генерируется из типов данных массивов, помеченных как читаемые. Правила генерации типа данных такие же, как для UFuncs. Особо следует отметить обработку байтового порядка в выбранном типе данных. Если имеется ровно один входной массив, тип данных входного массива используется как есть. В противном случае, если несколько типов данных входных массивов объединяются вместе, выходной массив будет в родном байтовом порядке.

После выделения с этим флагом вызывающая сторона может получить новый массив, вызвав NpyIter_GetOperandArray и получив i-й объект в возвращённом массиве C. Вызывающая сторона должна вызвать Py_INCREF на нём, чтобы получить ссылку на массив.

NPY_ITER_NO_SUBTYPE

Для использования с NPY_ITER_ALLOCATE этот флаг отключает выделение подтипа массива для вывода, заставляя его быть прямым ndarray.

TODO: Возможно, лучше было бы ввести функцию NpyIter_GetWrappedOutput и убрать этот флаг?

NPY_ITER_NO_BROADCAST

Гарантирует, что входной или выходной массив точно соответствует размерам итерации.

NPY_ITER_ARRAYMASK

New in version 1.7.

Указывает, что этот операнд является маской, используемой для выбора элементов при записи в операнды, которым применён флаг NPY_ITER_WRITEMASKED. Только один операнд может иметь флаг NPY_ITER_ARRAYMASK.

Тип данных операнда с этим флагом должен быть либо NPY_BOOL, либо NPY_MASK, либо типом данных структуры, все поля которой являются допустимыми типами данных маски. В последнем случае он должен соответствовать операнду структуры, являющемуся WRITEMASKED, так как он задаёт маску для каждого поля этого массива.

Этот флаг влияет только на запись из буфера обратно в массив. Это означает, что если операнд также является NPY_ITER_READWRITE или NPY_ITER_WRITEONLY, код, выполняющий итерацию, может записывать в этот операнд для управления элементами, которые останутся неизменными и которые будут изменены. Это полезно, когда маска должна быть комбинацией входных масок.

NPY_ITER_WRITEMASKED

New in version 1.7.

Этот массив является маской для всех writemasked операндов. Код использует флаг writemasked, который указывает, что только те элементы, где выбранный операнд ARRAYMASK является True, будут записаны. Как правило, итератор не навязывает это, за кодом, выполняющим итерацию, остаётся ответственность за выполнение этого условия.

Когда используется флаг writemasked, а этот операнд буферизуется, это меняет способ копирования данных из буфера в массив. Используется процедура копирования с маской, которая копирует только элементы из буфера, для которых writemasked возвращает true от соответствующего элемента в операнде ARRAYMASK.

NPY_ITER_OVERLAP_ASSUME_ELEMENTWISE

При проверке перекрытия в памяти предполагается, что операнды с NPY_ITER_OVERLAP_ASSUME_ELEMENTWISE включённым обращаются только в порядке итерации.

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

Этот флаг действует только если NPY_ITER_COPY_IF_OVERLAP включён в итераторе.

NpyIter* NpyIter_AdvancedNew(npy_intp nop, PyArrayObject** op, npy_uint32 flags, NPY_ORDER order, NPY_CASTING casting, npy_uint32* op_flags, PyArray_Descr** op_dtypes, int oa_ndim, int** op_axes, npy_intp const* itershape, npy_intp buffersize)

Расширяет NpyIter_MultiNew несколькими расширенными параметрами, обеспечивающими больший контроль над векторизацией и буферизацией.

Если значения -1/NULL передаются в oa_ndim, op_axes, itershape, и buffersize, это эквивалентно NpyIter_MultiNew.

Параметр oa_ndim, если он не равен 0 или -1, указывает количество измерений, которые будут итерироваться с настраиваемой векторизацией. Если он задан, op_axes должен быть задан, а itershape также может быть задан. Параметр op_axes позволяет детально управлять тем, как оси массивов операндов совмещаются и итерируются. В op_axes, вы должны предоставить массив nop указателей на массивы размером oa_ndim типа npy_intp. Если элемент в op_axes равен NULL, будут применяться стандартные правила векторизации. В op_axes[j][i] хранится либо действительная ось массива op[j], либо -1, что означает newaxis. Внутри каждого массива op_axes[j] оси не могут повторяться. Следующий пример показывает, как применяется стандартная векторизация к 3-мерному массиву, 2-мерному массиву, 1-мерному массиву и скаляру.

Примечание: До NumPy 1.8 oa_ndim == 0` was used for signalling that that ``op_axes и itershape не используются. Это устарело и должно быть заменено на -1. Для достижения лучшей обратной совместимости в этом случае следует использовать NpyIter_MultiNew.

int oa_ndim = 3;               /* # iteration axes */
int op0_axes[] = {0, 1, 2};    /* 3-D operand */
int op1_axes[] = {-1, 0, 1};   /* 2-D operand */
int op2_axes[] = {-1, -1, 0};  /* 1-D operand */
int op3_axes[] = {-1, -1, -1}  /* 0-D (scalar) operand */
int* op_axes[] = {op0_axes, op1_axes, op2_axes, op3_axes};

Параметр itershape позволяет принудительно задать форму итерации итератора. Это массив длиной oa_ndim. Когда элемент имеет отрицательное значение, его значение определяется по операндам. Этот параметр позволяет автоматически выделять выходы с дополнительными измерениями, которые не соответствуют измерениям входных массивов.

Если buffersize равно нулю, используется размер буфера по умолчанию, в противном случае он указывает, какой размер буфера использовать. Рекомендуются буферы, являющиеся степенями двойки, такие как 4096 или 8192.

Возвращает NULL в случае ошибки, в противном случае возвращает выделенный итератор.

NpyIter* NpyIter_Copy(NpyIter* iter)

Создает копию данного итератора. Эта функция предназначена в первую очередь для возможности многопоточной итерации данных.

TODO: Переместить эту информацию в раздел о многопоточной итерации.

Рекомендуемый подход к многопоточной итерации заключается в предварительном создании итератора с флагами NPY_ITER_EXTERNAL_LOOP, NPY_ITER_RANGED, NPY_ITER_BUFFERED, NPY_ITER_DELAY_BUFALLOC и, возможно, NPY_ITER_GROWINNER. Создайте копию этого итератора для каждого потока (кроме одного для первого итератора). Затем возьмите диапазон индексов итерации [0, NpyIter_GetIterSize(iter)) и разделите его на задачи, например, используя цикл TBB parallel_for. Когда поток получает задачу для выполнения, он использует свою копию итератора, вызывая NpyIter_ResetToIterIndexRange и итерирует по всему диапазону.

При использовании итератора в многопоточных кодах или в кодах, не удерживающих блокировку Python GIL, необходимо следить за тем, чтобы вызывать только функции, безопасные в этом контексте. NpyIter_Copy нельзя безопасно вызывать без Python GIL, поскольку он увеличивает количество ссылок на объекты Python. Reset* и некоторые другие функции могут быть безопасно вызваны, передав параметр errmsg как не-NULL, чтобы функции передавали ошибки через него вместо установки исключения Python.

NpyIter_Deallocate должен быть вызван для каждой копии.

int NpyIter_RemoveAxis(NpyIter* iter, int axis)``

Удаляет ось из итерации. Для этого необходимо было установить NPY_ITER_MULTI_INDEX при создании итератора, и это не работает, если включено буферирование или отслеживается индекс. Эта функция также сбрасывает итератор в исходное состояние.

Это полезно для настройки цикла накопления, например. Итератор сначала может быть создан со всеми измерениями, включая ось накопления, чтобы выходные данные создавались правильно. Затем ось накопления может быть удалена, и вычисления выполняются вложенным способом.

ВНИМАНИЕ: Эта функция может изменить внутреннюю структуру памяти итератора. Любые кэшированные функции или указатели из итератора необходимо получить заново! Диапазон итератора также будет сброшен.

Возвращает NPY_SUCCEED или NPY_FAIL.

int NpyIter_RemoveMultiIndex(NpyIter* iter)

Если итератор отслеживает многоиндекс, это отключает поддержку многоиндексов и выполняет дополнительные оптимизации итератора, возможные, если многоиндексы не нужны. Эта функция также сбрасывает итератор в исходное состояние.

ВНИМАНИЕ: Эта функция может изменить внутреннюю структуру памяти итератора. Любые кэшированные функции или указатели из итератора необходимо получить заново!

После вызова этой функции NpyIter_HasMultiIndex(iter) вернет false.

Возвращает NPY_SUCCEED или NPY_FAIL.

int NpyIter_EnableExternalLoop(NpyIter* iter)

Если была вызвана NpyIter_RemoveMultiIndex, вы можете включить флаг NPY_ITER_EXTERNAL_LOOP. Этот флаг недопустим совместно с NPY_ITER_MULTI_INDEX, поэтому эта функция предназначена для включения этой функции после вызова NpyIter_RemoveMultiIndex. Эта функция также сбрасывает итератор в исходное состояние.

ВНИМАНИЕ: Эта функция изменяет внутреннюю логику итератора. Любые кэшированные функции или указатели из итератора необходимо получить заново!

Возвращает NPY_SUCCEED или NPY_FAIL.

int NpyIter_Deallocate(NpyIter* iter)

Освобождает объект итератора и выполняет необходимые записи.

Возвращает NPY_SUCCEED или NPY_FAIL.

int NpyIter_Reset(NpyIter* iter, char** errmsg)

Сбрасывает итератор в исходное состояние, в начало диапазона итерации.

Возвращает NPY_SUCCEED или NPY_FAIL. Если errmsg не NULL, исключение Python не устанавливается, когда возвращается NPY_FAIL. Вместо этого *errmsg устанавливается в сообщение об ошибке. При не-NULL errmsg функцию можно безопасно вызывать без блокировки Python GIL.

int NpyIter_ResetToIterIndexRange(NpyIter* iter, npy_intp istart, npy_intp iend, char** errmsg)

Сбрасывает итератор и ограничивает его диапазоном iterindex [istart, iend). См. NpyIter_Copy для объяснения использования этого для многопоточной итерации. Для этого необходимо, чтобы флаг NPY_ITER_RANGED был передан в конструктор итератора.

Если вы хотите сбросить как диапазон iterindex , так и базовые указатели одновременно, можно сделать следующее, чтобы избежать дополнительной копирования буфера (убедитесь, что добавили проверки возвращаемых кодов при копировании этого кода).

/* Set to a trivial empty range */
NpyIter_ResetToIterIndexRange(iter, 0, 0);
/* Set the base pointers */
NpyIter_ResetBasePointers(iter, baseptrs);
/* Set to the desired range */
NpyIter_ResetToIterIndexRange(iter, istart, iend);

Возвращает NPY_SUCCEED или NPY_FAIL. Если errmsg не NULL, исключение Python не устанавливается, когда возвращается NPY_FAIL. Вместо этого *errmsg устанавливается в сообщение об ошибке. При не-NULL errmsg функцию можно безопасно вызывать без блокировки Python GIL.

int NpyIter_ResetBasePointers(NpyIter *iter, char** baseptrs, char** errmsg)

Сбрасывает итератор в исходное состояние, но использует значения в baseptrs для данных вместо указателей из массивов, по которым выполняется итерация. Эта функция предназначена для использования совместно с параметром op_axes вложенным кодом итерации с двумя или более итераторами.

Возвращает NPY_SUCCEED или NPY_FAIL. Если errmsg не NULL, исключение Python не устанавливается, когда возвращается NPY_FAIL. Вместо этого *errmsg устанавливается в сообщение об ошибке. При не-NULL errmsg функцию можно безопасно вызывать без блокировки Python GIL.

TODO: Переместить следующее в отдельный раздел по вложенным итераторам.

Создание итераторов для вложенной итерации требует определенной осторожности. Все операнды итератора должны точно совпадать, иначе вызовы NpyIter_ResetBasePointers будут некорректными. Это означает, что автоматические копии и выделение вывода не должны использоваться произвольно. Можно по-прежнему использовать автоматические функции преобразования и приведения типов итератора, создав один из итераторов со всеми включенными параметрами преобразования, а затем получив выделенные операнды с помощью функции NpyIter_GetOperandArray и передав их в конструкторы для остальных итераторов.

ВНИМАНИЕ: При создании итераторов для вложенной итерации код не должен использовать измерение более одного раза в разных итераторах. Если это сделано, вложенная итерация приведет к указателям за пределами границ во время итерации.

ВНИМАНИЕ: При создании итераторов для вложенной итерации буферирование может быть применено только к самому внутреннему итератору. Если буферизованный итератор используется в качестве источника для baseptrs, он будет указывать на небольшой буфер, а не на массив, и внутренняя итерация будет некорректной.

Шаблон использования вложенных итераторов выглядит следующим образом.

NpyIter *iter1, *iter1;
NpyIter_IterNextFunc *iternext1, *iternext2;
char **dataptrs1;

/*
 * With the exact same operands, no copies allowed, and
 * no axis in op_axes used both in iter1 and iter2.
 * Buffering may be enabled for iter2, but not for iter1.
 */
iter1 = ...; iter2 = ...;

iternext1 = NpyIter_GetIterNext(iter1);
iternext2 = NpyIter_GetIterNext(iter2);
dataptrs1 = NpyIter_GetDataPtrArray(iter1);

do {
    NpyIter_ResetBasePointers(iter2, dataptrs1);
    do {
        /* Use the iter2 values */
    } while (iternext2(iter2));
} while (iternext1(iter1));
int NpyIter_GotoMultiIndex(NpyIter* iter, npy_intp const* multi_index)

Настраивает итератор для указания на ndim индексы, на которые указывает multi_index. Возвращает ошибку, если многоиндекс не отслеживается, индексы выходят за пределы диапазона или итерация внутреннего цикла отключена.

Возвращает NPY_SUCCEED или NPY_FAIL.

int NpyIter_GotoIndex(NpyIter* iter, npy_intp index)

Настраивает итератор для указания на index значение. Если итератор был создан с флагом NPY_ITER_C_INDEX, index — это индекс в порядке C, а если с флагом NPY_ITER_F_INDEX, index — это индекс в порядке Fortran. Возвращает ошибку, если индекс не отслеживается, индекс выходит за пределы диапазона или итерация внутреннего цикла отключена.

Возвращает NPY_SUCCEED или NPY_FAIL.

npy_intp NpyIter_GetIterSize(NpyIter* iter)

Возвращает количество элементов, по которым выполняется итерация. Это произведение всех измерений в форме. Когда отслеживается многоиндекс (и может быть вызвано NpyIter_RemoveAxis) размер может быть -1 для обозначения слишком большого итератора. Такой итератор некорректен, но может стать корректным после вызова NpyIter_RemoveAxis . Нет необходимости проверять этот случай.

npy_intp NpyIter_GetIterIndex(NpyIter* iter)

Получает iterindex итератора, который является индексом, соответствующим порядку итерации итератора.

void NpyIter_GetIterIndexRange(NpyIter* iter, npy_intp* istart, npy_intp* iend)

Получает iterindex поддиапазон, по которому выполняется итерация. Если NPY_ITER_RANGED не был указан, возвращается диапазон [0, NpyIter_IterSize(iter)).

int NpyIter_GotoIterIndex(NpyIter* iter, npy_intp iterindex)

Настраивает итератор для указания на iterindex значение. IterIndex — это индекс, соответствующий порядку итерации итератора. Возвращает ошибку, если iterindex выходит за пределы диапазона, буферирование включено или итерация внутреннего цикла отключена.

Возвращает NPY_SUCCEED или NPY_FAIL.

END_OF_DOCUMENT_MARKER
npy_bool NpyIter_HasDelayedBufAlloc(NpyIter* iter)

Возвращает 1, если флаг NPY_ITER_DELAY_BUFALLOC был передан конструктору итератора, и ещё не был вызван ни один из функций Reset, в противном случае возвращает 0.

npy_bool NpyIter_HasExternalLoop(NpyIter* iter)

Возвращает 1, если вызывающей функции необходимо обработать внутренний одномерный цикл, или 0, если итератор обрабатывает все циклы. Это контролируется флагом конструктора NPY_ITER_EXTERNAL_LOOP или NpyIter_EnableExternalLoop.

npy_bool NpyIter_HasMultiIndex(NpyIter* iter)

Возвращает 1, если итератор был создан с флагом NPY_ITER_MULTI_INDEX, в противном случае возвращает 0.

npy_bool NpyIter_HasIndex(NpyIter* iter)

Возвращает 1, если итератор был создан с флагом NPY_ITER_C_INDEX или NPY_ITER_F_INDEX, в противном случае возвращает 0.

npy_bool NpyIter_RequiresBuffering(NpyIter* iter)

Возвращает 1, если итератор требует буферизации, что происходит, когда операнду требуется преобразование или выравнивание, и поэтому он не может быть использован напрямую.

npy_bool NpyIter_IsBuffered(NpyIter* iter)

Возвращает 1, если итератор был создан с флагом NPY_ITER_BUFFERED, в противном случае возвращает 0.

npy_bool NpyIter_IsGrowInner(NpyIter* iter)

Возвращает 1, если итератор был создан с флагом NPY_ITER_GROWINNER, в противном случае возвращает 0.

npy_intp NpyIter_GetBufferSize(NpyIter* iter)

Если итератор буферизован, возвращает размер используемого буфера, иначе возвращает 0.

int NpyIter_GetNDim(NpyIter* iter)

Возвращает количество измерений, по которым происходит итерация. Если многомерный индекс не был запрошен в конструкторе итератора, это значение может быть меньше, чем количество измерений в исходных объектах.

int NpyIter_GetNOp(NpyIter* iter)

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

npy_intp* NpyIter_GetAxisStrideArray(NpyIter* iter, int axis)

Получает массив шагов для указанной оси. Требует, чтобы итератор отслеживал многомерный индекс и чтобы буферизация не была включена.

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

Возвращает NULL при ошибке.

int NpyIter_GetShape(NpyIter* iter, npy_intp* outshape)

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

Возвращает NPY_SUCCEED или NPY_FAIL.

PyArray_Descr** NpyIter_GetDescrArray(NpyIter* iter)

Возвращает указатель на nop типы данных Descrs объектов, по которым выполняется итерация. Результат указывает на iter, поэтому вызывающая функция не получает никаких ссылок на Descrs.

Этот указатель можно кэшировать перед циклом итерации, вызов iternext не изменит его.

PyObject** NpyIter_GetOperandArray(NpyIter* iter)

Возвращает указатель на nop операнды PyObjects, по которым выполняется итерация. Результат указывает на iter, поэтому вызывающая функция не получает никаких ссылок на PyObjects.

PyObject* NpyIter_GetIterView(NpyIter* iter, npy_intp i)

Возвращает ссылку на новый вид ndarray, который является представлением i-го объекта в массиве NpyIter_GetOperandArray, измерения и шаги которого соответствуют внутренней оптимизированной схеме итерации. Итерация по этому представлению в порядке C эквивалентна порядку итерации итератора.

Например, если итератор был создан с использованием единственного массива в качестве входных данных, и было возможно переупорядочить все его оси, а затем свернуть их в одну строчную итерацию, это вернёт представление, которое является одномерным массивом.

void NpyIter_GetReadFlags(NpyIter* iter, char* outreadflags)

Заполняет nop флаги. Устанавливает outreadflags[i] в 1, если op[i] можно считать, и в 0, если нет.

void NpyIter_GetWriteFlags(NpyIter* iter, char* outwriteflags)

Заполняет nop флаги. Устанавливает outwriteflags[i] в 1, если op[i] можно записать, и в 0, если нет.

int NpyIter_CreateCompatibleStrides(NpyIter* iter, npy_intp itemsize, npy_intp* outstrides)

Создаёт набор шагов, которые совпадают с шагами выходного массива, созданного с использованием флага NPY_ITER_ALLOCATE, где для op_axes был передан NULL. Это для данных, упакованных непрерывно, но необязательно в порядке C или Fortran. Это следует использовать вместе с NpyIter_GetShape и NpyIter_GetNDim с флагом NPY_ITER_MULTI_INDEX, переданным в конструктор.

Случай использования этой функции — согласовать форму и расположение итератора и добавить одно или несколько измерений. Например, для генерации вектора на значение входных данных для численного градиента вы передаёте ndim*itemsize для itemsize, затем добавляете ещё одно измерение в конец с размером ndim и шагом itemsize. Для матрицы Гессе вы делаете то же самое, но добавляете два измерения или используете симметрию и упаковываете её в 1 измерение с определённым кодированием.

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

Если массив создан этим методом, просто добавление «itemsize» для каждой итерации пройдёт по новому массиву, соответствующему итератору.

Возвращает NPY_SUCCEED или NPY_FAIL.

npy_bool NpyIter_IsFirstVisit(NpyIter* iter, int iop)

Добавлен в версии 1.7.

Проверяет, является ли это первый раз, когда элементы указанного операнда редукции, на который указывает итератор, видятся впервые. Функция возвращает разумный ответ для операндов редукции и при отключённой буферизации. Ответ может быть неверным для буферизованных не-операндов редукции.

Эта функция предназначена для использования только в режиме EXTERNAL_LOOP и вернёт неверный ответ, когда этот режим не включен.

Если эта функция возвращает true, вызывающая функция должна также проверить шаг внутреннего цикла операнда, потому что если этот шаг равен 0, то только первый элемент самого внутреннего внешнего цикла посещается впервые.

ПРЕДУПРЕЖДЕНИЕ: по соображениям производительности ‘iop’ не проверяется на границы, не подтверждается, что ‘iop’ на самом деле является операндом редукции, и не подтверждается, что режим EXTERNAL_LOOP включён. Эти проверки возлагаются на вызывающую функцию и должны выполняться вне любых внутренних циклов.

Функции для итерации

NpyIter_IterNextFunc* NpyIter_GetIterNext(NpyIter* iter, char** errmsg)

Возвращает указатель на функцию для итерации. Специализированная версия указателя на функцию может быть рассчитана этой функцией вместо того, чтобы храниться в структуре итератора. Таким образом, для достижения высокой производительности требуется сохранить указатель на функцию в переменной, а не извлекать его для каждой итерации цикла.

Возвращает NULL, если произошла ошибка. Если errmsg не равен NULL, исключение Python не устанавливается, когда NPY_FAIL возвращает результат. Вместо этого *errmsg устанавливается в сообщение об ошибке. Когда errmsg не равен NULL, функция может быть безопасно вызвана без блокировки Python GIL.

Типичная структура цикла выглядит следующим образом.

NpyIter_IterNextFunc *iternext = NpyIter_GetIterNext(iter, NULL);
char** dataptr = NpyIter_GetDataPtrArray(iter);

do {
    /* use the addresses dataptr[0], ... dataptr[nop-1] */
} while(iternext(iter));

Когда NPY_ITER_EXTERNAL_LOOP указан, типичная структура внутреннего цикла выглядит следующим образом.

NpyIter_IterNextFunc *iternext = NpyIter_GetIterNext(iter, NULL);
char** dataptr = NpyIter_GetDataPtrArray(iter);
npy_intp* stride = NpyIter_GetInnerStrideArray(iter);
npy_intp* size_ptr = NpyIter_GetInnerLoopSizePtr(iter), size;
npy_intp iop, nop = NpyIter_GetNOp(iter);

do {
    size = *size_ptr;
    while (size--) {
        /* use the addresses dataptr[0], ... dataptr[nop-1] */
        for (iop = 0; iop < nop; ++iop) {
            dataptr[iop] += stride[iop];
        }
    }
} while (iternext());

Обратите внимание, что мы используем массив dataptr внутри итератора, а не копируем значения в локальную временную переменную. Это возможно, потому что когда iternext() вызывается, эти указатели будут перезаписаны свежими значениями, а не постепенно обновляться.

Если используется буфер фиксированного размера времени компиляции (оба флага NPY_ITER_BUFFERED и NPY_ITER_EXTERNAL_LOOP), внутренний размер также может использоваться как сигнал. Размер гарантируется как нулевой, когда iternext() возвращает false, что позволяет использовать следующую конструкцию цикла. Обратите внимание, что если вы используете эту конструкцию, не следует передавать NPY_ITER_GROWINNER в качестве флага, так как это приведёт к более крупным размерам в некоторых случаях.

/* The constructor should have buffersize passed as this value */
#define FIXED_BUFFER_SIZE 1024

NpyIter_IterNextFunc *iternext = NpyIter_GetIterNext(iter, NULL);
char **dataptr = NpyIter_GetDataPtrArray(iter);
npy_intp *stride = NpyIter_GetInnerStrideArray(iter);
npy_intp *size_ptr = NpyIter_GetInnerLoopSizePtr(iter), size;
npy_intp i, iop, nop = NpyIter_GetNOp(iter);

/* One loop with a fixed inner size */
size = *size_ptr;
while (size == FIXED_BUFFER_SIZE) {
    /*
     * This loop could be manually unrolled by a factor
     * which divides into FIXED_BUFFER_SIZE
     */
    for (i = 0; i < FIXED_BUFFER_SIZE; ++i) {
        /* use the addresses dataptr[0], ... dataptr[nop-1] */
        for (iop = 0; iop < nop; ++iop) {
            dataptr[iop] += stride[iop];
        }
    }
    iternext();
    size = *size_ptr;
}

/* Finish-up loop with variable inner size */
if (size > 0) do {
    size = *size_ptr;
    while (size--) {
        /* use the addresses dataptr[0], ... dataptr[nop-1] */
        for (iop = 0; iop < nop; ++iop) {
            dataptr[iop] += stride[iop];
        }
    }
} while (iternext());
NpyIter_GetMultiIndexFunc *NpyIter_GetGetMultiIndex(NpyIter* iter, char** errmsg)

Возвращает указатель на функцию для получения текущего многомерного индекса итератора. Возвращает NULL, если итератор не отслеживает многомерный индекс. Рекомендуется кэшировать этот указатель на функцию в локальной переменной перед циклом итерации.

Возвращает NULL, если произошла ошибка. Если errmsg не равен NULL, исключение Python не устанавливается, когда NPY_FAIL возвращает результат. Вместо этого *errmsg устанавливается в сообщение об ошибке. Когда errmsg не равен NULL, функция может быть безопасно вызвана без блокировки Python GIL.

END_OF_DOCUMENT_MARKER
char** NpyIter_GetDataPtrArray(NpyIter* iter)

Это возвращает указатель на массив указателей на данные nop. Если NPY_ITER_EXTERNAL_LOOP не был указан, каждый указатель на данные указывает на текущий элемент данных итератора. Если внутренняя итерация не была указана, он указывает на первый элемент данных внутреннего цикла.

Этот указатель может быть кэширован перед циклом итерации, вызов iternext не изменит его. Эту функцию можно безопасно вызывать без блокировки интерпретатора Python.

char** NpyIter_GetInitialDataPtrArray(NpyIter* iter)

Получает массив указателей на данные непосредственно в массивы (никогда в буферы), соответствующие индексу итерации 0.

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

Эту функцию можно безопасно вызывать без блокировки интерпретатора Python.

npy_intp* NpyIter_GetIndexPtr(NpyIter* iter)

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

Когда используется флаг NPY_ITER_EXTERNAL_LOOP, код должен знать параметры для выполнения внутреннего цикла. Эти функции предоставляют эту информацию.

npy_intp* NpyIter_GetInnerStrideArray(NpyIter* iter)

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

Этот указатель может быть кэширован перед циклом итерации, вызов iternext не изменит его. Эту функцию можно безопасно вызывать без блокировки интерпретатора Python.

ВНИМАНИЕ: Хотя указатель может быть кэширован, его значения могут измениться, если итератор буферизован.

npy_intp* NpyIter_GetInnerLoopSizePtr(NpyIter* iter)

Возвращает указатель на количество итераций, которое должен выполнить внутренний цикл.

Этот адрес может быть кэширован перед циклом итерации, вызов iternext не изменит его. Само значение может измениться во время итерации, в частности, если включена буферизация. Эту функцию можно безопасно вызывать без блокировки интерпретатора Python.

void NpyIter_GetInnerFixedStrideArray(NpyIter* iter, npy_intp* out_strides)

Получает массив шагов, которые фиксированы или не изменятся в течение всей итерации. Для шагов, которые могут изменяться, значение NPY_MAX_INTP помещается в шаг.

После подготовки итератора к итерации (после сброса, если NPY_DELAY_BUFALLOC использовался), вызовите эту функцию, чтобы получить шаги, которые могут быть использованы для выбора быстрой функции внутреннего цикла. Например, если шаг равен 0, это означает, что внутренний цикл всегда может загрузить своё значение в переменную один раз, а затем использовать переменную на протяжении всего цикла, или если шаг равен размеру элемента, может быть использована контигуированная версия для этого операнда.

Эту функцию можно безопасно вызывать без блокировки интерпретатора Python.

Преобразование из предыдущих итераторов NumPy

Старый API итераторов включает функции, такие как PyArrayIter_Check, PyArray_Iter* и PyArray_ITER_*. Массив многократной итерации включает PyArray_MultiIter*, PyArray_Broadcast и PyArray_RemoveSmallest. Новый дизайн итератора заменяет все эти функциональные возможности одним объектом и связанным API. Одна из целей нового API заключается в том, что все используемые существующие итераторы должны быть заменимы новым итератором без значительных усилий. В версии 1.6 основным исключением из этого является итератор соседства, у которого нет соответствующих функций в этом итераторе.

Вот таблица преобразования, какие функции использовать с новым итератором:

Функции итератора
PyArray_IterNew NpyIter_New
PyArray_IterAllButAxis NpyIter_New + параметр axes или флаг итератора NPY_ITER_EXTERNAL_LOOP
PyArray_BroadcastToShape НЕ ПОДДЕРЖИВАЕТСЯ (Используйте поддержку нескольких операндов вместо этого.)
PyArrayIter_Check Необходимо добавить в экспозицию Python
PyArray_ITER_RESET NpyIter_Reset
PyArray_ITER_NEXT Указатель на функцию из NpyIter_GetIterNext
PyArray_ITER_DATA NpyIter_GetDataPtrArray
PyArray_ITER_GOTO NpyIter_GotoMultiIndex
PyArray_ITER_GOTO1D NpyIter_GotoIndex или NpyIter_GotoIterIndex
PyArray_ITER_NOTDONE Значение возвращаемой функцией iternext
Функции многократной итерации
PyArray_MultiIterNew NpyIter_MultiNew
PyArray_MultiIter_RESET NpyIter_Reset
PyArray_MultiIter_NEXT Указатель на функцию из NpyIter_GetIterNext
PyArray_MultiIter_DATA NpyIter_GetDataPtrArray
PyArray_MultiIter_NEXTi НЕ ПОДДЕРЖИВАЕТСЯ (всегда итерация «ступень за ступенью»)
PyArray_MultiIter_GOTO NpyIter_GotoMultiIndex
PyArray_MultiIter_GOTO1D NpyIter_GotoIndex или NpyIter_GotoIterIndex
PyArray_MultiIter_NOTDONE Значение возвращаемой функцией iternext
PyArray_Broadcast Обрабатывается NpyIter_MultiNew
PyArray_RemoveSmallest Флаг итератора NPY_ITER_EXTERNAL_LOOP
Другие функции
PyArray_ConvertToCommonType Флаг итератора NPY_ITER_COMMON_DTYPE

© 2005–2019 NumPy Developers
Licensed under the 3-clause BSD License.
https://docs.scipy.org/doc/numpy-1.17.0/reference/c-api.iterator.html

Spec-Zone.ru

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