mirror of
https://github.com/php/doc-en.git
synced 2026-04-26 08:48:10 +02:00
Gina Peter Banyard
111 lines
2.7 KiB
XML
111 lines
2.7 KiB
XML
<?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
|
|
-->
|