1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
|
<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="function.fpow" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>fpow</refname>
<refpurpose>Raise one number to the power of another, according to IEEE 754</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>float</type><methodname>fpow</methodname>
<methodparam><type>float</type><parameter>num</parameter></methodparam>
<methodparam><type>float</type><parameter>exponent</parameter></methodparam>
</methodsynopsis>
<simpara>
Returns the floating point result of raising
<parameter>num</parameter> to the power of <parameter>exponent</parameter>.
If <parameter>num</parameter> is zero and <parameter>exponent</parameter>
is less than zero, then <constant>INF</constant> is returned.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>num</parameter></term>
<listitem>
<simpara>
The base to use.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>exponent</parameter></term>
<listitem>
<simpara>
The exponent.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Returns a <type>float</type> corresponding to
<code>$num<superscript>$exponent</superscript></code>.
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example xml:id="function.fpow.example.basic">
<title><function>fpow</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
var_dump(fpow(10, 2));
var_dump(fpow(0, -3));
var_dump(fpow(-1, 5.5));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
float(100)
float(INF)
float(NAN)
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member>
Exponentiation operator
<link linkend="language.operators.arithmetic"><literal>**</literal></link>
</member>
<member><function>pow</function></member>
<member><function>fdiv</function></member>
<member><function>fmod</function></member>
</simplelist>
</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
-->
|