numpy.heaviside#
- numpy.heaviside(x1,x2,/,out=None,*,where=True,casting='same_kind',order='K',dtype=None,subok=True[,signature])=<ufunc'heaviside'>#
Compute the Heaviside step function.
The Heaviside step function[1] is defined as:
0ifx1<0heaviside(x1,x2)=x2ifx1==01ifx1>0
wherex2 is often taken to be 0.5, but 0 and 1 are also sometimes used.
- Parameters:
- x1array_like
Input values.
- x2array_like
The value of the function when x1 is 0.If
x1.shape!=x2.shape, they must be broadcastable to a commonshape (which becomes the shape of the output).- outndarray, None, or tuple of ndarray and None, optional
A location into which the result is stored. If provided, it must havea shape that the inputs broadcast to. If not provided or None,a freshly-allocated array is returned. A tuple (possible only as akeyword argument) must have length equal to the number of outputs.
- wherearray_like, optional
This condition is broadcast over the input. At locations where thecondition is True, theout array will be set to the ufunc result.Elsewhere, theout array will retain its original value.Note that if an uninitializedout array is created via the default
out=None, locations within it where the condition is False willremain uninitialized.- **kwargs
For other keyword-only arguments, see theufunc docs.
- Returns:
- outndarray or scalar
The output array, element-wise Heaviside step function ofx1.This is a scalar if bothx1 andx2 are scalars.
References
[1]Wikipedia, “Heaviside step function”,https://en.wikipedia.org/wiki/Heaviside_step_function
Examples
>>>importnumpyasnp>>>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.])