stats-cdf-exponential.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.stats-cdf-exponential" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>stats_cdf_exponential</refname>
  <refpurpose>Calculates any one parameter of the exponential distribution given values for the others</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>float</type><methodname>stats_cdf_exponential</methodname>
   <methodparam><type>float</type><parameter>par1</parameter></methodparam>
   <methodparam><type>float</type><parameter>par2</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 exponential 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 lambda denotes cumulative distribution function, the value of the random
   variable, and the rate parameter of the exponential 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>lambda</entry>
      </row>
      <row>
       <entry>2</entry>
       <entry>x</entry>
       <entry>CDF</entry>
       <entry>lambda</entry>
      </row>
      <row>
       <entry>3</entry>
       <entry>lambda</entry>
       <entry>x</entry>
       <entry>CDF</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>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, or lambda, determined by <parameter>which</parameter>.
  </para>
 </refsect1>

 <!-- Use when ERRORS exist
 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   When does this function throw E_* level errors, or exceptions?
  </para>
 </refsect1>
 -->


 <!-- Use when a CHANGELOG exists
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>Enter the PHP version of change here</entry>
       <entry>Description of change</entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 -->


 <!-- Use when examples exist
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>stats_cdf_exponential</function> example</title>
    <para>
     Any text that describes the purpose of the example, or
     what goes on in the example should go here (inside the
     <example> tag, not out
    </para>
    <programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
    echo 'Use the PEAR Coding Standards';
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 -->


 <!-- Use when adding See Also links
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function></function></member>
    <member>Or <link linkend="somethingelse">something else</link></member>
   </simplelist>
  </para>
 </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
-->