Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: interpolate: add note to BarycentricInterpolator.add_xi about numerical stability #19373

Closed
j-bowhay opened this issue Oct 11, 2023 · 0 comments · Fixed by #19410
Closed
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org good first issue Good topic for first contributor pull requests, with a relatively straightforward solution scipy.interpolate
Milestone

Comments

@j-bowhay
Copy link
Member

Issue with current documentation:

Currently the docs for BarycentricInterpolator don't mention that new points added by add_xi are not randomly permuted so they may introduce numerical instability. It would be nice to add a note documenting this and explaining that, if this occurs to reconstruct the interpolant from scratch instead.

https://github.com/scipy/scipy/blob/f990b1d2471748c79bc4260baf8923db0a5248af/scipy/interpolate/_polyint.py#L562-L566C28

Idea or request for content:

Add note to add_xi docstring.a

Additional context (e.g. screenshots, GIFs)

Will get around to this eventually but in the meantime anybody is welcome to go for it

@j-bowhay j-bowhay added scipy.interpolate Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org good first issue Good topic for first contributor pull requests, with a relatively straightforward solution labels Oct 11, 2023
@j-bowhay j-bowhay added this to the 1.12.0 milestone Oct 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org good first issue Good topic for first contributor pull requests, with a relatively straightforward solution scipy.interpolate
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant