diff --git a/reference/stats/functions/stats-rand-gen-beta.xml b/reference/stats/functions/stats-rand-gen-beta.xml index 90ba2d0720..5d5405b653 100644 --- a/reference/stats/functions/stats-rand-gen-beta.xml +++ b/reference/stats/functions/stats-rand-gen-beta.xml @@ -3,7 +3,7 @@ stats_rand_gen_beta - Generates beta random deviate + Generates a random deviate from the beta distribution &reftitle.description; @@ -27,6 +27,7 @@ a + The shape parameter of the beta distribution @@ -34,6 +35,7 @@ b + The shape parameter of the beta distribution @@ -44,6 +46,7 @@ &reftitle.returnvalues; + A random deviate diff --git a/reference/stats/functions/stats-rand-gen-chisquare.xml b/reference/stats/functions/stats-rand-gen-chisquare.xml index c4a6a18224..372b57b7a5 100644 --- a/reference/stats/functions/stats-rand-gen-chisquare.xml +++ b/reference/stats/functions/stats-rand-gen-chisquare.xml @@ -3,7 +3,7 @@ stats_rand_gen_chisquare - Generates random deviate from the distribution of a chisquare with "df" degrees of freedom random variable. + Generates a random deviate from the chi-square distribution &reftitle.description; @@ -11,9 +11,10 @@ floatstats_rand_gen_chisquare floatdf - - &warn.undocumented.func; - + + Returns a random deviate from the chi-square distribution where the degrees of + freedom is df. + &reftitle.parameters; @@ -23,6 +24,7 @@ df + The degrees of freedom @@ -33,6 +35,7 @@ &reftitle.returnvalues; + A random deviate diff --git a/reference/stats/functions/stats-rand-gen-exponential.xml b/reference/stats/functions/stats-rand-gen-exponential.xml index 01f338d578..88d58536cd 100644 --- a/reference/stats/functions/stats-rand-gen-exponential.xml +++ b/reference/stats/functions/stats-rand-gen-exponential.xml @@ -3,7 +3,7 @@ stats_rand_gen_exponential - Generates a single random deviate from an exponential distribution with mean "av" + Generates a random deviate from the exponential distribution &reftitle.description; @@ -11,9 +11,10 @@ floatstats_rand_gen_exponential floatav - - &warn.undocumented.func; - + + Returns a random deviate from the exponential distribution of which the scale is + av. + &reftitle.parameters; @@ -23,6 +24,7 @@ av + The scale parameter @@ -33,6 +35,7 @@ &reftitle.returnvalues; + A random deviate diff --git a/reference/stats/functions/stats-rand-gen-f.xml b/reference/stats/functions/stats-rand-gen-f.xml index 0b6504e9ca..0574db6aae 100644 --- a/reference/stats/functions/stats-rand-gen-f.xml +++ b/reference/stats/functions/stats-rand-gen-f.xml @@ -3,7 +3,7 @@ stats_rand_gen_f - Generates a random deviate + Generates a random deviate from the F distribution &reftitle.description; @@ -26,6 +26,7 @@ dfn + The degrees of freedom in the numerator @@ -33,6 +34,7 @@ dfd + The degrees of freedom in the denominator @@ -43,6 +45,7 @@ &reftitle.returnvalues; + A random deviate diff --git a/reference/stats/functions/stats-rand-gen-funiform.xml b/reference/stats/functions/stats-rand-gen-funiform.xml index e188d5babf..087da301cd 100644 --- a/reference/stats/functions/stats-rand-gen-funiform.xml +++ b/reference/stats/functions/stats-rand-gen-funiform.xml @@ -12,9 +12,10 @@ floatlow floathigh - - &warn.undocumented.func; - + + Returns a random deviate from the uniform distribution from + low to high. + &reftitle.parameters; @@ -24,6 +25,7 @@ low + The lower bound (inclusive) @@ -31,6 +33,7 @@ high + The upper bound (exclusive) @@ -41,6 +44,7 @@ &reftitle.returnvalues; + A random deviate diff --git a/reference/stats/functions/stats-rand-gen-gamma.xml b/reference/stats/functions/stats-rand-gen-gamma.xml index 9fd335c7eb..85523b087d 100644 --- a/reference/stats/functions/stats-rand-gen-gamma.xml +++ b/reference/stats/functions/stats-rand-gen-gamma.xml @@ -4,7 +4,7 @@ stats_rand_gen_gamma - Generates random deviates from a gamma distribution + Generates a random deviate from the gamma distribution &reftitle.description; @@ -14,7 +14,7 @@ floatr - Generates random deviates from the gamma distribution whose density is + Generates a random deviate from the gamma distribution whose density is (A**R)/Gamma(R) * X**(R-1) * Exp(-A*X). @@ -47,6 +47,7 @@ &reftitle.returnvalues; + A random deviate diff --git a/reference/stats/functions/stats-rand-gen-ibinomial-negative.xml b/reference/stats/functions/stats-rand-gen-ibinomial-negative.xml index 1bfee637e4..ac7edfee03 100644 --- a/reference/stats/functions/stats-rand-gen-ibinomial-negative.xml +++ b/reference/stats/functions/stats-rand-gen-ibinomial-negative.xml @@ -3,7 +3,7 @@ stats_rand_gen_ibinomial_negative - Generates a single random deviate from a negative binomial distribution. Arguments : n - the number of trials in the negative binomial distribution from which a random deviate is to be generated (n > 0), p - the probability of an event (0 < p < 1)). + Generates a random deviate from the negative binomial distribution &reftitle.description; @@ -12,9 +12,10 @@ intn floatp - - &warn.undocumented.func; - + + Returns a random deviate from a negative binomial distribution where the number of success is + n and the success rate is p. + &reftitle.parameters; @@ -24,6 +25,7 @@ n + The number of success @@ -31,6 +33,7 @@ p + The success rate @@ -41,6 +44,7 @@ &reftitle.returnvalues; + A random deviate, which is the number of failure. diff --git a/reference/stats/functions/stats-rand-gen-ibinomial.xml b/reference/stats/functions/stats-rand-gen-ibinomial.xml index c06986eba7..348d4e9338 100644 --- a/reference/stats/functions/stats-rand-gen-ibinomial.xml +++ b/reference/stats/functions/stats-rand-gen-ibinomial.xml @@ -3,7 +3,7 @@ stats_rand_gen_ibinomial - Generates a single random deviate from a binomial distribution whose number of trials is "n" (n >= 0) and whose probability of an event in each trial is "pp" ([0;1]). Method : algorithm BTPE + Generates a random deviate from the binomial distribution &reftitle.description; @@ -12,9 +12,10 @@ intn floatpp - - &warn.undocumented.func; - + + Returns a random deviate from the binomial distribution whose number of trials is n + and whose probability of an event in each trial is pp. + &reftitle.parameters; @@ -24,6 +25,7 @@ n + The number of trials @@ -31,6 +33,7 @@ pp + The probability of an event in each trial @@ -41,6 +44,7 @@ &reftitle.returnvalues; + A random deviate diff --git a/reference/stats/functions/stats-rand-gen-int.xml b/reference/stats/functions/stats-rand-gen-int.xml index 1366836856..28aefa0574 100644 --- a/reference/stats/functions/stats-rand-gen-int.xml +++ b/reference/stats/functions/stats-rand-gen-int.xml @@ -11,19 +11,23 @@ intstats_rand_gen_int - - &warn.undocumented.func; - + + Returns a random integer between 1 and 2147483562 + + + &reftitle.returnvalues; + A random integer diff --git a/reference/stats/functions/stats-rand-gen-ipoisson.xml b/reference/stats/functions/stats-rand-gen-ipoisson.xml index fea98d9d8f..087ff4806f 100644 --- a/reference/stats/functions/stats-rand-gen-ipoisson.xml +++ b/reference/stats/functions/stats-rand-gen-ipoisson.xml @@ -3,7 +3,7 @@ stats_rand_gen_ipoisson - Generates a single random deviate from a Poisson distribution with mean "mu" (mu >= 0.0). + Generates a single random deviate from a Poisson distribution &reftitle.description; @@ -11,9 +11,9 @@ intstats_rand_gen_ipoisson floatmu - - &warn.undocumented.func; - + + Returns a random deviate from the Poisson distribution with parameter mu. + &reftitle.parameters; @@ -23,6 +23,7 @@ mu + The parameter of the Poisson distribution @@ -33,6 +34,7 @@ &reftitle.returnvalues; + A random deviate diff --git a/reference/stats/functions/stats-rand-gen-iuniform.xml b/reference/stats/functions/stats-rand-gen-iuniform.xml index dfb374781a..b676c1196f 100644 --- a/reference/stats/functions/stats-rand-gen-iuniform.xml +++ b/reference/stats/functions/stats-rand-gen-iuniform.xml @@ -12,9 +12,10 @@ intlow inthigh - - &warn.undocumented.func; - + + Returns a random integer from the discrete uniform distribution between low (inclusive) + and high (inclusive). + &reftitle.parameters; @@ -24,6 +25,7 @@ low + The lower bound @@ -31,6 +33,7 @@ high + The upper bound @@ -41,6 +44,7 @@ &reftitle.returnvalues; + A random integer diff --git a/reference/stats/functions/stats-rand-gen-noncenral-chisquare.xml b/reference/stats/functions/stats-rand-gen-noncenral-chisquare.xml index 4d3877b712..260061c69a 100644 --- a/reference/stats/functions/stats-rand-gen-noncenral-chisquare.xml +++ b/reference/stats/functions/stats-rand-gen-noncenral-chisquare.xml @@ -3,7 +3,7 @@ stats_rand_gen_noncenral_chisquare - Generates random deviate from the distribution of a noncentral chisquare with "df" degrees of freedom and noncentrality parameter "xnonc". d must be >= 1.0, xnonc must >= 0.0 + Generates a random deviate from the non-central chi-square distribution &reftitle.description; @@ -12,9 +12,10 @@ floatdf floatxnonc - - &warn.undocumented.func; - + + Returns a random deviate from the non-central chi-square distribution with degrees of freedom, + df, and non-centrality parameter, xnonc. + &reftitle.parameters; @@ -24,6 +25,7 @@ df + The degrees of freedom @@ -31,6 +33,7 @@ xnonc + The non-centrality parameter @@ -41,6 +44,7 @@ &reftitle.returnvalues; + A random deviate diff --git a/reference/stats/functions/stats-rand-gen-noncentral-f.xml b/reference/stats/functions/stats-rand-gen-noncentral-f.xml index 4659cc1c9c..de5e2cc632 100644 --- a/reference/stats/functions/stats-rand-gen-noncentral-f.xml +++ b/reference/stats/functions/stats-rand-gen-noncentral-f.xml @@ -3,7 +3,7 @@ stats_rand_gen_noncentral_f - Generates a random deviate from the noncentral F (variance ratio) distribution with "dfn" degrees of freedom in the numerator, and "dfd" degrees of freedom in the denominator, and noncentrality parameter "xnonc". Method : directly generates ratio of noncentral numerator chisquare variate to central denominator chisquare variate. + Generates a random deviate from the noncentral F distribution &reftitle.description; @@ -13,9 +13,11 @@ floatdfd floatxnonc - - &warn.undocumented.func; - + + Returns a random deviate from the non-central F distribution where the degrees of freedoms are + dfn (numerator) and dfd (denominator), and the non-centrality + parameter is xnonc. + &reftitle.parameters; @@ -25,6 +27,7 @@ dfn + The degrees of freedom of the numerator @@ -32,6 +35,7 @@ dfd + The degrees of freedom of the denominator @@ -39,6 +43,7 @@ xnonc + The non-centrality parameter @@ -49,6 +54,7 @@ &reftitle.returnvalues; + A random deviate diff --git a/reference/stats/functions/stats-rand-gen-noncentral-t.xml b/reference/stats/functions/stats-rand-gen-noncentral-t.xml index 6d29b5cc2d..ede7d12f2b 100644 --- a/reference/stats/functions/stats-rand-gen-noncentral-t.xml +++ b/reference/stats/functions/stats-rand-gen-noncentral-t.xml @@ -3,7 +3,7 @@ stats_rand_gen_noncentral_t - Generates a single random deviate from a noncentral T distribution + Generates a single random deviate from a non-central t-distribution &reftitle.description; @@ -12,9 +12,10 @@ floatdf floatxnonc - - &warn.undocumented.func; - + + Returns a random deviate from the non-central t-distribution with the degrees of freedom, + df, and the non-centrality parameter, xnonc. + &reftitle.parameters; @@ -24,6 +25,7 @@ df + The degrees of freedom @@ -31,6 +33,7 @@ xnonc + The non-centrality parameter @@ -41,6 +44,7 @@ &reftitle.returnvalues; + A random deviate diff --git a/reference/stats/functions/stats-rand-gen-normal.xml b/reference/stats/functions/stats-rand-gen-normal.xml index 507b0158e3..cc87d5509e 100644 --- a/reference/stats/functions/stats-rand-gen-normal.xml +++ b/reference/stats/functions/stats-rand-gen-normal.xml @@ -3,7 +3,7 @@ stats_rand_gen_normal - Generates a single random deviate from a normal distribution with mean, av, and standard deviation, sd (sd >= 0). Method : Renames SNORM from TOMS as slightly modified by BWB to use RANF instead of SUNIF. + Generates a single random deviate from a normal distribution &reftitle.description; @@ -12,7 +12,10 @@ floatav floatsd - + + Returns a random deviate from the normal distribution with mean, av, and standard deviation, + sd. + &warn.undocumented.func; @@ -24,6 +27,7 @@ av + The mean of the normal distribution @@ -31,6 +35,7 @@ sd + The standard deviation of the normal distribution @@ -41,6 +46,7 @@ &reftitle.returnvalues; + A random deviate diff --git a/reference/stats/functions/stats-rand-gen-t.xml b/reference/stats/functions/stats-rand-gen-t.xml index 5f9ded8872..3294ece5f8 100644 --- a/reference/stats/functions/stats-rand-gen-t.xml +++ b/reference/stats/functions/stats-rand-gen-t.xml @@ -3,7 +3,7 @@ stats_rand_gen_t - Generates a single random deviate from a T distribution + Generates a single random deviate from a t-distribution &reftitle.description; @@ -11,9 +11,9 @@ floatstats_rand_gen_t floatdf - - &warn.undocumented.func; - + + Returns a random deviate from the t-distribution with the degrees of freedom, df. + &reftitle.parameters; @@ -23,6 +23,7 @@ df + The degrees of freedom @@ -33,6 +34,7 @@ &reftitle.returnvalues; + A random deviate diff --git a/reference/stats/functions/stats-rand-ranf.xml b/reference/stats/functions/stats-rand-ranf.xml index 887074385e..a99de6dd99 100644 --- a/reference/stats/functions/stats-rand-ranf.xml +++ b/reference/stats/functions/stats-rand-ranf.xml @@ -3,7 +3,7 @@ stats_rand_ranf - Returns a random floating point number from a uniform distribution over 0 - 1 (endpoints of this interval are not returned) using the current generator + Generates a random floating point number between 0 and 1 &reftitle.description; @@ -11,19 +11,23 @@ floatstats_rand_ranf - - &warn.undocumented.func; - + + Returns a random floating point number from a uniform distribution between 0 (inclusive) and 1 (exclusive). + + + &reftitle.returnvalues; + A random floating point number