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 或标量

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

备注

在 1.13.0 版本加入.

参考文献

[1]

Wikipedia, “Heaviside 阶跃函数”, 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.])