Function floor_divide

python/paddle/tensor/math.py:1163–1230

Floor divide two tensors element-wise and rounds the quotinents to the nearest integer toward negative infinite. The equation is: .. math:: out = floor(x / y) - :math:`x`: Multidimensional Tensor. - :math:`y`: Multidimensional Tensor. Note: ``paddle.floor_divi

(
    x: Tensor,
    y: Number | Tensor,
    name: str | None = None,
    *,
    out: Tensor | None = None,
)

@param_two_alias(['x', 'input'], ['y', 'other'])
def floor_divide(
    x: Tensor,
    y: Number | Tensor,
    name: str | None = None,
    *,
    out: Tensor | None = None,
) -> Tensor:
    """
    Floor divide two tensors element-wise and rounds the quotinents to the nearest integer toward negative infinite. The equation is:

    .. math::
        out = floor(x / y)

    - :math:`x`: Multidimensional Tensor.
    - :math:`y`: Multidimensional Tensor.

    Note:
        ``paddle.floor_divide`` supports broadcasting. If you want know more about broadcasting, please refer to `Introduction to Tensor`_ .

        .. _Introduction to Tensor: ../../guides/beginner/tensor_en.html#chapter5-broadcasting-of-tensor


    Args:
        x (Tensor): the input tensor, it's data type should be uint8, int8, int32, int64, float32, float64, float16, bfloat16.
            alias: ``input``.
        y (Tensor|Number): the input tensor or number, it's data type should be uint8, int8, int32, int64, float32, float64, float16, bfloat16.
            alias: ``other``.
        name (str|None, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Keyword Args:
        out (Tensor|None, optional): The output tensor. Default: None.

    Returns:
        N-D Tensor. A location into which the result is stored. It's dimension equals with $x$.

    Examples:

        .. code-block:: pycon

            >>> import paddle

            >>> x = paddle.to_tensor([2, 3, 8, 7])
            >>> y = paddle.to_tensor([1, 5, 3, 3])
            >>> z = paddle.floor_divide(x, y)
            >>> print(z)
            Tensor(shape=[4], dtype=int64, place=Place(cpu), stop_gradient=True,
            [2, 0, 2, 2])

            >>> x = paddle.to_tensor([2, 3, 8, 7])
            >>> y = paddle.to_tensor([1, -5, -3, -3])
            >>> z = paddle.floor_divide(x=x, y=y)
            >>> print(z)
            Tensor(shape=[4], dtype=int64, place=Place(cpu), stop_gradient=True,
            [2, -1, -3, -3])

            >>> x = paddle.to_tensor([2, -3, 8, -7])
            >>> y = paddle.to_tensor([1, -5, -3, 3])
            >>> z = paddle.floor_divide(input=x, other=y)  # type: ignore[call-arg]