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 階躍函數。如果 x1 和 x2 都是純量，則這是一個純量。

參考文獻

[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.])