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, 或 ndarray 和 None 的元组,可选

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

wherearray_like,可选

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

**kwargs

对于其他仅限关键字的参数,请参阅 ufunc 文档

返回:
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.])