cvs: phpdoc /en/reference/math/functions acos.xml acosh.xml asin.xml asinh.xml atan.xml atanh.xml dechex.xml getrandmax.xml hexdec.xml
mt-getrandmax.xml mt-rand.xml mt-srand.xml number-format.xml rand.xml sqrt.xml srand.xml

sander Mon Jun 3 11:06:17 2002 EDT Modified files: /phpdoc/en/reference/math/functions acos.xml acosh.xml asin.xml asinh.xml atan.xml atanh.xml dechex.xml getrandmax.xml hexdec.xml mt-getrandmax.xml mt-rand.xml mt-srand.xml number-format.xml rand.xml sqrt.xml srand.xml Log: Some more (small) changes/improvements to the math functions

Index: phpdoc/en/reference/math/functions/acos.xml diff -u phpdoc/en/reference/math/functions/acos.xml:1.2 phpdoc/en/reference/math/functions/acos.xml:1.3 --- phpdoc/en/reference/math/functions/acos.xml:1.2 Wed Apr 17 02:39:49 2002 +++ phpdoc/en/reference/math/functions/acos.xml Mon Jun 3 11:06:16 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/math.xml, last change in rev 1.57 --> <refentry id="function.acos"> <refnamediv> @@ -14,6 +14,10 @@ </methodsynopsis> <para> Returns the arc cosine of <parameter>arg</parameter> in radians. + <function>acos</function> is the complementary function of + <function>cos</function>, which means that + <literal>a==cos(acos(a))</literal> for every value of a that is within + <function>acos</function>' range. </para> <para> See also <function>acosh</function>, <function>asin</function> Index: phpdoc/en/reference/math/functions/acosh.xml diff -u phpdoc/en/reference/math/functions/acosh.xml:1.2 phpdoc/en/reference/math/functions/acosh.xml:1.3 --- phpdoc/en/reference/math/functions/acosh.xml:1.2 Wed Apr 17 02:39:49 2002 +++ phpdoc/en/reference/math/functions/acosh.xml Mon Jun 3 11:06:16 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/math.xml, last change in rev 1.2 --> <refentry id="function.acosh"> <refnamediv> @@ -19,8 +19,8 @@ </para> &note.no-windows; <para> - See also <function>acos</function>, <function>asin</function> - and <function>atan</function>. + See also <function>acos</function>, <function>asinh</function> + and <function>atanh</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/math/functions/asin.xml diff -u phpdoc/en/reference/math/functions/asin.xml:1.2 phpdoc/en/reference/math/functions/asin.xml:1.3 --- phpdoc/en/reference/math/functions/asin.xml:1.2 Wed Apr 17 02:39:49 2002 +++ phpdoc/en/reference/math/functions/asin.xml Mon Jun 3 11:06:16 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/math.xml, last change in rev 1.57 --> <refentry id="function.asin"> <refnamediv> @@ -13,7 +13,11 @@ <methodparam><type>float</type><parameter>arg</parameter></methodparam> </methodsynopsis> <para> - Returns the arc sine of arg in radians. + Returns the arc sine of <parameter>arg</parameter> in radians. + <function>asin</function> is the complementary function of + <function>sin</function>, which means that + <literal>a==sin(asin(a))</literal> for every value of a that is within + <function>asin</function>'s range. </para> <para> See also <function>asinh</function>, <function>acos</function> Index: phpdoc/en/reference/math/functions/asinh.xml diff -u phpdoc/en/reference/math/functions/asinh.xml:1.2 phpdoc/en/reference/math/functions/asinh.xml:1.3 --- phpdoc/en/reference/math/functions/asinh.xml:1.2 Wed Apr 17 02:39:49 2002 +++ phpdoc/en/reference/math/functions/asinh.xml Mon Jun 3 11:06:16 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/math.xml, last change in rev 1.2 --> <refentry id="function.asinh"> <refnamediv> @@ -19,8 +19,8 @@ </para> &note.no-windows; <para> - See also <function>asin</function>, <function>acos</function> - and <function>atan</function>. + See also <function>asin</function>, <function>acosh</function> + and <function>atanh</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/math/functions/atan.xml diff -u phpdoc/en/reference/math/functions/atan.xml:1.2 phpdoc/en/reference/math/functions/atan.xml:1.3 --- phpdoc/en/reference/math/functions/atan.xml:1.2 Wed Apr 17 02:39:50 2002 +++ phpdoc/en/reference/math/functions/atan.xml Mon Jun 3 11:06:16 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/math.xml, last change in rev 1.57 --> <refentry id="function.atan"> <refnamediv> @@ -13,7 +13,11 @@ <methodparam><type>float</type><parameter>arg</parameter></methodparam> </methodsynopsis> <para> - Returns the arc tangent of arg in radians. + Returns the arc tangent of <parameter>arg</parameter> in radians. + <function>atan</function> is the complementary function of + <function>tan</function>, which means that + <literal>a==tan(atan(a))</literal> for every value of a that is within + <function>atan</function>'s range. </para> <para> See also <function>atanh</function>, <function>asin</function> Index: phpdoc/en/reference/math/functions/atanh.xml diff -u phpdoc/en/reference/math/functions/atanh.xml:1.2 phpdoc/en/reference/math/functions/atanh.xml:1.3 --- phpdoc/en/reference/math/functions/atanh.xml:1.2 Wed Apr 17 02:39:50 2002 +++ phpdoc/en/reference/math/functions/atanh.xml Mon Jun 3 11:06:16 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/math.xml, last change in rev 1.2 --> <refentry id="function.atanh"> <refnamediv> @@ -19,8 +19,8 @@ </para> &note.no-windows; <para> - See also <function>atan</function>, <function>asin</function> - and <function>acos</function>. + See also <function>atan</function>, <function>asinh</function> + and <function>acosh</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/math/functions/dechex.xml diff -u phpdoc/en/reference/math/functions/dechex.xml:1.2 phpdoc/en/reference/math/functions/dechex.xml:1.3 --- phpdoc/en/reference/math/functions/dechex.xml:1.2 Wed Apr 17 02:39:51 2002 +++ phpdoc/en/reference/math/functions/dechex.xml Mon Jun 3 11:06:16 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/math.xml, last change in rev 1.2 --> <refentry id="function.dechex"> <refnamediv> @@ -14,7 +14,7 @@ </methodsynopsis> <para> Returns a string containing a hexadecimal representation of the - given number argument. The largest number that can + given <parameter>number</parameter> argument. The largest number that can be converted is 2147483647 in decimal resulting to "7fffffff". </para> <para> Index: phpdoc/en/reference/math/functions/getrandmax.xml diff -u phpdoc/en/reference/math/functions/getrandmax.xml:1.2 phpdoc/en/reference/math/functions/getrandmax.xml:1.3 --- phpdoc/en/reference/math/functions/getrandmax.xml:1.2 Wed Apr 17 02:39:52 2002 +++ phpdoc/en/reference/math/functions/getrandmax.xml Mon Jun 3 11:06:16 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/math.xml, last change in rev 1.2 --> <refentry id="function.getrandmax"> <refnamediv> @@ -17,9 +17,8 @@ <function>rand</function>. </simpara> <simpara> - See also <function>rand</function>, <function>srand</function>, - <function>mt_rand</function>, <function>mt_srand</function>, and - <function>mt_getrandmax</function>. + See also <function>rand</function>, <function>srand</function> + and <function>mt_getrandmax</function>. </simpara> </refsect1> </refentry> Index: phpdoc/en/reference/math/functions/hexdec.xml diff -u phpdoc/en/reference/math/functions/hexdec.xml:1.2 phpdoc/en/reference/math/functions/hexdec.xml:1.3 --- phpdoc/en/reference/math/functions/hexdec.xml:1.2 Wed Apr 17 02:39:52 2002 +++ phpdoc/en/reference/math/functions/hexdec.xml Mon Jun 3 11:06:16 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/math.xml, last change in rev 1.16 --> <refentry id="function.hexdec"> <refnamediv> @@ -14,9 +14,10 @@ </methodsynopsis> <para> Returns the decimal equivalent of the hexadecimal number - represented by the hex_string argument. <function>hexdec</function> converts a - hexadecimal string to a decimal number. The largest number that - can be converted is 7fffffff or 2147483647 in decimal. + represented by the <parameter>hex_string</parameter> argument. + <function>hexdec</function> converts a hexadecimal string to a + decimal number. The largest number that can be converted is + 7fffffff or 2147483647 in decimal. </para> <para> <function>hexdec</function> will replace of any non-hexadecimal Index: phpdoc/en/reference/math/functions/mt-getrandmax.xml diff -u phpdoc/en/reference/math/functions/mt-getrandmax.xml:1.2 phpdoc/en/reference/math/functions/mt-getrandmax.xml:1.3 --- phpdoc/en/reference/math/functions/mt-getrandmax.xml:1.2 Wed Apr 17 02:39:54 2002 +++ phpdoc/en/reference/math/functions/mt-getrandmax.xml Mon Jun 3 11:06:16 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/math.xml, last change in rev 1.2 --> <refentry id="function.mt-getrandmax"> <refnamediv> @@ -18,9 +18,7 @@ </simpara> <simpara> See also <function>mt_rand</function>, - <function>mt_srand</function>, <function>rand</function>, - <function>srand</function>, and - <function>getrandmax</function>. + <function>mt_srand</function> and <function>getrandmax</function>. </simpara> </refsect1> </refentry> Index: phpdoc/en/reference/math/functions/mt-rand.xml diff -u phpdoc/en/reference/math/functions/mt-rand.xml:1.3 phpdoc/en/reference/math/functions/mt-rand.xml:1.4 --- phpdoc/en/reference/math/functions/mt-rand.xml:1.3 Sun May 12 09:18:54 2002 +++ phpdoc/en/reference/math/functions/mt-rand.xml Mon Jun 3 11:06:16 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/math.xml, last change in rev 1.2 --> <refentry id="function.mt-rand"> <refnamediv> @@ -53,8 +53,8 @@ </note> <simpara> See also <function>mt_srand</function>, - <function>mt_getrandmax</function>, <function>srand</function>, - <function>rand</function> and <function>getrandmax</function>. + <function>mt_getrandmax</function> and + <function>rand</function>. </simpara> </refsect1> </refentry> Index: phpdoc/en/reference/math/functions/mt-srand.xml diff -u phpdoc/en/reference/math/functions/mt-srand.xml:1.3 phpdoc/en/reference/math/functions/mt-srand.xml:1.4 --- phpdoc/en/reference/math/functions/mt-srand.xml:1.3 Sun May 12 09:18:54 2002 +++ phpdoc/en/reference/math/functions/mt-srand.xml Mon Jun 3 11:06:16 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/math.xml, last change in rev 1.2 --> <refentry id="function.mt-srand"> <refnamediv> @@ -37,9 +37,7 @@ </note> <simpara> See also <function>mt_rand</function>, - <function>mt_getrandmax</function>, <function>srand</function>, - <function>rand</function>, and - <function>getrandmax</function>. + <function>mt_getrandmax</function> and <function>srand</function>. </simpara> </refsect1> </refentry> Index: phpdoc/en/reference/math/functions/number-format.xml diff -u phpdoc/en/reference/math/functions/number-format.xml:1.3 phpdoc/en/reference/math/functions/number-format.xml:1.4 --- phpdoc/en/reference/math/functions/number-format.xml:1.3 Thu May 2 06:48:14 2002 +++ phpdoc/en/reference/math/functions/number-format.xml Mon Jun 3 11:06:16 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/math.xml, last change in rev 1.2 --> <refentry id="function.number-format"> <refnamediv> @@ -21,7 +21,7 @@ two or four parameters (not three): </para> <para>If only one parameter is given, - <parameter>Number</parameter> will be formatted without decimals, + <parameter>number</parameter> will be formatted without decimals, but with a comma (",") between every group of thousands. </para> <para> @@ -79,12 +79,10 @@ </programlisting> </example> </para> - <note> - <para> - See also: <function>sprintf</function>, - <function>printf</function> and <function>sscanf</function>. - </para> - </note> + <para> + See also: <function>sprintf</function>, + <function>printf</function> and <function>sscanf</function>. + </para> </refsect1> </refentry> Index: phpdoc/en/reference/math/functions/rand.xml diff -u phpdoc/en/reference/math/functions/rand.xml:1.3 phpdoc/en/reference/math/functions/rand.xml:1.4 --- phpdoc/en/reference/math/functions/rand.xml:1.3 Sun May 12 09:18:54 2002 +++ phpdoc/en/reference/math/functions/rand.xml Mon Jun 3 11:06:16 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/math.xml, last change in rev 1.2 --> <refentry id="function.rand"> <refnamediv> @@ -23,7 +23,7 @@ </simpara> <simpara> In older versions of PHP, you had to seed the random number generator - before use with <function>mt_srand</function>. Since 4.2.0 this is no + before use with <function>srand</function>. Since 4.2.0 this is no longer necessary. </simpara> <note> @@ -37,9 +37,8 @@ </note> <simpara> See also <function>srand</function>, - <function>getrandmax</function>, <function>mt_rand</function>, - <function>mt_srand</function>, and - <function>mt_getrandmax</function>. + <function>getrandmax</function>, and + <function>mt_rand</function>. </simpara> </refsect1> </refentry> Index: phpdoc/en/reference/math/functions/sqrt.xml diff -u phpdoc/en/reference/math/functions/sqrt.xml:1.2 phpdoc/en/reference/math/functions/sqrt.xml:1.3 --- phpdoc/en/reference/math/functions/sqrt.xml:1.2 Wed Apr 17 02:39:55 2002 +++ phpdoc/en/reference/math/functions/sqrt.xml Mon Jun 3 11:06:16 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/math.xml, last change in rev 1.2 --> <refentry id="function.sqrt"> <refnamediv> @@ -14,6 +14,19 @@ </methodsynopsis> <para> Returns the square root of <parameter>arg</parameter>. + </para> + <para> + <informalexample> + <programlisting> +<![CDATA[ +<?php +// Precision depends on your precision directive +echo sqrt(9); // 3 +echo sqrt(10); // 3.16227766 ... +?> +]]> + </programlisting> + </informalexample> </para> <para> See also <function>pow</function>. Index: phpdoc/en/reference/math/functions/srand.xml diff -u phpdoc/en/reference/math/functions/srand.xml:1.3 phpdoc/en/reference/math/functions/srand.xml:1.4 --- phpdoc/en/reference/math/functions/srand.xml:1.3 Sun May 12 09:18:54 2002 +++ phpdoc/en/reference/math/functions/srand.xml Mon Jun 3 11:06:16 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/math.xml, last change in rev 1.2 --> <refentry id="function.srand"> <refnamediv> @@ -37,9 +37,8 @@ </note> <simpara> See also <function>rand</function>, - <function>getrandmax</function>, <function>mt_rand</function>, - <function>mt_srand</function>, and - <function>mt_getrandmax</function>. + <function>getrandmax</function> and + <function>mt_srand</function>. </simpara> </refsect1> </refentry>