bundles / numpy latest / numpy / ldexp
ufunc
numpy:ldexp
source: /dev/numpy/build-install/usr/lib/python3.14/site-packages/numpy/__init__.py
Summary
Returns x1 * 2**x2, element-wise.
Extended Summary
The mantissas x1 and twos exponents x2 are used to construct floating point numbers x1 * 2**x2.
Parameters
x1: array_likeArray of multipliers.
x2: array_like, intArray of twos exponents. 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
y: ndarray or scalarThe result of
x1 * 2**x2. This is a scalar if both x1 and x2 are scalars.
Notes
Complex dtypes are not supported, they will raise a TypeError.
ldexp is useful as the inverse of frexp, if used by itself it is more clear to simply use the expression x1 * 2**x2.
Examples
import numpy as np np.ldexp(5, np.arange(4))✓
x = np.arange(6)
✓np.ldexp(*np.frexp(x))
✗See also
- frexp
Return (y1, y2) from
x = y1 * 2**y2, inverse toldexp.
Aliases
-
numpy.ldexp