Skip to content

Fix parameter inconsistencies in distribution docs #1335

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 3, 2025
Merged

Fix parameter inconsistencies in distribution docs #1335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/distributions/chi_squared.qbk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@

// Parameter estimation:
BOOST_MATH_GPU_ENABLED static RealType find_degrees_of_freedom(
RealType difference_from_mean,
RealType difference_from_variance,
RealType alpha,
RealType beta,
RealType sd,
RealType variance,
RealType hint = 100);
};

Expand Down
6 changes: 2 additions & 4 deletions doc/distributions/geometric.qbk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,9 @@
// Bounds on success fraction:
BOOST_MATH_GPU_ENABLED static RealType find_lower_bound_on_p(
RealType trials,
RealType successes,
RealType probability); // alpha
BOOST_MATH_GPU_ENABLED static RealType find_upper_bound_on_p(
RealType trials,
RealType successes,
RealType probability); // alpha

// Estimate min/max number of trials:
Expand Down Expand Up @@ -141,8 +139,8 @@ see __binomial_distrib and __negative_binomial_distrib for more discussion.
[h5 Lower Bound on success_fraction Parameter ['p]]

static RealType find_lower_bound_on_p(
RealType failures,
RealType probability) // (0 <= alpha <= 1), 0.05 equivalent to 95% confidence.
RealType trials,
RealType alpha) // (0 <= alpha <= 1), 0.05 equivalent to 95% confidence.

Returns a *lower bound* on the success fraction:

Expand Down
4 changes: 2 additions & 2 deletions doc/distributions/negative_binomial.qbk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,14 +135,14 @@ see __binomial_distrib for more discussion.
[h5 Lower Bound on Parameter p]

BOOST_MATH_GPU_ENABLED static RealType find_lower_bound_on_p(
RealType failures,
RealType trials,
RealType successes,
RealType probability) // (0 <= alpha <= 1), 0.05 equivalent to 95% confidence.

Returns a *lower bound* on the success fraction:

[variablelist
[[failures][The total number of failures before the ['r]th success.]]
[[trials][The total number of trials conducted.]]
[[successes][The number of successes required.]]
[[alpha][The largest acceptable probability that the true value of
the success fraction is [*less than] the value returned.]]
Expand Down