bundles / numpy latest / numpy / ufunc
class
numpy:ufunc
source: /dev/numpy/build-install/usr/lib/python3.14/site-packages/numpy/__init__.py
Signature
class ufunc ( ) Summary
Functions that operate element by element on whole arrays.
Extended Summary
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 ufuncs.
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
*x: array_likeInput arrays.
out: ndarray, None, ..., or tuple of ndarray and None, optionalLocation(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).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
r: ndarray or tuple of ndarrayr will have the shape that the arrays in
xbroadcast 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.
Aliases
-
numpy.ufunc