nums.numpy.floor_divide

nums.numpy.floor_divide(x1, x2, out=None, where=True, **kwargs)

Return the largest integer smaller or equal to the division of the inputs. It is equivalent to the Python // operator and pairs with the Python % (remainder), function so that a = a % b + b * (a // b) up to roundoff.

This docstring was copied from numpy.floor_divide.

Some inconsistencies with the NumS version may exist.

Parameters

• x1 (BlockArray) – Numerator.

• x2 (BlockArray) – Denominator. 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 – y = floor(x1/x2)

Return type

BlockArray

See also

remainder

Remainder complementary to floor_divide.

divmod

Simultaneous floor division and remainder.

divide

Standard division.

floor

Round a number to the nearest integer toward minus infinity.

ceil

Round a number to the nearest integer toward infinity.

Examples

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

>>> nps.floor_divide(nps.array(7),nps.array(3)).get()  
nps.array(2)
>>> nps.floor_divide(nps.array([1., 2., 3., 4.]), nps.array(2.5)).get()  
array([ 0.,  0.,  1.,  1.])