sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-17 01:18:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add descriptions for stats functions

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@342827 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Yuji Uchiyama 2017-08-09 22:18:20 +00:00
parent 3787c3f437
commit 35d9a03493
17 changed files with 116 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
reference/stats/functions/stats-rand-gen-beta.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-rand-gen-beta" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_rand_gen_beta</refname>
<refpurpose>Generates beta random deviate</refpurpose>
<refpurpose>Generates a random deviate from the beta distribution</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -27,6 +27,7 @@
<term><parameter>a</parameter></term>
<listitem>
<para>
The shape parameter of the beta distribution
</para>
</listitem>
</varlistentry>
@ -34,6 +35,7 @@
<term><parameter>b</parameter></term>
<listitem>
<para>
The shape parameter of the beta distribution
</para>
</listitem>
</varlistentry>
@ -44,6 +46,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A random deviate
</para>
</refsect1>

11
reference/stats/functions/stats-rand-gen-chisquare.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-rand-gen-chisquare" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_rand_gen_chisquare</refname>
<refpurpose>Generates random deviate from the distribution of a chisquare with "df" degrees of freedom random variable.</refpurpose>
<refpurpose>Generates a random deviate from the chi-square distribution</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -11,9 +11,10 @@
<type>float</type><methodname>stats_rand_gen_chisquare</methodname>
<methodparam><type>float</type><parameter>df</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns a random deviate from the chi-square distribution where the degrees of
freedom is <parameter>df</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -23,6 +24,7 @@
<term><parameter>df</parameter></term>
<listitem>
<para>
The degrees of freedom
</para>
</listitem>
</varlistentry>
@ -33,6 +35,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A random deviate
</para>
</refsect1>

11
reference/stats/functions/stats-rand-gen-exponential.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-rand-gen-exponential" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_rand_gen_exponential</refname>
<refpurpose>Generates a single random deviate from an exponential distribution with mean "av"</refpurpose>
<refpurpose>Generates a random deviate from the exponential distribution</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -11,9 +11,10 @@
<type>float</type><methodname>stats_rand_gen_exponential</methodname>
<methodparam><type>float</type><parameter>av</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns a random deviate from the exponential distribution of which the scale is
<parameter>av</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -23,6 +24,7 @@
<term><parameter>av</parameter></term>
<listitem>
<para>
The scale parameter
</para>
</listitem>
</varlistentry>
@ -33,6 +35,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A random deviate
</para>
</refsect1>

5
reference/stats/functions/stats-rand-gen-f.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-rand-gen-f" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_rand_gen_f</refname>
<refpurpose>Generates a random deviate</refpurpose>
<refpurpose>Generates a random deviate from the F distribution</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -26,6 +26,7 @@
<term><parameter>dfn</parameter></term>
<listitem>
<para>
The degrees of freedom in the numerator
</para>
</listitem>
</varlistentry>
@ -33,6 +34,7 @@
<term><parameter>dfd</parameter></term>
<listitem>
<para>
The degrees of freedom in the denominator
</para>
</listitem>
</varlistentry>
@ -43,6 +45,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A random deviate
</para>
</refsect1>

10
reference/stats/functions/stats-rand-gen-funiform.xml
View file

@ -12,9 +12,10 @@
<methodparam><type>float</type><parameter>low</parameter></methodparam>
<methodparam><type>float</type><parameter>high</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns a random deviate from the uniform distribution from
<parameter>low</parameter> to <parameter>high</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -24,6 +25,7 @@
<term><parameter>low</parameter></term>
<listitem>
<para>
The lower bound (inclusive)
</para>
</listitem>
</varlistentry>
@ -31,6 +33,7 @@
<term><parameter>high</parameter></term>
<listitem>
<para>
The upper bound (exclusive)
</para>
</listitem>
</varlistentry>
@ -41,6 +44,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A random deviate
</para>
</refsect1>

5
reference/stats/functions/stats-rand-gen-gamma.xml
View file

@ -4,7 +4,7 @@
<refentry xml:id="function.stats-rand-gen-gamma" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_rand_gen_gamma</refname>
<refpurpose>Generates random deviates from a gamma distribution</refpurpose>
<refpurpose>Generates a random deviate from the gamma distribution</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -14,7 +14,7 @@
<methodparam><type>float</type><parameter>r</parameter></methodparam>
</methodsynopsis>
<para>
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).
</para>
</refsect1>
@ -47,6 +47,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A random deviate
</para>
</refsect1>

12
reference/stats/functions/stats-rand-gen-ibinomial-negative.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-rand-gen-ibinomial-negative" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_rand_gen_ibinomial_negative</refname>
<refpurpose>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 &gt; 0), p - the probability of an event (0 &lt; p &lt; 1)).</refpurpose>
<refpurpose>Generates a random deviate from the negative binomial distribution</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -12,9 +12,10 @@
<methodparam><type>int</type><parameter>n</parameter></methodparam>
<methodparam><type>float</type><parameter>p</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns a random deviate from a negative binomial distribution where the number of success is
<parameter>n</parameter> and the success rate is <parameter>p</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -24,6 +25,7 @@
<term><parameter>n</parameter></term>
<listitem>
<para>
The number of success
</para>
</listitem>
</varlistentry>
@ -31,6 +33,7 @@
<term><parameter>p</parameter></term>
<listitem>
<para>
The success rate
</para>
</listitem>
</varlistentry>
@ -41,6 +44,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A random deviate, which is the number of failure.
</para>
</refsect1>

12
reference/stats/functions/stats-rand-gen-ibinomial.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-rand-gen-ibinomial" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_rand_gen_ibinomial</refname>
<refpurpose>Generates a single random deviate from a binomial distribution whose number of trials is "n" (n &gt;= 0) and whose probability of an event in each trial is "pp" ([0;1]). Method : algorithm BTPE</refpurpose>
<refpurpose>Generates a random deviate from the binomial distribution</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -12,9 +12,10 @@
<methodparam><type>int</type><parameter>n</parameter></methodparam>
<methodparam><type>float</type><parameter>pp</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns a random deviate from the binomial distribution whose number of trials is <parameter>n</parameter>
and whose probability of an event in each trial is <parameter>pp</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -24,6 +25,7 @@
<term><parameter>n</parameter></term>
<listitem>
<para>
The number of trials
</para>
</listitem>
</varlistentry>
@ -31,6 +33,7 @@
<term><parameter>pp</parameter></term>
<listitem>
<para>
The probability of an event in each trial
</para>
</listitem>
</varlistentry>
@ -41,6 +44,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A random deviate
</para>
</refsect1>

10
reference/stats/functions/stats-rand-gen-int.xml
View file

@ -11,19 +11,23 @@
<type>int</type><methodname>stats_rand_gen_int</methodname>
<void/>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns a random integer between 1 and 2147483562
</para>
</refsect1>
<!--
<refsect1 role="parameters">
&reftitle.parameters;
<para>
</para>
</refsect1>
-->
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A random integer
</para>
</refsect1>

10
reference/stats/functions/stats-rand-gen-ipoisson.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-rand-gen-ipoisson" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_rand_gen_ipoisson</refname>
<refpurpose>Generates a single random deviate from a Poisson distribution with mean "mu" (mu &gt;= 0.0).</refpurpose>
<refpurpose>Generates a single random deviate from a Poisson distribution</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -11,9 +11,9 @@
<type>int</type><methodname>stats_rand_gen_ipoisson</methodname>
<methodparam><type>float</type><parameter>mu</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns a random deviate from the Poisson distribution with parameter <parameter>mu</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -23,6 +23,7 @@
<term><parameter>mu</parameter></term>
<listitem>
<para>
The parameter of the Poisson distribution
</para>
</listitem>
</varlistentry>
@ -33,6 +34,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A random deviate
</para>
</refsect1>

10
reference/stats/functions/stats-rand-gen-iuniform.xml
View file

@ -12,9 +12,10 @@
<methodparam><type>int</type><parameter>low</parameter></methodparam>
<methodparam><type>int</type><parameter>high</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns a random integer from the discrete uniform distribution between <parameter>low</parameter> (inclusive)
and <parameter>high</parameter> (inclusive).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -24,6 +25,7 @@
<term><parameter>low</parameter></term>
<listitem>
<para>
The lower bound
</para>
</listitem>
</varlistentry>
@ -31,6 +33,7 @@
<term><parameter>high</parameter></term>
<listitem>
<para>
The upper bound
</para>
</listitem>
</varlistentry>
@ -41,6 +44,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A random integer
</para>
</refsect1>

12
reference/stats/functions/stats-rand-gen-noncenral-chisquare.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-rand-gen-noncenral-chisquare" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_rand_gen_noncenral_chisquare</refname>
<refpurpose>Generates random deviate from the distribution of a noncentral chisquare with "df" degrees of freedom and noncentrality parameter "xnonc". d must be &gt;= 1.0, xnonc must &gt;= 0.0</refpurpose>
<refpurpose>Generates a random deviate from the non-central chi-square distribution</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -12,9 +12,10 @@
<methodparam><type>float</type><parameter>df</parameter></methodparam>
<methodparam><type>float</type><parameter>xnonc</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns a random deviate from the non-central chi-square distribution with degrees of freedom,
<parameter>df</parameter>, and non-centrality parameter, <parameter>xnonc</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -24,6 +25,7 @@
<term><parameter>df</parameter></term>
<listitem>
<para>
The degrees of freedom
</para>
</listitem>
</varlistentry>
@ -31,6 +33,7 @@
<term><parameter>xnonc</parameter></term>
<listitem>
<para>
The non-centrality parameter
</para>
</listitem>
</varlistentry>
@ -41,6 +44,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A random deviate
</para>
</refsect1>

14
reference/stats/functions/stats-rand-gen-noncentral-f.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-rand-gen-noncentral-f" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_rand_gen_noncentral_f</refname>
<refpurpose>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.</refpurpose>
<refpurpose>Generates a random deviate from the noncentral F distribution</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -13,9 +13,11 @@
<methodparam><type>float</type><parameter>dfd</parameter></methodparam>
<methodparam><type>float</type><parameter>xnonc</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns a random deviate from the non-central F distribution where the degrees of freedoms are
<parameter>dfn</parameter> (numerator) and <parameter>dfd</parameter> (denominator), and the non-centrality
parameter is <parameter>xnonc</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -25,6 +27,7 @@
<term><parameter>dfn</parameter></term>
<listitem>
<para>
The degrees of freedom of the numerator
</para>
</listitem>
</varlistentry>
@ -32,6 +35,7 @@
<term><parameter>dfd</parameter></term>
<listitem>
<para>
The degrees of freedom of the denominator
</para>
</listitem>
</varlistentry>
@ -39,6 +43,7 @@
<term><parameter>xnonc</parameter></term>
<listitem>
<para>
The non-centrality parameter
</para>
</listitem>
</varlistentry>
@ -49,6 +54,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A random deviate
</para>
</refsect1>

12
reference/stats/functions/stats-rand-gen-noncentral-t.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-rand-gen-noncentral-t" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_rand_gen_noncentral_t</refname>
<refpurpose>Generates a single random deviate from a noncentral T distribution</refpurpose>
<refpurpose>Generates a single random deviate from a non-central t-distribution</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -12,9 +12,10 @@
<methodparam><type>float</type><parameter>df</parameter></methodparam>
<methodparam><type>float</type><parameter>xnonc</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns a random deviate from the non-central t-distribution with the degrees of freedom,
<parameter>df</parameter>, and the non-centrality parameter, <parameter>xnonc</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -24,6 +25,7 @@
<term><parameter>df</parameter></term>
<listitem>
<para>
The degrees of freedom
</para>
</listitem>
</varlistentry>
@ -31,6 +33,7 @@
<term><parameter>xnonc</parameter></term>
<listitem>
<para>
The non-centrality parameter
</para>
</listitem>
</varlistentry>
@ -41,6 +44,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A random deviate
</para>
</refsect1>

10
reference/stats/functions/stats-rand-gen-normal.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-rand-gen-normal" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_rand_gen_normal</refname>
<refpurpose>Generates a single random deviate from a normal distribution with mean, av, and standard deviation, sd (sd &gt;= 0). Method : Renames SNORM from TOMS as slightly modified by BWB to use RANF instead of SUNIF.</refpurpose>
<refpurpose>Generates a single random deviate from a normal distribution</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -12,7 +12,10 @@
<methodparam><type>float</type><parameter>av</parameter></methodparam>
<methodparam><type>float</type><parameter>sd</parameter></methodparam>
</methodsynopsis>
<para>
Returns a random deviate from the normal distribution with mean, <parameter>av</parameter>, and standard deviation,
<parameter>sd</parameter>.
</para>
&warn.undocumented.func;
</refsect1>
@ -24,6 +27,7 @@
<term><parameter>av</parameter></term>
<listitem>
<para>
The mean of the normal distribution
</para>
</listitem>
</varlistentry>
@ -31,6 +35,7 @@
<term><parameter>sd</parameter></term>
<listitem>
<para>
The standard deviation of the normal distribution
</para>
</listitem>
</varlistentry>
@ -41,6 +46,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A random deviate
</para>
</refsect1>

10
reference/stats/functions/stats-rand-gen-t.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-rand-gen-t" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_rand_gen_t</refname>
<refpurpose>Generates a single random deviate from a T distribution</refpurpose>
<refpurpose>Generates a single random deviate from a t-distribution</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -11,9 +11,9 @@
<type>float</type><methodname>stats_rand_gen_t</methodname>
<methodparam><type>float</type><parameter>df</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns a random deviate from the t-distribution with the degrees of freedom, <parameter>df</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -23,6 +23,7 @@
<term><parameter>df</parameter></term>
<listitem>
<para>
The degrees of freedom
</para>
</listitem>
</varlistentry>
@ -33,6 +34,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A random deviate
</para>
</refsect1>

12
reference/stats/functions/stats-rand-ranf.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-rand-ranf" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_rand_ranf</refname>
<refpurpose>Returns a random floating point number from a uniform distribution over 0 - 1 (endpoints of this interval are not returned) using the current generator</refpurpose>
<refpurpose>Generates a random floating point number between 0 and 1</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -11,19 +11,23 @@
<type>float</type><methodname>stats_rand_ranf</methodname>
<void/>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns a random floating point number from a uniform distribution between 0 (inclusive) and 1 (exclusive).
</para>
</refsect1>
<!--
<refsect1 role="parameters">
&reftitle.parameters;
<para>
</para>
</refsect1>
-->
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A random floating point number
</para>
</refsect1>