php-doc-en/reference/math/functions/pow.xml
Mehdi Achour e62b27dd06 Added title to examples
wrapped the see also lines (make it easy to translate)


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@153341 c90b9560-bf6c-de11-be94-00142212c4b1
2004-03-10 14:39:13 +00:00

82 lines
2.2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/math.xml, last change in rev 1.2 -->
<refentry id="function.pow">
<refnamediv>
<refname>pow</refname>
<refpurpose>Exponential expression</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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>. If possible, this function will
return an <type>integer</type>.
</para>
<para>
If the power cannot be computed, a warning will be issued,
and <function>pow</function> will return &false;. Since PHP 4.2.0
<function>pow</function> doesn't issue any warning.
</para>
<note>
<para>
PHP cannot handle negative <parameter>base</parameter>s.
</para>
</note>
<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(-1, 5.5); // error
?>
]]>
</programlisting>
</example>
<warning>
<para>
In PHP 4.0.6 and earlier <function>pow</function> always returned
a <type>float</type>, and did not issue warnings.
</para>
</warning>
<para>
See also:
<function>exp</function>,
<function>sqrt</function>,
<function>bcpow</function>, and
<function>gmp_pow</function>,
</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:"../../../../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
-->