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

Add documents for stats functions

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@342745 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Yuji Uchiyama 2017-08-01 00:06:34 +00:00
parent 2fa1fb072f
commit fd47c9ff17
5 changed files with 308 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

64
reference/stats/functions/stats-cdf-noncentral-chisquare.xml
View file

@ -14,9 +14,62 @@
<methodparam><type>float</type><parameter>par3</parameter></methodparam>
<methodparam><type>int</type><parameter>which</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns the cumulative distribution function, its inverse, or one of its parameters,
of the non-central chi-square distribution. The kind of the return value and parameters
(<parameter>par1</parameter>, <parameter>par2</parameter>, and <parameter>par3</parameter>)
are determined by <parameter>which</parameter>.
</para>
<para>
The following table lists the return value and parameters by <parameter>which</parameter>.
CDF, x, k, and lambda denotes cumurative distribution function, the value of the random
variable, the degree of freedom and the non-centrality parameter of the distribution,
respectively.
<table>
<title>Return value and parameters</title>
<tgroup cols="5">
<thead>
<row>
<entry><parameter>which</parameter></entry>
<entry>Return value</entry>
<entry><parameter>par1</parameter></entry>
<entry><parameter>par2</parameter></entry>
<entry><parameter>par3</parameter></entry>
</row>
</thead>
<tbody>
<row>
<entry>1</entry>
<entry>CDF</entry>
<entry>x</entry>
<entry>k</entry>
<entry>lambda</entry>
</row>
<row>
<entry>2</entry>
<entry>x</entry>
<entry>CDF</entry>
<entry>k</entry>
<entry>lambda</entry>
</row>
<row>
<entry>3</entry>
<entry>k</entry>
<entry>x</entry>
<entry>CDF</entry>
<entry>lambda</entry>
</row>
<row>
<entry>4</entry>
<entry>lambda</entry>
<entry>x</entry>
<entry>CDF</entry>
<entry>k</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -26,6 +79,7 @@
<term><parameter>par1</parameter></term>
<listitem>
<para>
The first parameter
</para>
</listitem>
</varlistentry>
@ -33,6 +87,7 @@
<term><parameter>par2</parameter></term>
<listitem>
<para>
The second parameter
</para>
</listitem>
</varlistentry>
@ -40,6 +95,7 @@
<term><parameter>par3</parameter></term>
<listitem>
<para>
The third parameter
</para>
</listitem>
</varlistentry>
@ -47,6 +103,7 @@
<term><parameter>which</parameter></term>
<listitem>
<para>
The flag to determine what to be calculated
</para>
</listitem>
</varlistentry>
@ -57,6 +114,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns CDF, x, k, or lambda, determined by <parameter>which</parameter>.
</para>
</refsect1>

80
reference/stats/functions/stats-cdf-noncentral-f.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-cdf-noncentral-f" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_cdf_noncentral_f</refname>
<refpurpose>Calculates any one parameter of the Non-central F distribution given values for the others.</refpurpose>
<refpurpose>Calculates any one parameter of the non-central F distribution given values for the others.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -15,9 +15,75 @@
<methodparam><type>float</type><parameter>par4</parameter></methodparam>
<methodparam><type>int</type><parameter>which</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns the cumulative distribution function, its inverse, or one of its parameters,
of the non-central F distribution. The kind of the return value and parameters
(<parameter>par1</parameter>, <parameter>par2</parameter>, <parameter>par3</parameter>,
and <parameter>par4</parameter>) are determined by <parameter>which</parameter>.
</para>
<para>
The following table lists the return value and parameters by <parameter>which</parameter>.
CDF, x, nu1, nu2, and lambda denotes cumurative distribution function, the value of the
random variable, the degree of freedoms and the non-centrality parameter of the distribution,
respectively.
<table>
<title>Return value and parameters</title>
<tgroup cols="6">
<thead>
<row>
<entry><parameter>which</parameter></entry>
<entry>Return value</entry>
<entry><parameter>par1</parameter></entry>
<entry><parameter>par2</parameter></entry>
<entry><parameter>par3</parameter></entry>
<entry><parameter>par4</parameter></entry>
</row>
</thead>
<tbody>
<row>
<entry>1</entry>
<entry>CDF</entry>
<entry>x</entry>
<entry>nu1</entry>
<entry>nu2</entry>
<entry>lambda</entry>
</row>
<row>
<entry>2</entry>
<entry>x</entry>
<entry>CDF</entry>
<entry>nu1</entry>
<entry>nu2</entry>
<entry>lambda</entry>
</row>
<row>
<entry>3</entry>
<entry>nu1</entry>
<entry>x</entry>
<entry>CDF</entry>
<entry>nu2</entry>
<entry>lambda</entry>
</row>
<row>
<entry>4</entry>
<entry>nu2</entry>
<entry>x</entry>
<entry>CDF</entry>
<entry>nu1</entry>
<entry>lambda</entry>
</row>
<row>
<entry>5</entry>
<entry>lambda</entry>
<entry>x</entry>
<entry>CDF</entry>
<entry>nu1</entry>
<entry>nu2</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -27,6 +93,7 @@
<term><parameter>par1</parameter></term>
<listitem>
<para>
The first parameter
</para>
</listitem>
</varlistentry>
@ -34,6 +101,7 @@
<term><parameter>par2</parameter></term>
<listitem>
<para>
The second parameter
</para>
</listitem>
</varlistentry>
@ -41,6 +109,7 @@
<term><parameter>par3</parameter></term>
<listitem>
<para>
The third parameter
</para>
</listitem>
</varlistentry>
@ -48,6 +117,7 @@
<term><parameter>par4</parameter></term>
<listitem>
<para>
The fourth parameter
</para>
</listitem>
</varlistentry>
@ -55,6 +125,7 @@
<term><parameter>which</parameter></term>
<listitem>
<para>
The flag to determine what to be calculated
</para>
</listitem>
</varlistentry>
@ -65,6 +136,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns CDF, x, nu1, nu2, or lambda, determined by <parameter>which</parameter>.
</para>
</refsect1>

53
reference/stats/functions/stats-cdf-t.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-cdf-t" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_cdf_t</refname>
<refpurpose>Calculates any one parameter of the T distribution given values for the others.</refpurpose>
<refpurpose>Calculates any one parameter of the Student's t-distribution given values for the others.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -13,9 +13,50 @@
<methodparam><type>float</type><parameter>par2</parameter></methodparam>
<methodparam><type>int</type><parameter>which</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns the cumulative distribution function, its inverse, or one of its parameters,
of the Student's t-distribution. The kind of the return value and parameters
(<parameter>par1</parameter> and <parameter>par2</parameter>) are determined by
<parameter>which</parameter>.
</para>
<para>
The following table lists the return value and parameters by <parameter>which</parameter>.
CDF, x, and nu denotes cumurative distribution function, the value of the random
variable, and the degrees of freedom of the Student's t-distribution, respectively.
<table>
<title>Return value and parameters</title>
<tgroup cols="4">
<thead>
<row>
<entry><parameter>which</parameter></entry>
<entry>Return value</entry>
<entry><parameter>par1</parameter></entry>
<entry><parameter>par2</parameter></entry>
</row>
</thead>
<tbody>
<row>
<entry>1</entry>
<entry>CDF</entry>
<entry>x</entry>
<entry>nu</entry>
</row>
<row>
<entry>2</entry>
<entry>x</entry>
<entry>CDF</entry>
<entry>nu</entry>
</row>
<row>
<entry>3</entry>
<entry>nu</entry>
<entry>x</entry>
<entry>CDF</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -25,6 +66,7 @@
<term><parameter>par1</parameter></term>
<listitem>
<para>
The first parameter
</para>
</listitem>
</varlistentry>
@ -32,6 +74,7 @@
<term><parameter>par2</parameter></term>
<listitem>
<para>
The second parameter
</para>
</listitem>
</varlistentry>
@ -39,6 +82,7 @@
<term><parameter>which</parameter></term>
<listitem>
<para>
The flag to determine what to be calculated
</para>
</listitem>
</varlistentry>
@ -49,6 +93,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns CDF, x, or nu, determined by <parameter>which</parameter>.
</para>
</refsect1>

65
reference/stats/functions/stats-cdf-uniform.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-cdf-uniform" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_cdf_uniform</refname>
<refpurpose>Not documented</refpurpose>
<refpurpose>Calculates any one parameter of the uniform distribution given values for the others.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -14,9 +14,61 @@
<methodparam><type>float</type><parameter>par3</parameter></methodparam>
<methodparam><type>int</type><parameter>which</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns the cumulative distribution function, its inverse, or one of its parameters,
of the uniform distribution. The kind of the return value and parameters
(<parameter>par1</parameter>, <parameter>par2</parameter>, and <parameter>par3</parameter>)
are determined by <parameter>which</parameter>.
</para>
<para>
The following table lists the return value and parameters by <parameter>which</parameter>.
CDF, x, a, and b denotes cumurative distribution function, the number of successes,
the lower bound and the higher bound of the uniform distribution, respectively.
<table>
<title>Return value and parameters</title>
<tgroup cols="5">
<thead>
<row>
<entry><parameter>which</parameter></entry>
<entry>Return value</entry>
<entry><parameter>par1</parameter></entry>
<entry><parameter>par2</parameter></entry>
<entry><parameter>par3</parameter></entry>
</row>
</thead>
<tbody>
<row>
<entry>1</entry>
<entry>CDF</entry>
<entry>x</entry>
<entry>a</entry>
<entry>b</entry>
</row>
<row>
<entry>2</entry>
<entry>x</entry>
<entry>CDF</entry>
<entry>a</entry>
<entry>b</entry>
</row>
<row>
<entry>3</entry>
<entry>a</entry>
<entry>x</entry>
<entry>CDF</entry>
<entry>b</entry>
</row>
<row>
<entry>4</entry>
<entry>b</entry>
<entry>x</entry>
<entry>CDF</entry>
<entry>a</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -26,6 +78,7 @@
<term><parameter>par1</parameter></term>
<listitem>
<para>
The first parameter
</para>
</listitem>
</varlistentry>
@ -33,6 +86,7 @@
<term><parameter>par2</parameter></term>
<listitem>
<para>
The second parameter
</para>
</listitem>
</varlistentry>
@ -40,6 +94,7 @@
<term><parameter>par3</parameter></term>
<listitem>
<para>
The third parameter
</para>
</listitem>
</varlistentry>
@ -47,6 +102,7 @@
<term><parameter>which</parameter></term>
<listitem>
<para>
The flag to determine what to be calculated
</para>
</listitem>
</varlistentry>
@ -57,6 +113,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns CDF, x, a, or b, determined by <parameter>which</parameter>.
</para>
</refsect1>

65
reference/stats/functions/stats-cdf-weibull.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-cdf-weibull" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_cdf_weibull</refname>
<refpurpose>Not documented</refpurpose>
<refpurpose>Calculates any one parameter of the Weibull distribution given values for the others.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -14,9 +14,61 @@
<methodparam><type>float</type><parameter>par3</parameter></methodparam>
<methodparam><type>int</type><parameter>which</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns the cumulative distribution function, its inverse, or one of its parameters,
of the binomial distribution. The kind of the return value and parameters
(<parameter>par1</parameter>, <parameter>par2</parameter>, and <parameter>par3</parameter>)
are determined by <parameter>which</parameter>.
</para>
<para>
The following table lists the return value and parameters by <parameter>which</parameter>.
CDF, x, k, and lambda denotes cumurative distribution function, the number of successes,
the shape and the scale parameter of the Weibull distribution, respectively.
<table>
<title>Return value and parameters</title>
<tgroup cols="5">
<thead>
<row>
<entry><parameter>which</parameter></entry>
<entry>Return value</entry>
<entry><parameter>par1</parameter></entry>
<entry><parameter>par2</parameter></entry>
<entry><parameter>par3</parameter></entry>
</row>
</thead>
<tbody>
<row>
<entry>1</entry>
<entry>CDF</entry>
<entry>x</entry>
<entry>k</entry>
<entry>lambda</entry>
</row>
<row>
<entry>2</entry>
<entry>x</entry>
<entry>CDF</entry>
<entry>k</entry>
<entry>lambda</entry>
</row>
<row>
<entry>3</entry>
<entry>k</entry>
<entry>x</entry>
<entry>CDF</entry>
<entry>lambda</entry>
</row>
<row>
<entry>4</entry>
<entry>lambda</entry>
<entry>x</entry>
<entry>CDF</entry>
<entry>k</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -26,6 +78,7 @@
<term><parameter>par1</parameter></term>
<listitem>
<para>
The first parameter
</para>
</listitem>
</varlistentry>
@ -33,6 +86,7 @@
<term><parameter>par2</parameter></term>
<listitem>
<para>
The second parameter
</para>
</listitem>
</varlistentry>
@ -40,6 +94,7 @@
<term><parameter>par3</parameter></term>
<listitem>
<para>
The third parameter
</para>
</listitem>
</varlistentry>
@ -47,6 +102,7 @@
<term><parameter>which</parameter></term>
<listitem>
<para>
The flag to determine what to be calculated
</para>
</listitem>
</varlistentry>
@ -57,6 +113,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns CDF, x, k, or lambda, determined by <parameter>which</parameter>.
</para>
</refsect1>