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

Интерфейс массива (иногда называемый протоколом массива) был создан в 2005 году, как способ для объектов Python, подобных массивам, интеллектуально повторно использовать буферы данных друг друга, когда это возможно. Однородный N-мерный интерфейс массива является механизмом по умолчанию для объектов, чтобы совместно использовать память и информацию массива N-измерений. Интерфейс состоит из Python-стороны и C-стороны, использующих два атрибута. Объекты, которые хотят рассматриваться как N-мерный массив в коде приложения, должны поддерживать по крайней мере один из этих атрибутов. Объекты, желающие поддерживать N-мерный массив в прикладном коде, должны искать хотя бы один из этих атрибутов и использовать предоставленную информацию должным образом.

Этот интерфейс описывает однородные массивы в том смысле, что каждый элемент массива имеет один и тот же «тип». Этот тип может быть очень простым или весьма произвольным и сложным C-подобным структурой.

Есть два способа использования интерфейса: со стороны Python и со стороны C. Оба являются отдельными атрибутами.

Сторона Python

Этот подход к интерфейсу состоит в том, что у объекта есть атрибут __array_interface__.

__array_interface__

Словарь элементов (3 обязательных и 5 необязательных). Необязательные ключи в словаре имеют неявные значения по умолчанию, если они не указаны.

Ключи:

shape (обязательно)

Кортеж, элементы которого являются размерами массива в каждом измерении. Каждый элемент – целое число (Python int или long). Обратите внимание, что эти целые числа могут быть больше, чем может вместить платформа «int» или «long» (Python int – это C long). Код, использующий этот атрибут, должен сам обработать это должным образом; либо подняв ошибку, когда возможно переполнение, или используя Py_LONG_LONG как тип C для размеров.

typestr (обязательно)

Строка, предоставляющая базовый тип однородного массива. Базовый формат строки состоит из 3 частей: символ, описывающий порядок байтов данных (<: little-endian, >: big-endian, |: нерелевантно), символ, дающий базовый тип массива, и целое число, представляющее количество байт, используемых типом.

Основные символы типов:

t	Битовое поле (последующее целое число указывает количество битов в битовом поле).
b	Булево (целочисленный тип, где все значения – только True или False)
i	Целое число
u	Беззнаковое целое число
f	Число с плавающей точкой
c	Комплексное число с плавающей точкой
m	Timedelta
M	Datetime
O	Объект (т. е. память содержит указатель на PyObject)
S	Строка (фиксированной длины последовательность char)
U	Unicode (последовательность фиксированной длины Py_UNICODE)
V	Другое (void * – каждый элемент – фиксированный кусок памяти)

descr (необязательно)

Список кортежей, предоставляющий более подробное описание расположения памяти для каждого элемента в однородном массиве. Каждый кортеж в списке имеет два или три элемента. Обычно этот атрибут используется, когда typestr равен V[0-9]+, но это не обязательно. Единственное требование состоит в том, что количество байт, представленных в ключе typestr, совпадает с общим количеством байт, представленных здесь. Идея состоит в том, чтобы поддерживать описания C-подобных структур, составляющих элементы массива. Элементы каждого кортежа в списке:

1. Строка, предоставляющая имя, связанное с этой частью типа данных. Это также может быть кортеж из ('full name', 'basic_name'), где базовое имя будет допустимым именем переменной Python, представляющим полное имя поля.
2. Либо строка описания базового типа, как в typestr, либо другой список (для вложенных структурированных типов)
3. Необязательный кортеж размеров, указывающий, сколько раз эта часть структуры должна повторяться. Если это не указано, предполагается отсутствие повторений. С помощью этого универсального интерфейса можно описать очень сложные структуры. Однако обратите внимание, что каждый элемент массива по-прежнему имеет один и тот же тип данных.

По умолчанию: [('', typestr)]

data (необязательно)

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

Этот атрибут также может быть объектом, который предоставляет buffer interface, который будет использоваться для совместного использования данных. Если этот ключ отсутствует (или возвращает None), то совместное использование памяти будет осуществляться через интерфейс буфера самого объекта. В этом случае ключ offset можно использовать для указания начала буфера. Ссылка на объект, предоставляющий интерфейс массива, должна быть сохранена новым объектом, если область памяти должна быть защищена.

По умолчанию: None

strides (необязательно)

Либо None для обозначения C-подобного непрерывного массива, либо кортеж шагов, который предоставляет количество байт, необходимое для перехода к следующему элементу массива в соответствующем измерении. Каждый элемент должен быть целым числом (Python int или long). Как и в случае с shape, значения могут быть больше, чем может представить C «int» или «long»; вызывающий код должен обработать это должным образом, либо подняв ошибку, либо используя Py_LONG_LONG в C. По умолчанию None, что подразумевает C-стильный непрерывный буфер памяти. В этой модели последнее измерение массива изменяется быстрее всего. Например, кортеж шагов по умолчанию для объекта, чьи элементы массива имеют длину 8 байт, а размерность (10,20,30) будет (4800, 240, 8)

По умолчанию: None (C-стильный непрерывный)

mask (необязательно)

None или объект, предоставляющий интерфейс массива. Все элементы массива маски должны интерпретироваться только как истинные или ложные, указывая, какие элементы этого массива действительны. Размеры этого объекта должны быть “broadcastable” размерам исходного массива.

По умолчанию: None (все значения массива действительны)

offset (необязательно)

Целое смещение в области данных массива. Это может быть использовано только когда data является None или возвращает объект buffer.

По умолчанию: 0.

version (обязательно)

Целое число, показывающее версию интерфейса (т. е. 3 для этой версии). Будьте осторожны, не используйте это, чтобы сделать недействительными объекты, предоставляющие будущие версии интерфейса.

Доступ к C-структуре

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

__array_struct__

Тип :c:type: PyCObject, члены voidptr содержат указатель на заполненную структуру PyArrayInterface. Память для структуры создается динамически, и PyCObject также создается с соответствующим деструктором, поэтому получатель этого атрибута просто должен применить Py_DECREF к возвращаемому объекту этого атрибута, когда закончит. Кроме того, либо данные нужно скопировать, либо необходимо удерживать ссылку на объект, предоставляющий этот атрибут, чтобы гарантировать, что данные не будут освобождены. Объекты, предоставляющие интерфейс __array_struct__ , также не должны перераспределять свою память, если на них ссылаются другие объекты.

Структура PyArrayInterface определена в numpy/ndarrayobject.h как:

typedef struct {
  int two;              /* contains the integer 2 -- simple sanity check */
  int nd;               /* number of dimensions */
  char typekind;        /* kind in array --- character code of typestr */
  int itemsize;         /* size of each element */
  int flags;            /* flags indicating how the data should be interpreted */
                        /*   must set ARR_HAS_DESCR bit to validate descr */
  Py_intptr_t *shape;   /* A length-nd array of shape information */
  Py_intptr_t *strides; /* A length-nd array of stride information */
  void *data;           /* A pointer to the first element of the array */
  PyObject *descr;      /* NULL or data-description (same as descr key
                                of __array_interface__) -- must set ARR_HAS_DESCR
                                flag or this will be ignored. */
} PyArrayInterface;

Член flags может состоять из 5 битов, показывающих, как следует интерпретировать данные, и одного бита, показывающего, как следует интерпретировать интерфейс. Битами данных являются CONTIGUOUS (0x1), FORTRAN (0x2), ALIGNED (0x100), NOTSWAPPED (0x200) и WRITEABLE (0x400). Финальный флаг ARR_HAS_DESCR (0x800) указывает, содержит ли эта структура поле arrdescr.

Примеры описания типа

Для ясности полезно привести несколько примеров описания типа и соответствующих записей ‘descr’ для __array_interface__. Спасибо Скотту Гильберту за эти примеры:

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

* Float data
    typestr == '>f4'
    descr == [('','>f4')]

* Complex double
    typestr == '>c8'
    descr == [('real','>f4'), ('imag','>f4')]

* RGB Pixel data
    typestr == '|V3'
    descr == [('r','|u1'), ('g','|u1'), ('b','|u1')]

* Mixed endian (weird but could happen).
    typestr == '|V8' (or '>u8')
    descr == [('big','>i4'), ('little','<i4')]

* Nested structure
    struct {
        int ival;
        struct {
            unsigned short sval;
            unsigned char bval;
            unsigned char cval;
        } sub;
    }
    typestr == '|V8' (or '<u8' if you want)
    descr == [('ival','<i4'), ('sub', [('sval','<u2'), ('bval','|u1'), ('cval','|u1') ]) ]

* Nested array
    struct {
        int ival;
        double data[16*4];
    }
    typestr == '|V516'
    descr == [('ival','>i4'), ('data','>f8',(16,4))]

* Padded structure
    struct {
        int ival;
        double dval;
    }
    typestr == '|V16'
    descr == [('ival','>i4'),('','|V4'),('dval','>f8')]

Должно быть ясно, что любой структурированный тип можно описать с помощью этого интерфейса.

Отличия от интерфейса массива (Версия 2)

Интерфейс версии 2 был очень похож. Различия были в основном косметическими. В частности:

1. Структура PyArrayInterface не имела члена descr в конце (и, следовательно, флага ARR_HAS_DESCR)
2. Член desc объекта PyCObject, возвращаемого из __array_struct__, не был указан. Обычно это был объект, экспонирующий массив (чтобы можно было сохранить ссылку на него и уничтожить её при уничтожении объекта C). Теперь это должен быть кортеж, первым элементом которого является строка “PyArrayInterface Версия #”, а вторым — объект, экспонирующий массив.
3. Кортеж, возвращаемый из __array_interface__[‘data’], раньше был шестнадцатеричной строкой (теперь это целое или длинное целое число).
4. Атрибута __array_interface__ не было; вместо этого все ключи (кроме версии) в словаре __array_interface__ были собственными атрибутами: таким образом, чтобы получить информацию со стороны Python, вам нужно было отдельно получить доступ к атрибутам:
   • __array_data__
   • __array_shape__
   • __array_strides__
   • __array_typestr__
   • __array_descr__
   • __array_offset__
   • __array_mask__