dask.array.negative — Dask documentation (original) (raw)

dask.array.negative¶

dask.array.negative(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, _subok=True_[, _signature_]) = <ufunc 'negative'>¶

This docstring was copied from numpy.negative.

Some inconsistencies with the Dask version may exist.

Numerical negative, element-wise.

Parameters

xarray_like or scalar

Input array.

outndarray, None, or tuple of ndarray and 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 defaultout=None, locations within it where the condition is False will remain uninitialized.

**kwargs

For other keyword-only arguments, see theufunc docs.

Returns

yndarray or scalar

Returned array or scalar: y = -x. This is a scalar if x is a scalar.

Examples

import numpy as np
np.negative([1.,-1.])
array([-1., 1.])

The unary - operator can be used as a shorthand for np.negative on ndarrays.

x1 = np.array(([1., -1.]))
-x1
array([-1., 1.])