1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.stats-cdf-gamma" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stats_cdf_gamma</refname>
<refpurpose>Calculates any one parameter of the gamma distribution given values for the others</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>float</type><methodname>stats_cdf_gamma</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 gamma 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 theta denotes cumulative distribution function, the value of the random
variable, and the shape and the scale parameter of the gamma 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>theta</entry>
</row>
<row>
<entry>2</entry>
<entry>x</entry>
<entry>CDF</entry>
<entry>k</entry>
<entry>theta</entry>
</row>
<row>
<entry>3</entry>
<entry>k</entry>
<entry>x</entry>
<entry>CDF</entry>
<entry>theta</entry>
</row>
<row>
<entry>4</entry>
<entry>theta</entry>
<entry>x</entry>
<entry>CDF</entry>
<entry>k</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, k, or theta, 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_gamma</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
-->
|