nums.numpy.fabs

nums.numpy.fabs(x, out=None, where=True, **kwargs)[source]

Compute the absolute values element-wise.

This docstring was copied from numpy.fabs.

Some inconsistencies with the NumS version may exist.

This function returns the absolute values (positive magnitude) of the data in x. Complex values are not handled, use absolute to find the absolute values of complex data.

Parameters

  • x (BlockArray) – The array of numbers for which the absolute values are required. If x is a scalar, the result y will also be a scalar.

  • 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 absolute values of x, the returned values are always floats.

Return type

BlockArray or scalar

See also

absolute

Absolute values including complex types.

Examples

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

>>> nps.fabs(nps.array(-1)).get()  
array(1.)
>>> nps.fabs(nps.array([-1.2, 1.2])).get()  
array([ 1.2,  1.2])