cvs: phpdoc /en/reference/bc/functions bcadd.xml bccomp.xml bcdiv.xml bcmod.xml bcmul.xml bcpow.xml bcpowmod.xml bcscale.xml bcsqrt.xml bcsub.xml
| From: | Mehdi Achour | Date: | Sat, 27 Jan 2007 00:21:09 +0000 |
| Subject: | cvs: phpdoc /en/reference/bc/functions bcadd.xml bccomp.xml bcdiv.xml bcmod.xml bcmul.xml bcpow.xml bcpowmod.xml bcscale.xml bcsqrt.xml bcsub.xml | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969375039@lists.php.net to get a copy of this message | ||
didou Sat Jan 27 00:21:09 2007 UTC
Modified files:
/phpdoc/en/reference/bc/functions bcadd.xml bccomp.xml bcdiv.xml
bcmod.xml bcmul.xml bcpow.xml
bcpowmod.xml bcscale.xml
bcsqrt.xml bcsub.xml
Log:
WS, prepare for new style
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcadd.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/bc/functions/bcadd.xml diff -u phpdoc/en/reference/bc/functions/bcadd.xml:1.5 phpdoc/en/reference/bc/functions/bcadd.xml:1.6 --- phpdoc/en/reference/bc/functions/bcadd.xml:1.5 Mon Jul 4 07:24:19 2005 +++ phpdoc/en/reference/bc/functions/bcadd.xml Sat Jan 27 00:21:08 2007 @@ -1,32 +1,32 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> - <refentry id="function.bcadd"> - <refnamediv> - <refname>bcadd</refname> - <refpurpose>Add two arbitrary precision numbers</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>bcadd</methodname> - <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> - <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> - </methodsynopsis> - <para> - Adds the <parameter>left_operand</parameter> to the - <parameter>right_operand</parameter> and returns the sum in a - string. The optional <parameter>scale</parameter> parameter is - used to set the number of digits after the decimal place in the - result. - </para> - </refsect1> - <refsect1> - &reftitle.examples; - <example> - <title><function>bcadd</function> example</title> - <programlisting role="php"> +<refentry id="function.bcadd"> + <refnamediv> + <refname>bcadd</refname> + <refpurpose>Add two arbitrary precision numbers</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>bcadd</methodname> + <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> + <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> + <para> + Adds the <parameter>left_operand</parameter> to the + <parameter>right_operand</parameter> and returns the sum in a + string. The optional <parameter>scale</parameter> parameter is + used to set the number of digits after the decimal place in the + result. + </para> + </refsect1> + <refsect1> + &reftitle.examples; + <example> + <title><function>bcadd</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -38,16 +38,16 @@ ?> ]]> - </programlisting> - </example> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>bcsub</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>bcsub</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bccomp.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/bc/functions/bccomp.xml diff -u phpdoc/en/reference/bc/functions/bccomp.xml:1.4 phpdoc/en/reference/bc/functions/bccomp.xml:1.5 --- phpdoc/en/reference/bc/functions/bccomp.xml:1.4 Tue Aug 10 23:40:27 2004 +++ phpdoc/en/reference/bc/functions/bccomp.xml Sat Jan 27 00:21:08 2007 @@ -1,37 +1,37 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> - <refentry id="function.bccomp"> - <refnamediv> - <refname>bccomp</refname> - <refpurpose>Compare two arbitrary precision numbers</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>bccomp</methodname> - <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> - <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> - </methodsynopsis> - <para> - Compares the <parameter>left_operand</parameter> to the - <parameter>right_operand</parameter> and returns the result as an - integer. The optional <parameter>scale</parameter> parameter is - used to set the number of digits after the decimal place which - will be used in the comparison. The return value is 0 if the two - operands are equal. If the <parameter>left_operand</parameter> - is larger than the <parameter>right_operand</parameter> the - return value is +1 and if the <parameter>left_operand</parameter> - is less than the <parameter>right_operand</parameter> the return - value is -1. - </para> - </refsect1> - <refsect1> - &reftitle.examples; - <example> - <title><function>bccomp</function> example</title> - <programlisting role="php"> +<refentry id="function.bccomp"> + <refnamediv> + <refname>bccomp</refname> + <refpurpose>Compare two arbitrary precision numbers</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>bccomp</methodname> + <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> + <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> + <para> + Compares the <parameter>left_operand</parameter> to the + <parameter>right_operand</parameter> and returns the result as an + integer. The optional <parameter>scale</parameter> parameter is + used to set the number of digits after the decimal place which + will be used in the comparison. The return value is 0 if the two + operands are equal. If the <parameter>left_operand</parameter> + is larger than the <parameter>right_operand</parameter> the + return value is +1 and if the <parameter>left_operand</parameter> + is less than the <parameter>right_operand</parameter> the return + value is -1. + </para> + </refsect1> + <refsect1> + &reftitle.examples; + <example> + <title><function>bccomp</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -41,10 +41,10 @@ ?> ]]> - </programlisting> - </example> - </refsect1> - </refentry> + </programlisting> + </example> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcdiv.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/bc/functions/bcdiv.xml diff -u phpdoc/en/reference/bc/functions/bcdiv.xml:1.6 phpdoc/en/reference/bc/functions/bcdiv.xml:1.7 --- phpdoc/en/reference/bc/functions/bcdiv.xml:1.6 Mon Jul 4 07:24:19 2005 +++ phpdoc/en/reference/bc/functions/bcdiv.xml Sat Jan 27 00:21:08 2007 @@ -1,31 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> - <refentry id="function.bcdiv"> - <refnamediv> - <refname>bcdiv</refname> - <refpurpose>Divide two arbitrary precision numbers</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>bcdiv</methodname> - <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> - <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> - </methodsynopsis> - <para> - Divides the <parameter>left_operand</parameter> by the - <parameter>right_operand</parameter> and returns the result. The - optional <parameter>scale</parameter> sets the number of digits - after the decimal place in the result, which defaults to 0. - </para> - </refsect1> - <refsect1> - &reftitle.examples; - <example> - <title><function>bcdiv</function> example</title> - <programlisting role="php"> +<refentry id="function.bcdiv"> + <refnamediv> + <refname>bcdiv</refname> + <refpurpose>Divide two arbitrary precision numbers</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>bcdiv</methodname> + <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> + <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> + <para> + Divides the <parameter>left_operand</parameter> by the + <parameter>right_operand</parameter> and returns the result. The + optional <parameter>scale</parameter> sets the number of digits + after the decimal place in the result, which defaults to 0. + </para> + </refsect1> + <refsect1> + &reftitle.examples; + <example> + <title><function>bcdiv</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -33,16 +33,16 @@ ?> ]]> - </programlisting> - </example> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>bcmul</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>bcmul</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcmod.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/bc/functions/bcmod.xml diff -u phpdoc/en/reference/bc/functions/bcmod.xml:1.5 phpdoc/en/reference/bc/functions/bcmod.xml:1.6 --- phpdoc/en/reference/bc/functions/bcmod.xml:1.5 Mon Jul 4 07:24:19 2005 +++ phpdoc/en/reference/bc/functions/bcmod.xml Sat Jan 27 00:21:08 2007 @@ -1,46 +1,44 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> - <refentry id="function.bcmod"> - <refnamediv> - <refname>bcmod</refname> - <refpurpose> - Get modulus of an arbitrary precision number - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>bcmod</methodname> - <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> - <methodparam><type>string</type><parameter>modulus</parameter></methodparam> - </methodsynopsis> - <para> - Get the modulus of the <parameter>left_operand</parameter> using - <parameter>modulus</parameter>. - </para> - </refsect1> - <refsect1> - &reftitle.examples; - <example> - <title><function>bcmod</function> example</title> - <programlisting role="php"> +<refentry id="function.bcmod"> + <refnamediv> + <refname>bcmod</refname> + <refpurpose>Get modulus of an arbitrary precision number</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>bcmod</methodname> + <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> + <methodparam><type>string</type><parameter>modulus</parameter></methodparam> + </methodsynopsis> + <para> + Get the modulus of the <parameter>left_operand</parameter> using + <parameter>modulus</parameter>. + </para> + </refsect1> + <refsect1> + &reftitle.examples; + <example> + <title><function>bcmod</function> example</title> + <programlisting role="php"> <![CDATA[ <?php echo bcmod('4', '2'); // 0 echo bcmod('2', '4'); // 2 ?> ]]> - </programlisting> - </example> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>bcdiv</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>bcdiv</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcmul.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/bc/functions/bcmul.xml diff -u phpdoc/en/reference/bc/functions/bcmul.xml:1.6 phpdoc/en/reference/bc/functions/bcmul.xml:1.7 --- phpdoc/en/reference/bc/functions/bcmul.xml:1.6 Thu Aug 31 22:12:25 2006 +++ phpdoc/en/reference/bc/functions/bcmul.xml Sat Jan 27 00:21:08 2007 @@ -1,47 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> - <refentry id="function.bcmul"> - <refnamediv> - <refname>bcmul</refname> - <refpurpose>Multiply two arbitrary precision number</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>bcmul</methodname> - <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> - <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> - </methodsynopsis> - <para> - Multiply the <parameter>left_operand</parameter> by the - <parameter>right_operand</parameter> and returns the result. The - optional <parameter>scale</parameter> sets the number of digits - after the decimal place in the result (by truncating). - </para> - </refsect1> - <refsect1> - &reftitle.examples; - <example> - <title><function>bcmul</function> example</title> - <programlisting role="php"> +<refentry id="function.bcmul"> + <refnamediv> + <refname>bcmul</refname> + <refpurpose>Multiply two arbitrary precision number</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>bcmul</methodname> + <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> + <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> + <para> + Multiply the <parameter>left_operand</parameter> by the + <parameter>right_operand</parameter> and returns the result. The + optional <parameter>scale</parameter> sets the number of digits + after the decimal place in the result (by truncating). + </para> + </refsect1> + <refsect1> + &reftitle.examples; + <example> + <title><function>bcmul</function> example</title> + <programlisting role="php"> <![CDATA[ <?php echo bcmul('1.34747474747', '35', 3); // 47.161 echo bcmul('2', '4'); // 8 ?> ]]> - </programlisting> - </example> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>bcdiv</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>bcdiv</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcpow.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/bc/functions/bcpow.xml diff -u phpdoc/en/reference/bc/functions/bcpow.xml:1.9 phpdoc/en/reference/bc/functions/bcpow.xml:1.10 --- phpdoc/en/reference/bc/functions/bcpow.xml:1.9 Mon Jul 4 07:24:19 2005 +++ phpdoc/en/reference/bc/functions/bcpow.xml Sat Jan 27 00:21:08 2007 @@ -1,33 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> - <refentry id="function.bcpow"> - <refnamediv> - <refname>bcpow</refname> - <refpurpose> - Raise an arbitrary precision number to another - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>bcpow</methodname> - <methodparam><type>string</type><parameter>x</parameter></methodparam> - <methodparam><type>string</type><parameter>y</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> - </methodsynopsis> - <para> - Raise <parameter>x</parameter> to the power - <parameter>y</parameter>. The optional - <parameter>scale</parameter> can be used to set the number of - digits after the decimal place in the result. - </para> - </refsect1> - <refsect1> - &reftitle.examples; - <example> - <title><function>bcpow</function> example</title> - <programlisting role="php"> +<refentry id="function.bcpow"> + <refnamediv> + <refname>bcpow</refname> + <refpurpose>Raise an arbitrary precision number to another</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>bcpow</methodname> + <methodparam><type>string</type><parameter>x</parameter></methodparam> + <methodparam><type>string</type><parameter>y</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> + <para> + Raise <parameter>x</parameter> to the power + <parameter>y</parameter>. The optional + <parameter>scale</parameter> can be used to set the number of + digits after the decimal place in the result. + </para> + </refsect1> + <refsect1> + &reftitle.examples; + <example> + <title><function>bcpow</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -35,17 +33,17 @@ ?> ]]> - </programlisting> - </example> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>bcpowmod</function>&listendand; - <function>bcsqrt</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>bcpowmod</function>&listendand; + <function>bcsqrt</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcpowmod.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/bc/functions/bcpowmod.xml diff -u phpdoc/en/reference/bc/functions/bcpowmod.xml:1.6 phpdoc/en/reference/bc/functions/bcpowmod.xml:1.7 --- phpdoc/en/reference/bc/functions/bcpowmod.xml:1.6 Fri Aug 20 09:36:58 2004 +++ phpdoc/en/reference/bc/functions/bcpowmod.xml Sat Jan 27 00:21:08 2007 @@ -1,66 +1,64 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> - <refentry id="function.bcpowmod"> - <refnamediv> - <refname>bcpowmod</refname> - <refpurpose> - Raise an arbitrary precision number to another, reduced by a specified modulus - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>bcpowmod</methodname> - <methodparam><type>string</type><parameter>x</parameter></methodparam> - <methodparam><type>string</type><parameter>y</parameter></methodparam> - <methodparam><type>string</type><parameter>modulus</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> - </methodsynopsis> - <para> - Use the fast-exponentiation method to raise <parameter>x</parameter> - to the power <parameter>y</parameter> with respect to the modulus - <parameter>modulus</parameter>. The optional - <parameter>scale</parameter> can be used to set the number of - digits after the decimal place in the result. - </para> - <note> - <para> - Because this method uses the modulus operation, non-natural numbers - may give unexpected results. A natural number is any positive - non-zero integer. - </para> - </note> - </refsect1> - <refsect1> - &reftitle.examples; - <para> - The following two statements are functionally identical. The - <function>bcpowmod</function> version however, executes in - less time and can accept larger parameters. - <informalexample> - <programlisting role="php"> +<!-- $Revision: 1.7 $ --> +<refentry id="function.bcpowmod"> + <refnamediv> + <refname>bcpowmod</refname> + <refpurpose>Raise an arbitrary precision number to another, reduced by a specified modulus</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>bcpowmod</methodname> + <methodparam><type>string</type><parameter>x</parameter></methodparam> + <methodparam><type>string</type><parameter>y</parameter></methodparam> + <methodparam><type>string</type><parameter>modulus</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> + <para> + Use the fast-exponentiation method to raise <parameter>x</parameter> + to the power <parameter>y</parameter> with respect to the modulus + <parameter>modulus</parameter>. The optional + <parameter>scale</parameter> can be used to set the number of + digits after the decimal place in the result. + </para> + <note> + <para> + Because this method uses the modulus operation, non-natural numbers + may give unexpected results. A natural number is any positive + non-zero integer. + </para> + </note> + </refsect1> + <refsect1> + &reftitle.examples; + <para> + The following two statements are functionally identical. The + <function>bcpowmod</function> version however, executes in + less time and can accept larger parameters. + <informalexample> + <programlisting role="php"> <![CDATA[ <?php $a = bcpowmod($x, $y, $mod); $b = bcmod(bcpow($x, $y), $mod); -// $a and $b are equal to each other. +// $a and $b are equal to each other. ?> ]]> - </programlisting> - </informalexample> - </para> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>bcpow</function>&listendand; - <function>bcmod</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </informalexample> + </para> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>bcpow</function>&listendand; + <function>bcmod</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcscale.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/bc/functions/bcscale.xml diff -u phpdoc/en/reference/bc/functions/bcscale.xml:1.7 phpdoc/en/reference/bc/functions/bcscale.xml:1.8 --- phpdoc/en/reference/bc/functions/bcscale.xml:1.7 Mon Jul 4 07:24:19 2005 +++ phpdoc/en/reference/bc/functions/bcscale.xml Sat Jan 27 00:21:08 2007 @@ -1,30 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> - <refentry id="function.bcscale"> - <refnamediv> - <refname>bcscale</refname> - <refpurpose> - Set default scale parameter for all bc math functions - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcscale</methodname> - <methodparam><type>int</type><parameter>scale</parameter></methodparam> - </methodsynopsis> - <para> - This function sets the default scale parameter for all subsequent - bc math functions that do not explicitly specify a scale - parameter. &return.success; - </para> - </refsect1> - <refsect1> - &reftitle.examples; - <example> - <title><function>bcscale</function> example</title> - <programlisting role="php"> +<refentry id="function.bcscale"> + <refnamediv> + <refname>bcscale</refname> + <refpurpose>Set default scale parameter for all bc math functions</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcscale</methodname> + <methodparam><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> + <para> + This function sets the default scale parameter for all subsequent + bc math functions that do not explicitly specify a scale + parameter. &return.success; + </para> + </refsect1> + <refsect1> + &reftitle.examples; + <example> + <title><function>bcscale</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -37,10 +35,10 @@ ?> ]]> - </programlisting> - </example> - </refsect1> - </refentry> + </programlisting> + </example> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcsqrt.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/bc/functions/bcsqrt.xml diff -u phpdoc/en/reference/bc/functions/bcsqrt.xml:1.5 phpdoc/en/reference/bc/functions/bcsqrt.xml:1.6 --- phpdoc/en/reference/bc/functions/bcsqrt.xml:1.5 Mon Jul 4 07:24:19 2005 +++ phpdoc/en/reference/bc/functions/bcsqrt.xml Sat Jan 27 00:21:08 2007 @@ -1,31 +1,29 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> - <refentry id="function.bcsqrt"> - <refnamediv> - <refname>bcsqrt</refname> - <refpurpose> - Get the square root of an arbitrary precision number - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>bcsqrt</methodname> - <methodparam><type>string</type><parameter>operand</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> - </methodsynopsis> - <para> - Return the square root of the <parameter>operand</parameter>. - The optional <parameter>scale</parameter> parameter sets the - number of digits after the decimal place in the result. - </para> - </refsect1> - <refsect1> - &reftitle.examples; - <example> - <title><function>bcsqrt</function> example</title> - <programlisting role="php"> +<refentry id="function.bcsqrt"> + <refnamediv> + <refname>bcsqrt</refname> + <refpurpose>Get the square root of an arbitrary precision number</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>bcsqrt</methodname> + <methodparam><type>string</type><parameter>operand</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> + <para> + Return the square root of the <parameter>operand</parameter>. + The optional <parameter>scale</parameter> parameter sets the + number of digits after the decimal place in the result. + </para> + </refsect1> + <refsect1> + &reftitle.examples; + <example> + <title><function>bcsqrt</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -33,16 +31,16 @@ ?> ]]> - </programlisting> - </example> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>bcpow</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>bcpow</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcsub.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/bc/functions/bcsub.xml diff -u phpdoc/en/reference/bc/functions/bcsub.xml:1.5 phpdoc/en/reference/bc/functions/bcsub.xml:1.6 --- phpdoc/en/reference/bc/functions/bcsub.xml:1.5 Mon Jul 4 07:24:19 2005 +++ phpdoc/en/reference/bc/functions/bcsub.xml Sat Jan 27 00:21:08 2007 @@ -1,55 +1,53 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> - <refentry id="function.bcsub"> - <refnamediv> - <refname>bcsub</refname> - <refpurpose> - Subtract one arbitrary precision number from another - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>bcsub</methodname> - <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> - <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> - </methodsynopsis> - <para> - Subtracts the <parameter>right_operand</parameter> from the - <parameter>left_operand</parameter> and returns the result in a - string. The optional <parameter>scale</parameter> parameter is - used to set the number of digits after the decimal place in the - result. - </para> - </refsect1> - <refsect1> - &reftitle.examples; - <example> - <title><function>bcsub</function> example</title> - <programlisting role="php"> +<refentry id="function.bcsub"> + <refnamediv> + <refname>bcsub</refname> + <refpurpose>Subtract one arbitrary precision number from another</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>bcsub</methodname> + <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> + <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> + <para> + Subtracts the <parameter>right_operand</parameter> from the + <parameter>left_operand</parameter> and returns the result in a + string. The optional <parameter>scale</parameter> parameter is + used to set the number of digits after the decimal place in the + result. + </para> + </refsect1> + <refsect1> + &reftitle.examples; + <example> + <title><function>bcsub</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $a = '1.234'; $b = '5'; - + echo bcsub($a, $b); // -3 echo bcsub($a, $b, 4); // -3.7660 ?> ]]> - </programlisting> - </example> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>bcadd</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>bcadd</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcadd.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/bc/functions/bcadd.xml diff -u phpdoc/en/reference/bc/functions/bcadd.xml:1.5 phpdoc/en/reference/bc/functions/bcadd.xml:1.6 --- phpdoc/en/reference/bc/functions/bcadd.xml:1.5 Mon Jul 4 07:24:19 2005 +++ phpdoc/en/reference/bc/functions/bcadd.xml Sat Jan 27 00:21:08 2007 @@ -1,32 +1,32 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> - <refentry id="function.bcadd"> - <refnamediv> - <refname>bcadd</refname> - <refpurpose>Add two arbitrary precision numbers</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>bcadd</methodname> - <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> - <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> - </methodsynopsis> - <para> - Adds the <parameter>left_operand</parameter> to the - <parameter>right_operand</parameter> and returns the sum in a - string. The optional <parameter>scale</parameter> parameter is - used to set the number of digits after the decimal place in the - result. - </para> - </refsect1> - <refsect1> - &reftitle.examples; - <example> - <title><function>bcadd</function> example</title> - <programlisting role="php"> +<refentry id="function.bcadd"> + <refnamediv> + <refname>bcadd</refname> + <refpurpose>Add two arbitrary precision numbers</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>bcadd</methodname> + <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> + <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> + <para> + Adds the <parameter>left_operand</parameter> to the + <parameter>right_operand</parameter> and returns the sum in a + string. The optional <parameter>scale</parameter> parameter is + used to set the number of digits after the decimal place in the + result. + </para> + </refsect1> + <refsect1> + &reftitle.examples; + <example> + <title><function>bcadd</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -38,16 +38,16 @@ ?> ]]> - </programlisting> - </example> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>bcsub</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>bcsub</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bccomp.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/bc/functions/bccomp.xml diff -u phpdoc/en/reference/bc/functions/bccomp.xml:1.4 phpdoc/en/reference/bc/functions/bccomp.xml:1.5 --- phpdoc/en/reference/bc/functions/bccomp.xml:1.4 Tue Aug 10 23:40:27 2004 +++ phpdoc/en/reference/bc/functions/bccomp.xml Sat Jan 27 00:21:08 2007 @@ -1,37 +1,37 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> - <refentry id="function.bccomp"> - <refnamediv> - <refname>bccomp</refname> - <refpurpose>Compare two arbitrary precision numbers</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>bccomp</methodname> - <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> - <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> - </methodsynopsis> - <para> - Compares the <parameter>left_operand</parameter> to the - <parameter>right_operand</parameter> and returns the result as an - integer. The optional <parameter>scale</parameter> parameter is - used to set the number of digits after the decimal place which - will be used in the comparison. The return value is 0 if the two - operands are equal. If the <parameter>left_operand</parameter> - is larger than the <parameter>right_operand</parameter> the - return value is +1 and if the <parameter>left_operand</parameter> - is less than the <parameter>right_operand</parameter> the return - value is -1. - </para> - </refsect1> - <refsect1> - &reftitle.examples; - <example> - <title><function>bccomp</function> example</title> - <programlisting role="php"> +<refentry id="function.bccomp"> + <refnamediv> + <refname>bccomp</refname> + <refpurpose>Compare two arbitrary precision numbers</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>bccomp</methodname> + <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> + <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> + <para> + Compares the <parameter>left_operand</parameter> to the + <parameter>right_operand</parameter> and returns the result as an + integer. The optional <parameter>scale</parameter> parameter is + used to set the number of digits after the decimal place which + will be used in the comparison. The return value is 0 if the two + operands are equal. If the <parameter>left_operand</parameter> + is larger than the <parameter>right_operand</parameter> the + return value is +1 and if the <parameter>left_operand</parameter> + is less than the <parameter>right_operand</parameter> the return + value is -1. + </para> + </refsect1> + <refsect1> + &reftitle.examples; + <example> + <title><function>bccomp</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -41,10 +41,10 @@ ?> ]]> - </programlisting> - </example> - </refsect1> - </refentry> + </programlisting> + </example> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcdiv.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/bc/functions/bcdiv.xml diff -u phpdoc/en/reference/bc/functions/bcdiv.xml:1.6 phpdoc/en/reference/bc/functions/bcdiv.xml:1.7 --- phpdoc/en/reference/bc/functions/bcdiv.xml:1.6 Mon Jul 4 07:24:19 2005 +++ phpdoc/en/reference/bc/functions/bcdiv.xml Sat Jan 27 00:21:08 2007 @@ -1,31 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> - <refentry id="function.bcdiv"> - <refnamediv> - <refname>bcdiv</refname> - <refpurpose>Divide two arbitrary precision numbers</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>bcdiv</methodname> - <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> - <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> - </methodsynopsis> - <para> - Divides the <parameter>left_operand</parameter> by the - <parameter>right_operand</parameter> and returns the result. The - optional <parameter>scale</parameter> sets the number of digits - after the decimal place in the result, which defaults to 0. - </para> - </refsect1> - <refsect1> - &reftitle.examples; - <example> - <title><function>bcdiv</function> example</title> - <programlisting role="php"> +<refentry id="function.bcdiv"> + <refnamediv> + <refname>bcdiv</refname> + <refpurpose>Divide two arbitrary precision numbers</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>bcdiv</methodname> + <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> + <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> + <para> + Divides the <parameter>left_operand</parameter> by the + <parameter>right_operand</parameter> and returns the result. The + optional <parameter>scale</parameter> sets the number of digits + after the decimal place in the result, which defaults to 0. + </para> + </refsect1> + <refsect1> + &reftitle.examples; + <example> + <title><function>bcdiv</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -33,16 +33,16 @@ ?> ]]> - </programlisting> - </example> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>bcmul</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>bcmul</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcmod.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/bc/functions/bcmod.xml diff -u phpdoc/en/reference/bc/functions/bcmod.xml:1.5 phpdoc/en/reference/bc/functions/bcmod.xml:1.6 --- phpdoc/en/reference/bc/functions/bcmod.xml:1.5 Mon Jul 4 07:24:19 2005 +++ phpdoc/en/reference/bc/functions/bcmod.xml Sat Jan 27 00:21:08 2007 @@ -1,46 +1,44 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> - <refentry id="function.bcmod"> - <refnamediv> - <refname>bcmod</refname> - <refpurpose> - Get modulus of an arbitrary precision number - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>bcmod</methodname> - <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> - <methodparam><type>string</type><parameter>modulus</parameter></methodparam> - </methodsynopsis> - <para> - Get the modulus of the <parameter>left_operand</parameter> using - <parameter>modulus</parameter>. - </para> - </refsect1> - <refsect1> - &reftitle.examples; - <example> - <title><function>bcmod</function> example</title> - <programlisting role="php"> +<refentry id="function.bcmod"> + <refnamediv> + <refname>bcmod</refname> + <refpurpose>Get modulus of an arbitrary precision number</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>bcmod</methodname> + <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> + <methodparam><type>string</type><parameter>modulus</parameter></methodparam> + </methodsynopsis> + <para> + Get the modulus of the <parameter>left_operand</parameter> using + <parameter>modulus</parameter>. + </para> + </refsect1> + <refsect1> + &reftitle.examples; + <example> + <title><function>bcmod</function> example</title> + <programlisting role="php"> <![CDATA[ <?php echo bcmod('4', '2'); // 0 echo bcmod('2', '4'); // 2 ?> ]]> - </programlisting> - </example> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>bcdiv</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>bcdiv</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcmul.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/bc/functions/bcmul.xml diff -u phpdoc/en/reference/bc/functions/bcmul.xml:1.6 phpdoc/en/reference/bc/functions/bcmul.xml:1.7 --- phpdoc/en/reference/bc/functions/bcmul.xml:1.6 Thu Aug 31 22:12:25 2006 +++ phpdoc/en/reference/bc/functions/bcmul.xml Sat Jan 27 00:21:08 2007 @@ -1,47 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> - <refentry id="function.bcmul"> - <refnamediv> - <refname>bcmul</refname> - <refpurpose>Multiply two arbitrary precision number</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>bcmul</methodname> - <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> - <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> - </methodsynopsis> - <para> - Multiply the <parameter>left_operand</parameter> by the - <parameter>right_operand</parameter> and returns the result. The - optional <parameter>scale</parameter> sets the number of digits - after the decimal place in the result (by truncating). - </para> - </refsect1> - <refsect1> - &reftitle.examples; - <example> - <title><function>bcmul</function> example</title> - <programlisting role="php"> +<refentry id="function.bcmul"> + <refnamediv> + <refname>bcmul</refname> + <refpurpose>Multiply two arbitrary precision number</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>bcmul</methodname> + <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> + <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> + <para> + Multiply the <parameter>left_operand</parameter> by the + <parameter>right_operand</parameter> and returns the result. The + optional <parameter>scale</parameter> sets the number of digits + after the decimal place in the result (by truncating). + </para> + </refsect1> + <refsect1> + &reftitle.examples; + <example> + <title><function>bcmul</function> example</title> + <programlisting role="php"> <![CDATA[ <?php echo bcmul('1.34747474747', '35', 3); // 47.161 echo bcmul('2', '4'); // 8 ?> ]]> - </programlisting> - </example> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>bcdiv</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>bcdiv</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcpow.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/bc/functions/bcpow.xml diff -u phpdoc/en/reference/bc/functions/bcpow.xml:1.9 phpdoc/en/reference/bc/functions/bcpow.xml:1.10 --- phpdoc/en/reference/bc/functions/bcpow.xml:1.9 Mon Jul 4 07:24:19 2005 +++ phpdoc/en/reference/bc/functions/bcpow.xml Sat Jan 27 00:21:08 2007 @@ -1,33 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> - <refentry id="function.bcpow"> - <refnamediv> - <refname>bcpow</refname> - <refpurpose> - Raise an arbitrary precision number to another - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>bcpow</methodname> - <methodparam><type>string</type><parameter>x</parameter></methodparam> - <methodparam><type>string</type><parameter>y</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> - </methodsynopsis> - <para> - Raise <parameter>x</parameter> to the power - <parameter>y</parameter>. The optional - <parameter>scale</parameter> can be used to set the number of - digits after the decimal place in the result. - </para> - </refsect1> - <refsect1> - &reftitle.examples; - <example> - <title><function>bcpow</function> example</title> - <programlisting role="php"> +<refentry id="function.bcpow"> + <refnamediv> + <refname>bcpow</refname> + <refpurpose>Raise an arbitrary precision number to another</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>bcpow</methodname> + <methodparam><type>string</type><parameter>x</parameter></methodparam> + <methodparam><type>string</type><parameter>y</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> + <para> + Raise <parameter>x</parameter> to the power + <parameter>y</parameter>. The optional + <parameter>scale</parameter> can be used to set the number of + digits after the decimal place in the result. + </para> + </refsect1> + <refsect1> + &reftitle.examples; + <example> + <title><function>bcpow</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -35,17 +33,17 @@ ?> ]]> - </programlisting> - </example> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>bcpowmod</function>&listendand; - <function>bcsqrt</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>bcpowmod</function>&listendand; + <function>bcsqrt</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcpowmod.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/bc/functions/bcpowmod.xml diff -u phpdoc/en/reference/bc/functions/bcpowmod.xml:1.6 phpdoc/en/reference/bc/functions/bcpowmod.xml:1.7 --- phpdoc/en/reference/bc/functions/bcpowmod.xml:1.6 Fri Aug 20 09:36:58 2004 +++ phpdoc/en/reference/bc/functions/bcpowmod.xml Sat Jan 27 00:21:08 2007 @@ -1,66 +1,64 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> - <refentry id="function.bcpowmod"> - <refnamediv> - <refname>bcpowmod</refname> - <refpurpose> - Raise an arbitrary precision number to another, reduced by a specified modulus - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>bcpowmod</methodname> - <methodparam><type>string</type><parameter>x</parameter></methodparam> - <methodparam><type>string</type><parameter>y</parameter></methodparam> - <methodparam><type>string</type><parameter>modulus</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> - </methodsynopsis> - <para> - Use the fast-exponentiation method to raise <parameter>x</parameter> - to the power <parameter>y</parameter> with respect to the modulus - <parameter>modulus</parameter>. The optional - <parameter>scale</parameter> can be used to set the number of - digits after the decimal place in the result. - </para> - <note> - <para> - Because this method uses the modulus operation, non-natural numbers - may give unexpected results. A natural number is any positive - non-zero integer. - </para> - </note> - </refsect1> - <refsect1> - &reftitle.examples; - <para> - The following two statements are functionally identical. The - <function>bcpowmod</function> version however, executes in - less time and can accept larger parameters. - <informalexample> - <programlisting role="php"> +<!-- $Revision: 1.7 $ --> +<refentry id="function.bcpowmod"> + <refnamediv> + <refname>bcpowmod</refname> + <refpurpose>Raise an arbitrary precision number to another, reduced by a specified modulus</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>bcpowmod</methodname> + <methodparam><type>string</type><parameter>x</parameter></methodparam> + <methodparam><type>string</type><parameter>y</parameter></methodparam> + <methodparam><type>string</type><parameter>modulus</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> + <para> + Use the fast-exponentiation method to raise <parameter>x</parameter> + to the power <parameter>y</parameter> with respect to the modulus + <parameter>modulus</parameter>. The optional + <parameter>scale</parameter> can be used to set the number of + digits after the decimal place in the result. + </para> + <note> + <para> + Because this method uses the modulus operation, non-natural numbers + may give unexpected results. A natural number is any positive + non-zero integer. + </para> + </note> + </refsect1> + <refsect1> + &reftitle.examples; + <para> + The following two statements are functionally identical. The + <function>bcpowmod</function> version however, executes in + less time and can accept larger parameters. + <informalexample> + <programlisting role="php"> <![CDATA[ <?php $a = bcpowmod($x, $y, $mod); $b = bcmod(bcpow($x, $y), $mod); -// $a and $b are equal to each other. +// $a and $b are equal to each other. ?> ]]> - </programlisting> - </informalexample> - </para> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>bcpow</function>&listendand; - <function>bcmod</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </informalexample> + </para> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>bcpow</function>&listendand; + <function>bcmod</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcscale.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/bc/functions/bcscale.xml diff -u phpdoc/en/reference/bc/functions/bcscale.xml:1.7 phpdoc/en/reference/bc/functions/bcscale.xml:1.8 --- phpdoc/en/reference/bc/functions/bcscale.xml:1.7 Mon Jul 4 07:24:19 2005 +++ phpdoc/en/reference/bc/functions/bcscale.xml Sat Jan 27 00:21:08 2007 @@ -1,30 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> - <refentry id="function.bcscale"> - <refnamediv> - <refname>bcscale</refname> - <refpurpose> - Set default scale parameter for all bc math functions - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcscale</methodname> - <methodparam><type>int</type><parameter>scale</parameter></methodparam> - </methodsynopsis> - <para> - This function sets the default scale parameter for all subsequent - bc math functions that do not explicitly specify a scale - parameter. &return.success; - </para> - </refsect1> - <refsect1> - &reftitle.examples; - <example> - <title><function>bcscale</function> example</title> - <programlisting role="php"> +<refentry id="function.bcscale"> + <refnamediv> + <refname>bcscale</refname> + <refpurpose>Set default scale parameter for all bc math functions</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcscale</methodname> + <methodparam><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> + <para> + This function sets the default scale parameter for all subsequent + bc math functions that do not explicitly specify a scale + parameter. &return.success; + </para> + </refsect1> + <refsect1> + &reftitle.examples; + <example> + <title><function>bcscale</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -37,10 +35,10 @@ ?> ]]> - </programlisting> - </example> - </refsect1> - </refentry> + </programlisting> + </example> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcsqrt.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/bc/functions/bcsqrt.xml diff -u phpdoc/en/reference/bc/functions/bcsqrt.xml:1.5 phpdoc/en/reference/bc/functions/bcsqrt.xml:1.6 --- phpdoc/en/reference/bc/functions/bcsqrt.xml:1.5 Mon Jul 4 07:24:19 2005 +++ phpdoc/en/reference/bc/functions/bcsqrt.xml Sat Jan 27 00:21:08 2007 @@ -1,31 +1,29 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> - <refentry id="function.bcsqrt"> - <refnamediv> - <refname>bcsqrt</refname> - <refpurpose> - Get the square root of an arbitrary precision number - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>bcsqrt</methodname> - <methodparam><type>string</type><parameter>operand</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> - </methodsynopsis> - <para> - Return the square root of the <parameter>operand</parameter>. - The optional <parameter>scale</parameter> parameter sets the - number of digits after the decimal place in the result. - </para> - </refsect1> - <refsect1> - &reftitle.examples; - <example> - <title><function>bcsqrt</function> example</title> - <programlisting role="php"> +<refentry id="function.bcsqrt"> + <refnamediv> + <refname>bcsqrt</refname> + <refpurpose>Get the square root of an arbitrary precision number</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>bcsqrt</methodname> + <methodparam><type>string</type><parameter>operand</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> + <para> + Return the square root of the <parameter>operand</parameter>. + The optional <parameter>scale</parameter> parameter sets the + number of digits after the decimal place in the result. + </para> + </refsect1> + <refsect1> + &reftitle.examples; + <example> + <title><function>bcsqrt</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -33,16 +31,16 @@ ?> ]]> - </programlisting> - </example> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>bcpow</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>bcpow</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcsub.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/bc/functions/bcsub.xml diff -u phpdoc/en/reference/bc/functions/bcsub.xml:1.5 phpdoc/en/reference/bc/functions/bcsub.xml:1.6 --- phpdoc/en/reference/bc/functions/bcsub.xml:1.5 Mon Jul 4 07:24:19 2005 +++ phpdoc/en/reference/bc/functions/bcsub.xml Sat Jan 27 00:21:08 2007 @@ -1,55 +1,53 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> - <refentry id="function.bcsub"> - <refnamediv> - <refname>bcsub</refname> - <refpurpose> - Subtract one arbitrary precision number from another - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>bcsub</methodname> - <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> - <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> - </methodsynopsis> - <para> - Subtracts the <parameter>right_operand</parameter> from the - <parameter>left_operand</parameter> and returns the result in a - string. The optional <parameter>scale</parameter> parameter is - used to set the number of digits after the decimal place in the - result. - </para> - </refsect1> - <refsect1> - &reftitle.examples; - <example> - <title><function>bcsub</function> example</title> - <programlisting role="php"> +<refentry id="function.bcsub"> + <refnamediv> + <refname>bcsub</refname> + <refpurpose>Subtract one arbitrary precision number from another</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>bcsub</methodname> + <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> + <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> + <para> + Subtracts the <parameter>right_operand</parameter> from the + <parameter>left_operand</parameter> and returns the result in a + string. The optional <parameter>scale</parameter> parameter is + used to set the number of digits after the decimal place in the + result. + </para> + </refsect1> + <refsect1> + &reftitle.examples; + <example> + <title><function>bcsub</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $a = '1.234'; $b = '5'; - + echo bcsub($a, $b); // -3 echo bcsub($a, $b, 4); // -3.7660 ?> ]]> - </programlisting> - </example> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>bcadd</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>bcadd</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: