<?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 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.bcpowmod.php',
    1 => 'bcpowmod',
    2 => '任意精度数値のべき乗の、指定した数値による剰余',
  ),
  'up' => 
  array (
    0 => 'ref.bc.php',
    1 => 'BC Math 関数',
  ),
  'prev' => 
  array (
    0 => 'function.bcpow.php',
    1 => 'bcpow',
  ),
  'next' => 
  array (
    0 => 'function.bcround.php',
    1 => 'bcround',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    '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">任意精度数値のべき乗の、指定した数値による剰余</span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-function.bcpowmod-description">
  <h3 class="title">説明</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">
   <code class="parameter">modulus</code> で割った余りを求めることを考慮して、
   <code class="parameter">num</code> の
   <code class="parameter">exponent</code> 乗を高速に計算します。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.bcpowmod-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">num</code></dt>
     <dd>
      <p class="para">
       基数を表す整数の文字列。
       (つまり、scale は 0 でなければいけません)
      </p>
     </dd>
    
    
     <dt><code class="parameter">exponent</code></dt>
     <dd>
      <p class="para">
       指数を表す、負でない、整数の文字列。
       (つまり、scale は 0 でなければいけません)
      </p>
     </dd>
    
    
     <dt><code class="parameter">modulus</code></dt>
     <dd>
      <p class="para">
       法を表す、整数の文字列。
       (つまり、scale は 0 でなければいけません)
      </p>
     </dd>
    
    
     <dt><code class="parameter">scale</code></dt>
     <dd>
      <span class="simpara">
       結果の小数点以下の桁数を指定します。<strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> の場合は、 <span class="function"><a href="function.bcscale.php" class="function">bcscale()</a></span> 関数でグローバルに
       設定した桁数をデフォルトとして使用します。
       それも設定されていない場合は <a href="bc.configuration.php#ini.bcmath.scale" class="link"><code class="literal">bcmath.scale</code></a>
       INI ディレクティブの値を使用します。
      </span>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.bcpowmod-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   結果を文字列で返します。
  </p>
 </div>

 
 <div class="refsect1 errors" id="refsect1-function.bcpowmod-errors">
  <h3 class="title">エラー / 例外</h3>
  <p class="para">
   この関数は、以下の場合に <span class="exceptionname"><a href="class.valueerror.php" class="exceptionname">ValueError</a></span> をスローします:
   <ul class="simplelist">
    <li><code class="parameter">num</code> か <code class="parameter">exponent</code> か <code class="parameter">modulus</code> のいずれかが、BCMath で有効でない数値形式の文字列である場合</li>
    <li><code class="parameter">num</code> か <code class="parameter">exponent</code> か <code class="parameter">modulus</code> のいずれかが整数値でない場合</li>
    <li><code class="parameter">exponent</code> が負の値である場合</li>
    <li><code class="parameter">scale</code> が範囲外の値である場合</li>
   </ul>
  </p>
  <p class="simpara">
   この関数は、<code class="parameter">modulus</code> の値が <code class="literal">0</code> である場合、
   <span class="exceptionname"><a href="class.divisionbyzeroerror.php" class="exceptionname">DivisionByZeroError</a></span> 例外をスローします。
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.bcpowmod-changelog">
  <h3 class="title">変更履歴</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>バージョン</th>
      <th>説明</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">scale</code> は、nullable になりました。
      </td>
     </tr>

     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">exponent</code> が負の値の場合、<strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返す代わりに <span class="exceptionname"><a href="class.valueerror.php" class="exceptionname">ValueError</a></span> をスローするようになりました。
      </td>
     </tr>

     <tr>
      <td>8.0.0</td>
      <td>
       <code class="literal">0</code> 除算を行うと、<span class="exceptionname"><a href="class.divisionbyzeroerror.php" class="exceptionname">DivisionByZeroError</a></span>
       例外がスローされるようになりました。以前は <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">例</h3>
  <p class="para">
   以下の 2 つの文は機能的に同じです。しかし
   <span class="function"><strong>bcpowmod()</strong></span> バージョンのほうが実行時間が早いうえ、
   より大きな値の計算が可能です。
   <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 と $b は同じ値になります<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">注意</h3>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <p class="para">
    このメソッドでは剰余計算を行っているので、
    正の整数以外を指定すると予期せぬ結果となります。
   </p>
  </p></blockquote>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.bcpowmod-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.bcpow.php" class="function" rel="rdfs-seeAlso">bcpow()</a> - 任意精度数値をべき乗する</span></li>
    <li><span class="function"><a href="function.bcmod.php" class="function" rel="rdfs-seeAlso">bcmod()</a> - 2 つの任意精度数値の剰余を取得する</span></li>
    <li><span class="methodname"><a href="bcmath-number.powmod.php" class="methodname" rel="rdfs-seeAlso">BcMath\Number::powmod()</a> - 任意精度数値のべき乗の、指定した数値による剰余</span></li>
   </ul>
  </p>
 </div>

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