pollita Tue Dec 10 15:33:42 2002 EDT
Added files:
/phpdoc/en/reference/bc/functions bc-powmod.xml
Modified files:
/phpdoc/en/reference/bc/functions bcpow.xml
Log:
Documentation for new function bc_powmod() and additiona 'see also' for bcpow()
Index: phpdoc/en/reference/bc/functions/bcpow.xml
diff -u phpdoc/en/reference/bc/functions/bcpow.xml:1.2
phpdoc/en/reference/bc/functions/bcpow.xml:1.3
--- phpdoc/en/reference/bc/functions/bcpow.xml:1.2 Wed Apr 17 02:36:33 2002
+++ phpdoc/en/reference/bc/functions/bcpow.xml Tue Dec 10 15:33:41 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 -->
<refentry id="function.bcpow">
<refnamediv>
@@ -23,7 +23,8 @@
digits after the decimal place in the result.
</para>
<para>
- See also <function>bcsqrt</function>.
+ See also <function>bc_powmod</function>, and
+ <function>bcsqrt</function>.
</para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/bc/functions/bc-powmod.xml
+++ phpdoc/en/reference/bc/functions/bc-powmod.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/bcpow.xml, last change in rev 1.2 -->
<refentry id="function.bc-powmod">
<refnamediv>
<refname>bc_powmod</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>bc_powmod</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>
<simpara>
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.
</simpara>
<para>
The following two statements are functionally identical. The
<function>bc_powmod</function> version however, executes in
less time and can accept larger parameters.
<informalexample>
<programlisting>
<![CDATA[
bc_powmod($x,$y,$mod)
bcmod(bcpow($x,$y),$mod)
]]>
</programlisting>
</informalexample>
</para>
<para>
<note>
<simpara>
Because this method uses the modulus operation, non-natural numbers
may give unexpected results. A natural number is any positive
non-zero integer.
</simpara>
</note>
</para>
<para>
See also <function>bcpow</function>, and
<function>bcmod</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
