在 scipy.special
中添加向量化 ufunc#
special
中的许多函数是标量函数的向量化版本。标量函数是手工编写的,而向量化所需的循环是自动生成的。本节讨论添加新的向量化特殊函数所必需的步骤。
添加新的向量化函数的第一步是编写相应的标量函数。这可以用 Cython、C、C++ 或 Fortran 完成。如果从头开始,则应首选 Cython,因为对于只熟悉 Python 的开发人员来说,代码更容易维护。如果主要代码在 Fortran 中,则需要在代码周围编写一个 C 包装器;有关此类包装器的示例,请参见 specfun_wrappers.c
。
在实现标量函数之后,通过向 functions.json
添加条目来注册新函数。generate_ufuncs.py
中的文档字符串解释了格式。此外,通过向 add_newdocs.py
添加条目来为新函数添加文档;在文件中查找示例。
在编写 ufunc 的文档的参数部分时,参数的类型应为 array_like
。关于参数是否可以为实值或复值的讨论应保留在描述中。因此,例如,如果我们想记录 Gamma 函数的参数,它应该像这样:
Parameters
----------
z : array_like
Real or complex valued argument
在记录返回部分时,返回值的类型应为 scalar or ndarray
,因为当给定标量作为参数时,ufunc 返回标量。还要记住,为返回值提供一个 name
是可选的,实际上对于特殊函数通常没有帮助。因此,对于 Gamma 函数,我们可能会有这样的结果:
Returns
-------
scalar or ndarray
Values of the Gamma function