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: Add method details/reference to scipy.integrate.dblquad and scipy.integrate.tplquad #14249

Closed
wants to merge 2 commits into from

Conversation

ShantanuDash
Copy link

Reference issue

Closes #13872

What does this implement/fix?

Add method details/reference to the documentation of scipy.integrate.dblquad and scipy.integrate.tplquad

Additional information

Both scipy.integrate.dblquad and scipy.integrate.tplquad wrap scipy.integrate.nquad to perform double and triple integration (definite) respectively. This was previously unclear, see here

- dblquad and tplquad warp nquad to perform their jobs- added this piece of documentation
fixed some typos in the documentation
@rgommers rgommers added Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.integrate labels Jun 19, 2021
@rgommers
Copy link
Member

Hi @ShantanuDash, thanks for working on this. This doesn't yet address the issue though. nquad is not a method. The request is to look at the actual numerical method used (as implemented in QUADPACK) and then add some details like the name of the method and a reference to the original paper about this method.

@ShantanuDash
Copy link
Author

@rgommers thanks a lot for informing! I am absolutely new to this. Will look into QUADPACK and would follow up.

@ShantanuDash
Copy link
Author

@rgommers the quad function calls different QUADPACK routines depending on the parameters, each of which subsequently uses different routines. Here's the original documentation. . So should i add something like this and specify how exactly different QUADPACKS routines are called and then add the original QUADPACK documentation as reference?

@rgommers
Copy link
Member

So should i add something like this and specify how exactly different QUADPACKS routines are called and then add the original QUADPACK documentation as reference?

Yes that sounds about right. Check which routines are called exactly, and then a phrasing like on Wikipedia like "uses global adaptive quadrature based on 21-point Gauss–Kronrod quadrature within each subinterval, with acceleration by Peter Wynn's epsilon algorithm." (not sure that's the correct one, just stole it from the QAGS).

@mdhaber
Copy link
Contributor

mdhaber commented Apr 16, 2022

Hi @ShantanuDash were you still interested in finishing this? If so, I can resolve the merge conflicts for you.

@mdhaber
Copy link
Contributor

mdhaber commented Sep 28, 2022

The referenced issue is closed, so I'll close this PR.

@mdhaber mdhaber closed this Sep 28, 2022
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 scipy.integrate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add method details or reference to scipy.integrate.dblquad
3 participants