numpy.heaviside#

numpy.heaviside(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature]) = <ufunc 'heaviside'>#

计算 Heaviside 阶跃函数.

Heaviside 阶跃函数 [1] 定义为:

                      0   if x1 < 0
heaviside(x1, x2) =  x2   if x1 == 0
                      1   if x1 > 0

其中 x2 通常取 0.5,但有时也使用 0 和 1.

参数:
x1array_like

输入值.

x2array_like

当 x1 为 0 时函数的值.如果 x1.shape != x2.shape ,它们必须可广播到公共形状(该形状成为输出的形状).

outndarray, None, or tuple of ndarray and None, optional

存储结果的位置.如果提供,则它必须具有输入广播到的形状.如果未提供或为None,则返回一个新分配的数组.一个元组(可能仅作为关键字参数)的长度必须等于输出的数量.

其中类数组,可选

此条件会在输入上进行广播.在条件为True的位置, out 数组将被设置为ufunc结果.否则, out 数组将保留其原始值.请注意,如果通过默认的 out=None 创建一个未初始化的 out 数组,则其中条件为False的位置将保持未初始化.

\kwargs

对于其他仅限关键字的参数,请参见 ufunc docs .

返回:
outndarray 或标量

输出数组, x1 的逐元素 Heaviside 阶跃函数.如果 x1x2 都是标量,则这是一个标量.

参考文献

[1]

Wikipedia, “Heaviside step function”, https://en.wikipedia.org/wiki/Heaviside_step_function

示例

>>> import numpy as np
>>> np.heaviside([-1.5, 0, 2.0], 0.5)
array([ 0. ,  0.5,  1. ])
>>> np.heaviside([-1.5, 0, 2.0], 1)
array([ 0.,  1.,  1.])