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 documents for stats functions

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@342783 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Yuji Uchiyama 2017-08-05 00:35:05 +00:00
parent 387e6d7cdd
commit a816d3565e
9 changed files with 63 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
reference/stats/functions/stats-rand-get-seeds.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-rand-get-seeds" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_rand_get_seeds</refname>
<refpurpose>Not documented</refpurpose>
<refpurpose>Get the seed values of the random number generator</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -11,19 +11,22 @@
<type>array</type><methodname>stats_rand_get_seeds</methodname>
<void/>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns the current seed values of the random number generator
</para>
</refsect1>
<!--
<refsect1 role="parameters">
&reftitle.parameters;
<para>
</para>
</refsect1>
-->
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of two integers.
</para>
</refsect1>

10
reference/stats/functions/stats-rand-phrase-to-seeds.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-rand-phrase-to-seeds" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_rand_phrase_to_seeds</refname>
<refpurpose>generate two seeds for the RGN random number generator</refpurpose>
<refpurpose>Generate two seeds for the RGN random number generator</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -11,9 +11,9 @@
<type>array</type><methodname>stats_rand_phrase_to_seeds</methodname>
<methodparam><type>string</type><parameter>phrase</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Generate two seeds for the random number generator from a <parameter>phrase</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -23,6 +23,7 @@
<term><parameter>phrase</parameter></term>
<listitem>
<para>
The input phrase
</para>
</listitem>
</varlistentry>
@ -33,6 +34,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of two integers.
</para>
</refsect1>

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

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-rand-setall" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_rand_setall</refname>
<refpurpose>Not documented</refpurpose>
<refpurpose>Set seed values to the random generator</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -12,9 +12,10 @@
<methodparam><type>int</type><parameter>iseed1</parameter></methodparam>
<methodparam><type>int</type><parameter>iseed2</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Set <parameter>iseed1</parameter> and <parameter>iseed2</parameter> as seed values to the random generator
used in statistic functions.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -24,6 +25,7 @@
<term><parameter>iseed1</parameter></term>
<listitem>
<para>
The value which is used as the random seed
</para>
</listitem>
</varlistentry>
@ -31,6 +33,7 @@
<term><parameter>iseed2</parameter></term>
<listitem>
<para>
The value which is used as the random seed
</para>
</listitem>
</varlistentry>
@ -41,6 +44,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
No values are returned.
</para>
</refsect1>

11
reference/stats/functions/stats-stat-binomial-coef.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-stat-binomial-coef" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_stat_binomial_coef</refname>
<refpurpose>Not documented</refpurpose>
<refpurpose>Returns a binomial coefficient</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -12,9 +12,9 @@
<methodparam><type>int</type><parameter>x</parameter></methodparam>
<methodparam><type>int</type><parameter>n</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns the binomial coefficient of <parameter>n</parameter> choose <parameter>x</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -24,6 +24,7 @@
<term><parameter>x</parameter></term>
<listitem>
<para>
The number of chooses from the set
</para>
</listitem>
</varlistentry>
@ -31,6 +32,7 @@
<term><parameter>n</parameter></term>
<listitem>
<para>
The number of elements in the set
</para>
</listitem>
</varlistentry>
@ -41,6 +43,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the binomial coefficient
</para>
</refsect1>

10
reference/stats/functions/stats-stat-independent-t.xml
View file

@ -4,7 +4,7 @@
<refentry xml:id="function.stats-stat-independent-t" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_stat_independent_t</refname>
<refpurpose>Not documented</refpurpose>
<refpurpose>Returns the t-value from the independent two-sample t-test</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -13,7 +13,10 @@
<methodparam><type>array</type><parameter>arr1</parameter></methodparam>
<methodparam><type>array</type><parameter>arr2</parameter></methodparam>
</methodsynopsis>
<para>
Returns the t-value of the independent two-sample t-test between
<parameter>arr1</parameter> and <parameter>arr2</parameter>.
</para>
&warn.undocumented.func;
</refsect1>
@ -25,6 +28,7 @@
<term><parameter>arr1</parameter></term>
<listitem>
<para>
The first set of values
</para>
</listitem>
</varlistentry>
@ -32,6 +36,7 @@
<term><parameter>arr2</parameter></term>
<listitem>
<para>
The second set of values
</para>
</listitem>
</varlistentry>
@ -42,6 +47,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the t-value, or &false; if failure.
</para>
</refsect1>

12
reference/stats/functions/stats-stat-paired-t.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-stat-paired-t" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_stat_paired_t</refname>
<refpurpose>Not documented</refpurpose>
<refpurpose>Returns the t-value of the dependent t-test for paired samples</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -12,9 +12,10 @@
<methodparam><type>array</type><parameter>arr1</parameter></methodparam>
<methodparam><type>array</type><parameter>arr2</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns the t-value of the dependent t-test for paired samples
<parameter>arr1</parameter> and <parameter>arr2</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -24,6 +25,7 @@
<term><parameter>arr1</parameter></term>
<listitem>
<para>
The first samples
</para>
</listitem>
</varlistentry>
@ -31,6 +33,7 @@
<term><parameter>arr2</parameter></term>
<listitem>
<para>
The second samples
</para>
</listitem>
</varlistentry>
@ -41,6 +44,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the t-value, or &false; if failure.
</para>
</refsect1>

19
reference/stats/functions/stats-stat-percentile.xml
View file

@ -3,34 +3,36 @@
<refentry xml:id="function.stats-stat-percentile" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_stat_percentile</refname>
<refpurpose>Not documented</refpurpose>
<refpurpose>Returns the percentile value</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>float</type><methodname>stats_stat_percentile</methodname>
<methodparam><type>float</type><parameter>df</parameter></methodparam>
<methodparam><type>float</type><parameter>xnonc</parameter></methodparam>
<methodparam><type>array</type><parameter>arr</parameter></methodparam>
<methodparam><type>float</type><parameter>perc</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns the <parameter>perc</parameter>-th percentile value of the array <parameter>arr</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>df</parameter></term>
<term><parameter>arr</parameter></term>
<listitem>
<para>
The input array
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>xnonc</parameter></term>
<term><parameter>perc</parameter></term>
<listitem>
<para>
The percentile
</para>
</listitem>
</varlistentry>
@ -41,6 +43,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the percentile values of the input array.
</para>
</refsect1>

11
reference/stats/functions/stats-stat-powersum.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-stat-powersum" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_stat_powersum</refname>
<refpurpose>Not documented</refpurpose>
<refpurpose>Returns the power sum of a vector</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -12,9 +12,9 @@
<methodparam><type>array</type><parameter>arr</parameter></methodparam>
<methodparam><type>float</type><parameter>power</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns the sum of the <parameter>power</parameter>-th power of a vector represented as an array <parameter>arr</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -24,6 +24,7 @@
<term><parameter>arr</parameter></term>
<listitem>
<para>
The input array
</para>
</listitem>
</varlistentry>
@ -31,6 +32,7 @@
<term><parameter>power</parameter></term>
<listitem>
<para>
The power
</para>
</listitem>
</varlistentry>
@ -41,6 +43,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the power sum of the input array.
</para>
</refsect1>

2
reference/stats/functions/stats-variance.xml
View file

@ -3,7 +3,7 @@
<refentry xml:id="function.stats-variance" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_variance</refname>
<refpurpose>Returns the population variance</refpurpose>
<refpurpose>Returns the variance</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;