nums.numpy.negative
-
nums.numpy.negative(x, out=None, where=True, **kwargs)[source] Numerical negative, element-wise.
This docstring was copied from numpy.negative.
Some inconsistencies with the NumS version may exist.
- Parameters
x (BlockArray or scalar) – Input array.
out (BlockArray, None, or 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.
where (BlockArray, 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 ufunc docs.
- Returns
y – Returned array or scalar: y = -x.
- Return type
BlockArray or scalar
Examples
The doctests shown below are copied from NumPy. They won’t show the correct result until you operate
get().>>> nps.negative(nps.array([1.,-1.])).get() array([-1., 1.])