nlcpy.heaviside

nlcpy.heaviside = <ufunc 'nlcpy_heaviside'>

Computes Heaviside step function.

The Heaviside step function is defined as follows:

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

Parameters

x1, x2array_like

Input arrays or scalars. If x1.shape != x2.shape, they must be broadcastable to a common shape (which becomes the shape of the output).

outndarray or None, optional

A location into which the result is stored. If provided, it must have a shape that the inputs broadcast to. If not provided or None, a freshly-allocated array is returned. A tuple (possible only as a keyword argument) must have length equal to the number of outputs.

wherearray_like, optional

This condition is broadcast over the input. At locations where the condition is True, the out array will be set to the ufunc result. Elsewhere, the out array will retain its original value. Note that if an uninitialized out array is created via the default out=None, locations within it where the condition is False will remain uninitialized.

**kwargs

For other keyword-only arguments, see the section Optional Keyword Arguments.

Returns

yndarray

Heaviside step function of x1 and x2, element-wise. If x1 and x2 are both scalars, this function returns the result as a 0-dimension ndarray.

Examples

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