Commits

Bryan O'Sullivan committed 465f482

Update docs.

  • Participants
  • Parent commits 783730e

Comments (0)

Files changed (3)

File Data/Double/Conversion/ByteString.hs

 --
 -- Fast, efficient support for converting between double precision
 -- floating point values and text.
+--
+-- Although about 15 times faster than plain 'show', these functions
+-- are /slower/ than their 'Text' counterparts, at roughly half the
+-- speed.  (This seems to be due to the cost of allocating
+-- 'ByteString' values via @malloc@.)
 
 module Data.Double.Conversion.ByteString
     (

File Data/Double/Conversion/Text.hs

 --
 -- Fast, efficient support for converting between double precision
 -- floating point values and text.
+--
+-- These functions are about 30 times faster than the default 'show'
+-- implementation for the 'Double' type.
 
 module Data.Double.Conversion.Text
     (

File double-conversion.cabal

 cabal-version:  >= 1.8
 build-type:     Simple
 description:
-    A library that performs fast conversion between double precision
-    floating point and text, implemented as bindings to the C++
-    double-conversion library written by Florian Loitsch at Google.
+    A library that performs fast, accurate conversion between double
+    precision floating point and text.
+    .
+    This library is implemented as bindings to the C++
+    @double-conversion@ library written by Florian Loitsch at Google:
+    <http://code.google.com/p/double-conversion/>.
+    .
+    The 'Text' versions of these functions are about 30 times faster
+    than the default 'show' implementation for the 'Double' type.
+    .
+    The 'ByteString' versions are /slower/ than the 'Text' versions;
+    roughly half the speed.  (This seems to be due to the cost of
+    allocating 'ByteString' values via @malloc@.)
+    .
+    As a final note, be aware that the @bytestring-show@ package is
+    about 50% slower than simply using 'show'.
 
 extra-source-files:
     README.markdown