nums.numpy.divide

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

Returns a true division of the inputs, element-wise.

This docstring was copied from numpy.divide.

Some inconsistencies with the NumS version may exist.

Instead of the Python traditional ‘floor division’, this returns a true division. True division adjusts the output type to present the best answer, regardless of input types.

Parameters

  • x1 (BlockArray) – Dividend array.

  • x2 (BlockArray) – Divisor array. 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

out

Return type

BlockArray or scalar

Notes

In Python, // is the floor division operator and / the true division operator. The true_divide(x1, x2) function is equivalent to true division in Python.

Examples

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

>>> x = nps.arange(5)  
>>> nps.true_divide(x, nps.array(4)).get()  
array([ 0.  ,  0.25,  0.5 ,  0.75,  1.  ])

>>> (x/4).get()  
array([ 0.  ,  0.25,  0.5 ,  0.75,  1.  ])