cvs: phpdoc /en language-snippets.ent /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 16:51:45 +0000 |
| Subject: | cvs: phpdoc /en language-snippets.ent /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-969375041@lists.php.net to get a copy of this message | ||
didou Sat Jan 27 16:51:45 2007 UTC
Modified files:
/phpdoc/en language-snippets.ent
/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:
ref.bc: switch to new style
http://cvs.php.net/viewvc.cgi/phpdoc/en/language-snippets.ent?r1=1.186&r2=1.187&diff_format=u Index: phpdoc/en/language-snippets.ent diff -u phpdoc/en/language-snippets.ent:1.186 phpdoc/en/language-snippets.ent:1.187 --- phpdoc/en/language-snippets.ent:1.186 Mon Jan 22 01:59:05 2007 +++ phpdoc/en/language-snippets.ent Sat Jan 27 16:51:44 2007 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.186 $ --> +<!-- $Revision: 1.187 $ --> <!-- Keep 'em sorted --> @@ -488,6 +488,11 @@ functional traces (TIMING, FUNCTIONS, ARGS SUMMARY (like strace -c)) use the value 99</para> </listitem></varlistentry>'> +<!-- BCMath Notes --> +<!ENTITY bc.scale.description '<varlistentry><term><parameter> +scale</parameter></term><listitem><para>This optional parameter is used to set the number +of digits after the decimal place in the result. You can also set the global default scale +for all functions by using <function>bcscale</function>.</para></listitem></varlistentry>'> <!-- FBSQL Notes --> <!ENTITY fbsql.link-identifier.description '<varlistentry><term><parameter> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcadd.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/bc/functions/bcadd.xml diff -u phpdoc/en/reference/bc/functions/bcadd.xml:1.6 phpdoc/en/reference/bc/functions/bcadd.xml:1.7 --- phpdoc/en/reference/bc/functions/bcadd.xml:1.6 Sat Jan 27 00:21:08 2007 +++ phpdoc/en/reference/bc/functions/bcadd.xml Sat Jan 27 16:51:44 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.bcadd"> <refnamediv> <refname>bcadd</refname> <refpurpose>Add two arbitrary precision numbers</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bcadd</methodname> <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> @@ -15,14 +15,44 @@ <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. + Sums <parameter>left_operand</parameter> and + <parameter>right_operand</parameter>. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>left_operand</parameter></term> + <listitem> + <para> + The left operand, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>right_operand</parameter></term> + <listitem> + <para> + The right operand, as a string. + </para> + </listitem> + </varlistentry> + &bc.scale.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The sum of the two operands, as a string. + </para> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title><function>bcadd</function> example</title> @@ -41,10 +71,13 @@ </programlisting> </example> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bcsub</function>. + <simplelist> + <member><function>bcsub</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bccomp.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/bc/functions/bccomp.xml diff -u phpdoc/en/reference/bc/functions/bccomp.xml:1.5 phpdoc/en/reference/bc/functions/bccomp.xml:1.6 --- phpdoc/en/reference/bc/functions/bccomp.xml:1.5 Sat Jan 27 00:21:08 2007 +++ phpdoc/en/reference/bc/functions/bccomp.xml Sat Jan 27 16:51:44 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.bccomp"> <refnamediv> <refname>bccomp</refname> <refpurpose>Compare two arbitrary precision numbers</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>bccomp</methodname> <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> @@ -17,17 +17,54 @@ <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. + integer. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>left_operand</parameter></term> + <listitem> + <para> + The left operand, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>right_operand</parameter></term> + <listitem> + <para> + The right operand, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>scale</parameter></term> + <listitem> + <para> + 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. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns 0 if the two operands are equal, 1 if the + <parameter>left_operand</parameter> is larger than the + <parameter>right_operand</parameter>, -1 otherwise. + </para> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title><function>bccomp</function> example</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcdiv.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/bc/functions/bcdiv.xml diff -u phpdoc/en/reference/bc/functions/bcdiv.xml:1.7 phpdoc/en/reference/bc/functions/bcdiv.xml:1.8 --- phpdoc/en/reference/bc/functions/bcdiv.xml:1.7 Sat Jan 27 00:21:08 2007 +++ phpdoc/en/reference/bc/functions/bcdiv.xml Sat Jan 27 16:51:44 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.bcdiv"> <refnamediv> <refname>bcdiv</refname> <refpurpose>Divide two arbitrary precision numbers</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bcdiv</methodname> <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> @@ -16,12 +16,44 @@ </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. + <parameter>right_operand</parameter>. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>left_operand</parameter></term> + <listitem> + <para> + The left operand, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>right_operand</parameter></term> + <listitem> + <para> + The right operand, as a string. + </para> + </listitem> + </varlistentry> + &bc.scale.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the result of the division as a string, or &null; if + <parameter>right_operand</parameter> is 0. + </para> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title><function>bcdiv</function> example</title> @@ -36,10 +68,13 @@ </programlisting> </example> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bcmul</function>. + <simplelist> + <member><function>bcmul</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcmod.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/bc/functions/bcmod.xml diff -u phpdoc/en/reference/bc/functions/bcmod.xml:1.6 phpdoc/en/reference/bc/functions/bcmod.xml:1.7 --- phpdoc/en/reference/bc/functions/bcmod.xml:1.6 Sat Jan 27 00:21:08 2007 +++ phpdoc/en/reference/bc/functions/bcmod.xml Sat Jan 27 16:51:44 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.bcmod"> <refnamediv> <refname>bcmod</refname> <refpurpose>Get modulus of an arbitrary precision number</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bcmod</methodname> <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> @@ -18,7 +18,40 @@ <parameter>modulus</parameter>. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>left_operand</parameter></term> + <listitem> + <para> + The left operand, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>modulus</parameter></term> + <listitem> + <para> + The modulus, as a string. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the modulus as a string, or &null; if + <parameter>modulus</parameter> is 0. + </para> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title><function>bcmod</function> example</title> @@ -32,10 +65,13 @@ </programlisting> </example> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bcdiv</function>. + <simplelist> + <member><function>bcdiv</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcmul.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/bc/functions/bcmul.xml diff -u phpdoc/en/reference/bc/functions/bcmul.xml:1.7 phpdoc/en/reference/bc/functions/bcmul.xml:1.8 --- phpdoc/en/reference/bc/functions/bcmul.xml:1.7 Sat Jan 27 00:21:08 2007 +++ phpdoc/en/reference/bc/functions/bcmul.xml Sat Jan 27 16:51:44 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.bcmul"> <refnamediv> <refname>bcmul</refname> <refpurpose>Multiply two arbitrary precision number</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bcmul</methodname> <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> @@ -16,12 +16,43 @@ </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). + <parameter>right_operand</parameter>. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>left_operand</parameter></term> + <listitem> + <para> + The left operand, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>right_operand</parameter></term> + <listitem> + <para> + The right operand, as a string. + </para> + </listitem> + </varlistentry> + &bc.scale.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the result as a string. + </para> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title><function>bcmul</function> example</title> @@ -35,10 +66,13 @@ </programlisting> </example> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bcdiv</function>. + <simplelist> + <member><function>bcdiv</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcpow.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/bc/functions/bcpow.xml diff -u phpdoc/en/reference/bc/functions/bcpow.xml:1.10 phpdoc/en/reference/bc/functions/bcpow.xml:1.11 --- phpdoc/en/reference/bc/functions/bcpow.xml:1.10 Sat Jan 27 00:21:08 2007 +++ phpdoc/en/reference/bc/functions/bcpow.xml Sat Jan 27 16:51:44 2007 @@ -1,27 +1,58 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> -<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.11 $ --> <refentry id="function.bcpow"> <refnamediv> <refname>bcpow</refname> <refpurpose>Raise an arbitrary precision number to another</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bcpow</methodname> - <methodparam><type>string</type><parameter>x</parameter></methodparam> - <methodparam><type>string</type><parameter>y</parameter></methodparam> + <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> - 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. + Raise <parameter>left_operand</parameter> to the power + <parameter>right_operand</parameter>. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>left_operand</parameter></term> + <listitem> + <para> + The left operand, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>right_operand</parameter></term> + <listitem> + <para> + The right operand, as a string. + </para> + </listitem> + </varlistentry> + &bc.scale.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the result as a string. + </para> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title><function>bcpow</function> example</title> @@ -36,11 +67,14 @@ </programlisting> </example> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bcpowmod</function>&listendand; - <function>bcsqrt</function>. + <simplelist> + <member><function>bcpowmod</function></member> + <member><function>bcsqrt</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcpowmod.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/bc/functions/bcpowmod.xml diff -u phpdoc/en/reference/bc/functions/bcpowmod.xml:1.7 phpdoc/en/reference/bc/functions/bcpowmod.xml:1.8 --- phpdoc/en/reference/bc/functions/bcpowmod.xml:1.7 Sat Jan 27 00:21:08 2007 +++ phpdoc/en/reference/bc/functions/bcpowmod.xml Sat Jan 27 16:51:44 2007 @@ -1,26 +1,70 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <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> + + <refsect1 role="description"> + &reftitle.description; <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>left_operand</parameter></methodparam> + <methodparam><type>string</type><parameter>right_operand</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. + Use the fast-exponentiation method to raise + <parameter>left_operand</parameter> to the power + <parameter>right_operand</parameter> with respect to the modulus + <parameter>modulus</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>left_operand</parameter></term> + <listitem> + <para> + The left operand, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>right_operand</parameter></term> + <listitem> + <para> + The right operand, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>modulus</parameter></term> + <listitem> + <para> + The modulus, as a string. + </para> + </listitem> + </varlistentry> + &bc.scale.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the result as a string. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> Because this method uses the modulus operation, non-natural numbers @@ -29,7 +73,8 @@ </para> </note> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <para> The following two statements are functionally identical. The @@ -51,11 +96,14 @@ </informalexample> </para> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bcpow</function>&listendand; - <function>bcmod</function>. + <simplelist> + <member><function>bcpow</function></member> + <member><function>bcmod</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcscale.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/bc/functions/bcscale.xml diff -u phpdoc/en/reference/bc/functions/bcscale.xml:1.8 phpdoc/en/reference/bc/functions/bcscale.xml:1.9 --- phpdoc/en/reference/bc/functions/bcscale.xml:1.8 Sat Jan 27 00:21:08 2007 +++ phpdoc/en/reference/bc/functions/bcscale.xml Sat Jan 27 16:51:44 2007 @@ -1,28 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> -<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.9 $ --> <refentry id="function.bcscale"> <refnamediv> <refname>bcscale</refname> <refpurpose>Set default scale parameter for all bc math functions</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <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; + Sets the default scale parameter for all subsequent bc math functions that + do not explicitly specify a scale parameter. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>scale</parameter></term> + <listitem> + <para> + The scale factor. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; - <example> - <title><function>bcscale</function> example</title> - <programlisting role="php"> + <para> + <example> + <title><function>bcscale</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -35,8 +59,9 @@ ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcsqrt.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/bc/functions/bcsqrt.xml diff -u phpdoc/en/reference/bc/functions/bcsqrt.xml:1.6 phpdoc/en/reference/bc/functions/bcsqrt.xml:1.7 --- phpdoc/en/reference/bc/functions/bcsqrt.xml:1.6 Sat Jan 27 00:21:08 2007 +++ phpdoc/en/reference/bc/functions/bcsqrt.xml Sat Jan 27 16:51:44 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.bcsqrt"> <refnamediv> <refname>bcsqrt</refname> <refpurpose>Get the square root of an arbitrary precision number</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bcsqrt</methodname> <methodparam><type>string</type><parameter>operand</parameter></methodparam> @@ -15,11 +15,34 @@ </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> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>operand</parameter></term> + <listitem> + <para> + The operand, as a string. + </para> + </listitem> + </varlistentry> + &bc.scale.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the square root, as a string. + </para> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title><function>bcsqrt</function> example</title> @@ -34,10 +57,13 @@ </programlisting> </example> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bcpow</function>. + <simplelist> + <member><function>bcpow</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcsub.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/bc/functions/bcsub.xml diff -u phpdoc/en/reference/bc/functions/bcsub.xml:1.6 phpdoc/en/reference/bc/functions/bcsub.xml:1.7 --- phpdoc/en/reference/bc/functions/bcsub.xml:1.6 Sat Jan 27 00:21:08 2007 +++ phpdoc/en/reference/bc/functions/bcsub.xml Sat Jan 27 16:51:44 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.bcsub"> <refnamediv> <refname>bcsub</refname> <refpurpose>Subtract one arbitrary precision number from another</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bcsub</methodname> <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> @@ -16,13 +16,43 @@ </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. + <parameter>left_operand</parameter>. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>left_operand</parameter></term> + <listitem> + <para> + The left operand, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>right_operand</parameter></term> + <listitem> + <para> + The right operand, as a string. + </para> + </listitem> + </varlistentry> + &bc.scale.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The result of the substraction, as a string. + </para> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title><function>bcsub</function> example</title> @@ -41,10 +71,13 @@ </programlisting> </example> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bcadd</function>. + <simplelist> + <member><function>bcadd</function></member> + </simplelist> </para> </refsect1> </refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/language-snippets.ent?r1=1.186&r2=1.187&diff_format=u Index: phpdoc/en/language-snippets.ent diff -u phpdoc/en/language-snippets.ent:1.186 phpdoc/en/language-snippets.ent:1.187 --- phpdoc/en/language-snippets.ent:1.186 Mon Jan 22 01:59:05 2007 +++ phpdoc/en/language-snippets.ent Sat Jan 27 16:51:44 2007 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.186 $ --> +<!-- $Revision: 1.187 $ --> <!-- Keep 'em sorted --> @@ -488,6 +488,11 @@ functional traces (TIMING, FUNCTIONS, ARGS SUMMARY (like strace -c)) use the value 99</para> </listitem></varlistentry>'> +<!-- BCMath Notes --> +<!ENTITY bc.scale.description '<varlistentry><term><parameter> +scale</parameter></term><listitem><para>This optional parameter is used to set the number +of digits after the decimal place in the result. You can also set the global default scale +for all functions by using <function>bcscale</function>.</para></listitem></varlistentry>'> <!-- FBSQL Notes --> <!ENTITY fbsql.link-identifier.description '<varlistentry><term><parameter> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcadd.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/bc/functions/bcadd.xml diff -u phpdoc/en/reference/bc/functions/bcadd.xml:1.6 phpdoc/en/reference/bc/functions/bcadd.xml:1.7 --- phpdoc/en/reference/bc/functions/bcadd.xml:1.6 Sat Jan 27 00:21:08 2007 +++ phpdoc/en/reference/bc/functions/bcadd.xml Sat Jan 27 16:51:44 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.bcadd"> <refnamediv> <refname>bcadd</refname> <refpurpose>Add two arbitrary precision numbers</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bcadd</methodname> <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> @@ -15,14 +15,44 @@ <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. + Sums <parameter>left_operand</parameter> and + <parameter>right_operand</parameter>. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>left_operand</parameter></term> + <listitem> + <para> + The left operand, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>right_operand</parameter></term> + <listitem> + <para> + The right operand, as a string. + </para> + </listitem> + </varlistentry> + &bc.scale.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The sum of the two operands, as a string. + </para> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title><function>bcadd</function> example</title> @@ -41,10 +71,13 @@ </programlisting> </example> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bcsub</function>. + <simplelist> + <member><function>bcsub</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bccomp.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/bc/functions/bccomp.xml diff -u phpdoc/en/reference/bc/functions/bccomp.xml:1.5 phpdoc/en/reference/bc/functions/bccomp.xml:1.6 --- phpdoc/en/reference/bc/functions/bccomp.xml:1.5 Sat Jan 27 00:21:08 2007 +++ phpdoc/en/reference/bc/functions/bccomp.xml Sat Jan 27 16:51:44 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.bccomp"> <refnamediv> <refname>bccomp</refname> <refpurpose>Compare two arbitrary precision numbers</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>bccomp</methodname> <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> @@ -17,17 +17,54 @@ <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. + integer. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>left_operand</parameter></term> + <listitem> + <para> + The left operand, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>right_operand</parameter></term> + <listitem> + <para> + The right operand, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>scale</parameter></term> + <listitem> + <para> + 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. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns 0 if the two operands are equal, 1 if the + <parameter>left_operand</parameter> is larger than the + <parameter>right_operand</parameter>, -1 otherwise. + </para> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title><function>bccomp</function> example</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcdiv.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/bc/functions/bcdiv.xml diff -u phpdoc/en/reference/bc/functions/bcdiv.xml:1.7 phpdoc/en/reference/bc/functions/bcdiv.xml:1.8 --- phpdoc/en/reference/bc/functions/bcdiv.xml:1.7 Sat Jan 27 00:21:08 2007 +++ phpdoc/en/reference/bc/functions/bcdiv.xml Sat Jan 27 16:51:44 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.bcdiv"> <refnamediv> <refname>bcdiv</refname> <refpurpose>Divide two arbitrary precision numbers</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bcdiv</methodname> <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> @@ -16,12 +16,44 @@ </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. + <parameter>right_operand</parameter>. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>left_operand</parameter></term> + <listitem> + <para> + The left operand, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>right_operand</parameter></term> + <listitem> + <para> + The right operand, as a string. + </para> + </listitem> + </varlistentry> + &bc.scale.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the result of the division as a string, or &null; if + <parameter>right_operand</parameter> is 0. + </para> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title><function>bcdiv</function> example</title> @@ -36,10 +68,13 @@ </programlisting> </example> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bcmul</function>. + <simplelist> + <member><function>bcmul</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcmod.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/bc/functions/bcmod.xml diff -u phpdoc/en/reference/bc/functions/bcmod.xml:1.6 phpdoc/en/reference/bc/functions/bcmod.xml:1.7 --- phpdoc/en/reference/bc/functions/bcmod.xml:1.6 Sat Jan 27 00:21:08 2007 +++ phpdoc/en/reference/bc/functions/bcmod.xml Sat Jan 27 16:51:44 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.bcmod"> <refnamediv> <refname>bcmod</refname> <refpurpose>Get modulus of an arbitrary precision number</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bcmod</methodname> <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> @@ -18,7 +18,40 @@ <parameter>modulus</parameter>. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>left_operand</parameter></term> + <listitem> + <para> + The left operand, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>modulus</parameter></term> + <listitem> + <para> + The modulus, as a string. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the modulus as a string, or &null; if + <parameter>modulus</parameter> is 0. + </para> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title><function>bcmod</function> example</title> @@ -32,10 +65,13 @@ </programlisting> </example> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bcdiv</function>. + <simplelist> + <member><function>bcdiv</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcmul.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/bc/functions/bcmul.xml diff -u phpdoc/en/reference/bc/functions/bcmul.xml:1.7 phpdoc/en/reference/bc/functions/bcmul.xml:1.8 --- phpdoc/en/reference/bc/functions/bcmul.xml:1.7 Sat Jan 27 00:21:08 2007 +++ phpdoc/en/reference/bc/functions/bcmul.xml Sat Jan 27 16:51:44 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.bcmul"> <refnamediv> <refname>bcmul</refname> <refpurpose>Multiply two arbitrary precision number</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bcmul</methodname> <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> @@ -16,12 +16,43 @@ </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). + <parameter>right_operand</parameter>. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>left_operand</parameter></term> + <listitem> + <para> + The left operand, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>right_operand</parameter></term> + <listitem> + <para> + The right operand, as a string. + </para> + </listitem> + </varlistentry> + &bc.scale.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the result as a string. + </para> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title><function>bcmul</function> example</title> @@ -35,10 +66,13 @@ </programlisting> </example> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bcdiv</function>. + <simplelist> + <member><function>bcdiv</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcpow.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/bc/functions/bcpow.xml diff -u phpdoc/en/reference/bc/functions/bcpow.xml:1.10 phpdoc/en/reference/bc/functions/bcpow.xml:1.11 --- phpdoc/en/reference/bc/functions/bcpow.xml:1.10 Sat Jan 27 00:21:08 2007 +++ phpdoc/en/reference/bc/functions/bcpow.xml Sat Jan 27 16:51:44 2007 @@ -1,27 +1,58 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> -<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.11 $ --> <refentry id="function.bcpow"> <refnamediv> <refname>bcpow</refname> <refpurpose>Raise an arbitrary precision number to another</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bcpow</methodname> - <methodparam><type>string</type><parameter>x</parameter></methodparam> - <methodparam><type>string</type><parameter>y</parameter></methodparam> + <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> - 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. + Raise <parameter>left_operand</parameter> to the power + <parameter>right_operand</parameter>. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>left_operand</parameter></term> + <listitem> + <para> + The left operand, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>right_operand</parameter></term> + <listitem> + <para> + The right operand, as a string. + </para> + </listitem> + </varlistentry> + &bc.scale.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the result as a string. + </para> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title><function>bcpow</function> example</title> @@ -36,11 +67,14 @@ </programlisting> </example> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bcpowmod</function>&listendand; - <function>bcsqrt</function>. + <simplelist> + <member><function>bcpowmod</function></member> + <member><function>bcsqrt</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcpowmod.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/bc/functions/bcpowmod.xml diff -u phpdoc/en/reference/bc/functions/bcpowmod.xml:1.7 phpdoc/en/reference/bc/functions/bcpowmod.xml:1.8 --- phpdoc/en/reference/bc/functions/bcpowmod.xml:1.7 Sat Jan 27 00:21:08 2007 +++ phpdoc/en/reference/bc/functions/bcpowmod.xml Sat Jan 27 16:51:44 2007 @@ -1,26 +1,70 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <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> + + <refsect1 role="description"> + &reftitle.description; <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>left_operand</parameter></methodparam> + <methodparam><type>string</type><parameter>right_operand</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. + Use the fast-exponentiation method to raise + <parameter>left_operand</parameter> to the power + <parameter>right_operand</parameter> with respect to the modulus + <parameter>modulus</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>left_operand</parameter></term> + <listitem> + <para> + The left operand, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>right_operand</parameter></term> + <listitem> + <para> + The right operand, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>modulus</parameter></term> + <listitem> + <para> + The modulus, as a string. + </para> + </listitem> + </varlistentry> + &bc.scale.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the result as a string. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> Because this method uses the modulus operation, non-natural numbers @@ -29,7 +73,8 @@ </para> </note> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <para> The following two statements are functionally identical. The @@ -51,11 +96,14 @@ </informalexample> </para> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bcpow</function>&listendand; - <function>bcmod</function>. + <simplelist> + <member><function>bcpow</function></member> + <member><function>bcmod</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcscale.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/bc/functions/bcscale.xml diff -u phpdoc/en/reference/bc/functions/bcscale.xml:1.8 phpdoc/en/reference/bc/functions/bcscale.xml:1.9 --- phpdoc/en/reference/bc/functions/bcscale.xml:1.8 Sat Jan 27 00:21:08 2007 +++ phpdoc/en/reference/bc/functions/bcscale.xml Sat Jan 27 16:51:44 2007 @@ -1,28 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> -<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.9 $ --> <refentry id="function.bcscale"> <refnamediv> <refname>bcscale</refname> <refpurpose>Set default scale parameter for all bc math functions</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <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; + Sets the default scale parameter for all subsequent bc math functions that + do not explicitly specify a scale parameter. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>scale</parameter></term> + <listitem> + <para> + The scale factor. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; - <example> - <title><function>bcscale</function> example</title> - <programlisting role="php"> + <para> + <example> + <title><function>bcscale</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -35,8 +59,9 @@ ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcsqrt.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/bc/functions/bcsqrt.xml diff -u phpdoc/en/reference/bc/functions/bcsqrt.xml:1.6 phpdoc/en/reference/bc/functions/bcsqrt.xml:1.7 --- phpdoc/en/reference/bc/functions/bcsqrt.xml:1.6 Sat Jan 27 00:21:08 2007 +++ phpdoc/en/reference/bc/functions/bcsqrt.xml Sat Jan 27 16:51:44 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.bcsqrt"> <refnamediv> <refname>bcsqrt</refname> <refpurpose>Get the square root of an arbitrary precision number</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bcsqrt</methodname> <methodparam><type>string</type><parameter>operand</parameter></methodparam> @@ -15,11 +15,34 @@ </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> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>operand</parameter></term> + <listitem> + <para> + The operand, as a string. + </para> + </listitem> + </varlistentry> + &bc.scale.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the square root, as a string. + </para> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title><function>bcsqrt</function> example</title> @@ -34,10 +57,13 @@ </programlisting> </example> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bcpow</function>. + <simplelist> + <member><function>bcpow</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bc/functions/bcsub.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/bc/functions/bcsub.xml diff -u phpdoc/en/reference/bc/functions/bcsub.xml:1.6 phpdoc/en/reference/bc/functions/bcsub.xml:1.7 --- phpdoc/en/reference/bc/functions/bcsub.xml:1.6 Sat Jan 27 00:21:08 2007 +++ phpdoc/en/reference/bc/functions/bcsub.xml Sat Jan 27 16:51:44 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.bcsub"> <refnamediv> <refname>bcsub</refname> <refpurpose>Subtract one arbitrary precision number from another</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bcsub</methodname> <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> @@ -16,13 +16,43 @@ </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. + <parameter>left_operand</parameter>. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>left_operand</parameter></term> + <listitem> + <para> + The left operand, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>right_operand</parameter></term> + <listitem> + <para> + The right operand, as a string. + </para> + </listitem> + </varlistentry> + &bc.scale.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The result of the substraction, as a string. + </para> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title><function>bcsub</function> example</title> @@ -41,10 +71,13 @@ </programlisting> </example> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bcadd</function>. + <simplelist> + <member><function>bcadd</function></member> + </simplelist> </para> </refsect1> </refentry>