bundles / numpy 2.4.3 / numpy / ma / core / add
_MaskedBinaryOperation
numpy.ma.core:add
source: /numpy/ma/core.py
Summary
Add arguments element-wise.
Parameters
x1, x2: array_likeThe arrays to be added. If
x1.shape != x2.shape, they must be broadcastable to a common shape (which becomes the shape of the output).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
add: ndarray or scalarThe sum of x1 and x2, element-wise. This is a scalar if both x1 and x2 are scalars.
Notes
Equivalent to x1 + x2 in terms of array broadcasting.
Examples
import numpy as np np.add(1.0, 4.0) x1 = np.arange(9.0).reshape((3, 3)) x2 = np.arange(3.0) np.add(x1, x2)The ``+`` operator can be used as a shorthand for ``np.add`` on ndarrays.
x1 = np.arange(9.0).reshape((3, 3)) x2 = np.arange(3.0) x1 + x2
Aliases
-
numpy.ma.add