nums.numpy.ldexp

nums.numpy.ldexp(x1, x2, out=None, where=True, **kwargs)[source]

Returns x1 * 2**x2, element-wise.

This docstring was copied from numpy.ldexp.

Some inconsistencies with the NumS version may exist.

The mantissas x1 and twos exponents x2 are used to construct floating point numbers x1 * 2**x2.

Parameters

  • x1 (BlockArray) – Array of multipliers.

  • x2 (BlockArray, int) – Array of twos exponents. If x1.shape != x2.shape, they must be broadcastable to a common shape (which becomes the shape of the output).

  • out (BlockArray, None, or 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.

  • where (BlockArray, 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 default out=None, locations within it where the condition is False will remain uninitialized.

  • **kwargs – For other keyword-only arguments, see the ufunc docs.

Returns

y – The result of x1 * 2**x2.

Return type

BlockArray

See also

frexp

Return (y1, y2) from x = y1 * 2**y2, inverse to ldexp.

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

The doctests shown below are copied from NumPy. They won’t show the correct result until you operate get().

>>> x = nps.arange(6)  
>>> nps.ldexp(*nps.frexp(x)).get()  
array([ 0.,  1.,  2.,  3.,  4.,  5.])