archived-doc-ja/reference/bc/functions/bcpowmod.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 3295741565f760edd22e305bd10e37f243e9e194 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.bcpowmod" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 <refnamediv>
  <refname>bcpowmod</refname>
  <refpurpose>任意精度数値のべき乗の、指定した数値による剰余</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>
   <parameter>modulus</parameter> で割った余りを求めることを考慮して、
   <parameter>num</parameter> の
   <parameter>exponent</parameter> 乗を高速に計算します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>num</parameter></term>
     <listitem>
      <para>
       基数を表す整数の文字列。
       (つまり、scale は 0 でなければいけません)
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>exponent</parameter></term>
     <listitem>
      <para>
       指数を表す、負でない、整数の文字列。
       (つまり、scale は 0 でなければいけません)
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>modulus</parameter></term>
     <listitem>
      <para>
       法を表す、整数の文字列。
       (つまり、scale は 0 でなければいけません)
      </para>
     </listitem>
    </varlistentry>
    <xi:include xpointer="function.bcadd..parameters.scale" />
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   結果を文字列で返します。
  </para>
 </refsect1>
 
 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   この関数は、以下の場合に <exceptionname>ValueError</exceptionname> をスローします:
   <simplelist>
    <member><parameter>num</parameter> か <parameter>exponent</parameter> か <parameter>modulus</parameter> のいずれかが、BCMath で有効でない数値形式の文字列である場合</member>
    <member><parameter>num</parameter> か <parameter>exponent</parameter> か <parameter>modulus</parameter> のいずれかが整数値でない場合</member>
    <member><parameter>exponent</parameter> が負の値である場合</member>
    <member><parameter>scale</parameter> が範囲外の値である場合</member>
   </simplelist>
  </para>
  <simpara>
   この関数は、<parameter>modulus</parameter> の値が <literal>0</literal> である場合、
   <exceptionname>DivisionByZeroError</exceptionname> 例外をスローします。
  </simpara>
 </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> は、nullable になりました。
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>exponent</parameter> が負の値の場合、&false; を返す代わりに <exceptionname>ValueError</exceptionname> をスローするようになりました。
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <literal>0</literal> 除算を行うと、<exceptionname>DivisionByZeroError</exceptionname>
       例外がスローされるようになりました。以前は &false; が返されていました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   以下の 2 つの文は機能的に同じです。しかし
   <function>bcpowmod</function> バージョンのほうが実行時間が早いうえ、
   より大きな値の計算が可能です。
   <informalexample>
    <programlisting role="php">
<![CDATA[
<?php
$a = bcpowmod($x, $y, $mod);

$b = bcmod(bcpow($x, $y), $mod);

// $a と $b は同じ値になります

?>
]]>
    </programlisting>
   </informalexample>
  </para>
 </refsect1>
 
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    このメソッドでは剰余計算を行っているので、
    正の整数以外を指定すると予期せぬ結果となります。
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>bcpow</function></member>
    <member><function>bcmod</function></member>
    <member><methodname>BcMath\Number::powmod</methodname></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
-->