Introduce Benchmarks

cabal.project

@@ -8,3 +8,4 @@ packages: containers-sig-readonly
           containers-contrib
           containers-example
           containers-sig-laws
+          containers-sig-benchmarks

containers-contrib-readonly/containers-contrib.cabal

@@ -20,9 +20,13 @@ source-repository head
 library
   hs-source-dirs:      src
   exposed-modules:     Map.Contrib.Laws
+                       Map.Contrib.Bench
 
   build-depends:       base
                      , QuickCheck
                      , containers-sig-readonly
+                     , gauge
+                     , text
+                     , relude
   ghc-options:         -Wall -fhide-source-paths
   default-language:    Haskell2010

containers-contrib-readonly/src/Map/Contrib/Bench.hs

@@ -0,0 +1,39 @@
+{-# LANGUAGE BangPatterns #-}
+{-# LANGUAGE ScopedTypeVariables #-}
+{-# LANGUAGE NoImplicitPrelude #-}
+{-# LANGUAGE TypeFamilies #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE FlexibleContexts #-}
+{-# LANGUAGE TypeApplications #-}
+
+module Map.Contrib.Bench where
+
+import Map
+import Gauge.Main (Benchmark, bench, defaultMain, whnf)
+import Relude hiding (fromList, Map)
+
+benchmark
+  :: forall k. (Enum k, Bounded k, Key k, NFData (Map k Int))
+  => String
+  -> Proxy k
+  -> IO ()
+benchmark label _ = do
+  let benchMaxElems = min 1024 (fromEnum (maxBound @k))
+  let upBound = foldl' (.) id (replicate benchMaxElems succ) minBound
+  let map_keys :: [k] = [minBound..upBound]
+
+  let mapEntries = zip map_keys [0..]
+
+  let m = fromList mapEntries
+
+  evaluateNF_ m
+
+  defaultMain
+    [ lookupBench (label <> "-lookup/all") m (map fst mapEntries)
+    ]
+
+lookupBench :: forall k. Key k => String -> Map k Int -> [k] -> Benchmark
+lookupBench label m = bench label . whnf (go 0)
+  where
+    go :: Int -> [k] -> Int
+    go = foldl' (\a -> (a +) . fromMaybe 0 . flip lookup m)

containers-int-strict/containers-int-strict.cabal

@@ -25,7 +25,7 @@ library
   exposed-modules:     Map.Int
   reexported-modules:  Map.Int as Map
 
-  build-depends:       base, containers
+  build-depends:       base, containers, deepseq
   ghc-options:         -Wall -fhide-source-paths
                        -fexpose-all-unfoldings
   default-language:    Haskell2010

containers-int-strict/src/Map/Int.hs

@@ -34,10 +34,10 @@ module Map.Int
        , alter
        ) where
 
-import Prelude hiding (lookup, null)
+import Control.DeepSeq (NFData (..))
 import Data.Coerce (coerce)
-
 import qualified Data.IntMap.Strict as M
+import Prelude hiding (lookup, null)
 
 newtype Map k v = IM (M.IntMap v)
     deriving newtype (Show, Eq)
@@ -111,3 +111,6 @@ delete = coerce @(k -> M.IntMap v -> M.IntMap v) M.delete
 alter :: forall k v. Key k => (Maybe v -> Maybe v) -> k -> Map k v -> Map k v
 alter = coerce @((Maybe v -> Maybe v) -> k -> M.IntMap v -> M.IntMap v) M.alter
 {-# INLINE alter #-}
+
+instance NFData v => NFData (Map k v) where
+  rnf (IM m) = rnf m

containers-primitive/containers-primitive.cabal

@@ -23,7 +23,7 @@ library
   exposed-modules:     Map.Prim
   reexported-modules:  Map.Prim as Map
 
-  build-depends:       base, primitive-containers >= 0.3.0
+  build-depends:       base, primitive-containers >= 0.3.0, deepseq
   ghc-options:         -Wall -fhide-source-paths
                        -fexpose-all-unfoldings
   default-language:    Haskell2010

containers-primitive/src/Map/Prim.hs

@@ -20,6 +20,8 @@ module Map.Prim
        , elems
        ) where
 
+import Control.DeepSeq (NFData (..))
+
 import Prelude hiding (lookup, null)
 
 import Data.Maybe (fromMaybe, isJust)

containers-sig-benchmarks/CHANGELOG.md

@@ -0,0 +1,13 @@
+Change log
+==========
+
+`containers-benchmark` uses [PVP Versioning][1].
+The change log is available [on GitHub][2].
+
+0.0.0
+=====
+* Initially created.
+
+[1]: https://pvp.haskell.org
+[2]: https://github.com/kowainik/containers-backpack/releases
+