numpy.vectorize

class numpy.vectorize(pyfunc, otypes=None, doc=None, excluded=None, cache=False, signature=None) [source]

Обобщённый класс функций.

Определяет векторизованную функцию, которая принимает в качестве входных данных вложенную последовательность объектов или массивов NumPy и возвращает один массив NumPy или кортеж массивов NumPy. Векторизованная функция вычисляет pyfunc над последовательными кортежами входных массивов, как функция python map, за исключением того, что она использует правила векторизации NumPy.

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

Параметры:

pyfunc : callable Функция или метод Python. otypes : str or list of dtypes, optional Тип данных выходных данных. Он должен быть указан либо как строка символов типа данных, либо как список спецификаторов типов данных. Должен быть один спецификатор типа данных для каждого выхода. doc : str, optional Строка документации для функции. Если None, строка документации будет pyfunc.__doc__. excluded : set, optional Набор строк или целых чисел, представляющих позиционные или именованные аргументы, для которых функция не будет векторизована. Они будут переданы непосредственно в pyfunc без изменений. Добавлена в версии 1.7.0. cache : bool, optional Если True, тогда кэшировать первый вызов функции, определяющий количество выходов, если otypes не указан. Добавлена в версии 1.7.0. signature : string, optional Обобщённая сигнатура универсальной функции, например, (m,n),(n)->(m) для векторизованного умножения матрицы на вектор. Если указано, pyfunc будет вызвана с массивами, имеющими формы, задаваемые размером соответствующих основных измерений. По умолчанию предполагается, что pyfunc принимает скаляры в качестве входных данных и выводит скаляры. Добавлена в версии 1.12.0.

Возвращает:

vectorized : callable Векторизованная функция.

См. также

frompyfunc

Принимает произвольную Python-функцию и возвращает ufunc

Примечания

Функция vectorize предоставлена в первую очередь для удобства, а не для производительности. Реализация по существу представляет собой цикл for.

Если otypes не указан, то вызов функции с первым аргументом будет использован для определения количества выходов. Результаты этого вызова будут кэшированы, если cache равно True, чтобы избежать вызова функции дважды. Однако для реализации кэша исходная функция должна быть обернута, что замедлит последующие вызовы, поэтому делайте это только в том случае, если ваша функция ресурсоёмкая.

Новый интерфейс именованных аргументов и аргумент excluded далее снижают производительность.

Ссылки

[1]	Справочник NumPy, раздел API обобщённых универсальных функций.

Примеры

>>> def myfunc(a, b):
...     "Return a-b if a>b, otherwise return a+b"
...     if a > b:
...         return a - b
...     else:
...         return a + b

>>> vfunc = np.vectorize(myfunc)
>>> vfunc([1, 2, 3, 4], 2)
array([3, 4, 1, 2])

Строка документации взята из входной функции для vectorize, если она не указана:

>>> vfunc.__doc__
'Return a-b if a>b, otherwise return a+b'
>>> vfunc = np.vectorize(myfunc, doc='Vectorized `myfunc`')
>>> vfunc.__doc__
'Vectorized `myfunc`'

Тип выходных данных определяется путём оценки первого элемента входных данных, если он не указан:

>>> out = vfunc([1, 2, 3, 4], 2)
>>> type(out[0])
<type 'numpy.int32'>
>>> vfunc = np.vectorize(myfunc, otypes=[float])
>>> out = vfunc([1, 2, 3, 4], 2)
>>> type(out[0])
<type 'numpy.float64'>

Аргумент excluded может быть использован для предотвращения векторизации над определёнными аргументами. Это может быть полезно для массивоподобных аргументов фиксированной длины, таких как коэффициенты полинома, как в polyval:

>>> def mypolyval(p, x):
...     _p = list(p)
...     res = _p.pop(0)
...     while _p:
...         res = res*x + _p.pop(0)
...     return res
>>> vpolyval = np.vectorize(mypolyval, excluded=['p'])
>>> vpolyval(p=[1, 2, 3], x=[0, 1])
array([3, 6])

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

>>> vpolyval.excluded.add(0)
>>> vpolyval([1, 2, 3], x=[0, 1])
array([3, 6])

Аргумент signature позволяет векторизовать функции, которые действуют на нескалярных массивах фиксированной длины. Например, его можно использовать для векторизованного вычисления коэффициента Пирсона и его p-значения:

>>> import scipy.stats
>>> pearsonr = np.vectorize(scipy.stats.pearsonr,
...                         signature='(n),(n)->(),()')
>>> pearsonr([[0, 1, 2, 3]], [[1, 2, 3, 4], [4, 3, 2, 1]])
(array([ 1., -1.]), array([ 0.,  0.]))

Или для векторизованной свёртки:

>>> convolve = np.vectorize(np.convolve, signature='(n),(m)->(k)')
>>> convolve(np.eye(4), [1, 2, 1])
array([[ 1.,  2.,  1.,  0.,  0.,  0.],
       [ 0.,  1.,  2.,  1.,  0.,  0.],
       [ 0.,  0.,  1.,  2.,  1.,  0.],
       [ 0.,  0.,  0.,  1.,  2.,  1.]])

Методы

__call__(*args, **kwargs)

Возвращает массивы с результатами pyfunc векторизации над args и kwargs не в excluded.