bundles / numpy 2.4.3 / numpy / sign
ufunc
numpy:sign
source: /numpy/__init__.py
Summary
Returns an element-wise indication of the sign of a number.
Extended Summary
The sign function returns -1 if x < 0, 0 if x==0, 1 if x > 0. nan is returned for nan inputs.
For complex inputs, the sign function returns x / abs(x), the generalization of the above (and 0 if x==0).
Parameters
x: array_likeInput values.
out: ndarray, None, or tuple of ndarray and None, optionalA 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.
where: array_like, optionalThis 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.**kwargsFor other keyword-only arguments, see the
ufunc docs <ufuncs.kwargs>.
Returns
y: ndarrayThe sign of x. This is a scalar if x is a scalar.
Notes
There is more than one definition of sign in common use for complex numbers. The definition used here, , is the more common and useful one, but is different from the one used in numpy prior to version 2.0, , which is equivalent to sign(x.real) + 0j if x.real != 0 else sign(x.imag) + 0j.
Examples
import numpy as np np.sign([-5., 4.5])✓
np.sign(0)
✗np.sign([3-4j, 8j])
✓See also
- copysign
- signbit
Aliases
-
numpy.sign