Document feedback

Question document fragment

When a question document fragment contains a formula, it is displayed as a space.

Submission type

issue

It's a little complicated...

I'd like to ask someone.

Please select the submission type

Problem type

Specifications and Common Mistakes

- Specifications and Common Mistakes:

- Misspellings or punctuation mistakes,incorrect formulas, abnormal display.

- Incorrect links, empty cells, or wrong formats.

- Chinese characters in English context.

- Minor inconsistencies between the UI and descriptions.

- Low writing fluency that does not affect understanding.

- Incorrect version numbers, including software package names and version numbers on the UI.

Usability

- Usability:

- Incorrect or missing key steps.

- Missing main function descriptions, keyword explanation, necessary prerequisites, or precautions.

- Ambiguous descriptions, unclear reference, or contradictory context.

- Unclear logic, such as missing classifications, items, and steps.

Correctness

- Correctness:

- Technical principles, function descriptions, supported platforms, parameter types, or exceptions inconsistent with that of software implementation.

- Incorrect schematic or architecture diagrams.

- Incorrect commands or command parameters.

- Incorrect code.

- Commands inconsistent with the functions.

- Wrong screenshots.

- Sample code running error, or running results inconsistent with the expectation.

Risk Warnings

- Risk Warnings:

- Lack of risk warnings for operations that may damage the system or important data.

Content Compliance

- Content Compliance:

- Contents that may violate applicable laws and regulations or geo-cultural context-sensitive words and expressions.

- Copyright infringement.

Please select the type of question

Problem description

Describe the bug so that we can quickly locate the problem.

Submit

Document feedback

mindspore.ops.heaviside

mindspore.ops.heaviside(x, values)

Computes the Heaviside step function for each element in input.

$$\begin{array}{r}\text{ heaviside }(\text{ x, values })=\{\begin{array}{ll}0,& \text{ if x }<0\\ \text{ values, }& \text{ if x }==0\\ 1,& \text{ if x }>0\end{array}\end{array}$$

Parameters

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

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

Returns

Tensor, has the same type as ‘x’ and ‘values’.

Raises

• TypeError – If x or values is not Tensor.

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

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

Supported Platforms:

GPU CPU

Examples

>>> x = Tensor(np.array([-1.5, 0., 2.]))
>>> values = Tensor(np.array([0.5]))
>>> y = ops.heaviside(x, values)
>>> print(y)
[ 0.  0.5 1. ]