scientific 0.3.6.2 → 0.3.8.1
raw patch · 9 files changed
Files
- bench/bench.hs +15/−0
- changelog +11/−0
- scientific.cabal +87/−73
- src/Data/ByteString/Builder/Scientific.hs +9/−22
- src/Data/Scientific.hs +59/−79
- src/Data/Text/Lazy/Builder/Scientific.hs +9/−18
- src/GHC/Integer/Compat.hs +9/−1
- src/Utils.hs +47/−0
- test/test.hs +7/−10
bench/bench.hs view
@@ -57,6 +57,21 @@ , bgroup "dangerouslyBig" $ benchToBoundedInteger dangerouslyBig , bgroup "64" $ benchToBoundedInteger 64 ]++ , bgroup "read"+ [ benchRead "123456789.123456789"+ , benchRead "12345678900000000000.12345678900000000000000000"+ , benchRead "12345678900000000000.12345678900000000000000000e1234"+ ]++ , bgroup "division"+ [ bench (show n ++ " / " ++ show d) $ nf (uncurry (/)) t+ | t@(n, d) <-+ [ (0.4 , 20.0)+ , (0.4e-100, 0.2e50)+ ] :: [(Scientific, Scientific)]+ ]+ ] where pos :: Fractional a => a
changelog view
@@ -1,3 +1,14 @@+0.3.7.0++ * Make division (/) on Scientifics slightly more efficient.++ * Fix the Show instance to surround negative numbers with parentheses when+ necessary.++ * Add (Template Haskell) Lift Scientific instance++ * Mark modules as Safe or Trustworthy (Safe Haskell).+ 0.3.6.2 * Due to a regression introduced in 0.3.4.14 the RealFrac methods and floatingOrInteger became vulnerable to a space blowup when
scientific.cabal view
@@ -1,6 +1,6 @@-name: scientific-version: 0.3.6.2-synopsis: Numbers represented using scientific notation+name: scientific+version: 0.3.8.1+synopsis: Numbers represented using scientific notation description: "Data.Scientific" provides the number type 'Scientific'. Scientific numbers are arbitrary precision and space efficient. They are represented using@@ -32,94 +32,107 @@ @'Integral's@ (like: 'Int') or @'RealFloat's@ (like: 'Double' or 'Float') will always be bounded by the target type. -homepage: https://github.com/basvandijk/scientific-bug-reports: https://github.com/basvandijk/scientific/issues-license: BSD3-license-file: LICENSE-author: Bas van Dijk-maintainer: Bas van Dijk <v.dijk.bas@gmail.com>-category: Data-build-type: Simple-cabal-version: >=1.10--extra-source-files:- changelog--Tested-With: GHC == 7.6.3- , GHC == 7.8.4- , GHC == 7.10.3- , GHC == 8.0.2- , GHC == 8.2.2- , GHC == 8.4.1+homepage: https://github.com/basvandijk/scientific+bug-reports: https://github.com/basvandijk/scientific/issues+license: BSD3+license-file: LICENSE+author: Bas van Dijk+maintainer: Bas van Dijk <v.dijk.bas@gmail.com>+category: Data+build-type: Simple+cabal-version: >=1.10+extra-source-files: changelog+tested-with:+ GHC ==8.6.5+ || ==8.8.4+ || ==8.10.7+ || ==9.0.2+ || ==9.2.8+ || ==9.4.8+ || ==9.6.6+ || ==9.8.4+ || ==9.10.3+ || ==9.12.2+ || ==9.14.1 source-repository head type: git- location: git://github.com/basvandijk/scientific.git--flag bytestring-builder- description: Depend on the bytestring-builder package for backwards compatibility.- default: False- manual: False+ location: https://github.com/basvandijk/scientific.git flag integer-simple description: Use the integer-simple package instead of integer-gmp default: False library- exposed-modules: Data.ByteString.Builder.Scientific- Data.Scientific- Data.Text.Lazy.Builder.Scientific- other-modules: GHC.Integer.Compat- Utils- other-extensions: DeriveDataTypeable, BangPatterns- ghc-options: -Wall- build-depends: base >= 4.3 && < 5- , integer-logarithms >= 1- , deepseq >= 1.3- , text >= 0.8- , hashable >= 1.1.2- , primitive >= 0.1- , containers >= 0.1- , binary >= 0.4.1+ exposed-modules:+ Data.ByteString.Builder.Scientific+ Data.Scientific+ Data.Text.Lazy.Builder.Scientific - if flag(bytestring-builder)- build-depends: bytestring >= 0.9 && < 0.10.4- , bytestring-builder >= 0.10.4 && < 0.11- else- build-depends: bytestring >= 0.10.4+ other-modules:+ GHC.Integer.Compat+ Utils - if flag(integer-simple)- build-depends: integer-simple+ other-extensions:+ BangPatterns+ DeriveDataTypeable+ Trustworthy++ ghc-options: -Wall+ build-depends:+ base >=4.12.0.0 && <4.23+ , binary >=0.8.6.0 && <0.9+ , bytestring >=0.10.8.2 && <0.13+ , containers >=0.6.0.1 && <0.9+ , deepseq >=1.4.4.0 && <1.6+ , hashable >=1.4.4.0 && <1.6+ , integer-logarithms >=1.0.3.1 && <1.1+ , primitive >=0.9.0.0 && <0.10+ , template-haskell >=2.14.0.0 && <2.25+ , text >=1.2.3.0 && <1.3 || >=2.0 && <2.2++ if impl(ghc >=9.0)+ build-depends: base >=4.15++ if flag(integer-simple)+ build-depends: invalid-cabal-flag-settings <0+ else+ if flag(integer-simple)+ build-depends: integer-simple++ else build-depends: integer-gmp - hs-source-dirs: src- default-language: Haskell2010+ if impl(ghc <8)+ other-extensions: TemplateHaskell + if impl(ghc >=9.0)+ -- these flags may abort compilation with GHC-8.10+ -- https://gitlab.haskell.org/ghc/ghc/-/merge_requests/3295+ ghc-options: -Winferred-safe-imports -Wmissing-safe-haskell-mode++ hs-source-dirs: src+ default-language: Haskell2010+ test-suite test-scientific type: exitcode-stdio-1.0 hs-source-dirs: test main-is: test.hs default-language: Haskell2010 ghc-options: -Wall-- build-depends: scientific- , base >= 4.3 && < 5- , binary >= 0.4.1- , tasty >= 0.5- , tasty-ant-xml >= 1.0- , tasty-hunit >= 0.8- , tasty-smallcheck >= 0.2- , tasty-quickcheck >= 0.8- , smallcheck >= 1.0- , QuickCheck >= 2.5- , text >= 0.8-- if flag(bytestring-builder)- build-depends: bytestring >= 0.9 && < 0.10.4- , bytestring-builder >= 0.10.4 && < 0.11- else- build-depends: bytestring >= 0.10.4+ build-depends:+ base+ , binary+ , bytestring+ , QuickCheck >=2.14.2+ , scientific+ , smallcheck >=1.0+ , tasty >=1.4.0.1+ , tasty-hunit >=0.8+ , tasty-quickcheck >=0.8+ , tasty-smallcheck >=0.2+ , text benchmark bench-scientific type: exitcode-stdio-1.0@@ -127,6 +140,7 @@ main-is: bench.hs default-language: Haskell2010 ghc-options: -O2- build-depends: scientific- , base >= 4.3 && < 5- , criterion >= 0.5+ build-depends:+ base+ , criterion >=0.5+ , scientific
src/Data/ByteString/Builder/Scientific.hs view
@@ -1,4 +1,4 @@-{-# LANGUAGE CPP, OverloadedStrings #-}+{-# LANGUAGE OverloadedStrings, Safe #-} module Data.ByteString.Builder.Scientific ( scientificBuilder@@ -17,18 +17,7 @@ import Utils (roundTo, i2d) -#if !MIN_VERSION_base(4,8,0)-import Data.Monoid (mempty)-#endif--#if MIN_VERSION_base(4,5,0) import Data.Monoid ((<>))-#else-import Data.Monoid (Monoid, mappend)-(<>) :: Monoid a => a -> a -> a-(<>) = mappend-infixr 6 <>-#endif -- | A @ByteString@ @Builder@ which renders a scientific number to full@@ -70,11 +59,10 @@ byteStringCopy (BC8.replicate dec' '0') <> byteStringCopy "e0" _ ->- let- (ei,is') = roundTo (dec'+1) is- (d:ds') = map i2d (if ei > 0 then init is' else is')- in- char8 d <> char8 '.' <> string8 ds' <> char8 'e' <> intDec (e-1+ei)+ let (ei,is') = roundTo (dec'+1) is+ in case map i2d (if ei > 0 then init is' else is') of+ [] -> mempty+ d:ds' -> char8 d <> char8 '.' <> string8 ds' <> char8 'e' <> intDec (e-1+ei) Fixed -> let mk0 ls = case ls of { "" -> char8 '0' ; _ -> string8 ls}@@ -100,8 +88,7 @@ in mk0 ls <> (if null rs then mempty else char8 '.' <> string8 rs) else- let- (ei,is') = roundTo dec' (replicate (-e) 0 ++ is)- d:ds' = map i2d (if ei > 0 then is' else 0:is')- in- char8 d <> (if null ds' then mempty else char8 '.' <> string8 ds')+ let (ei,is') = roundTo dec' (replicate (-e) 0 ++ is)+ in case map i2d (if ei > 0 then is' else 0:is') of+ [] -> mempty+ d:ds' -> char8 d <> (if null ds' then mempty else char8 '.' <> string8 ds')
src/Data/Scientific.hs view
@@ -1,9 +1,11 @@-{-# LANGUAGE CPP #-} {-# LANGUAGE DeriveDataTypeable #-} {-# LANGUAGE BangPatterns #-} {-# LANGUAGE ScopedTypeVariables #-} {-# LANGUAGE UnboxedTuples #-} {-# LANGUAGE PatternGuards #-}+{-# LANGUAGE Trustworthy #-}+{-# LANGUAGE DeriveLift #-}+{-# LANGUAGE StandaloneDeriving #-} -- | -- Module : Data.Scientific@@ -48,7 +50,7 @@ -- -- This module is designed to be imported qualified: ----- @import Data.Scientific as Scientific@+-- @import qualified Data.Scientific as Scientific@ module Data.Scientific ( Scientific @@ -98,7 +100,6 @@ import Control.Exception (throw, ArithException(DivideByZero)) import Control.Monad (mplus)-import Control.Monad.ST (runST) import Control.DeepSeq (NFData, rnf) import Data.Binary (Binary, get, put) import Data.Char (intToDigit, ord)@@ -108,7 +109,6 @@ import qualified Data.Map as M (Map, empty, insert, lookup) import Data.Ratio ((%), numerator, denominator) import Data.Typeable (Typeable)-import qualified Data.Primitive.Array as Primitive import Data.Word (Word8, Word16, Word32, Word64) import Math.NumberTheory.Logarithms (integerLog10') import qualified Numeric (floatToDigits)@@ -119,26 +119,10 @@ import Text.ParserCombinators.ReadP ( ReadP ) import Data.Text.Lazy.Builder.RealFloat (FPFormat(..)) -#if !MIN_VERSION_base(4,9,0)-import Control.Applicative ((*>))-#endif--#if !MIN_VERSION_base(4,8,0)-import Data.Functor ((<$>))-import Data.Word (Word)-import Control.Applicative ((<*>))-#endif--#if MIN_VERSION_base(4,5,0)-import Data.Bits (unsafeShiftR)-#else-import Data.Bits (shiftR)-#endif--import GHC.Integer (quotRemInteger, quotInteger)-import GHC.Integer.Compat (divInteger)-import Utils (roundTo)+import GHC.Integer.Compat (quotRemInteger, quotInteger, divInteger)+import Utils (maxExpt, roundTo, magnitude) +import Language.Haskell.TH.Syntax (Lift (..)) ---------------------------------------------------------------------- -- Type@@ -163,6 +147,20 @@ -- in 'toDecimalDigits'. -- -- Use 'normalize' to do manual normalization.+ --+ -- /WARNING:/ 'coefficient' and 'base10exponent' violate+ -- substantivity of 'Eq'.+ --+ -- >>> let x = scientific 1 2+ -- >>> let y = scientific 100 0+ -- >>> x == y+ -- True+ --+ -- but+ --+ -- >>> (coefficient x == coefficient y, base10Exponent x == base10Exponent y)+ -- (False,False)+ -- , base10Exponent :: {-# UNPACK #-} !Int -- ^ The base-10 exponent of a scientific number.@@ -173,17 +171,26 @@ scientific :: Integer -> Int -> Scientific scientific = Scientific - ---------------------------------------------------------------------- -- Instances ---------------------------------------------------------------------- +-- | @since 0.3.7.0+deriving instance Lift Scientific+ instance NFData Scientific where rnf (Scientific _ _) = () -- | A hash can be safely calculated from a @Scientific@. No magnitude @10^e@ is -- calculated so there's no risk of a blowup in space or time when hashing -- scientific numbers coming from untrusted sources.+--+-- >>> import Data.Hashable (hash)+-- >>> let x = scientific 1 2+-- >>> let y = scientific 100 0+-- >>> (x == y, hash x == hash y)+-- (True,True)+-- instance Hashable Scientific where hashWithSalt salt s = salt `hashWithSalt` c `hashWithSalt` e where@@ -295,15 +302,23 @@ -- | /WARNING:/ 'recip' and '/' will throw an error when their outputs are -- <https://en.wikipedia.org/wiki/Repeating_decimal repeating decimals>. --+-- These methods also compute 'Integer' magnitudes (@10^e@). If these methods+-- are applied to arguments which have huge exponents this could fill up all+-- space and crash your program! So don't apply these methods to scientific+-- numbers coming from untrusted sources.+-- -- 'fromRational' will throw an error when the input 'Rational' is a repeating -- decimal. Consider using 'fromRationalRepetend' for these rationals which -- will detect the repetition and indicate where it starts. instance Fractional Scientific where recip = fromRational . recip . toRational- {-# INLINABLE recip #-} - x / y = fromRational $ toRational x / toRational y- {-# INLINABLE (/) #-}+ Scientific c1 e1 / Scientific c2 e2+ | d < 0 = fromRational (x / (fromInteger (magnitude (-d))))+ | otherwise = fromRational (x * fromInteger (magnitude d))+ where+ d = e1 - e2+ x = c1 % c2 fromRational rational = case mbRepetendIx of@@ -651,48 +666,10 @@ {-# INLINE toIntegral #-} -------------------------------------------------------------------------- Exponentiation with a cache for the most common numbers.----------------------------------------------------------------------- --- | The same limit as in GHC.Float.-maxExpt :: Int-maxExpt = 324 -expts10 :: Primitive.Array Integer-expts10 = runST $ do- ma <- Primitive.newArray maxExpt uninitialised- Primitive.writeArray ma 0 1- Primitive.writeArray ma 1 10- let go !ix- | ix == maxExpt = Primitive.unsafeFreezeArray ma- | otherwise = do- Primitive.writeArray ma ix xx- Primitive.writeArray ma (ix+1) (10*xx)- go (ix+2)- where- xx = x * x- x = Primitive.indexArray expts10 half-#if MIN_VERSION_base(4,5,0)- !half = ix `unsafeShiftR` 1-#else- !half = ix `shiftR` 1-#endif- go 2 -uninitialised :: error-uninitialised = error "Data.Scientific: uninitialised element" --- | @magnitude e == 10 ^ e@-magnitude :: Num a => Int -> a-magnitude e | e < maxExpt = cachedPow10 e- | otherwise = cachedPow10 hi * 10 ^ (e - hi)- where- cachedPow10 = fromInteger . Primitive.indexArray expts10-- hi = maxExpt - 1-- ---------------------------------------------------------------------- -- Conversions ----------------------------------------------------------------------@@ -979,12 +956,17 @@ -- | See 'formatScientific' if you need more control over the rendering. instance Show Scientific where- show s | coefficient s < 0 = '-':showPositive (-s)- | otherwise = showPositive s+ showsPrec d s+ | coefficient s < 0 = showParen (d > prefixMinusPrec) $+ showChar '-' . showPositive (-s)+ | otherwise = showPositive s where- showPositive :: Scientific -> String- showPositive = fmtAsGeneric . toDecimalDigits+ prefixMinusPrec :: Int+ prefixMinusPrec = 6 + showPositive :: Scientific -> ShowS+ showPositive = showString . fmtAsGeneric . toDecimalDigits+ fmtAsGeneric :: ([Int], Int) -> String fmtAsGeneric x@(_is, e) | e < 0 || e > 7 = fmtAsExponent x@@ -1054,11 +1036,10 @@ case is of [0] -> '0' :'.' : take dec' (repeat '0') ++ "e0" _ ->- let- (ei,is') = roundTo (dec'+1) is- (d:ds') = map intToDigit (if ei > 0 then init is' else is')- in- d:'.':ds' ++ 'e':show (e-1+ei)+ let (ei,is') = roundTo (dec'+1) is+ in case map intToDigit (if ei > 0 then init is' else is') of+ [] -> ""+ d:ds' -> d:'.':ds' ++ 'e':show (e-1+ei) fmtAsFixedDecs :: Int -> ([Int], Int) -> String fmtAsFixedDecs dec (is, e) =@@ -1070,11 +1051,10 @@ in mk0 ls ++ (if null rs then "" else '.':rs) else- let- (ei,is') = roundTo dec' (replicate (-e) 0 ++ is)- d:ds' = map intToDigit (if ei > 0 then is' else 0:is')- in- d : (if null ds' then "" else '.':ds')+ let (ei,is') = roundTo dec' (replicate (-e) 0 ++ is)+ in case map intToDigit (if ei > 0 then is' else 0:is') of+ [] -> ""+ d:ds' -> d : (if null ds' then "" else '.':ds') where mk0 ls = case ls of { "" -> "0" ; _ -> ls}
src/Data/Text/Lazy/Builder/Scientific.hs view
@@ -1,4 +1,4 @@-{-# LANGUAGE CPP, OverloadedStrings #-}+{-# LANGUAGE OverloadedStrings, Safe #-} module Data.Text.Lazy.Builder.Scientific ( scientificBuilder@@ -16,14 +16,7 @@ import qualified Data.Text as T (replicate) import Utils (roundTo, i2d) -#if MIN_VERSION_base(4,5,0) import Data.Monoid ((<>))-#else-import Data.Monoid (Monoid, mappend)-(<>) :: Monoid a => a -> a -> a-(<>) = mappend-infixr 6 <>-#endif -- | A @Text@ @Builder@ which renders a scientific number to full -- precision, using standard decimal notation for arguments whose@@ -62,11 +55,10 @@ case is of [0] -> "0." <> fromText (T.replicate dec' "0") <> "e0" _ ->- let- (ei,is') = roundTo (dec'+1) is- (d:ds') = map i2d (if ei > 0 then init is' else is')- in- singleton d <> singleton '.' <> fromString ds' <> singleton 'e' <> decimal (e-1+ei)+ let (ei,is') = roundTo (dec'+1) is+ in case map i2d (if ei > 0 then init is' else is') of+ [] -> mempty+ d:ds' -> singleton d <> singleton '.' <> fromString ds' <> singleton 'e' <> decimal (e-1+ei) Fixed -> let mk0 ls = case ls of { "" -> "0" ; _ -> fromString ls}@@ -90,8 +82,7 @@ in mk0 ls <> (if null rs then "" else singleton '.' <> fromString rs) else- let- (ei,is') = roundTo dec' (replicate (-e) 0 ++ is)- d:ds' = map i2d (if ei > 0 then is' else 0:is')- in- singleton d <> (if null ds' then "" else singleton '.' <> fromString ds')+ let (ei,is') = roundTo dec' (replicate (-e) 0 ++ is)+ in case map i2d (if ei > 0 then is' else 0:is') of+ [] -> mempty+ d:ds' -> singleton d <> (if null ds' then "" else singleton '.' <> fromString ds')
src/GHC/Integer/Compat.hs view
@@ -1,7 +1,14 @@ {-# LANGUAGE CPP #-}+{-# LANGUAGE Trustworthy #-} -module GHC.Integer.Compat (divInteger) where+module GHC.Integer.Compat (divInteger, quotRemInteger, quotInteger) where +import GHC.Integer (quotRemInteger, quotInteger)++#if MIN_VERSION_base(4,15,0)+import GHC.Integer (divInteger)+#else+ #ifdef MIN_VERSION_integer_simple #if MIN_VERSION_integer_simple(0,1,1)@@ -20,4 +27,5 @@ divInteger = div #endif +#endif #endif
src/Utils.hs view
@@ -1,14 +1,24 @@+{-# LANGUAGE CPP #-} {-# LANGUAGE BangPatterns #-} {-# LANGUAGE MagicHash #-} {-# LANGUAGE UnboxedTuples #-}+{-# LANGUAGE Trustworthy #-}+{-# LANGUAGE ScopedTypeVariables #-} module Utils ( roundTo , i2d+ , maxExpt+ , magnitude ) where import GHC.Base (Int(I#), Char(C#), chr#, ord#, (+#)) +import qualified Data.Primitive.Array as Primitive+import Control.Monad.ST (runST)++import Data.Bits (unsafeShiftR)+ roundTo :: Int -> [Int] -> (Int, [Int]) roundTo d is = case f d True is of@@ -34,3 +44,40 @@ {-# INLINE i2d #-} i2d :: Int -> Char i2d (I# i#) = C# (chr# (ord# '0'# +# i# ))++----------------------------------------------------------------------+-- Exponentiation with a cache for the most common numbers.+----------------------------------------------------------------------++-- | The same limit as in GHC.Float.+maxExpt :: Int+maxExpt = 324++expts10 :: Primitive.Array Integer+expts10 = runST $ do+ ma <- Primitive.newArray maxExpt uninitialised+ Primitive.writeArray ma 0 1+ Primitive.writeArray ma 1 10+ let go !ix+ | ix == maxExpt = Primitive.unsafeFreezeArray ma+ | otherwise = do+ Primitive.writeArray ma ix xx+ Primitive.writeArray ma (ix+1) (10*xx)+ go (ix+2)+ where+ xx = x * x+ x = Primitive.indexArray expts10 half+ !half = ix `unsafeShiftR` 1+ go 2++uninitialised :: error+uninitialised = error "Data.Scientific: uninitialised element"++-- | @magnitude e == 10 ^ e@+magnitude :: Num a => Int -> a+magnitude e | e < maxExpt = cachedPow10 e+ | otherwise = cachedPow10 hi * 10 ^ (e - hi)+ where+ cachedPow10 = fromInteger . Primitive.indexArray expts10++ hi = maxExpt - 1
test/test.hs view
@@ -1,4 +1,3 @@-{-# LANGUAGE CPP #-} {-# LANGUAGE FlexibleInstances #-} {-# LANGUAGE FlexibleContexts #-} {-# LANGUAGE MultiParamTypeClasses #-}@@ -10,15 +9,11 @@ module Main where -#if !MIN_VERSION_base(4,8,0)-import Control.Applicative-#endif import Control.Monad import Data.Int import Data.Word import Data.Scientific as Scientific import Test.Tasty-import Test.Tasty.Runners.AntXML import Test.Tasty.HUnit (testCase, (@?=), Assertion, assertBool) import qualified Test.SmallCheck as SC import qualified Test.SmallCheck.Series as SC@@ -114,6 +109,9 @@ , testGroup "Formatting" [ testProperty "read . show == id" $ \s -> read (show s) === s+ , testCase "show (Just 1)" $ testShow (Just 1) "Just 1.0"+ , testCase "show (Just 0)" $ testShow (Just 0) "Just 0.0"+ , testCase "show (Just (-1))" $ testShow (Just (-1)) "Just (-1.0)" , testGroup "toDecimalDigits" [ smallQuick "laws"@@ -279,7 +277,7 @@ ] testMain :: TestTree -> IO ()-testMain = defaultMainWithIngredients (antXMLRunner:defaultIngredients)+testMain = defaultMainWithIngredients defaultIngredients testReads :: String -> [(Scientific, String)] -> Assertion testReads inp out = reads inp @?= out@@ -287,6 +285,9 @@ testRead :: String -> Scientific -> Assertion testRead inp out = read inp @?= out +testShow :: Maybe Scientific -> String -> Assertion+testShow inp out = show inp @?= out+ testScientificP :: String -> [(Scientific, String)] -> Assertion testScientificP inp out = readP_to_S Scientific.scientificP inp @?= out @@ -463,8 +464,4 @@ bigIntGen = QC.sized $ \size -> QC.resize (size * 1000) intGen intGen :: QC.Gen Int-#if MIN_VERSION_QuickCheck(2,7,0) intGen = QC.arbitrary-#else-intGen = QC.sized $ \n -> QC.choose (-n, n)-#endif