From d892e030700d80b999a5301a720d1d104c46d480 Mon Sep 17 00:00:00 2001 From: Matt Borland Date: Mon, 12 Aug 2024 14:11:43 -0400 Subject: [PATCH] Add notes to individual dist docs for specializations --- doc/distributions/exponential.qbk | 3 +++ doc/distributions/extreme_value.qbk | 3 +++ doc/distributions/gamma.qbk | 3 +++ doc/distributions/geometric.qbk | 3 +++ doc/distributions/inverse_gamma.qbk | 3 +++ doc/distributions/inverse_gaussian.qbk | 3 +++ doc/distributions/laplace.qbk | 3 +++ doc/distributions/logistic.qbk | 3 +++ doc/distributions/pareto.qbk | 3 +++ doc/distributions/poisson.qbk | 3 +++ doc/distributions/rayleigh.qbk | 3 +++ doc/distributions/weibull.qbk | 3 +++ 12 files changed, 36 insertions(+) diff --git a/doc/distributions/exponential.qbk b/doc/distributions/exponential.qbk index 043818b4a..0b7ea5cbb 100644 --- a/doc/distributions/exponential.qbk +++ b/doc/distributions/exponential.qbk @@ -57,6 +57,9 @@ that are generic to all distributions are supported: __usual_accessors. The domain of the random variable is \[0, +[infin]\]. +In this distribution the implementation of both `logcdf`, and `logpdf` are specialized +to improve numerical accuracy. + [h4 Accuracy] The exponential distribution is implemented in terms of the diff --git a/doc/distributions/extreme_value.qbk b/doc/distributions/extreme_value.qbk index 314917ebc..56c4fb5df 100644 --- a/doc/distributions/extreme_value.qbk +++ b/doc/distributions/extreme_value.qbk @@ -81,6 +81,9 @@ that are generic to all distributions are supported: __usual_accessors. The domain of the random parameter is \[-[infin], +[infin]\]. +In this distribution the implementation of both `logcdf`, and `logpdf` are specialized +to improve numerical accuracy. + [h4 Accuracy] The extreme value distribution is implemented in terms of the diff --git a/doc/distributions/gamma.qbk b/doc/distributions/gamma.qbk index eefcc84a0..8e53ec6ee 100644 --- a/doc/distributions/gamma.qbk +++ b/doc/distributions/gamma.qbk @@ -99,6 +99,9 @@ distributions are supported: __usual_accessors. The domain of the random variable is \[0,+[infin]\]. +In this distribution the implementation of `logpdf` is specialized +to improve numerical accuracy. + [h4 Accuracy] The gamma distribution is implemented in terms of the diff --git a/doc/distributions/geometric.qbk b/doc/distributions/geometric.qbk index 7aa1a3343..9992b016d 100644 --- a/doc/distributions/geometric.qbk +++ b/doc/distributions/geometric.qbk @@ -303,6 +303,9 @@ the context of this distribution: ``quantile(complement(geometric(p), P))``]] ] +In this distribution the implementation of `logcdf` is specialized +to improve numerical accuracy. + [h4 Accuracy] This distribution is implemented using the pow and exp functions, so most results diff --git a/doc/distributions/inverse_gamma.qbk b/doc/distributions/inverse_gamma.qbk index 8fccbc19c..8fb64dde8 100644 --- a/doc/distributions/inverse_gamma.qbk +++ b/doc/distributions/inverse_gamma.qbk @@ -87,6 +87,9 @@ The domain of the random variate is \[0,+[infin]\]. [note Unlike some definitions, this implementation supports a random variate equal to zero as a special case, returning zero for pdf and cdf.] +In this distribution the implementation of `logpdf` is specialized +to improve numerical accuracy. + [h4 Accuracy] The inverse gamma distribution is implemented in terms of the diff --git a/doc/distributions/inverse_gaussian.qbk b/doc/distributions/inverse_gaussian.qbk index c5b824385..776a37772 100644 --- a/doc/distributions/inverse_gaussian.qbk +++ b/doc/distributions/inverse_gaussian.qbk @@ -115,6 +115,9 @@ The domain of the random variate is \[0,+[infin]). [note Unlike some definitions, this implementation supports a random variate equal to zero as a special case, returning zero for both pdf and cdf.] +In this distribution the implementation of `logpdf` is specialized +to improve numerical accuracy. + [h4 Accuracy] The inverse_gaussian distribution is implemented in terms of the diff --git a/doc/distributions/laplace.qbk b/doc/distributions/laplace.qbk index 93327e022..998072811 100644 --- a/doc/distributions/laplace.qbk +++ b/doc/distributions/laplace.qbk @@ -76,6 +76,9 @@ distributions are supported: __usual_accessors. The domain of the random variable is \[-[infin],+[infin]\]. +In this distribution the implementation of both `logcdf`, and `logpdf` are specialized +to improve numerical accuracy. + [h4 Accuracy] The laplace distribution is implemented in terms of the diff --git a/doc/distributions/logistic.qbk b/doc/distributions/logistic.qbk index 0a22b48d4..ba1b29a17 100644 --- a/doc/distributions/logistic.qbk +++ b/doc/distributions/logistic.qbk @@ -67,6 +67,9 @@ At `p=1` and `p=0`, the quantile function returns the result of quantile function returns the result of -__overflow_error and +__overflow_error respectively. +In this distribution the implementation of `logcdf` is specialized +to improve numerical accuracy. + [h4 Accuracy] The logistic distribution is implemented in terms of the `std::exp` diff --git a/doc/distributions/pareto.qbk b/doc/distributions/pareto.qbk index fcc7eee42..7938ed86d 100644 --- a/doc/distributions/pareto.qbk +++ b/doc/distributions/pareto.qbk @@ -73,6 +73,9 @@ distributions are supported: __usual_accessors. The supported domain of the random variable is \[scale, [infin]\]. +In this distribution the implementation of `logcdf` is specialized +to improve numerical accuracy. + [h4 Accuracy] The Pareto distribution is implemented in terms of the diff --git a/doc/distributions/poisson.qbk b/doc/distributions/poisson.qbk index 50a3b12ce..a1ccc1b8b 100644 --- a/doc/distributions/poisson.qbk +++ b/doc/distributions/poisson.qbk @@ -62,6 +62,9 @@ distributions are supported: __usual_accessors. The domain of the random variable is \[0, [infin]\]. +In this distribution the implementation of `logpdf` is specialized +to improve numerical accuracy. + [h4 Accuracy] The Poisson distribution is implemented in terms of the diff --git a/doc/distributions/rayleigh.qbk b/doc/distributions/rayleigh.qbk index 5fd6fe44c..89054ac0e 100644 --- a/doc/distributions/rayleigh.qbk +++ b/doc/distributions/rayleigh.qbk @@ -77,6 +77,9 @@ distributions are supported: __usual_accessors. The domain of the random variable is \[0, max_value\]. +In this distribution the implementation of both `logcdf`, and `logpdf` are specialized +to improve numerical accuracy. + [h4 Accuracy] The Rayleigh distribution is implemented in terms of the diff --git a/doc/distributions/weibull.qbk b/doc/distributions/weibull.qbk index 95c9e461e..d01ceded9 100644 --- a/doc/distributions/weibull.qbk +++ b/doc/distributions/weibull.qbk @@ -88,6 +88,9 @@ distributions are supported: __usual_accessors. The domain of the random variable is \[0, [infin]\]. +In this distribution the implementation of both `logcdf`, and `logpdf` are specialized +to improve numerical accuracy. + [h4 Accuracy] The Weibull distribution is implemented in terms of the