mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-24 04:48:55 +00:00
40abc0dac4
While we're at it, we also update the following example. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@339951 c90b9560-bf6c-de11-be94-00142212c4b1
123 lines
3 KiB
XML
123 lines
3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.pow" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>pow</refname>
|
|
<refpurpose>Exponential expression</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>number</type><methodname>pow</methodname>
|
|
<methodparam><type>number</type><parameter>base</parameter></methodparam>
|
|
<methodparam><type>number</type><parameter>exp</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns <parameter>base</parameter> raised to the power of
|
|
<parameter>exp</parameter>.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
In PHP 5.6 onwards, you may prefer to use the
|
|
<link linkend="language.operators.arithmetic">**</link> operator.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>base</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The base to use
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>exp</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The exponent
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
<parameter>base</parameter> raised to the power of <parameter>exp</parameter>.
|
|
If both arguments are non-negative integers and the result can be represented
|
|
as an integer, the result will be returned with <type>integer</type> type,
|
|
otherwise it will be returned as a <type>float</type>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Some examples of <function>pow</function></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
var_dump(pow(2, 8)); // int(256)
|
|
echo pow(-1, 20); // 1
|
|
echo pow(0, 0); // 1
|
|
echo pow(10, -1); // 0.1
|
|
|
|
echo pow(-1, 5.5); // PHP >=5.2.2: NAN
|
|
echo pow(-1, 5.5); // PHP <5.2.2: -NAN
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
This function will convert all input to a number, even non-scalar values,
|
|
which could lead to <literal>weird</literal> results.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<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>
|
|
|
|
<!-- 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
|
|
-->
|