Permalink
Browse files

Update docs.

  • Loading branch information...
1 parent 129a987 commit b87a85de5e60d01730814f6f355bb93bd28b7db3 @bos committed Jun 29, 2011
Showing with 24 additions and 3 deletions.
  1. +5 −0 Data/Double/Conversion/ByteString.hs
  2. +3 −0 Data/Double/Conversion/Text.hs
  3. +16 −3 double-conversion.cabal
@@ -9,6 +9,11 @@
--
-- 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
(
@@ -11,6 +11,9 @@
--
-- 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
(
@@ -13,9 +13,22 @@ synopsis: Fast conversion between double precision floating point and text
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

0 comments on commit b87a85d

Please sign in to comment.