numpy.vectorize#

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

返回一个对象,该对象行为类似于 pyfunc,但接受数组作为输入。

定义一个向量化函数,该函数接受对象或 numpy 数组的嵌套序列作为输入,并返回一个 numpy 数组或 numpy 数组的元组。向量化函数像 python 的 map 函数一样,对输入数组的连续元组评估 pyfunc,但它使用 numpy 的广播规则。

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

参数:
pyfunccallable, optional

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

otypesstr or list of dtypes, optional

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

docstr, optional

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

excludedset, optional

字符串或整数的集合,表示将不对其进行向量化的位置或关键字参数。这些参数将直接传递给 pyfunc,不做修改。

cachebool, optional

如果未提供 otypessignature,并且 cacheTrue,则缓存输出的数量。

signaturestring, optional

广义通用函数签名,例如,向量化矩阵-向量乘法的 (m,n),(n)->(m)。如果提供,pyfunc 将使用(并期望返回)具有由相关核心维度大小给定的形状的数组。默认情况下,假定 pyfunc 接受标量作为输入和输出。

返回:
outcallable

如果提供了 pyfunc,则为向量化函数,否则为装饰器。

另请参阅

frompyfunc

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

备注

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

如果未指定 otypessignature,则将使用第一个参数的函数调用来确定输出的数量。如果 cacheTrue,则将缓存此调用的结果,以防止函数被调用两次。但是,为了实现缓存,必须包装原始函数,这会减慢后续调用的速度,因此只有在您的函数计算成本很高时才应执行此操作。

新的关键字参数接口和 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)

将 self 作为函数调用。