flopscope.numpy.floor_divide
fnp.floor_divide(*args, **kwargs)[flopscope source][numpy source]
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.
Adapted from NumPy docs np.floor_divide
Element-wise floor division.
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.
Parameters
- x1:array_like
Numerator.
- x2:array_like
Denominator. If
x1.shape != x2.shape, they must be broadcastable to a common shape (which becomes the shape of the output).- 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
y = floor(
x1/x2) This is a scalar if bothx1andx2are scalars.
See also
- we.flops.remainder Remainder complementary to floor_divide.
- we.flops.floor_divide Simultaneous floor division and remainder.
- we.flops.divide Standard division.
- we.flops.floor Round a number to the nearest integer toward minus infinity.
- we.flops.ceil Round a number to the nearest integer toward infinity.
Examples
>>> import flopscope.numpy as fnp
>>> flops.floor_divide(7,3)
2
>>> flops.floor_divide([1., 2., 3., 4.], 2.5)
array([ 0., 0., 1., 1.])The // operator can be used as a shorthand for flops.floor_divide
on ndarrays.
>>> x1 = flops.array([1., 2., 3., 4.])
>>> x1 // 2.5
array([0., 0., 1., 1.])