<?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>Potenz einer Zahl beliebiger Genauigkeit</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>

Potenziert <parameter>num</parameter> mit

<parameter>exponent</parameter>.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

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

<listitem>

<para>

Die Basis als Zeichenkette.

</para>

</listitem>

</varlistentry>

<varlistentry>

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

<listitem>

<para>

Der Exponent in Form einer Zeichenkette; muss ein Wert ohne

Nachkommastelle sein.

Der gültige Bereich des Exponenten ist plattformabhängig, ist allerdings

mindestens <literal>-2147483648</literal> bis

<literal>2147483647</literal>.

</para>

</listitem>

</varlistentry>

<xi:include xpointer="function.bcadd..parameters.scale" />

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Gibt das Ergebnis als Zeichenkette zurück.

</para>

</refsect1>

<refsect1 role="errors">

&reftitle.errors;

<para>

In den folgenden Fällen löst diese Funktion einen

<exceptionname>ValueError</exceptionname> aus:

<simplelist>

<member><parameter>num</parameter> oder <parameter>exponent</parameter> ist keine wohlgeformte numerische BCMath-Zeichenkette</member>

<member><parameter>exponent</parameter> hat eine Nachkommastelle</member>

<member><parameter>exponent</parameter> oder <parameter>scale</parameter> liegt außerhalb des gültigen Bereichs</member>

</simplelist>

</para>

<simpara>

Wenn <parameter>num</parameter> <literal>0</literal> ist und

<parameter>exponent</parameter> ein negativer Wert ist, löst diese Funktion

eine <exceptionname>DivisionByZeroError</exceptionname>-Exception aus.

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

Bei negativen Potenzen von <literal>0</literal> wurde bisher

<literal>0</literal> zurückgegeben, nun wird eine

<exceptionname>DivisionByZeroError</exceptionname>-Exception ausgelöst.

</entry>

</row>

<row>

<entry>8.0.0</entry>

<entry>

Wenn <parameter>exponent</parameter> eine Nachkommastelle hat, wird nun

ein <exceptionname>ValueError</exceptionname> ausgelöst, anstatt den

Wert abzuschneiden.

</entry>

</row>

<row>

<entry>7.3.0</entry>

<entry>

<function>bcpow</function> gibt nun Zahlen mit den angeforderten

Nachkommastellen zurück. Zuvor haben die zurückgegebenen Zahlen

möglicherweise abschließende Dezimalnullen ausgelassen.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

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

<refsect1 role="examples">

&reftitle.examples;

<example>

<title><function>bcpow</function>-Beispiel</title>

<programlisting role="php">

</programlisting>

</example>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

<note>

<para>

Vor PHP 7.3.0 kann <function>bcpow</function> ein Ergebnis mit weniger

Nachkommastellen zurückgeben, als der Parameter

<parameter>scale</parameter> angibt. Dies geschieht nur, wenn das Ergebnis

nicht die gesamte durch <parameter>scale</parameter> erlaubte Genauigkeit

erfordert. Zum Beispiel:

<example>

<title><function>bcpow</function> Genauigkeitsbeispiel</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>