DOC: special: Add documentation for betainc function
#10682
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pvanmulbregt
added
Documentation
pvanmulbregt
requested changes
Aug 18, 2019
| ------- | ||
| array-like | ||
| Value of the incomplete beta function | ||
|
|
There was a problem hiding this comment.
Suggest adding a "See also:" block here, referring to beta, betaincinv.
scipy/special/add_newdocs.py
Outdated
| incomplete beta. Under this definition, you can get the incomplete beta by | ||
| multiplying the result of the scipy function by beta(a, b). | ||
| The incomplete beta function is also sometimes defined | ||
| without the terms in gamma, in which case the above |
There was a problem hiding this comment.
Perhaps "... without the Gamma terms ..."?
There was a problem hiding this comment.
Sure. I also made it link to the gamma doc using backticks.
scipy/special/add_newdocs.py
Outdated
| >>> sc.betainc(9, 0.1, 1.0) | ||
| 1.0 | ||
| >>> sc.betainc(0.0003, 7.4, 1.0) | ||
| 1.0 |
There was a problem hiding this comment.
There are 3 examples here showing I_x(a, b) = 1 and one is probably sufficient. Suggest using the space to show other relations, such as to the hypergeometric function. E.g. https://dlmf.nist.gov/8.17#ii
:math:I_x(a, b) = x^a * F(a, 1-b, a+1, x)/ (a * B(a, b))
>>> a, b, x = 0.2, 3.5, 0.5
>>> x**a * sc.hyp2f1(a, 1-b, a+1, x)/(a*sc.beta(a, b)), sc.betainc(a, b, x)
(0.9896206102333263, 0.9896206102333264)
pvanmulbregt
approved these changes
Aug 20, 2019
person142
added
the
special-docs-marathon
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reference issue
None.
What does this implement/fix?
Adds a definition, a parameter description, a reference, and some examples of
special.betaincsatisfying some known properties.Additional information
None.