From a816d3565edd9ea0ce589c34d9c216acf898f04d Mon Sep 17 00:00:00 2001 From: Yuji Uchiyama Date: Sat, 5 Aug 2017 00:35:05 +0000 Subject: [PATCH] Add documents for stats functions git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@342783 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../stats/functions/stats-rand-get-seeds.xml | 11 +++++++---- .../functions/stats-rand-phrase-to-seeds.xml | 10 ++++++---- .../stats/functions/stats-rand-setall.xml | 12 ++++++++---- .../functions/stats-stat-binomial-coef.xml | 11 +++++++---- .../functions/stats-stat-independent-t.xml | 10 ++++++++-- .../stats/functions/stats-stat-paired-t.xml | 12 ++++++++---- .../stats/functions/stats-stat-percentile.xml | 19 +++++++++++-------- .../stats/functions/stats-stat-powersum.xml | 11 +++++++---- reference/stats/functions/stats-variance.xml | 2 +- 9 files changed, 63 insertions(+), 35 deletions(-) diff --git a/reference/stats/functions/stats-rand-get-seeds.xml b/reference/stats/functions/stats-rand-get-seeds.xml index 1a57125fce..488129a5e9 100644 --- a/reference/stats/functions/stats-rand-get-seeds.xml +++ b/reference/stats/functions/stats-rand-get-seeds.xml @@ -3,7 +3,7 @@ stats_rand_get_seeds - Not documented + Get the seed values of the random number generator &reftitle.description; @@ -11,19 +11,22 @@ arraystats_rand_get_seeds - - &warn.undocumented.func; - + + Returns the current seed values of the random number generator + + &reftitle.returnvalues; + Returns an array of two integers. diff --git a/reference/stats/functions/stats-rand-phrase-to-seeds.xml b/reference/stats/functions/stats-rand-phrase-to-seeds.xml index 2d7f27efda..f15b1abefd 100644 --- a/reference/stats/functions/stats-rand-phrase-to-seeds.xml +++ b/reference/stats/functions/stats-rand-phrase-to-seeds.xml @@ -3,7 +3,7 @@ stats_rand_phrase_to_seeds - generate two seeds for the RGN random number generator + Generate two seeds for the RGN random number generator &reftitle.description; @@ -11,9 +11,9 @@ arraystats_rand_phrase_to_seeds stringphrase - - &warn.undocumented.func; - + + Generate two seeds for the random number generator from a phrase. + &reftitle.parameters; @@ -23,6 +23,7 @@ phrase + The input phrase @@ -33,6 +34,7 @@ &reftitle.returnvalues; + Returns an array of two integers. diff --git a/reference/stats/functions/stats-rand-setall.xml b/reference/stats/functions/stats-rand-setall.xml index 94d3313c59..dcdf15030b 100644 --- a/reference/stats/functions/stats-rand-setall.xml +++ b/reference/stats/functions/stats-rand-setall.xml @@ -3,7 +3,7 @@ stats_rand_setall - Not documented + Set seed values to the random generator &reftitle.description; @@ -12,9 +12,10 @@ intiseed1 intiseed2 - - &warn.undocumented.func; - + + Set iseed1 and iseed2 as seed values to the random generator + used in statistic functions. + &reftitle.parameters; @@ -24,6 +25,7 @@ iseed1 + The value which is used as the random seed @@ -31,6 +33,7 @@ iseed2 + The value which is used as the random seed @@ -41,6 +44,7 @@ &reftitle.returnvalues; + No values are returned. diff --git a/reference/stats/functions/stats-stat-binomial-coef.xml b/reference/stats/functions/stats-stat-binomial-coef.xml index 27bd4a50cf..94f5f7171e 100644 --- a/reference/stats/functions/stats-stat-binomial-coef.xml +++ b/reference/stats/functions/stats-stat-binomial-coef.xml @@ -3,7 +3,7 @@ stats_stat_binomial_coef - Not documented + Returns a binomial coefficient &reftitle.description; @@ -12,9 +12,9 @@ intx intn - - &warn.undocumented.func; - + + Returns the binomial coefficient of n choose x. + &reftitle.parameters; @@ -24,6 +24,7 @@ x + The number of chooses from the set @@ -31,6 +32,7 @@ n + The number of elements in the set @@ -41,6 +43,7 @@ &reftitle.returnvalues; + Returns the binomial coefficient diff --git a/reference/stats/functions/stats-stat-independent-t.xml b/reference/stats/functions/stats-stat-independent-t.xml index d808152548..4ac049fff4 100644 --- a/reference/stats/functions/stats-stat-independent-t.xml +++ b/reference/stats/functions/stats-stat-independent-t.xml @@ -4,7 +4,7 @@ stats_stat_independent_t - Not documented + Returns the t-value from the independent two-sample t-test &reftitle.description; @@ -13,7 +13,10 @@ arrayarr1 arrayarr2 - + + Returns the t-value of the independent two-sample t-test between + arr1 and arr2. + &warn.undocumented.func; @@ -25,6 +28,7 @@ arr1 + The first set of values @@ -32,6 +36,7 @@ arr2 + The second set of values @@ -42,6 +47,7 @@ &reftitle.returnvalues; + Returns the t-value, or &false; if failure. diff --git a/reference/stats/functions/stats-stat-paired-t.xml b/reference/stats/functions/stats-stat-paired-t.xml index 760399b2fe..b4a0e02873 100644 --- a/reference/stats/functions/stats-stat-paired-t.xml +++ b/reference/stats/functions/stats-stat-paired-t.xml @@ -3,7 +3,7 @@ stats_stat_paired_t - Not documented + Returns the t-value of the dependent t-test for paired samples &reftitle.description; @@ -12,9 +12,10 @@ arrayarr1 arrayarr2 - - &warn.undocumented.func; - + + Returns the t-value of the dependent t-test for paired samples + arr1 and arr2. + &reftitle.parameters; @@ -24,6 +25,7 @@ arr1 + The first samples @@ -31,6 +33,7 @@ arr2 + The second samples @@ -41,6 +44,7 @@ &reftitle.returnvalues; + Returns the t-value, or &false; if failure. diff --git a/reference/stats/functions/stats-stat-percentile.xml b/reference/stats/functions/stats-stat-percentile.xml index 918beefbba..35901a186d 100644 --- a/reference/stats/functions/stats-stat-percentile.xml +++ b/reference/stats/functions/stats-stat-percentile.xml @@ -3,34 +3,36 @@ stats_stat_percentile - Not documented + Returns the percentile value &reftitle.description; floatstats_stat_percentile - floatdf - floatxnonc + arrayarr + floatperc - - &warn.undocumented.func; - + + Returns the perc-th percentile value of the array arr. + &reftitle.parameters; - df + arr + The input array - xnonc + perc + The percentile @@ -41,6 +43,7 @@ &reftitle.returnvalues; + Returns the percentile values of the input array. diff --git a/reference/stats/functions/stats-stat-powersum.xml b/reference/stats/functions/stats-stat-powersum.xml index 630a5c2efc..29f1d83a5a 100644 --- a/reference/stats/functions/stats-stat-powersum.xml +++ b/reference/stats/functions/stats-stat-powersum.xml @@ -3,7 +3,7 @@ stats_stat_powersum - Not documented + Returns the power sum of a vector &reftitle.description; @@ -12,9 +12,9 @@ arrayarr floatpower - - &warn.undocumented.func; - + + Returns the sum of the power-th power of a vector represented as an array arr. + &reftitle.parameters; @@ -24,6 +24,7 @@ arr + The input array @@ -31,6 +32,7 @@ power + The power @@ -41,6 +43,7 @@ &reftitle.returnvalues; + Returns the power sum of the input array. diff --git a/reference/stats/functions/stats-variance.xml b/reference/stats/functions/stats-variance.xml index 0b8de8e5c1..28feedb9ea 100644 --- a/reference/stats/functions/stats-variance.xml +++ b/reference/stats/functions/stats-variance.xml @@ -3,7 +3,7 @@ stats_variance - Returns the population variance + Returns the variance &reftitle.description;