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

<refentry xml:id="function.bcpow" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">

<refnamediv>

<refname>bcpow</refname>

<refpurpose>任意精度数字的乘方</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>string</type><methodname>bcpow</methodname>

<methodparam><type>string</type><parameter>num</parameter></methodparam>

<methodparam><type>string</type><parameter>exponent</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> 次方运算。

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

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

<listitem>

<para>

string 类型的底数。

</para>

</listitem>

</varlistentry>

<varlistentry>

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

<listitem>

<para>

string 类型的指数。必须是没有小数部分的值。指数的有效范围取决于平台，但起码支持

<literal>-2147483648</literal> 到 <literal>2147483647</literal> 的范围。

</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> 不是格式正确的 BCMath 数字字符串</member>

<member><parameter>exponent</parameter> 有小数部分</member>

<member><parameter>exponent</parameter> 或 <parameter>scale</parameter> 超出有效范围</member>

</simplelist>

</para>

<simpara>

如果 <parameter>num</parameter> 为 <literal>0</literal> 且 <parameter>exponent</parameter>

为负值，则此函数抛出 <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.4.0</entry>

<entry>

<literal>0</literal> 的负幂以前返回 <literal>0</literal>，但现在会引发 <exceptionname>DivisionByZeroError</exceptionname> 异常。

</entry>

</row>

<row>

<entry>8.0.0</entry>

<entry>

当 <parameter>exponent</parameter> 有小数部分时，现在会抛出 <exceptionname>ValueError</exceptionname> 而不是截断。

</entry>

</row>

<row>

<entry>7.3.0</entry>

<entry>

现在 <function>bcpow</function> 可以按想要的小数点位数返回数字。

而之前，返回的数字会忽略尾随零（trailing decimal zeroes）。

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1><!-- }}} -->

<refsect1 role="examples">

&reftitle.examples;

<example>

<title><function>bcpow</function> 示例</title>

<programlisting role="php">

</programlisting>

</example>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

<note>

<para>

PHP 7.3.0 之前，<function>bcpow</function> 返回的结果，小数点后的小数位数可能比 <parameter>scale</parameter>

参数指定的少。只有当结果不需要 <parameter>scale</parameter> 允许的所有小数位数时，才会发生这种情况。例如：

<example>

<title><function>bcpow</function> 小数位数示例</title>

<programlisting role="php">

</programlisting>

</example>

</para>

</note>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>bcpowmod</function></member>

<member><function>bcsqrt</function></member>

<member><methodname>BcMath\Number::pow</methodname></member>

</simplelist>

</para>

</refsect1>

</refentry>