numpy.vectorize#

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

返回一个类似于 pyfunc 的对象，但它接受数组作为输入。

定义一个矢量化函数，该函数将嵌套的对象序列或 NumPy 数组作为输入，并返回单个 NumPy 数组或 NumPy 数组元组。矢量化函数类似于 Python 的 map 函数，它对输入数组的连续元组评估 pyfunc，只是它使用了 NumPy 的广播规则。

vectorized 的输出数据类型是通过使用输入的第一个元素调用该函数来确定的。可以通过指定 otypes 参数来避免这种情况。

参数：
pyfunc可选的可调用对象

Python 函数或方法。可以省略以生成带有关键字参数的装饰器。

otypes字符串或 dtype 列表，可选

输出数据类型。它必须指定为类型代码字符的字符串或数据类型说明符列表。每个输出应该有一个数据类型说明符。

doc字符串，可选

函数的文档字符串。如果为 None，则文档字符串将为 pyfunc.__doc__。

excluded集合，可选

表示位置或关键字参数的字符串或整数集合，对于这些参数，函数将不会被矢量化。这些参数将直接未经修改地传递给 pyfunc。

cache布尔值，可选

如果为 True，则缓存第一个确定输出数量的函数调用（如果未提供 otypes）。

signature字符串，可选

广义的通用函数签名，例如，对于矢量化的矩阵向量乘法，为 (m,n),(n)->(m)。如果提供，则 pyfunc 将被调用（并预期返回）形状由相应核心维度的大小给出的数组。默认情况下，假设 pyfunc 接受标量作为输入和输出。

返回：
out可调用对象

如果提供了 pyfunc，则为矢量化函数；否则为装饰器。

另请参见

frompyfunc

接受任意 Python 函数并返回一个 ufunc

备注

vectorize 函数主要为了方便而提供，而不是为了性能。其实现本质上是一个 for 循环。

如果未指定 otypes，则将使用对该函数的第一个参数的调用来确定输出的数量。如果 cache 为 True，则此调用的结果将被缓存，以防止两次调用该函数。但是，要实现缓存，必须包装原始函数，这会减慢随后的调用速度，因此只有在您的函数代价很高的情况下才这样做。

新的关键字参数接口和 excluded 参数支持进一步降低性能。

参考文献

示例

>>> import numpy as np
>>> 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])
<class 'numpy.int64'>
>>> vfunc = np.vectorize(myfunc, otypes=[float])
>>> out = vfunc([1, 2, 3, 4], 2)
>>> type(out[0])
<class '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={0, 'p'})
>>> vpolyval([1, 2, 3], x=[0, 1])
array([3, 6])
>>> vpolyval(p=[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.]])

支持装饰器语法。装饰器可以作为函数调用来提供关键字参数。

>>> @np.vectorize
... def identity(x):
...     return x
...
>>> identity([0, 1, 2])
array([0, 1, 2])
>>> @np.vectorize(otypes=[float])
... def as_float(x):
...     return x
...
>>> as_float([0, 1, 2])
array([0., 1., 2.])

方法

__call__(*args, **kwargs)

将自身作为函数调用。
本页内容