Skip to content

Commit b0a8da1

Browse files
GirgiasGirgias
committed
PHP-8.4: Document fpow()
1 parent b6c220c commit b0a8da1

File tree

4 files changed

+117
-2
lines changed

4 files changed

+117
-2
lines changed

‎reference/math/functions/fdiv.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,9 @@ var_dump(fdiv(0.0, 0.0)); // float(NAN)
7676
&reftitle.seealso;
7777
<para>
7878
<simplelist>
79-
<member><link linkend="language.operators.arithmetic"><literal>/</literal></link> - Floating-point division</member>
8079
<member><function>intdiv</function> - Integer division</member>
81-
<member><function>fmod</function> - Modulus</member>
80+
<member><function>fmod</function></member>
81+
<member><function>fpow</function></member>
8282
</simplelist>
8383
</para>
8484
</refsect1>

‎reference/math/functions/fpow.xml

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<refentry xml:id="function.fpow" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
3+
<refnamediv>
4+
<refname>fpow</refname>
5+
<refpurpose>Raise one number to the power of another, according to IEEE 754</refpurpose>
6+
</refnamediv>
7+
8+
<refsect1 role="description">
9+
&reftitle.description;
10+
<methodsynopsis>
11+
<type>float</type><methodname>fpow</methodname>
12+
<methodparam><type>float</type><parameter>num1</parameter></methodparam>
13+
<methodparam><type>float</type><parameter>num2</parameter></methodparam>
14+
</methodsynopsis>
15+
<simpara>
16+
Returns the floating point result of raising
17+
<parameter>num1</parameter> to the power of <parameter>num2</parameter>.
18+
If <parameter>num1</parameter> is zero and <parameter>num2</parameter>
19+
is less than zero, then <constant>INF</constant> is returned.
20+
</simpara>
21+
</refsect1>
22+
23+
<refsect1 role="parameters">
24+
&reftitle.parameters;
25+
<simpara>
26+
<variablelist>
27+
<varlistentry>
28+
<term><parameter>num1</parameter></term>
29+
<listitem>
30+
<simpara>
31+
The base to number.
32+
</simpara>
33+
</listitem>
34+
</varlistentry>
35+
<varlistentry>
36+
<term><parameter>num2</parameter></term>
37+
<listitem>
38+
<simpara>
39+
The exponent.
40+
</simpara>
41+
</listitem>
42+
</varlistentry>
43+
</variablelist>
44+
</simpara>
45+
</refsect1>
46+
47+
<refsect1 role="returnvalues">
48+
&reftitle.returnvalues;
49+
<simpara>
50+
Returns a <type>float</type> corresponding to
51+
<literal><parameter>num1</parameter><superscript><parameter>num2</parameter></superscript></literal>.
52+
</simpara>
53+
</refsect1>
54+
55+
<refsect1 role="examples">
56+
&reftitle.examples;
57+
<example xml:id="function.fpow.example.basic">
58+
<title><function>fpow</function> example</title>
59+
<simpara>
60+
Description.
61+
</simpara>
62+
<programlisting role="php">
63+
<![CDATA[
64+
<?php
65+
var_dump(fpow(0, -3));
66+
var_dump(fpow(-1, 5.5));
67+
?>
68+
]]>
69+
</programlisting>
70+
&example.outputs;
71+
<screen>
72+
<![CDATA[
73+
float(INF)
74+
float(NAN)
75+
]]>
76+
</screen>
77+
</example>
78+
</refsect1>
79+
80+
<refsect1 role="seealso">
81+
&reftitle.seealso;
82+
<simplelist>
83+
<member><link linkend="language.operators.arithmetic"><literal>/</literal></link> - Floating-point division</member>
84+
<member><function>pow</function></member>
85+
<member><function>fdiv</function></member>
86+
<member><function>fmod</function></member>
87+
<!-- TODO ** operator link?
88+
<member><link linkend="some.id.chunk.to.link">something appendix</link></member>
89+
-->
90+
</simplelist>
91+
</refsect1>
92+
93+
</refentry>
94+
<!-- Keep this comment at the end of the file
95+
Local variables:
96+
mode: sgml
97+
sgml-omittag:t
98+
sgml-shorttag:t
99+
sgml-minimize-attributes:nil
100+
sgml-always-quote-attributes:t
101+
sgml-indent-step:1
102+
sgml-indent-data:t
103+
indent-tabs-mode:nil
104+
sgml-parent-document:nil
105+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
106+
sgml-exposed-tags:nil
107+
sgml-local-catalogs:nil
108+
sgml-local-ecat-files:nil
109+
End:
110+
vim600: syn=xml fen fdm=syntax fdl=2 si
111+
vim: et tw=78 syn=sgml
112+
vi: ts=1 sw=1
113+
-->

‎reference/math/functions/pow.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ echo pow(-1, 5.5); // NAN
9595
&reftitle.seealso;
9696
<para>
9797
<simplelist>
98+
<member><function>fpow</function></member>
9899
<member><function>exp</function></member>
99100
<member><function>sqrt</function></member>
100101
<member><function>bcpow</function></member>

‎reference/math/versions.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
<function name="fdiv" from="PHP 8"/>
2727
<function name="floor" from="PHP 4, PHP 5, PHP 7, PHP 8"/>
2828
<function name="fmod" from="PHP 4 &gt;= 4.2.0, PHP 5, PHP 7, PHP 8"/>
29+
<function name="fpow" from="PHP 8 &gt;= 8.4.0"/>
2930
<function name="hexdec" from="PHP 4, PHP 5, PHP 7, PHP 8"/>
3031
<function name="hypot" from="PHP 4 &gt;= 4.1.0, PHP 5, PHP 7, PHP 8"/>
3132
<function name="is_finite" from="PHP 4 &gt;= 4.2.0, PHP 5, PHP 7, PHP 8"/>

0 commit comments

Comments
 (0)