<?xml version="1.0" encoding="utf-8"?>

<!-- EN-Revision: 3295741565f760edd22e305bd10e37f243e9e194 Maintainer: tmn Status: ready -->

<!-- Reviewed: no -->

<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>num</parameter>

в степень <parameter>exponent</parameter> методом быстрого возведения в степень

и возвращает остаток от деления степени числа на модуль числа в аргументе <parameter>modulus</parameter>.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>num</parameter></term>

<listitem>

<para>

Основание степени в виде строки с целым числом, без дробной части.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>exponent</parameter></term>

<listitem>

<para>

Показатель степени в виде строки с неотрицательным целым числом, без дробной части.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>modulus</parameter></term>

<listitem>

<para>

Неполное кратное в виде строки с целым числом, без дробной части.

</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>

Функция выбрасывает ошибку <exceptionname>DivisionByZeroError</exceptionname>,

если значение аргумента <parameter>modulus</parameter> равняется <literal>0</literal>.

</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> теперь принимает значение &null;.

</entry>

</row>

<row>

<entry>8.0.0</entry>

<entry>

Функция теперь выбрасывает ошибку <exceptionname>ValueError</exceptionname> вместо возврата значения &false;,

если показатель степени <parameter>exponent</parameter> оказался отрицательным значением.

</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>

Следующие выражения дают одинаковый результат. Однако функция

<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

-->