From 1572284ed3ed5abe25d71ae520b3e9e758f7c3ce Mon Sep 17 00:00:00 2001 From: Yuji Uchiyama Date: Tue, 1 Aug 2017 21:15:55 +0000 Subject: [PATCH] Add documents for stats functions git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@342758 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/stats/functions/stats-den-uniform.xml | 14 ++++++++++---- reference/stats/functions/stats-dens-beta.xml | 14 ++++++++++---- reference/stats/functions/stats-dens-cauchy.xml | 14 ++++++++++---- .../stats/functions/stats-dens-chisquare.xml | 13 +++++++++---- .../stats/functions/stats-dens-exponential.xml | 13 +++++++++---- reference/stats/functions/stats-dens-f.xml | 14 ++++++++++---- reference/stats/functions/stats-dens-gamma.xml | 14 ++++++++++---- reference/stats/functions/stats-dens-laplace.xml | 14 ++++++++++---- .../stats/functions/stats-dens-logistic.xml | 14 ++++++++++---- .../functions/stats-dens-negative-binomial.xml | 14 ++++++++++---- .../stats/functions/stats-dens-pmf-binomial.xml | 14 ++++++++++---- .../functions/stats-dens-pmf-hypergeometric.xml | 16 ++++++++++++---- .../stats/functions/stats-dens-pmf-poisson.xml | 12 ++++++++---- reference/stats/functions/stats-dens-t.xml | 13 +++++++++---- reference/stats/functions/stats-dens-weibull.xml | 14 ++++++++++---- 15 files changed, 147 insertions(+), 60 deletions(-) diff --git a/reference/stats/functions/stats-den-uniform.xml b/reference/stats/functions/stats-den-uniform.xml index bd571f4d7e..6a446335ad 100644 --- a/reference/stats/functions/stats-den-uniform.xml +++ b/reference/stats/functions/stats-den-uniform.xml @@ -3,7 +3,7 @@ stats_den_uniform - Not documented + Probability density function of the uniform distribution &reftitle.description; @@ -13,9 +13,11 @@ floata floatb - - &warn.undocumented.func; - + + Returns the probability density at x, where the + random variable follows the uniform distribution of which the lower bound is + a and the upper bound is b. + &reftitle.parameters; @@ -25,6 +27,7 @@ x + The value at which the probability density is calculated @@ -32,6 +35,7 @@ a + The lower bound of the distribution @@ -39,6 +43,7 @@ b + The upper bound of the distribution @@ -49,6 +54,7 @@ &reftitle.returnvalues; + The probability density at x or &false; for failure. diff --git a/reference/stats/functions/stats-dens-beta.xml b/reference/stats/functions/stats-dens-beta.xml index c8c96d99b9..1e9c3aa741 100644 --- a/reference/stats/functions/stats-dens-beta.xml +++ b/reference/stats/functions/stats-dens-beta.xml @@ -3,7 +3,7 @@ stats_dens_beta - Not documented + Probability density function of the beta distribution &reftitle.description; @@ -13,9 +13,11 @@ floata floatb - - &warn.undocumented.func; - + + Returns the probability density at x, where the + random variable follows the beta distribution of which the shape parameters + are a and b. + &reftitle.parameters; @@ -25,12 +27,14 @@ x + The value at which the probability density is calculated a + The shape parameter of the distribution @@ -39,6 +43,7 @@ b + The shape parameter of the distribution @@ -49,6 +54,7 @@ &reftitle.returnvalues; + The probability density at x or &false; for failure. diff --git a/reference/stats/functions/stats-dens-cauchy.xml b/reference/stats/functions/stats-dens-cauchy.xml index 9c5f494ab6..3048d0833c 100644 --- a/reference/stats/functions/stats-dens-cauchy.xml +++ b/reference/stats/functions/stats-dens-cauchy.xml @@ -3,7 +3,7 @@ stats_dens_cauchy - Not documented + Probability density function of the Cauchy distribution &reftitle.description; @@ -13,9 +13,11 @@ floatave floatstdev - - &warn.undocumented.func; - + + Returns the probability density at x, where the + random variable follows the Cauchy distribution whose location and scale are + ave and stdev, respectively. + &reftitle.parameters; @@ -25,6 +27,7 @@ x + The value at which the probability density is calculated @@ -32,6 +35,7 @@ ave + The location parameter of the distribution @@ -39,6 +43,7 @@ stdev + The scale parameter of the distribution @@ -49,6 +54,7 @@ &reftitle.returnvalues; + The probability density at x or &false; for failure. diff --git a/reference/stats/functions/stats-dens-chisquare.xml b/reference/stats/functions/stats-dens-chisquare.xml index 211821b0b0..812fb4ad30 100644 --- a/reference/stats/functions/stats-dens-chisquare.xml +++ b/reference/stats/functions/stats-dens-chisquare.xml @@ -3,7 +3,7 @@ stats_dens_chisquare - Not documented + Probability density function of the chi-square distribution &reftitle.description; @@ -12,9 +12,11 @@ floatx floatdfr - - &warn.undocumented.func; - + + Returns the probability density at x, where the + random variable follows the chi-square distribution of which the degree of + freedom is dfr. + &reftitle.parameters; @@ -24,6 +26,7 @@ x + The value at which the probability density is calculated @@ -31,6 +34,7 @@ dfr + The degree of freedom of the distribution @@ -41,6 +45,7 @@ &reftitle.returnvalues; + The probability density at x or &false; for failure. diff --git a/reference/stats/functions/stats-dens-exponential.xml b/reference/stats/functions/stats-dens-exponential.xml index 6c1baab6f5..dffa0e5e15 100644 --- a/reference/stats/functions/stats-dens-exponential.xml +++ b/reference/stats/functions/stats-dens-exponential.xml @@ -3,7 +3,7 @@ stats_dens_exponential - Not documented + Probability density function of the exponential distribution &reftitle.description; @@ -12,9 +12,11 @@ floatx floatscale - - &warn.undocumented.func; - + + Returns the probability density at x, where the + random variable follows the exponential distribution of which the scale is + scale. + &reftitle.parameters; @@ -24,6 +26,7 @@ x + The value at which the probability density is calculated @@ -31,6 +34,7 @@ scale + The scale of the distribution @@ -41,6 +45,7 @@ &reftitle.returnvalues; + The probability density at x or &false; for failure. diff --git a/reference/stats/functions/stats-dens-f.xml b/reference/stats/functions/stats-dens-f.xml index 7a9450849a..b1eb378007 100644 --- a/reference/stats/functions/stats-dens-f.xml +++ b/reference/stats/functions/stats-dens-f.xml @@ -3,7 +3,7 @@ stats_dens_f - + Probability density function of the F distribution &reftitle.description; @@ -13,9 +13,11 @@ floatdfr1 floatdfr2 - - &warn.undocumented.func; - + + Returns the probability density at x, where the + random variable follows the F distribution of which the degree of freedoms + are dfr1 and dfr2. + &reftitle.parameters; @@ -25,6 +27,7 @@ x + The value at which the probability density is calculated @@ -32,6 +35,7 @@ dfr1 + The degree of freedom of the distribution @@ -39,6 +43,7 @@ dfr2 + The degree of freedom of the distribution @@ -49,6 +54,7 @@ &reftitle.returnvalues; + The probability density at x or &false; for failure. diff --git a/reference/stats/functions/stats-dens-gamma.xml b/reference/stats/functions/stats-dens-gamma.xml index 01b01df5b6..7493ecf771 100644 --- a/reference/stats/functions/stats-dens-gamma.xml +++ b/reference/stats/functions/stats-dens-gamma.xml @@ -3,7 +3,7 @@ stats_dens_gamma - Not documented + Probability density function of the gamma distribution &reftitle.description; @@ -13,9 +13,11 @@ floatshape floatscale - - &warn.undocumented.func; - + + Returns the probability density at x, where the + random variable follows the gamma distribution of which the shape parameter + is shape and the scale parameter is scale. + &reftitle.parameters; @@ -25,6 +27,7 @@ x + The value at which the probability density is calculated @@ -32,6 +35,7 @@ shape + The shape parameter of the distribution @@ -39,6 +43,7 @@ scale + The scale parameter of the distribution @@ -49,6 +54,7 @@ &reftitle.returnvalues; + The probability density at x or &false; for failure. diff --git a/reference/stats/functions/stats-dens-laplace.xml b/reference/stats/functions/stats-dens-laplace.xml index 0ccd17a43e..e2443edb84 100644 --- a/reference/stats/functions/stats-dens-laplace.xml +++ b/reference/stats/functions/stats-dens-laplace.xml @@ -3,7 +3,7 @@ stats_dens_laplace - Not documented + Probability density function of the Laplace distribution &reftitle.description; @@ -13,9 +13,11 @@ floatave floatstdev - - &warn.undocumented.func; - + + Returns the probability density at x, where the + random variable follows the Laplace distribution of which the location parameter + is ave and the scale parameter is stdev. + &reftitle.parameters; @@ -25,6 +27,7 @@ x + The value at which the probability density is calculated @@ -32,6 +35,7 @@ ave + The location parameter of the distribution @@ -39,6 +43,7 @@ stdev + The shape parameter of the distribution @@ -49,6 +54,7 @@ &reftitle.returnvalues; + The probability density at x or &false; for failure. diff --git a/reference/stats/functions/stats-dens-logistic.xml b/reference/stats/functions/stats-dens-logistic.xml index c8bef5e4d0..189a4c5326 100644 --- a/reference/stats/functions/stats-dens-logistic.xml +++ b/reference/stats/functions/stats-dens-logistic.xml @@ -3,7 +3,7 @@ stats_dens_logistic - Not documented + Probability density function of the logistic distribution &reftitle.description; @@ -13,9 +13,11 @@ floatave floatstdev - - &warn.undocumented.func; - + + Returns the probability density at x, where the + random variable follows the gamma distribution of which the location parameter + is ave and the scale parameter is stdev. + &reftitle.parameters; @@ -25,6 +27,7 @@ x + The value at which the probability density is calculated @@ -32,6 +35,7 @@ ave + The location parameter of the distribution @@ -39,6 +43,7 @@ stdev + The shape parameter of the distribution @@ -49,6 +54,7 @@ &reftitle.returnvalues; + The probability density at x or &false; for failure. diff --git a/reference/stats/functions/stats-dens-negative-binomial.xml b/reference/stats/functions/stats-dens-negative-binomial.xml index 0739425b7c..7c515623b9 100644 --- a/reference/stats/functions/stats-dens-negative-binomial.xml +++ b/reference/stats/functions/stats-dens-negative-binomial.xml @@ -3,7 +3,7 @@ stats_dens_negative_binomial - Not documented + Probability density function of the negative binomial distribution &reftitle.description; @@ -13,9 +13,11 @@ floatn floatpi - - &warn.undocumented.func; - + + Returns the probability density at x, where the + random variable follows the negative binomial distribution of which the number of the success + is n and the success rate is pi. + &reftitle.parameters; @@ -25,6 +27,7 @@ x + The value at which the probability density is calculated @@ -32,6 +35,7 @@ n + The number of the success of the distribution @@ -39,6 +43,7 @@ pi + The success rate of the distribution @@ -49,6 +54,7 @@ &reftitle.returnvalues; + The probability density at x or &false; for failure. diff --git a/reference/stats/functions/stats-dens-pmf-binomial.xml b/reference/stats/functions/stats-dens-pmf-binomial.xml index b318acffc0..3f6422c6da 100644 --- a/reference/stats/functions/stats-dens-pmf-binomial.xml +++ b/reference/stats/functions/stats-dens-pmf-binomial.xml @@ -3,7 +3,7 @@ stats_dens_pmf_binomial - Not documented + Probability mass function of the binomial distribution &reftitle.description; @@ -13,9 +13,11 @@ floatn floatpi - - &warn.undocumented.func; - + + Returns the probability mass at x, where the random variable + follows the binomial distribution of which the number of trials is n + and the success rate is pi. + &reftitle.parameters; @@ -25,6 +27,7 @@ x + The value at which the probability mass is calculated @@ -32,6 +35,7 @@ n + The number of trials of the distribution @@ -39,6 +43,7 @@ pi + The success rate of the distribution @@ -49,6 +54,7 @@ &reftitle.returnvalues; + The probability mass at x or &false; for failure. diff --git a/reference/stats/functions/stats-dens-pmf-hypergeometric.xml b/reference/stats/functions/stats-dens-pmf-hypergeometric.xml index b93b4507a8..26867dbac0 100644 --- a/reference/stats/functions/stats-dens-pmf-hypergeometric.xml +++ b/reference/stats/functions/stats-dens-pmf-hypergeometric.xml @@ -3,7 +3,7 @@ stats_dens_pmf_hypergeometric - + Probability mass function of the hypergeometric distribution &reftitle.description; @@ -14,9 +14,12 @@ floatN1 floatN2 - - &warn.undocumented.func; - + + Returns the probability mass at n1, where the random variable + follows the hypergeometric distribution of which the number of failure is + n2, the number of success samples is N1, + and the number of failure samples is N2. + &reftitle.parameters; @@ -26,6 +29,7 @@ n1 + The number of success, at which the probability mass is calculated @@ -33,6 +37,7 @@ n2 + The number of failure of the distribution @@ -40,6 +45,7 @@ N1 + The number of success samples of the distribution @@ -47,6 +53,7 @@ N2 + The number of failure samples of the distribution @@ -57,6 +64,7 @@ &reftitle.returnvalues; + The probability mass at n1 or &false; for failure. diff --git a/reference/stats/functions/stats-dens-pmf-poisson.xml b/reference/stats/functions/stats-dens-pmf-poisson.xml index ba130c820a..633aee3c8f 100644 --- a/reference/stats/functions/stats-dens-pmf-poisson.xml +++ b/reference/stats/functions/stats-dens-pmf-poisson.xml @@ -3,7 +3,7 @@ stats_dens_pmf_poisson - Not documented + Probability mass function of the Poisson distribution &reftitle.description; @@ -12,9 +12,10 @@ floatx floatlb - - &warn.undocumented.func; - + + Returns the probability mass at x, where the random variable + follows the Poisson distribution whose parameter is lb. + &reftitle.parameters; @@ -24,6 +25,7 @@ x + The value at which the probability mass is calculated @@ -31,6 +33,7 @@ lb + The parameter of the Poisson distribution @@ -41,6 +44,7 @@ &reftitle.returnvalues; + The probability mass at x or &false; for failure. diff --git a/reference/stats/functions/stats-dens-t.xml b/reference/stats/functions/stats-dens-t.xml index 5fdb71abfa..1f5415b7e6 100644 --- a/reference/stats/functions/stats-dens-t.xml +++ b/reference/stats/functions/stats-dens-t.xml @@ -3,7 +3,7 @@ stats_dens_t - Not documented + Probability density function of the t-distribution &reftitle.description; @@ -12,9 +12,11 @@ floatx floatdfr - - &warn.undocumented.func; - + + Returns the probability density at x, where the + random variable follows the t-distribution of which the degree of + freedom is dfr. + &reftitle.parameters; @@ -24,6 +26,7 @@ x + The value at which the probability density is calculated @@ -31,6 +34,7 @@ dfr + The degree of freedom of the distribution @@ -41,6 +45,7 @@ &reftitle.returnvalues; + The probability density at x or &false; for failure. diff --git a/reference/stats/functions/stats-dens-weibull.xml b/reference/stats/functions/stats-dens-weibull.xml index 7757579c18..8db137ad5f 100644 --- a/reference/stats/functions/stats-dens-weibull.xml +++ b/reference/stats/functions/stats-dens-weibull.xml @@ -3,7 +3,7 @@ stats_dens_weibull - Not documented + Probability density function of the Weibull distribution &reftitle.description; @@ -13,9 +13,11 @@ floata floatb - - &warn.undocumented.func; - + + Returns the probability density at x, where the + random variable follows the gamma distribution of which the shape parameter + is a and the scale parameter is b. + &reftitle.parameters; @@ -25,6 +27,7 @@ x + The value at which the probability density is calculated @@ -32,6 +35,7 @@ a + The shape parameter of the distribution @@ -39,6 +43,7 @@ b + The scale parameter of the distribution @@ -49,6 +54,7 @@ &reftitle.returnvalues; + The probability density at x or &false; for failure.