mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
Add documents for stats functions
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@342841 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Yuji Uchiyama
parent
db9b1381c5
commit
e9d33150a5
3 changed files with 526 additions and 0 deletions
186
reference/stats/functions/stats-dens-pmf-negative-binomial.xml
Normal file
186
reference/stats/functions/stats-dens-pmf-negative-binomial.xml
Normal file
|
|
@ -0,0 +1,186 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="function.stats-dens-pmf-negative-binomial" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>stats_dens_pmf_negative_binomial</refname>
|
||||
<refpurpose>Probability density function of the negative binomial distribution</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>float</type><methodname>stats_dens_pmf_negative_binomial</methodname>
|
||||
<methodparam><type>float</type><parameter>x</parameter></methodparam>
|
||||
<methodparam><type>float</type><parameter>n</parameter></methodparam>
|
||||
<methodparam><type>float</type><parameter>pi</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Returns the probability density at <parameter>x</parameter>, where the
|
||||
random variable follows the negative binomial distribution of which the number of the success
|
||||
is <parameter>n</parameter> and the success rate is <parameter>pi</parameter>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>x</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The value at which the probability density is calculated
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>n</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The number of the success of the distribution
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>pi</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The success rate of the distribution
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
The probability density at <parameter>x</parameter> or &false; for failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<!--
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
When does this function issue E_* level errors, and/or throw exceptions.
|
||||
</para>
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
<!--
|
||||
<refsect1 role="unicode">
|
||||
&reftitle.unicode;
|
||||
<para>
|
||||
Information specific to unicode, from the PHP 6 changes.
|
||||
</para>
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
<!--
|
||||
<refsect1 role="changelog">
|
||||
&reftitle.changelog;
|
||||
<informaltable>
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>&Version;</entry>
|
||||
<entry>&Description;</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>Enter the version of change here</entry>
|
||||
<entry>
|
||||
Describe the change
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
<!--
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example xml:id="function-name.example.basic">
|
||||
<title><function>function-name</function> example</title>
|
||||
<para>
|
||||
Any text that describes the purpose of the example, or what
|
||||
goes on in the example should be here. (Inside the <example> tag, not out).
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
if ($anexample === true) {
|
||||
echo 'Use the PEAR Coding standards';
|
||||
}
|
||||
if ($thereisoutput === 'and it is multiple lines') {
|
||||
echo 'Use a screen like we did below';
|
||||
}
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs.similar;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
Use the PEAR Coding standards
|
||||
Use a screen like we did below
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
<!--
|
||||
<refsect1 role="notes">
|
||||
&reftitle.notes;
|
||||
<caution>
|
||||
<para>
|
||||
Any notes that don't fit anywhere else should go here.
|
||||
90% of the time, notes, warnings or cautions are better placed in the
|
||||
parameters section. Consider that before using this section!
|
||||
</para>
|
||||
</caution>
|
||||
¬e.language-construct;
|
||||
¬e.not-bin-safe;
|
||||
¬e.registerglobals;
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
<!--
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><function>somefunc</function></member>
|
||||
<member><function>another_func</function></member>
|
||||
<member>The <link linkend="something">something appendix</link></member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-omittag:t
|
||||
sgml-shorttag:t
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-indent-step:1
|
||||
sgml-indent-data:t
|
||||
indent-tabs-mode:nil
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
||||
sgml-exposed-tags:nil
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
End:
|
||||
vim600: syn=xml fen fdm=syntax fdl=2 si
|
||||
vim: et tw=78 syn=sgml
|
||||
vi: ts=1 sw=1
|
||||
-->
|
||||
|
|
@ -0,0 +1,176 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="function.stats-rand-gen-noncentral-chisquare" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>stats_rand_gen_noncentral_chisquare</refname>
|
||||
<refpurpose>Generates a random deviate from the non-central chi-square distribution</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>float</type><methodname>stats_rand_gen_noncentral_chisquare</methodname>
|
||||
<methodparam><type>float</type><parameter>df</parameter></methodparam>
|
||||
<methodparam><type>float</type><parameter>xnonc</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<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;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>df</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The degrees of freedom
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>xnonc</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The non-centrality parameter
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
A random deviate
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<!--
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
When does this function issue E_* level errors, and/or throw exceptions.
|
||||
</para>
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
<!--
|
||||
<refsect1 role="unicode">
|
||||
&reftitle.unicode;
|
||||
<para>
|
||||
Information specific to unicode, from the PHP 6 changes.
|
||||
</para>
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
<!--
|
||||
<refsect1 role="changelog">
|
||||
&reftitle.changelog;
|
||||
<informaltable>
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>&Version;</entry>
|
||||
<entry>&Description;</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>Enter the version of change here</entry>
|
||||
<entry>
|
||||
Describe the change
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
<!--
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example xml:id="function-name.example.basic">
|
||||
<title><function>function-name</function> example</title>
|
||||
<para>
|
||||
Any text that describes the purpose of the example, or what
|
||||
goes on in the example should be here. (Inside the <example> tag, not out).
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
if ($anexample === true) {
|
||||
echo 'Use the PEAR Coding standards';
|
||||
}
|
||||
if ($thereisoutput === 'and it is multiple lines') {
|
||||
echo 'Use a screen like we did below';
|
||||
}
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs.similar;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
Use the PEAR Coding standards
|
||||
Use a screen like we did below
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
<!--
|
||||
<refsect1 role="notes">
|
||||
&reftitle.notes;
|
||||
<caution>
|
||||
<para>
|
||||
Any notes that don't fit anywhere else should go here.
|
||||
90% of the time, notes, warnings or cautions are better placed in the
|
||||
parameters section. Consider that before using this section!
|
||||
</para>
|
||||
</caution>
|
||||
¬e.language-construct;
|
||||
¬e.not-bin-safe;
|
||||
¬e.registerglobals;
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
<!--
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><function>somefunc</function></member>
|
||||
<member><function>another_func</function></member>
|
||||
<member>The <link linkend="something">something appendix</link></member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-omittag:t
|
||||
sgml-shorttag:t
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-indent-step:1
|
||||
sgml-indent-data:t
|
||||
indent-tabs-mode:nil
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
||||
sgml-exposed-tags:nil
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
End:
|
||||
vim600: syn=xml fen fdm=syntax fdl=2 si
|
||||
vim: et tw=78 syn=sgml
|
||||
vi: ts=1 sw=1
|
||||
-->
|
||||
164
reference/stats/functions/stats-stat-factorial.xml
Normal file
164
reference/stats/functions/stats-stat-factorial.xml
Normal file
|
|
@ -0,0 +1,164 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="function.stats-stat-factorial" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>stats_stat_factorial</refname>
|
||||
<refpurpose>Returns the factorial of an integer</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis role="procedural">
|
||||
<type>float</type><methodname>stats_stat_factorial</methodname>
|
||||
<methodparam><type>int</type><parameter>n</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Returns the factorial of an integer, <parameter>n</parameter>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>n</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
An integer
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
The factorial of <parameter>n</parameter>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<!--
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
When does this function issue E_* level errors, and/or throw exceptions.
|
||||
</para>
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
<!--
|
||||
<refsect1 role="unicode">
|
||||
&reftitle.unicode;
|
||||
<para>
|
||||
Information specific to unicode, from the PHP 6 changes.
|
||||
</para>
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
<!--
|
||||
<refsect1 role="changelog">
|
||||
&reftitle.changelog;
|
||||
<informaltable>
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>&Version;</entry>
|
||||
<entry>&Description;</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>Enter the version of change here</entry>
|
||||
<entry>
|
||||
Describe the change
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
<!--
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example xml:id="function-name.example.basic">
|
||||
<title><function>function-name</function> example</title>
|
||||
<para>
|
||||
Any text that describes the purpose of the example, or what
|
||||
goes on in the example should be here. (Inside the <example> tag, not out).
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
if ($anexample === true) {
|
||||
echo 'Use the PEAR Coding standards';
|
||||
}
|
||||
if ($thereisoutput === 'and it is multiple lines') {
|
||||
echo 'Use a screen like we did below';
|
||||
}
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs.similar;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
Use the PEAR Coding standards
|
||||
Use a screen like we did below
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
<!--
|
||||
<refsect1 role="notes">
|
||||
&reftitle.notes;
|
||||
<caution>
|
||||
<para>
|
||||
Any notes that don't fit anywhere else should go here.
|
||||
90% of the time, notes, warnings or cautions are better placed in the
|
||||
parameters section. Consider that before using this section!
|
||||
</para>
|
||||
</caution>
|
||||
¬e.language-construct;
|
||||
¬e.not-bin-safe;
|
||||
¬e.registerglobals;
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
<!--
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><function>somefunc</function></member>
|
||||
<member><function>another_func</function></member>
|
||||
<member>The <link linkend="something">something appendix</link></member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-omittag:t
|
||||
sgml-shorttag:t
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-indent-step:1
|
||||
sgml-indent-data:t
|
||||
indent-tabs-mode:nil
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
||||
sgml-exposed-tags:nil
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
End:
|
||||
vim600: syn=xml fen fdm=syntax fdl=2 si
|
||||
vim: et tw=78 syn=sgml
|
||||
vi: ts=1 sw=1
|
||||
-->
|
||||
Loading…
Reference in a new issue