mindspore.ops.heaviside

mindspore.ops.heaviside(input, values)[source]

Computes the Heaviside step function for each element in input.

\[\begin{split}\text { heaviside }(\text { input, values })=\left\{\begin{array}{ll} 0, & \text { if input }<0 \\ \text { values, } & \text { if input }=0 \\ 1, & \text { if input }>0 \end{array}\right.\end{split}\]
Parameters

  • input (Tensor) – The input tensor. With real number data type.

  • values (Tensor) – The values to use where input is zero. Values can be broadcast with input . input should have the same dtype with values .

Returns

Tensor, has the same type as input and values.

Raises

  • TypeError – If input or values is not Tensor.

  • TypeError – If data type input and values is different.

  • ValueError – If shape of two inputs are not broadcastable.

Supported Platforms:

Ascend GPU CPU

Examples

>>> import numpy as np
>>> from mindspore import Tensor, ops
>>> input = Tensor(np.array([-5., 1., 0., 2., 0.]))
>>> values = Tensor(np.array([3.]))
>>> y = ops.heaviside(input, values)
>>> print(y)
[0. 1. 3. 1. 3.]