Fix minor Api Change, export new HashMapT

jappeace · jappeace · commit 1162033e07b8 · 2021-09-22T00:43:38.000+02:00
diff --git a/Data/HashMap/Internal.hs b/Data/HashMap/Internal.hs
@@ -32,7 +32,9 @@ module Data.HashMap.Internal
 
       -- * Construction
     , empty
+    , empty'
     , singleton
+    , singleton'
 
       -- * Basic interface
     , null
@@ -325,7 +327,7 @@ instance (Eq k, Hashable k, KnownNat salt) => Semigroup (HashMapT salt k v) wher
 -- >>> mappend (fromList [(1,'a'),(2,'b')]) (fromList [(2,'c'),(3,'d')])
 -- fromList [(1,'a'),(2,'b'),(3,'d')]
 instance (Eq k, Hashable k, KnownNat salt) => Monoid (HashMapT salt k v) where
-  mempty = empty
+  mempty = empty'
   {-# INLINE mempty #-}
 #if __GLASGOW_HASKELL__ >= 711
   mappend = (<>)
@@ -597,12 +599,20 @@ isLeafOrCollision _               = False
 -- * Construction
 
 -- | /O(1)/ Construct an empty map.
-empty :: forall k v salt . HashMapT salt k v
-empty = Empty
+empty :: forall k v salt . HashMap k v
+empty = empty'
+
+-- | like 'empty' but allows a custom salt to be set
+empty' :: forall k v salt . HashMapT salt k v
+empty' = Empty
 
 -- | /O(1)/ Construct a map with a single element.
-singleton :: forall k v salt . (Hashable k, KnownNat salt) => k -> v -> HashMapT salt k v
-singleton k v = Leaf (hash (Proxy :: Proxy salt) k) (L k v)
+singleton :: forall k v salt . (Hashable k) => k -> v -> HashMap k v
+singleton = singleton'
+
+-- | like 'singleton' but allows a custom salt to be set
+singleton' :: forall k v salt . (Hashable k, KnownNat salt) => k -> v -> HashMapT salt k v
+singleton' k v = Leaf (hash (Proxy :: Proxy salt) k) (L k v)
 
 ------------------------------------------------------------------------
 -- * Basic interface
@@ -1728,7 +1738,7 @@ unionArrayBy f b1 b2 ary1 ary2 = A.run $ do
 
 -- | Construct a set containing all elements from a list of sets.
 unions :: (Eq k, Hashable k, KnownNat salt) => [HashMapT salt k v] -> HashMapT salt k v
-unions = L.foldl' union empty
+unions = L.foldl' union empty'
 {-# INLINE unions #-}
 
 
@@ -1824,7 +1834,7 @@ mapKeys f = fromList . foldrWithKey (\k x xs -> (f k, x) : xs) []
 -- | /O(n*log m)/ Difference of two maps. Return elements of the first map
 -- not existing in the second.
 difference :: (Eq k, Hashable k, KnownNat salt) => HashMapT salt k v -> HashMapT salt k w -> HashMapT salt k v
-difference a b = foldlWithKey' go empty a
+difference a b = foldlWithKey' go empty' a
   where
     go m k v = case lookup k b of
                  Nothing -> insert k v m
@@ -1836,7 +1846,7 @@ difference a b = foldlWithKey' go empty a
 -- If it returns 'Nothing', the element is discarded (proper set difference). If
 -- it returns (@'Just' y@), the element is updated with a new value @y@.
 differenceWith :: (Eq k, Hashable k, KnownNat salt) => (v -> w -> Maybe v) -> HashMapT salt k v -> HashMapT salt k w -> HashMapT salt k v
-differenceWith f a b = foldlWithKey' go empty a
+differenceWith f a b = foldlWithKey' go empty' a
   where
     go m k v = case lookup k b of
                  Nothing -> insert k v m
@@ -1846,7 +1856,7 @@ differenceWith f a b = foldlWithKey' go empty a
 -- | /O(n*log m)/ Intersection of two maps. Return elements of the first
 -- map for keys existing in the second.
 intersection :: (Eq k, Hashable k, KnownNat salt) => HashMapT salt k v -> HashMapT salt k w -> HashMapT salt k v
-intersection a b = foldlWithKey' go empty a
+intersection a b = foldlWithKey' go empty' a
   where
     go m k v = case lookup k b of
                  Just _ -> insert k v m
@@ -1858,7 +1868,7 @@ intersection a b = foldlWithKey' go empty a
 -- maps.
 intersectionWith :: (Eq k, Hashable k, KnownNat salt) => (v1 -> v2 -> v3) -> HashMapT salt k v1
                  -> HashMapT salt k v2 -> HashMapT salt k v3
-intersectionWith f a b = foldlWithKey' go empty a
+intersectionWith f a b = foldlWithKey' go empty' a
   where
     go m k v = case lookup k b of
                  Just w -> insert k (f v w) m
@@ -1870,7 +1880,7 @@ intersectionWith f a b = foldlWithKey' go empty a
 -- maps.
 intersectionWithKey :: (Eq k, Hashable k, KnownNat salt) => (k -> v1 -> v2 -> v3)
                     -> HashMapT salt k v1 -> HashMapT salt k v2 -> HashMapT salt k v3
-intersectionWithKey f a b = foldlWithKey' go empty a
+intersectionWithKey f a b = foldlWithKey' go empty' a
   where
     go m k v = case lookup k b of
                  Just w -> insert k (f k v w) m
@@ -2117,7 +2127,7 @@ toList t = build (\ c z -> foldrWithKey (curry c) z t)
 -- | /O(n)/ Construct a map with the supplied mappings.  If the list
 -- contains duplicate mappings, the later mappings take precedence.
 fromList :: (Eq k, Hashable k, KnownNat salt) => [(k, v)] -> HashMapT salt k v
-fromList = L.foldl' (\ m (k, v) -> unsafeInsert k v m) empty
+fromList = L.foldl' (\ m (k, v) -> unsafeInsert k v m) empty'
 {-# INLINABLE fromList #-}
 
 -- | /O(n*log n)/ Construct a map from a list of elements.  Uses
@@ -2151,7 +2161,7 @@ fromList = L.foldl' (\ m (k, v) -> unsafeInsert k v m) empty
 -- > fromListWith f [(k, a), (k, b), (k, c), (k, d)]
 -- > = fromList [(k, f d (f c (f b a)))]
 fromListWith :: (Eq k, Hashable k, KnownNat salt) => (v -> v -> v) -> [(k, v)] -> HashMapT salt k v
-fromListWith f = L.foldl' (\ m (k, v) -> unsafeInsertWith f k v m) empty
+fromListWith f = L.foldl' (\ m (k, v) -> unsafeInsertWith f k v m) empty'
 {-# INLINE fromListWith #-}
 
 -- | /O(n*log n)/ Construct a map from a list of elements.  Uses
@@ -2181,7 +2191,7 @@ fromListWith f = L.foldl' (\ m (k, v) -> unsafeInsertWith f k v m) empty
 --
 -- @since 0.2.11
 fromListWithKey :: (Eq k, Hashable k, KnownNat salt) => (k -> v -> v -> v) -> [(k, v)] -> HashMapT salt k v
-fromListWithKey f = L.foldl' (\ m (k, v) -> unsafeInsertWithKey f k v m) empty
+fromListWithKey f = L.foldl' (\ m (k, v) -> unsafeInsertWithKey f k v m) empty'
 {-# INLINE fromListWithKey #-}
 
 ------------------------------------------------------------------------
diff --git a/Data/HashMap/Internal/Strict.hs b/Data/HashMap/Internal/Strict.hs
@@ -44,6 +44,7 @@ module Data.HashMap.Internal.Strict
       -- $strictness
 
       HashMap
+    , HashMapT
 
       -- * Construction
     , empty
@@ -132,7 +133,7 @@ import qualified Data.HashMap.Internal.Array as A
 import qualified Data.HashMap.Internal as HM
 import Data.HashMap.Internal hiding (
     alter, alterF, adjust, fromList, fromListWith, fromListWithKey,
-    insert, insertWith,
+    insert, insertWith, singleton',
     differenceWith, intersectionWith, intersectionWithKey, map, mapWithKey,
     mapMaybe, mapMaybeWithKey, singleton, update, unionWith, unionWithKey,
     traverseWithKey)
@@ -158,8 +159,12 @@ import Data.Proxy(Proxy(..))
 -- * Construction
 
 -- | /O(1)/ Construct a map with a single element.
-singleton :: (Hashable k, KnownNat salt) => k -> v -> HashMapT salt k v
-singleton k !v = HM.singleton k v
+singleton :: (Hashable k) => k -> v -> HashMap k v
+singleton = singleton'
+
+-- | like 'singleton' but allows a custom salt to be set
+singleton' :: (Hashable k, KnownNat salt) => k -> v -> HashMapT salt k v
+singleton' k !v = HM.singleton' k v
 
 ------------------------------------------------------------------------
 -- * Basic interface
@@ -600,7 +605,7 @@ traverseWithKey f = go
 -- If it returns 'Nothing', the element is discarded (proper set difference). If
 -- it returns (@'Just' y@), the element is updated with a new value @y@.
 differenceWith :: (Eq k, Hashable k, KnownNat salt) => (v -> w -> Maybe v) -> HashMapT salt k v -> HashMapT salt k w -> HashMapT salt k v
-differenceWith f a b = foldlWithKey' go empty a
+differenceWith f a b = foldlWithKey' go empty' a
   where
     go m k v = case HM.lookup k b of
                  Nothing -> insert k v m
@@ -612,7 +617,7 @@ differenceWith f a b = foldlWithKey' go empty a
 -- maps.
 intersectionWith :: (Eq k, Hashable k, KnownNat salt) => (v1 -> v2 -> v3) -> HashMapT salt k v1
                  -> HashMapT salt k v2 -> HashMapT salt k v3
-intersectionWith f a b = foldlWithKey' go empty a
+intersectionWith f a b = foldlWithKey' go empty' a
   where
     go m k v = case HM.lookup k b of
                  Just w -> insert k (f v w) m
@@ -624,7 +629,7 @@ intersectionWith f a b = foldlWithKey' go empty a
 -- maps.
 intersectionWithKey :: (Eq k, Hashable k, KnownNat salt) => (k -> v1 -> v2 -> v3)
                     -> HashMapT salt k v1 -> HashMapT salt k v2 -> HashMapT salt k v3
-intersectionWithKey f a b = foldlWithKey' go empty a
+intersectionWithKey f a b = foldlWithKey' go empty' a
   where
     go m k v = case HM.lookup k b of
                  Just w -> insert k (f k v w) m
@@ -638,7 +643,7 @@ intersectionWithKey f a b = foldlWithKey' go empty a
 -- list contains duplicate mappings, the later mappings take
 -- precedence.
 fromList :: (Eq k, Hashable k, KnownNat salt) => [(k, v)] -> HashMapT salt k v
-fromList = L.foldl' (\ m (k, !v) -> HM.unsafeInsert k v m) empty
+fromList = L.foldl' (\ m (k, !v) -> HM.unsafeInsert k v m) empty'
 {-# INLINABLE fromList #-}
 
 -- | /O(n*log n)/ Construct a map from a list of elements.  Uses
@@ -672,7 +677,7 @@ fromList = L.foldl' (\ m (k, !v) -> HM.unsafeInsert k v m) empty
 -- > fromListWith f [(k, a), (k, b), (k, c), (k, d)]
 -- > = fromList [(k, f d (f c (f b a)))]
 fromListWith :: (Eq k, Hashable k, KnownNat salt) => (v -> v -> v) -> [(k, v)] -> HashMapT salt k v
-fromListWith f = L.foldl' (\ m (k, v) -> unsafeInsertWith f k v m) empty
+fromListWith f = L.foldl' (\ m (k, v) -> unsafeInsertWith f k v m) empty'
 {-# INLINE fromListWith #-}
 
 -- | /O(n*log n)/ Construct a map from a list of elements.  Uses
@@ -702,7 +707,7 @@ fromListWith f = L.foldl' (\ m (k, v) -> unsafeInsertWith f k v m) empty
 --
 -- @since 0.2.11
 fromListWithKey :: (Eq k, Hashable k, KnownNat salt) => (k -> v -> v -> v) -> [(k, v)] -> HashMapT salt k v
-fromListWithKey f = L.foldl' (\ m (k, v) -> unsafeInsertWithKey f k v m) empty
+fromListWithKey f = L.foldl' (\ m (k, v) -> unsafeInsertWithKey f k v m) empty'
 {-# INLINE fromListWithKey #-}
 
 ------------------------------------------------------------------------
diff --git a/Data/HashMap/Strict.hs b/Data/HashMap/Strict.hs
@@ -26,7 +26,8 @@ module Data.HashMap.Strict
       -- * Strictness properties
       -- $strictness
 
-      HashMap
+      HashMapT
+    , HashMap
 
       -- * Construction
     , empty
