Skip to content

Commit 9eba9d7

Browse files
authored
Merge pull request #1335 from andrjohns/update-docs
Fix parameter inconsistencies in distribution docs
2 parents 8af4499 + 517a22b commit 9eba9d7

File tree

3 files changed

+6
-8
lines changed

3 files changed

+6
-8
lines changed

doc/distributions/chi_squared.qbk

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@
2525

2626
// Parameter estimation:
2727
BOOST_MATH_GPU_ENABLED static RealType find_degrees_of_freedom(
28-
RealType difference_from_mean,
28+
RealType difference_from_variance,
2929
RealType alpha,
3030
RealType beta,
31-
RealType sd,
31+
RealType variance,
3232
RealType hint = 100);
3333
};
3434

doc/distributions/geometric.qbk

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,9 @@
2626
// Bounds on success fraction:
2727
BOOST_MATH_GPU_ENABLED static RealType find_lower_bound_on_p(
2828
RealType trials,
29-
RealType successes,
3029
RealType probability); // alpha
3130
BOOST_MATH_GPU_ENABLED static RealType find_upper_bound_on_p(
3231
RealType trials,
33-
RealType successes,
3432
RealType probability); // alpha
3533

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

143141
static RealType find_lower_bound_on_p(
144-
RealType failures,
145-
RealType probability) // (0 <= alpha <= 1), 0.05 equivalent to 95% confidence.
142+
RealType trials,
143+
RealType alpha) // (0 <= alpha <= 1), 0.05 equivalent to 95% confidence.
146144

147145
Returns a *lower bound* on the success fraction:
148146

doc/distributions/negative_binomial.qbk

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,14 +135,14 @@ see __binomial_distrib for more discussion.
135135
[h5 Lower Bound on Parameter p]
136136

137137
BOOST_MATH_GPU_ENABLED static RealType find_lower_bound_on_p(
138-
RealType failures,
138+
RealType trials,
139139
RealType successes,
140140
RealType probability) // (0 <= alpha <= 1), 0.05 equivalent to 95% confidence.
141141

142142
Returns a *lower bound* on the success fraction:
143143

144144
[variablelist
145-
[[failures][The total number of failures before the ['r]th success.]]
145+
[[trials][The total number of trials conducted.]]
146146
[[successes][The number of successes required.]]
147147
[[alpha][The largest acceptable probability that the true value of
148148
the success fraction is [*less than] the value returned.]]

0 commit comments

Comments
 (0)