php-doc-en/reference/stats/functions/stats-cdf-normal.xml

220 lines
5.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.stats-cdf-normal" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>stats_cdf_normal</refname>
<refpurpose>Calculates any one parameter of the normal distribution given values for the others</refpurpose>
</refnamediv>
<refsect1 role="description"><!-- {{{ -->
&reftitle.description;
<methodsynopsis role="procedural">
<type>float</type><methodname>stats_cdf_normal</methodname>
<methodparam><type>float</type><parameter>par1</parameter></methodparam>
<methodparam><type>float</type><parameter>par2</parameter></methodparam>
<methodparam><type>float</type><parameter>par3</parameter></methodparam>
<methodparam><type>int</type><parameter>which</parameter></methodparam>
</methodsynopsis>
<para>
Returns the cumulative distribution function, its inverse, or one of its parameters,
of the normal 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, mu, and sigma denotes cumulative distribution function, the value of the random
variable, the mean and the standard deviation of the normal 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>mu</entry>
<entry>sigma</entry>
</row>
<row>
<entry>2</entry>
<entry>x</entry>
<entry>CDF</entry>
<entry>mu</entry>
<entry>sigma</entry>
</row>
<row>
<entry>3</entry>
<entry>mu</entry>
<entry>x</entry>
<entry>CDF</entry>
<entry>sigma</entry>
</row>
<row>
<entry>4</entry>
<entry>sigma</entry>
<entry>x</entry>
<entry>CDF</entry>
<entry>mu</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1><!-- }}} -->
<refsect1 role="parameters"><!-- {{{ -->
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>par1</parameter></term>
<listitem>
<para>
The first parameter
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>par2</parameter></term>
<listitem>
<para>
The second parameter
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>par3</parameter></term>
<listitem>
<para>
The third parameter
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>which</parameter></term>
<listitem>
<para>
The flag to determine what to be calculated
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1><!-- }}} -->
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
<para>
Returns CDF, x, mu, or sigma, determined by <parameter>which</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="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="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
-->