numpy.ufunc — NumPy v2.3.dev0 Manual (original) (raw)
Functions that operate element by element on whole arrays.
To see the documentation for a specific ufunc, use info. For example, np.info(np.sin). Because ufuncs are written in C (for speed) and linked into Python with NumPy’s ufunc facility, Python’s help() function finds this page whenever help() is called on a ufunc.
A detailed explanation of ufuncs can be found in the docs for Universal functions (ufunc).
Calling ufuncs: op(*x[, out], where=True, **kwargs)
Apply op to the arguments *x elementwise, broadcasting the arguments.
The broadcasting rules are:
- Dimensions of length 1 may be prepended to either array.
- Arrays may be repeated along dimensions of length 1.
Parameters:
*xarray_like
Input arrays.
outndarray, None, …, or tuple of ndarray and None, optional
Location(s) into which the result(s) are stored. If not provided or None, new array(s) are created by the ufunc. If passed as a keyword argument, can be Ellipses (out=...) to ensure an array is returned even if the result is 0-dimensional, or a tuple with length equal to the number of outputs (where None can be used for allocation by the ufunc).
New in version 2.3: Support for out=... was added.
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 the ufunc docs.
Returns:
rndarray or tuple of ndarray
r will have the shape that the arrays in x broadcast to; if out is provided, it will be returned. If not, r will be allocated and may contain uninitialized values. If the function has more than one output, then the result will be a tuple of arrays.
Attributes:
The identity value.
The number of arguments.
The number of inputs.
The number of outputs.
The number of types.
Definition of the core elements a generalized ufunc operates on.
Returns a list with types grouped input->output.
Methods