<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.bc.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.bcpowmod.php',
    1 => 'bcpowmod',
    2 => 'Eleva um n&uacute;mero de precis&atilde;o arbitr&aacute;ria para outro, reduzido por um m&oacute;dulo especificado',
  ),
  'up' => 
  array (
    0 => 'ref.bc.php',
    1 => 'BC Math Fun&ccedil;&otilde;es',
  ),
  'prev' => 
  array (
    0 => 'function.bcpow.php',
    1 => 'bcpow',
  ),
  'next' => 
  array (
    0 => 'function.bcround.php',
    1 => 'bcround',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/bc/functions/bcpowmod.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.bcpowmod" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">bcpowmod</h1>
  <p class="verinfo">(PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">bcpowmod</span> &mdash; <span class="dc-title">Eleva um número de precisão arbitrária para outro, reduzido por um módulo especificado</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.bcpowmod-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>bcpowmod</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$num</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$exponent</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$modulus</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></span> <code class="parameter">$scale</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span><br>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

  <p class="para rdfs-comment">
   Utiliza o método de exponenciação rápida para elevar
   <code class="parameter">num</code> à potência
   <code class="parameter">exponent</code> levando em conta o módulo
   <code class="parameter">modulus</code>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.bcpowmod-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">num</code></dt>
     <dd>
      <p class="para">
       A base, na forma de inteiro em string (a escala tem que ser zero).
      </p>
     </dd>
    
    
     <dt><code class="parameter">exponent</code></dt>
     <dd>
      <p class="para">
       O expoente, na forma de um inteiro não negativo, em string (a escala tem que ser zero).
      </p>
     </dd>
    
    
     <dt><code class="parameter">modulus</code></dt>
     <dd>
      <p class="para">
       O  módulo, na forma de um inteiro em string (a escala tem que ser zero).
      </p>
     </dd>
    
    
     <dt><code class="parameter">scale</code></dt>
     <dd>
      <span class="simpara">
       Este parâmetro é usado para definir o número de dígitos após o separador de decimais do resultado.
       Se for <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>, será usada a escala padrão definida com <span class="function"><a href="function.bcscale.php" class="function">bcscale()</a></span>,
       ou será usado o valor da diretiva INI
       <a href="bc.configuration.php#ini.bcmath.scale" class="link"><code class="literal">bcmath.scale</code></a>.
      </span>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.bcpowmod-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Retorna o resultado como uma string.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.bcpowmod-errors">
  <h3 class="title">Erros/Exceções</h3>
  <p class="para">
   Esta função lança uma exceção <span class="exceptionname"><a href="class.valueerror.php" class="exceptionname">ValueError</a></span> nos seguintes casos:
   <ul class="simplelist">
    <li><code class="parameter">num</code>, <code class="parameter">exponent</code> ou <code class="parameter">modulus</code> não é uma string numérica BCMath bem formada</li>
    <li><code class="parameter">num</code>, <code class="parameter">exponent</code> ou <code class="parameter">modulus</code> tem uma parte fracionária</li>
    <li><code class="parameter">exponent</code> é um valor negativo</li>
    <li><code class="parameter">scale</code> está fora do intervalo válido</li>
   </ul>
  </p>
  <p class="simpara">
   Esta função lança uma exceção <span class="exceptionname"><a href="class.divisionbyzeroerror.php" class="exceptionname">DivisionByZeroError</a></span> se <code class="parameter">modulus</code>
   for igual a <code class="literal">0</code>.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.bcpowmod-changelog">
  <h3 class="title">Registro de Alterações</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Versão</th>
      <th>Descrição</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">scale</code> agora pode ser nulo.
      </td>
     </tr>

     <tr>
      <td>8.0.0</td>
      <td>
       Agora lança uma exceção <span class="exceptionname"><a href="class.valueerror.php" class="exceptionname">ValueError</a></span> ao invés de retornar <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> se <code class="parameter">exponent</code> for negativo.
      </td>
     </tr>

     <tr>
      <td>8.0.0</td>
      <td>
       Dividir por <code class="literal">0</code> agora lança uma exceção <span class="exceptionname"><a href="class.divisionbyzeroerror.php" class="exceptionname">DivisionByZeroError</a></span> ao invés de retornar <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.bcpowmod-examples">
  <h3 class="title">Exemplos</h3>
  <p class="para">
   As seguintes instruções têm funcionalidades idênticas. A versão
   <span class="function"><strong>bcpowmod()</strong></span>, no entanto, executa em
   menos tempo e pode aceitar parâmetros maiores.
   <div class="informalexample">
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$a </span><span style="color: #007700">= </span><span style="color: #0000BB">bcpowmod</span><span style="color: #007700">(</span><span style="color: #0000BB">$x</span><span style="color: #007700">, </span><span style="color: #0000BB">$y</span><span style="color: #007700">, </span><span style="color: #0000BB">$mod</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$b </span><span style="color: #007700">= </span><span style="color: #0000BB">bcmod</span><span style="color: #007700">(</span><span style="color: #0000BB">bcpow</span><span style="color: #007700">(</span><span style="color: #0000BB">$x</span><span style="color: #007700">, </span><span style="color: #0000BB">$y</span><span style="color: #007700">), </span><span style="color: #0000BB">$mod</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// $a e $b são iguais.<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 notes" id="refsect1-function.bcpowmod-notes">
  <h3 class="title">Notas</h3>
  <blockquote class="note"><p><strong class="note">Nota</strong>: 
   <p class="para">
    Por esse método realizar operações em módulo, números que não sejam
    inteiros positivos podem gerar resultados inesperados.
   </p>
  </p></blockquote>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.bcpowmod-seealso">
  <h3 class="title">Veja Também</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.bcpow.php" class="function" rel="rdfs-seeAlso">bcpow()</a> - Eleva um n&uacute;mero de precis&atilde;o arbitr&aacute;ria a outro</span></li>
    <li><span class="function"><a href="function.bcmod.php" class="function" rel="rdfs-seeAlso">bcmod()</a> - Obt&eacute;m o resto de uma divis&atilde;o com precis&atilde;o arbitr&aacute;ria</span></li>
    <li><span class="methodname"><a href="bcmath-number.powmod.php" class="methodname" rel="rdfs-seeAlso">BcMath\Number::powmod()</a> - Eleva um n&uacute;mero de precis&atilde;o arbitr&aacute;ria, reduzido por um m&oacute;dulo especificado</span></li>
   </ul>
  </p>
 </div>

</div><?php manual_footer($setup); ?>