Skip to content

Let math.nextafter() compute multiple steps at a time. #94906

Description

@rhettinger

Sometimes math.nextafter() needs to be applied multiple times in succession.

   x = nextafter(nextafter( nextafter(x, inf), inf), inf)    # Three steps up

It would be nice if the function supported this directly:

   x = nextafter(x, inf, n=3)

The implementation would just be a for-loop:

def newnextafter(x, y, /, *, n=1):
    'Return the floating-point value n steps after x towards y.'
    for i in range(n):
        x = nextafter(x, y)
    return x

The formal paramater can be just n or the longer but more descriptive steps.

Linked PRs

Activity

  1. added a commit that references this issue on Jul 16, 2022
  2. mdickinson commented on Jul 17, 2022

    @mdickinson
    Member

    This feels like a needless expansion of the API to me; I don't think I've ever encountered a use-case for this. On the rare occasions that such a use-case turns up, what's wrong with the for loop, or with adding an integer multiple of math.ulp(x) to x?

    -1 from me.

  3. rhettinger commented on Jul 17, 2022

    @rhettinger
    ContributorAuthor

    I wouldn't posted the issue if I hadn't needed this, so it is not "needless".

    In 30 seconds of searching, I found another example:

    https://github.com/ericherman/libefloat/blob/ad606d566ac5310aabb4fff8890e35200a718e8d/tests/test-distance-64.c#L94

    Python is a high level language and it is suitable to incorporate options that are more expansive than used in low level languages like C that tend to focus on atomic steps.

  4. mdickinson commented on Jul 17, 2022

    @mdickinson
    Member

    Sure, I don't doubt that you had a genuine need, but that need is trivially addressed with a for loop. My use of "needless" referred to the expansion of the API. You needing the functionality is not the same thing as the math module needing to support the functionality directly.

    Sorry, but I don't see this use-case as valuable enough or common enough to warrant expanding the math.nextafter API.

    I'm also concerned that this might be a performance trap: a user could easily write nextafter(x, y, steps=10**6) without realising that that means a million invocations of nextafter internally. With an explicit for loop, the effect on running time is much more obvious.

  5. serhiy-storchaka commented on Jul 17, 2022

    @serhiy-storchaka
    Member

    I concur with @mdickinson. It is too niche feature, and it is not difficult to implement a wrapper in Python. BTW, the case you found is in tests.

  6. rhettinger commented on Jul 17, 2022

    @rhettinger
    ContributorAuthor

    I wish this wasn't dismissed so casually. All uses of nextafter() are "niche". There are only a handful of people who will ever use it.

    I submitted the feature request because I needed to write the replacement function in pure Python (much like the example I posted above) and it was distracting and felt amiss, like something the should have already have been built in to a higher level language.

    I wrote the function while working on another problem and had casually created an incorrect result along the way:

    >>> sixth_largest_random = 1.0 - 6 * ulp(1.0)
    >>> sixth_largest_random
    0.9999999999999987
    

    Fortunately, I spotted the problem before going too far with it and wrote the above function giving the correct answer:

    >>> sixth_largest_random = newnextafter(1.0, -inf, n=6)
    >>> sixth_largest_random
    0.9999999999999993
    
    

    The entire side trip was distracting and annoying. It took the focus away for the error analysis I was working on at the time.

    The proposal is an easy thing to do. It isn't even slightly confusing. It would be handy when needed by the few who ever use this function. I don't see any downside.

    Note, in numpy and scipy, most interesting functions have many options. That seems to work well for them. But in Python, there seems to be an urge to fight against the simplest of options as "unnecessary API expansion".

  7. matthiasgoergens commented on Aug 15, 2022

    @matthiasgoergens
    Contributor

    @rhettinger @hauntsaninja @mdickinson

    You don't need a loop for this. See this pure Python prototype inspired by an old StackOverflow question of mine.

    And here's a prototype of a fix of the PR. (Please keep in mind that the C code in the PR isn't tested nor even run. The pure Python version has Hypothesis tests, so it's much more reliable.)

  8. ambv commented on Apr 24, 2023

    @ambv
    Contributor

    Removing "easy" for now as this needs a resolution between the two maintainers of the math module.

  9. mblahay commented on Apr 24, 2023

    @mblahay
    Contributor

    @rhettinger @mdickinson

    If the goal here is to produce a one line implementation capable of looping the execution of math.next after, it can be achieved using the reduce function from func tools.

    from math import nextafter,inf
    from functools import reduce
    
    reduce(nextafter,[-inf]*6,1.0)
    

    The starting point, 1.0, is the third argument, then you must provide an iterator that outputs the direction of nextafter for the desired number of times, in this case I use a list and duplicate -inf 6 times.

  10. 7 remaining items

  11. rhettinger commented on Apr 25, 2023

    @rhettinger
    ContributorAuthor

    Removing "easy" for now as this needs a resolution between the two maintainers of the math module.

    FWIW, I only care about this a tiny bit. Though I think it would be nice to have, I won't lose any sleep if this gets closed.

  12. matthiasgoergens commented on Apr 25, 2023

    @matthiasgoergens
    Contributor

    I overhauled the C PR https://github.com/matthiasgoergens/cpython/pull/5/files Tests pass now.

    I'll point it at the upstream CPython repository, after I polish the git history.

  13. added 4 commits that reference this issue on Apr 26, 2023
  14. added a commit that references this issue on May 19, 2023
  15. added a commit that references this issue on May 20, 2023
  16. mdickinson commented on May 20, 2023

    @mdickinson
    Member

    Done in #103881. Thanks to @matthiasgoergens.

  17. matthiasgoergens commented on May 20, 2023

    @matthiasgoergens
    Contributor

    Done in #103881. Thanks to @matthiasgoergens.

    Thanks for fixing the PR up at the end, too!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    3.12only security fixestype-featureA feature request or enhancement

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions