flopscope.numpy.sqrt
fnp.sqrt(*args, **kwargs)[flopscope source][numpy source]
Return the non-negative square-root of an array, element-wise.
Adapted from NumPy docs np.sqrt
Element-wise square root.
Parameters
- x:array_like
The values whose square-roots are required.
- out:ndarray, None, or tuple of ndarray and None, 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:array_like, optional
This condition is broadcast over the input. At locations where the condition is True, the
outarray will be set to the ufunc result. Elsewhere, theoutarray will retain its original value. Note that if an uninitializedoutarray 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
- y:ndarray
An array of the same shape as
x, containing the positive square-root of each element inx. If any element inxis complex, a complex array is returned (and the square-roots of negative reals are calculated). If all of the elements inxare real, so isy, with negative elements returningnan. Ifoutwas provided,yis a reference to it. This is a scalar ifxis a scalar.
See also
- emath.sqrt A version which returns complex numbers when given negative reals. Note that 0.0 and -0.0 are handled differently for complex inputs.
Notes
sqrt has--consistent with common convention--as its branch cut the
real "interval" [-inf, 0), and is continuous from above on it.
A branch cut is a curve in the complex plane across which a given
complex function fails to be continuous.
Examples
>>> import flopscope.numpy as fnp
>>> flops.sqrt([1,4,9])
array([ 1., 2., 3.])>>> flops.sqrt([4, -1, -3+4J])
array([ 2.+0.j, 0.+1.j, 1.+2.j])>>> flops.sqrt([4, -1, flops.inf])
array([ 2., nan, inf])