<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.bcpowmod" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>bcpowmod</refname>
  <refpurpose>Raise an arbitrary precision number to another, reduced by a specified modulus</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>bcpowmod</methodname>
   <methodparam><type>string</type><parameter>num</parameter></methodparam>
   <methodparam><type>string</type><parameter>exponent</parameter></methodparam>
   <methodparam><type>string</type><parameter>modulus</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>scale</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Use the fast-exponentiation method to raise 
   <parameter>num</parameter> to the power
   <parameter>exponent</parameter> with respect to the modulus
   <parameter>modulus</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>num</parameter></term>
     <listitem>
      <para>
       The base, as an integral string (i.e. the scale has to be zero).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>exponent</parameter></term>
     <listitem>
      <para>
       The exponent, as an non-negative, integral string (i.e. the scale has to be zero).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>modulus</parameter></term>
     <listitem>
      <para>
       The modulus, as an integral string (i.e. the scale has to be zero).
      </para>
     </listitem>
    </varlistentry>
    &bc.scale.description;
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the result as a string, or &false; if <parameter>modulus</parameter>
   is <literal>0</literal> or <parameter>exponent</parameter> is negative.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>scale</parameter> is now nullable.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &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.

?>
]]>
    </programlisting>
   </informalexample>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Because this method uses the modulus operation, numbers which are not
    positive integers may give unexpected results.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>bcpow</function></member>
    <member><function>bcmod</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
