reference/math/functions/pow.xml
fc174e8d6162091550edde46159917ee7e5a2e73
...
...
@@ -8,21 +8,26 @@
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
-
<type>number</type><methodname>pow</methodname>
12
-
<methodparam><type>number</type><parameter>base</parameter></methodparam>
13
-
<methodparam><type>number</type><parameter>exp</parameter></methodparam>
14
-
</methodsynopsis>
11
+
<type class="union"><type>int</type><type>float</type><type>object</type></type><methodname>pow</methodname>
12
+
<methodparam><type>mixed</type><parameter>num</parameter></methodparam>
13
+
<methodparam><type>mixed</type><parameter>exponent</parameter></methodparam>
14
+
</methodsynopsis>
15
15
<para>
16
-
Returns <parameter>base</parameter> raised to the power of
17
-
<parameter>exp</parameter>.
16
+
Returns <parameter>num</parameter> raised to the power of
17
+
<parameter>exponent</parameter>.
18
18
</para>
19
+
<note>
20
+
<para>
21
+
It is possible to use the <link linkend="language.operators.arithmetic">**</link> operator instead.
22
+
</para>
23
+
</note>
19
24
</refsect1>
20
25
<refsect1 role="parameters">
21
26
&reftitle.parameters;
22
27
<para>
23
28
<variablelist>
24
29
<varlistentry>
25
-
<term><parameter>base</parameter></term>
30
+
<term><parameter>num</parameter></term>
26
31
<listitem>
27
32
<para>
28
33
The base to use
...
...
@@ -30,7 +35,7 @@
30
35
</listitem>
31
36
</varlistentry>
32
37
<varlistentry>
33
-
<term><parameter>exp</parameter></term>
38
+
<term><parameter>exponent</parameter></term>
34
39
<listitem>
35
40
<para>
36
41
The exponent
...
...
@@ -43,43 +48,12 @@
43
48
<refsect1 role="returnvalues">
44
49
&reftitle.returnvalues;
45
50
<para>
46
-
<parameter>base</parameter> raised to the power of <parameter>exp</parameter>.
51
+
<parameter>num</parameter> raised to the power of <parameter>exponent</parameter>.
47
52
If both arguments are non-negative integers and the result can be represented
48
-
as an integer, the result will be returned with <type>integer</type> type,
53
+
as an integer, the result will be returned with <type>int</type> type,
49
54
otherwise it will be returned as a <type>float</type>.
50
55
</para>
51
56
</refsect1>
52
-
<refsect1 role="changelog">
53
-
&reftitle.changelog;
54
-
<para>
55
-
<informaltable>
56
-
<tgroup cols="2">
57
-
<thead>
58
-
<row>
59
-
<entry>&Version;</entry>
60
-
<entry>&Description;</entry>
61
-
</row>
62
-
</thead>
63
-
<tbody>
64
-
<row>
65
-
<entry>4.2.0</entry>
66
-
<entry>
67
-
No warning is emitted on errors, even if the value can't be computed.
68
-
</entry>
69
-
</row>
70
-
<row>
71
-
<entry>4.0.6</entry>
72
-
<entry>
73
-
The function will now return <type>integer</type> results if possible,
74
-
before this it always returned a <type>float</type> result. For older
75
-
versions, you may receive a bogus result for complex numbers.
76
-
</entry>
77
-
</row>
78
-
</tbody>
79
-
</tgroup>
80
-
</informaltable>
81
-
</para>
82
-
</refsect1>
83
57
<refsect1 role="examples">
84
58
&reftitle.examples;
85
59
<para>
...
...
@@ -92,9 +66,9 @@
92
66
var_dump(pow(2, 8)); // int(256)
93
67
echo pow(-1, 20); // 1
94
68
echo pow(0, 0); // 1
69
+
echo pow(10, -1); // 0.1
95
70

96
-
echo pow(-1, 5.5); // PHP >4.0.6 NAN
97
-
echo pow(-1, 5.5); // PHP <=4.0.6 1.#IND
71
+
echo pow(-1, 5.5); // NAN
98
72
?>
99
73
]]>
100
74
</programlisting>
...
...
@@ -107,7 +81,7 @@ echo pow(-1, 5.5); // PHP <=4.0.6 1.#IND
107
81
<note>
108
82
<para>
109
83
This function will convert all input to a number, even non-scalar values,
110
-
which could lead to <literal>weird</literal> results.
84
+
which could lead to <emphasis>weird</emphasis> results.
111
85
</para>
112
86
</note>
113
87
</refsect1>
...
...
@@ -124,7 +98,6 @@ echo pow(-1, 5.5); // PHP <=4.0.6 1.#IND
124
98
</para>
125
99
</refsect1>
126
100
</refentry>
127
-

128
101
<!-- Keep this comment at the end of the file
129
102
Local variables:
130
103
mode: sgml
131
104