From 5279b3af4efee5d3e7d9755f0f06bd7b0f5dd05c Mon Sep 17 00:00:00 2001
From: Lukas Larsson <lukas@erlang-solutions.com>
Date: Fri, 8 Feb 2013 18:23:22 +0100
Subject: Add float_to_binary and binary_to_float

---
 erts/doc/src/erlang.xml | 53 ++++++++++++++++++++++++++++++++++++-------------
 1 file changed, 39 insertions(+), 14 deletions(-)

(limited to 'erts/doc')

diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml
index 36d606130f..06fefa8efb 100644
--- a/erts/doc/src/erlang.xml
+++ b/erts/doc/src/erlang.xml
@@ -299,6 +299,18 @@
         <p>Failure: <c>badarg</c> if the atom does not already exist.</p>
       </desc>
     </func>
+    <func>
+      <name name="binary_to_float" arity="1"/>
+      <fsummary>Convert from text representation to a float</fsummary>
+      <desc>
+        <p>Returns the float whose text representation is <c><anno>Binary</anno></c>.</p>
+        <pre>
+> <input>binary_to_float(&lt;&lt;"2.2017764e+0">>).</input>
+2.2017764</pre>
+        <p>Failure: <c>badarg</c> if <c><anno>Binary</anno></c> contains a bad
+          representation of a float.</p>
+      </desc>
+    </func>
     <func>
       <name name="binary_to_integer" arity="1"/>
       <fsummary>Convert from text representation to an integer</fsummary>
@@ -987,26 +999,38 @@ true
       </desc>
     </func>
     <func>
-      <name name="float_to_list" arity="1"/>
+      <name name="float_to_binary" arity="1"/>
       <fsummary>Text representation of a float</fsummary>
       <desc>
-        <p>Returns a string which corresponds to the text
-          representation of <c><anno>Float</anno></c>.</p>
+        <p>The same as <c>float_to_binary(<anno>Float</anno>,[{scientific,20}])</c>.</p>
+      </desc>
+    </func>
+    <func>
+      <name name="float_to_binary" arity="2"/>
+      <fsummary>Text representation of a float formatted using given options</fsummary>
+      <desc>
+        <p>Returns a binary which corresponds to the text
+          representation of <c><anno>Float</anno></c> using fixed decimal 
+	  point formatting. The <c><anno>Options</anno></c> behave in the same
+	  way as <seealso marker="#float_to_list/2">float_to_list/2</seealso>.
+	</p>
         <pre>
-> <input>float_to_list(7.0).</input>
-"7.00000000000000000000e+00"</pre>
+> <input>float_to_binary(7.12, [{decimals, 4}]).</input>
+&lt;&lt;"7.1200">>
+> <input>float_to_binary(7.12, [{decimals, 4}, compact]).</input>
+&lt;&lt;"7.12">></pre>
+      </desc>
+    </func>
+    <func>
+      <name name="float_to_list" arity="1"/>
+      <fsummary>Text representation of a float</fsummary>
+      <desc>
+	<p>The same as <c>float_to_list(<anno>Float</anno>,[{scientific,20}])</c>.</p>
       </desc>
     </func>
     <func>
-      <name>float_to_list(Float, Options) -> string()</name>
+      <name name="float_to_list" arity="2"/>
       <fsummary>Text representation of a float formatted using given options</fsummary>
-      <type>
-        <v>Float = float()</v>
-        <v>Options = [Option]</v>
-        <v>Option = {decimals, Decimals::0..253} |
-                    {scientific, Decimals::0..249} |
-                    compact</v>
-      </type>
       <desc>
         <p>Returns a string which corresponds to the text
           representation of <c>Float</c> using fixed decimal point formatting.
@@ -1019,7 +1043,8 @@ true
           only meaningful together with the <c>decimals</c> option). When
           <c>scientific</c> option is provided, the float will be formatted using
           scientific notation with <c>Decimals</c> digits of precision. If
-          <c>Options</c> is <c>[]</c> the function behaves like <c>float_to_list/1</c>.
+          <c>Options</c> is <c>[]</c> the function behaves like 
+	  <c><seealso marker="#float_to_list/1">float_to_list/1</seealso></c>.
           </p>
         <pre>
 > <input>float_to_list(7.12, [{decimals, 4}]).</input>
-- 
cgit v1.2.3