numpy.vectorize#

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

返回一个行为类似于 pyfunc 但以数组作为输入的S对象。

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

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

参数:
pyfunc可调用对象，可选

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

otypes字符串或数据类型列表，可选

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

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)

将自身作为函数调用。
在此页面