From e8558faecb38ec88ef62084d468e3ac36e355b4a Mon Sep 17 00:00:00 2001
From: Jeroen van Wolffelaar <jeroen@php.net>
Date: Sat, 4 Aug 2001 13:08:04 +0000
Subject: [PATCH] New pow() documentation to reflect 407-changes

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@53263 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/math.xml | 39 +++++++++++++++++++++++++++++++++------
 1 file changed, 33 insertions(+), 6 deletions(-)

diff --git a/functions/math.xml b/functions/math.xml
index c7d4200aa3..a54a30c6f4 100644
--- a/functions/math.xml
+++ b/functions/math.xml
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.39 $ -->
+<!-- $Revision: 1.40 $ -->
  <reference id="ref.math">
   <title>Mathematical Functions</title>
   <titleabbrev>Math</titleabbrev>
@@ -974,16 +974,42 @@ echo pi();
     <title>Description</title>
     <funcsynopsis>
      <funcprototype>
-      <funcdef>float <function>pow</function></funcdef>
-      <paramdef>float <parameter>base</parameter></paramdef>
-      <paramdef>float <parameter>exp</parameter></paramdef>
+      <funcdef>number <function>pow</function></funcdef>
+      <paramdef>number <parameter>base</parameter></paramdef>
+      <paramdef>number <parameter>exp</parameter></paramdef>
      </funcprototype>
     </funcsynopsis>
     <para>
      Returns <parameter>base</parameter> raised to the power of 
-     <parameter>exp</parameter>. If this can't be computed, 
-     <function>exp</function> will return <literal>NAN</literal>.
+     <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;.
+    </para>
+    <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>.
     </para>
@@ -1219,4 +1245,5 @@ sgml-exposed-tags:nil
 sgml-local-catalogs:nil
 sgml-local-ecat-files:nil
 End:
+vim: ts=4 sw=4 et syntax=sgml
 -->