From 1858cb99ad2bb8328c479ef7489bf7db2515c5af Mon Sep 17 00:00:00 2001 From: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Date: Sun, 8 Dec 2024 16:15:19 +0000 Subject: [PATCH] Update fmod() doc --- Doc/library/math.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/Doc/library/math.rst b/Doc/library/math.rst index bf79b23a72bbf9..2db64ecf5e759c 100644 --- a/Doc/library/math.rst +++ b/Doc/library/math.rst @@ -248,16 +248,16 @@ Floating point arithmetic .. function:: fmod(x, y) - Return ``fmod(x, y)``, as defined by the platform C library. Note that the - Python expression ``x % y`` may not return the same result. The intent of the C - standard is that ``fmod(x, y)`` be exactly (mathematically; to infinite - precision) equal to ``x - n*y`` for some integer *n* such that the result has - the same sign as *x* and magnitude less than ``abs(y)``. Python's ``x % y`` - returns a result with the sign of *y* instead, and may not be exactly computable - for float arguments. For example, ``fmod(-1e-100, 1e100)`` is ``-1e-100``, but - the result of Python's ``-1e-100 % 1e100`` is ``1e100-1e-100``, which cannot be - represented exactly as a float, and rounds to the surprising ``1e100``. For - this reason, function :func:`fmod` is generally preferred when working with + Return the remainder of division ``x / y``, as defined by the platform C library + function ``fmod(x, y)``. Note that the Python expression ``x % y`` may not return + the same result. The intent of the C standard is that ``fmod(x, y)`` be exactly + (mathematically; to infinite precision) equal to ``x - n*y`` for some integer *n* + such that the result has the same sign as *x* and magnitude less than ``abs(y)``. + Python's ``x % y`` returns a result with the sign of *y* instead, and may not be + exactly computable for float arguments. For example, ``fmod(-1e-100, 1e100)`` + is ``-1e-100``, but the result of Python's ``-1e-100 % 1e100`` is ``1e100-1e-100``, + which cannot be represented exactly as a float, and rounds to the surprising ``1e100``. + For this reason, the function :func:`fmod` is generally preferred when working with floats, while Python's ``x % y`` is preferred when working with integers.