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

<refentry xml:id="function.pow" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>pow</refname>

<refpurpose>Возводит число в степень</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>int</type><type>float</type><type>object</type></type><methodname>pow</methodname>

<methodparam><type>mixed</type><parameter>num</parameter></methodparam>

<methodparam><type>mixed</type><parameter>exponent</parameter></methodparam>

</methodsynopsis>

<para>

Функция возвращает число <parameter>num</parameter> в степени <parameter>exponent</parameter>.

</para>

<note>

<para>

Вместо вызова функции указывают оператор <link linkend="language.operators.arithmetic">**</link>.

</para>

</note>

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

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Функция возвращает основание <parameter>num</parameter> в степени <parameter>exponent</parameter>.

Функция возвращает целое число (<type>int</type>), если оба аргумента —

неотрицательные целые числа и функция сумеет представить результат как целое число,

иначе функция возвращает число с плавающей точкой (<type>float</type>).

</para>

<para>

PHP-модули иногда переопределяют поведение операции и заставляют её возвращать объект.

</para>

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

Передача в аргументе <parameter>exponent</parameter> отрицательного значения

для возведения <literal>0</literal> в отрицательную степень устарела.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Примеры возведения числа в степень функцией <function>pow</function></title>

<programlisting role="php">

</programlisting>

</example>

</para>

<para>

<example>

<title>Пример работы функции <function>pow</function> с объектом модуля GMP</title>

<programlisting role="php" annotations="non-interactive">

</programlisting>

</example>

</para>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

<note>

<para>

Функция преобразовывает входные данные в числа, даже нескалярные значения,

что иногда даёт <emphasis>странные</emphasis> результаты.

</para>

</note>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member>

<link linkend="language.operators.arithmetic"><literal>**</literal></link> — Оператор возведения в степень

</member>

<member><function>fpow</function></member>

<member><function>exp</function></member>

<member><function>sqrt</function></member>

<member><function>bcpow</function></member>

<member><function>gmp_pow</function></member>

</simplelist>

</para>

</refsect1>

</refentry>