diff --git a/CHANGES.md b/CHANGES.md --- a/CHANGES.md +++ b/CHANGES.md @@ -1,3 +1,36 @@ +## [0.2.21] - December 2025 + +* API enhancements: + * [Add `HashMap.lookupKey` and `HashSet.lookupElement`](https://github.com/haskell-unordered-containers/unordered-containers/pull/554) + * [Add `differenceWithKey`](https://github.com/haskell-unordered-containers/unordered-containers/pull/542) + * [Add `disjoint`](https://github.com/haskell-unordered-containers/unordered-containers/pull/559) + +* Performance improvements: + * [`HashSet.fromList`: Use `unsafeInsert`](https://github.com/haskell-unordered-containers/unordered-containers/pull/515) + * [Use tree-diffing for `difference`](https://github.com/haskell-unordered-containers/unordered-containers/pull/535) + * [Remove some unnecessary forcing of HashMaps](https://github.com/haskell-unordered-containers/unordered-containers/pull/545) + * [Remove the `Array.index` function](https://github.com/haskell-unordered-containers/unordered-containers/pull/539) + * [`hashWithSalt`: Ensure that the salt `Int` is unboxed](https://github.com/haskell-unordered-containers/unordered-containers/pull/569) + +* Documentation changes: + * [Turn some comments into docstrings](https://github.com/haskell-unordered-containers/unordered-containers/pull/516) + * [Reword disclaimer regarding hash collision attacks](https://github.com/haskell-unordered-containers/unordered-containers/pull/557) + * [Update time complexity of some HashSet functions](https://github.com/haskell-unordered-containers/unordered-containers/pull/568) + * [Update instructions for code inspection](https://github.com/haskell-unordered-containers/unordered-containers/pull/567) + +* Other changes: + * [Drop support for GHC < 8.10](https://github.com/haskell-unordered-containers/unordered-containers/pull/510) + * [Address deprecation warnings and other warnings](https://github.com/haskell-unordered-containers/unordered-containers/pull/512) + * [Optimize indexing in arrays of length 2](https://github.com/haskell-unordered-containers/unordered-containers/pull/528) + * [Introduce `ShiftedHash`](https://github.com/haskell-unordered-containers/unordered-containers/pull/529) + * [New "fine-grained" benchmarks](https://github.com/haskell-unordered-containers/unordered-containers/pull/526) + * [Make it compile with MicroHs](https://github.com/haskell-unordered-containers/unordered-containers/pull/553). Thanks, @augustss! + * [Remove redundant `Eq` constraints](https://github.com/haskell-unordered-containers/unordered-containers/pull/558) + * [Refactor `delete`](https://github.com/haskell-unordered-containers/unordered-containers/pull/571) + * [`difference[With]`: Undo constraint relaxation](https://github.com/haskell-unordered-containers/unordered-containers/pull/573) + +[0.2.21]: https://github.com/haskell-unordered-containers/unordered-containers/compare/v0.2.20.1...v0.2.21 + ## [0.2.20.1] - October 2025 * [Fix infinite loop in `isSubmapOf[By]` / `isSubsetOf` on 32-bit platforms](https://github.com/haskell-unordered-containers/unordered-containers/pull/501). @@ -15,7 +48,7 @@ * [Remove bad `isSubmapOf` testcase](https://github.com/haskell-unordered-containers/unordered-containers/pull/504) - +[0.2.20.1]: https://github.com/haskell-unordered-containers/unordered-containers/compare/v0.2.20...v0.2.20.1 ## [0.2.20] - January 2024 @@ -43,6 +76,8 @@ * [Improve test case generation](https://github.com/haskell-unordered-containers/unordered-containers/pull/442) * [Improve test failure reporting](https://github.com/haskell-unordered-containers/unordered-containers/pull/440) + +[0.2.20]: https://github.com/haskell-unordered-containers/unordered-containers/compare/v0.2.19.1...v0.2.20 ## [0.2.19.1] – April 2022 diff --git a/Data/HashMap/Internal.hs b/Data/HashMap/Internal.hs --- a/Data/HashMap/Internal.hs +++ b/Data/HashMap/Internal.hs @@ -4,2527 +4,2991 @@ {-# LANGUAGE LambdaCase #-} {-# LANGUAGE MagicHash #-} {-# LANGUAGE PatternGuards #-} -{-# LANGUAGE RoleAnnotations #-} -{-# LANGUAGE ScopedTypeVariables #-} -{-# LANGUAGE StandaloneDeriving #-} -{-# LANGUAGE TemplateHaskellQuotes #-} -{-# LANGUAGE TypeFamilies #-} -{-# LANGUAGE TypeInType #-} -{-# LANGUAGE UnboxedSums #-} -{-# LANGUAGE UnboxedTuples #-} -{-# OPTIONS_GHC -fno-full-laziness -funbox-strict-fields #-} -{-# OPTIONS_HADDOCK not-home #-} - -#include "MachDeps.h" - --- | = WARNING --- --- This module is considered __internal__. --- --- The Package Versioning Policy __does not apply__. --- --- The contents of this module may change __in any way whatsoever__ --- and __without any warning__ between minor versions of this package. --- --- Authors importing this module are expected to track development --- closely. - -module Data.HashMap.Internal - ( - HashMap(..) - , Leaf(..) - - -- * Construction - , empty - , singleton - - -- * Basic interface - , null - , size - , member - , lookup - , (!?) - , findWithDefault - , lookupDefault - , (!) - , insert - , insertWith - , unsafeInsert - , delete - , adjust - , update - , alter - , alterF - , isSubmapOf - , isSubmapOfBy - - -- * Combine - -- ** Union - , union - , unionWith - , unionWithKey - , unions - - -- ** Compose - , compose - - -- * Transformations - , map - , mapWithKey - , traverseWithKey - , mapKeys - - -- * Difference and intersection - , difference - , differenceWith - , intersection - , intersectionWith - , intersectionWithKey - , intersectionWithKey# - - -- * Folds - , foldr' - , foldl' - , foldrWithKey' - , foldlWithKey' - , foldr - , foldl - , foldrWithKey - , foldlWithKey - , foldMapWithKey - - -- * Filter - , mapMaybe - , mapMaybeWithKey - , filter - , filterWithKey - - -- * Conversions - , keys - , elems - - -- ** Lists - , toList - , fromList - , fromListWith - , fromListWithKey - - -- ** Internals used by the strict version - , Hash - , Bitmap - , Shift - , bitmapIndexedOrFull - , collision - , hash - , mask - , index - , bitsPerSubkey - , maxChildren - , isLeafOrCollision - , fullBitmap - , subkeyMask - , nextShift - , sparseIndex - , two - , unionArrayBy - , updateFullArray - , updateFullArrayM - , updateFullArrayWith' - , updateOrConcatWithKey - , filterMapAux - , equalKeys - , equalKeys1 - , lookupRecordCollision - , LookupRes(..) - , lookupResToMaybe - , insert' - , delete' - , lookup' - , insertNewKey - , insertKeyExists - , deleteKeyExists - , insertModifying - , ptrEq - , adjust# - ) where - -import Control.Applicative (Const (..)) -import Control.DeepSeq (NFData (..), NFData1 (..), NFData2 (..)) -import Control.Monad.ST (ST, runST) -import Data.Bifoldable (Bifoldable (..)) -import Data.Bits (complement, countTrailingZeros, popCount, - shiftL, unsafeShiftL, unsafeShiftR, (.&.), - (.|.)) -import Data.Coerce (coerce) -import Data.Data (Constr, Data (..), DataType) -import Data.Functor.Classes (Eq1 (..), Eq2 (..), Ord1 (..), Ord2 (..), - Read1 (..), Show1 (..), Show2 (..)) -import Data.Functor.Identity (Identity (..)) -import Data.Hashable (Hashable) -import Data.Hashable.Lifted (Hashable1, Hashable2) -import Data.HashMap.Internal.List (isPermutationBy, unorderedCompare) -import Data.Semigroup (Semigroup (..), stimesIdempotentMonoid) -import GHC.Exts (Int (..), Int#, TYPE, (==#)) -import GHC.Stack (HasCallStack) -import Prelude hiding (Foldable(..), filter, lookup, map, - pred) -import Text.Read hiding (step) - -import qualified Data.Data as Data -import qualified Data.Foldable as Foldable -import qualified Data.Functor.Classes as FC -import qualified Data.Hashable as H -import qualified Data.Hashable.Lifted as H -import qualified Data.HashMap.Internal.Array as A -import qualified Data.List as List -import qualified GHC.Exts as Exts -import qualified Language.Haskell.TH.Syntax as TH - --- | Convenience function. Compute a hash value for the given value. -hash :: H.Hashable a => a -> Hash -hash = fromIntegral . H.hash - -data Leaf k v = L !k v - deriving (Eq) - -instance (NFData k, NFData v) => NFData (Leaf k v) where - rnf (L k v) = rnf k `seq` rnf v - --- | @since 0.2.17.0 -instance (TH.Lift k, TH.Lift v) => TH.Lift (Leaf k v) where -#if MIN_VERSION_template_haskell(2,16,0) - liftTyped (L k v) = [|| L k $! v ||] -#else - lift (L k v) = [| L k $! v |] -#endif - --- | @since 0.2.14.0 -instance NFData k => NFData1 (Leaf k) where - liftRnf = liftRnf2 rnf - --- | @since 0.2.14.0 -instance NFData2 Leaf where - liftRnf2 rnf1 rnf2 (L k v) = rnf1 k `seq` rnf2 v - --- | A map from keys to values. A map cannot contain duplicate keys; --- each key can map to at most one value. -data HashMap k v - = Empty - -- ^ Invariants: - -- - -- * 'Empty' is not a valid sub-node. It can only appear at the root. (INV1) - | BitmapIndexed !Bitmap !(A.Array (HashMap k v)) - -- ^ Invariants: - -- - -- * Only the lower @maxChildren@ bits of the 'Bitmap' may be set. The - -- remaining upper bits must be 0. (INV2) - -- * The array of a 'BitmapIndexed' node stores at least 1 and at most - -- @'maxChildren' - 1@ sub-nodes. (INV3) - -- * The number of sub-nodes is equal to the number of 1-bits in its - -- 'Bitmap'. (INV4) - -- * If a 'BitmapIndexed' node has only one sub-node, this sub-node must - -- be a 'BitmapIndexed' or a 'Full' node. (INV5) - | Leaf !Hash !(Leaf k v) - -- ^ Invariants: - -- - -- * The location of a 'Leaf' or 'Collision' node in the tree must be - -- compatible with its 'Hash'. (INV6) - -- (TODO: Document this properly (#425)) - -- * The 'Hash' of a 'Leaf' node must be the 'hash' of its key. (INV7) - | Full !(A.Array (HashMap k v)) - -- ^ Invariants: - -- - -- * The array of a 'Full' node stores exactly 'maxChildren' sub-nodes. (INV8) - | Collision !Hash !(A.Array (Leaf k v)) - -- ^ Invariants: - -- - -- * The location of a 'Leaf' or 'Collision' node in the tree must be - -- compatible with its 'Hash'. (INV6) - -- (TODO: Document this properly (#425)) - -- * The array of a 'Collision' node must contain at least two sub-nodes. (INV9) - -- * The 'hash' of each key in a 'Collision' node must be the one stored in - -- the node. (INV7) - -- * No two keys stored in a 'Collision' can be equal according to their - -- 'Eq' instance. (INV10) - -type role HashMap nominal representational - --- | @since 0.2.17.0 -deriving instance (TH.Lift k, TH.Lift v) => TH.Lift (HashMap k v) - -instance (NFData k, NFData v) => NFData (HashMap k v) where - rnf Empty = () - rnf (BitmapIndexed _ ary) = rnf ary - rnf (Leaf _ l) = rnf l - rnf (Full ary) = rnf ary - rnf (Collision _ ary) = rnf ary - --- | @since 0.2.14.0 -instance NFData k => NFData1 (HashMap k) where - liftRnf = liftRnf2 rnf - --- | @since 0.2.14.0 -instance NFData2 HashMap where - liftRnf2 _ _ Empty = () - liftRnf2 rnf1 rnf2 (BitmapIndexed _ ary) = liftRnf (liftRnf2 rnf1 rnf2) ary - liftRnf2 rnf1 rnf2 (Leaf _ l) = liftRnf2 rnf1 rnf2 l - liftRnf2 rnf1 rnf2 (Full ary) = liftRnf (liftRnf2 rnf1 rnf2) ary - liftRnf2 rnf1 rnf2 (Collision _ ary) = liftRnf (liftRnf2 rnf1 rnf2) ary - -instance Functor (HashMap k) where - fmap = map - -instance Foldable.Foldable (HashMap k) where - foldMap f = foldMapWithKey (\ _k v -> f v) - {-# INLINE foldMap #-} - foldr = foldr - {-# INLINE foldr #-} - foldl = foldl - {-# INLINE foldl #-} - foldr' = foldr' - {-# INLINE foldr' #-} - foldl' = foldl' - {-# INLINE foldl' #-} - null = null - {-# INLINE null #-} - length = size - {-# INLINE length #-} - --- | @since 0.2.11 -instance Bifoldable HashMap where - bifoldMap f g = foldMapWithKey (\ k v -> f k `mappend` g v) - {-# INLINE bifoldMap #-} - bifoldr f g = foldrWithKey (\ k v acc -> k `f` (v `g` acc)) - {-# INLINE bifoldr #-} - bifoldl f g = foldlWithKey (\ acc k v -> (acc `f` k) `g` v) - {-# INLINE bifoldl #-} - --- | '<>' = 'union' --- --- If a key occurs in both maps, the mapping from the first will be the mapping in the result. --- --- ==== __Examples__ --- --- >>> fromList [(1,'a'),(2,'b')] <> fromList [(2,'c'),(3,'d')] --- fromList [(1,'a'),(2,'b'),(3,'d')] -instance (Eq k, Hashable k) => Semigroup (HashMap k v) where - (<>) = union - {-# INLINE (<>) #-} - stimes = stimesIdempotentMonoid - {-# INLINE stimes #-} - --- | 'mempty' = 'empty' --- --- 'mappend' = 'union' --- --- If a key occurs in both maps, the mapping from the first will be the mapping in the result. --- --- ==== __Examples__ --- --- >>> mappend (fromList [(1,'a'),(2,'b')]) (fromList [(2,'c'),(3,'d')]) --- fromList [(1,'a'),(2,'b'),(3,'d')] -instance (Eq k, Hashable k) => Monoid (HashMap k v) where - mempty = empty - {-# INLINE mempty #-} - mappend = (<>) - {-# INLINE mappend #-} - -instance (Data k, Data v, Eq k, Hashable k) => Data (HashMap k v) where - gfoldl f z m = z fromList `f` toList m - toConstr _ = fromListConstr - gunfold k z c = case Data.constrIndex c of - 1 -> k (z fromList) - _ -> error "gunfold" - dataTypeOf _ = hashMapDataType - dataCast1 f = Data.gcast1 f - dataCast2 f = Data.gcast2 f - -fromListConstr :: Constr -fromListConstr = Data.mkConstr hashMapDataType "fromList" [] Data.Prefix - -hashMapDataType :: DataType -hashMapDataType = Data.mkDataType "Data.HashMap.Internal.HashMap" [fromListConstr] - --- | This type is used to store the hash of a key, as produced with 'hash'. -type Hash = Word - --- | A bitmap as contained by a 'BitmapIndexed' node, or a 'fullBitmap' --- corresponding to a 'Full' node. --- --- Only the lower 'maxChildren' bits are used. The remaining bits must be zeros. -type Bitmap = Word - --- | 'Shift' values correspond to the level of the tree that we're currently --- operating at. At the root level the 'Shift' is @0@. For the subsequent --- levels the 'Shift' values are 'bitsPerSubkey', @2*'bitsPerSubkey'@ etc. --- --- Valid values are non-negative and less than @bitSize (0 :: Word)@. -type Shift = Int - -instance Show2 HashMap where - liftShowsPrec2 spk slk spv slv d m = - FC.showsUnaryWith (liftShowsPrec sp sl) "fromList" d (toList m) - where - sp = liftShowsPrec2 spk slk spv slv - sl = liftShowList2 spk slk spv slv - -instance Show k => Show1 (HashMap k) where - liftShowsPrec = liftShowsPrec2 showsPrec showList - -instance (Eq k, Hashable k, Read k) => Read1 (HashMap k) where - liftReadsPrec rp rl = FC.readsData $ - FC.readsUnaryWith (liftReadsPrec rp' rl') "fromList" fromList - where - rp' = liftReadsPrec rp rl - rl' = liftReadList rp rl - -instance (Eq k, Hashable k, Read k, Read e) => Read (HashMap k e) where - readPrec = parens $ prec 10 $ do - Ident "fromList" <- lexP - fromList <$> readPrec - - readListPrec = readListPrecDefault - -instance (Show k, Show v) => Show (HashMap k v) where - showsPrec d m = showParen (d > 10) $ - showString "fromList " . shows (toList m) - -instance Traversable (HashMap k) where - traverse f = traverseWithKey (const f) - {-# INLINABLE traverse #-} - -instance Eq2 HashMap where - liftEq2 = equal2 - -instance Eq k => Eq1 (HashMap k) where - liftEq = equal1 - --- | Note that, in the presence of hash collisions, equal @HashMap@s may --- behave differently, i.e. extensionality may be violated: --- --- >>> data D = A | B deriving (Eq, Show) --- >>> instance Hashable D where hashWithSalt salt _d = salt --- --- >>> x = fromList [(A,1), (B,2)] --- >>> y = fromList [(B,2), (A,1)] --- --- >>> x == y --- True --- >>> toList x --- [(A,1),(B,2)] --- >>> toList y --- [(B,2),(A,1)] --- --- In general, the lack of extensionality can be observed with any function --- that depends on the key ordering, such as folds and traversals. -instance (Eq k, Eq v) => Eq (HashMap k v) where - (==) = equal1 (==) - -equal1 :: Eq k - => (v -> v' -> Bool) - -> HashMap k v -> HashMap k v' -> Bool -equal1 eq = go - where - go Empty Empty = True - go (BitmapIndexed bm1 ary1) (BitmapIndexed bm2 ary2) - = bm1 == bm2 && A.sameArray1 go ary1 ary2 - go (Leaf h1 l1) (Leaf h2 l2) = h1 == h2 && leafEq l1 l2 - go (Full ary1) (Full ary2) = A.sameArray1 go ary1 ary2 - go (Collision h1 ary1) (Collision h2 ary2) - = h1 == h2 && isPermutationBy leafEq (A.toList ary1) (A.toList ary2) - go _ _ = False - - leafEq (L k1 v1) (L k2 v2) = k1 == k2 && eq v1 v2 - -equal2 :: (k -> k' -> Bool) -> (v -> v' -> Bool) - -> HashMap k v -> HashMap k' v' -> Bool -equal2 eqk eqv t1 t2 = go (leavesAndCollisions t1 []) (leavesAndCollisions t2 []) - where - -- If the two trees are the same, then their lists of 'Leaf's and - -- 'Collision's read from left to right should be the same (modulo the - -- order of elements in 'Collision'). - - go (Leaf k1 l1 : tl1) (Leaf k2 l2 : tl2) - | k1 == k2 && - leafEq l1 l2 - = go tl1 tl2 - go (Collision h1 ary1 : tl1) (Collision h2 ary2 : tl2) - | h1 == h2 && - A.length ary1 == A.length ary2 && - isPermutationBy leafEq (A.toList ary1) (A.toList ary2) - = go tl1 tl2 - go [] [] = True - go _ _ = False - - leafEq (L k v) (L k' v') = eqk k k' && eqv v v' - -instance Ord2 HashMap where - liftCompare2 = cmp - -instance Ord k => Ord1 (HashMap k) where - liftCompare = cmp compare - --- | The ordering is total and consistent with the `Eq` instance. However, --- nothing else about the ordering is specified, and it may change from --- version to version of either this package or of @hashable@. -instance (Ord k, Ord v) => Ord (HashMap k v) where - compare = cmp compare compare - -cmp :: (k -> k' -> Ordering) -> (v -> v' -> Ordering) - -> HashMap k v -> HashMap k' v' -> Ordering -cmp cmpk cmpv t1 t2 = go (leavesAndCollisions t1 []) (leavesAndCollisions t2 []) - where - go (Leaf k1 l1 : tl1) (Leaf k2 l2 : tl2) - = compare k1 k2 `mappend` - leafCompare l1 l2 `mappend` - go tl1 tl2 - go (Collision h1 ary1 : tl1) (Collision h2 ary2 : tl2) - = compare h1 h2 `mappend` - compare (A.length ary1) (A.length ary2) `mappend` - unorderedCompare leafCompare (A.toList ary1) (A.toList ary2) `mappend` - go tl1 tl2 - go (Leaf _ _ : _) (Collision _ _ : _) = LT - go (Collision _ _ : _) (Leaf _ _ : _) = GT - go [] [] = EQ - go [] _ = LT - go _ [] = GT - go _ _ = error "cmp: Should never happen, leavesAndCollisions includes non Leaf / Collision" - - leafCompare (L k v) (L k' v') = cmpk k k' `mappend` cmpv v v' - --- Same as 'equal2' but doesn't compare the values. -equalKeys1 :: (k -> k' -> Bool) -> HashMap k v -> HashMap k' v' -> Bool -equalKeys1 eq t1 t2 = go (leavesAndCollisions t1 []) (leavesAndCollisions t2 []) - where - go (Leaf k1 l1 : tl1) (Leaf k2 l2 : tl2) - | k1 == k2 && leafEq l1 l2 - = go tl1 tl2 - go (Collision h1 ary1 : tl1) (Collision h2 ary2 : tl2) - | h1 == h2 && A.length ary1 == A.length ary2 && - isPermutationBy leafEq (A.toList ary1) (A.toList ary2) - = go tl1 tl2 - go [] [] = True - go _ _ = False - - leafEq (L k _) (L k' _) = eq k k' - --- Same as 'equal1' but doesn't compare the values. -equalKeys :: Eq k => HashMap k v -> HashMap k v' -> Bool -equalKeys = go - where - go :: Eq k => HashMap k v -> HashMap k v' -> Bool - go Empty Empty = True - go (BitmapIndexed bm1 ary1) (BitmapIndexed bm2 ary2) - = bm1 == bm2 && A.sameArray1 go ary1 ary2 - go (Leaf h1 l1) (Leaf h2 l2) = h1 == h2 && leafEq l1 l2 - go (Full ary1) (Full ary2) = A.sameArray1 go ary1 ary2 - go (Collision h1 ary1) (Collision h2 ary2) - = h1 == h2 && isPermutationBy leafEq (A.toList ary1) (A.toList ary2) - go _ _ = False - - leafEq (L k1 _) (L k2 _) = k1 == k2 - -instance Hashable2 HashMap where - liftHashWithSalt2 hk hv salt hm = go salt (leavesAndCollisions hm []) - where - -- go :: Int -> [HashMap k v] -> Int - go s [] = s - go s (Leaf _ l : tl) - = s `hashLeafWithSalt` l `go` tl - -- For collisions we hashmix hash value - -- and then array of values' hashes sorted - go s (Collision h a : tl) - = (s `H.hashWithSalt` h) `hashCollisionWithSalt` a `go` tl - go s (_ : tl) = s `go` tl - - -- hashLeafWithSalt :: Int -> Leaf k v -> Int - hashLeafWithSalt s (L k v) = (s `hk` k) `hv` v - - -- hashCollisionWithSalt :: Int -> A.Array (Leaf k v) -> Int - hashCollisionWithSalt s - = List.foldl' H.hashWithSalt s . arrayHashesSorted s - - -- arrayHashesSorted :: Int -> A.Array (Leaf k v) -> [Int] - arrayHashesSorted s = List.sort . List.map (hashLeafWithSalt s) . A.toList - -instance (Hashable k) => Hashable1 (HashMap k) where - liftHashWithSalt = H.liftHashWithSalt2 H.hashWithSalt - -instance (Hashable k, Hashable v) => Hashable (HashMap k v) where - hashWithSalt salt hm = go salt hm - where - go :: Int -> HashMap k v -> Int - go s Empty = s - go s (BitmapIndexed _ a) = A.foldl' go s a - go s (Leaf h (L _ v)) - = s `H.hashWithSalt` h `H.hashWithSalt` v - -- For collisions we hashmix hash value - -- and then array of values' hashes sorted - go s (Full a) = A.foldl' go s a - go s (Collision h a) - = (s `H.hashWithSalt` h) `hashCollisionWithSalt` a - - hashLeafWithSalt :: Int -> Leaf k v -> Int - hashLeafWithSalt s (L k v) = s `H.hashWithSalt` k `H.hashWithSalt` v - - hashCollisionWithSalt :: Int -> A.Array (Leaf k v) -> Int - hashCollisionWithSalt s - = List.foldl' H.hashWithSalt s . arrayHashesSorted s - - arrayHashesSorted :: Int -> A.Array (Leaf k v) -> [Int] - arrayHashesSorted s = List.sort . List.map (hashLeafWithSalt s) . A.toList - --- | Helper to get 'Leaf's and 'Collision's as a list. -leavesAndCollisions :: HashMap k v -> [HashMap k v] -> [HashMap k v] -leavesAndCollisions (BitmapIndexed _ ary) a = A.foldr leavesAndCollisions a ary -leavesAndCollisions (Full ary) a = A.foldr leavesAndCollisions a ary -leavesAndCollisions l@(Leaf _ _) a = l : a -leavesAndCollisions c@(Collision _ _) a = c : a -leavesAndCollisions Empty a = a - --- | Helper function to detect 'Leaf's and 'Collision's. -isLeafOrCollision :: HashMap k v -> Bool -isLeafOrCollision (Leaf _ _) = True -isLeafOrCollision (Collision _ _) = True -isLeafOrCollision _ = False - ------------------------------------------------------------------------- --- * Construction - --- | \(O(1)\) Construct an empty map. -empty :: HashMap k v -empty = Empty - --- | \(O(1)\) Construct a map with a single element. -singleton :: (Hashable k) => k -> v -> HashMap k v -singleton k v = Leaf (hash k) (L k v) - ------------------------------------------------------------------------- --- * Basic interface - --- | \(O(1)\) Return 'True' if this map is empty, 'False' otherwise. -null :: HashMap k v -> Bool -null Empty = True -null _ = False - --- | \(O(n)\) Return the number of key-value mappings in this map. -size :: HashMap k v -> Int -size t = go t 0 - where - go Empty !n = n - go (Leaf _ _) n = n + 1 - go (BitmapIndexed _ ary) n = A.foldl' (flip go) n ary - go (Full ary) n = A.foldl' (flip go) n ary - go (Collision _ ary) n = n + A.length ary - --- | \(O(\log n)\) Return 'True' if the specified key is present in the --- map, 'False' otherwise. -member :: (Eq k, Hashable k) => k -> HashMap k a -> Bool -member k m = case lookup k m of - Nothing -> False - Just _ -> True -{-# INLINABLE member #-} - --- | \(O(\log n)\) Return the value to which the specified key is mapped, --- or 'Nothing' if this map contains no mapping for the key. -lookup :: (Eq k, Hashable k) => k -> HashMap k v -> Maybe v --- GHC does not yet perform a worker-wrapper transformation on --- unboxed sums automatically. That seems likely to happen at some --- point (possibly as early as GHC 8.6) but for now we do it manually. -lookup k m = case lookup# k m of - (# (# #) | #) -> Nothing - (# | a #) -> Just a -{-# INLINE lookup #-} - -lookup# :: (Eq k, Hashable k) => k -> HashMap k v -> (# (# #) | v #) -lookup# k m = lookupCont (\_ -> (# (# #) | #)) (\v _i -> (# | v #)) (hash k) k 0 m -{-# INLINABLE lookup# #-} - --- | lookup' is a version of lookup that takes the hash separately. --- It is used to implement alterF. -lookup' :: Eq k => Hash -> k -> HashMap k v -> Maybe v --- GHC does not yet perform a worker-wrapper transformation on --- unboxed sums automatically. That seems likely to happen at some --- point (possibly as early as GHC 8.6) but for now we do it manually. --- lookup' would probably prefer to be implemented in terms of its own --- lookup'#, but it's not important enough and we don't want too much --- code. -lookup' h k m = case lookupRecordCollision# h k m of - (# (# #) | #) -> Nothing - (# | (# a, _i #) #) -> Just a -{-# INLINE lookup' #-} - --- The result of a lookup, keeping track of if a hash collision occurred. --- If a collision did not occur then it will have the Int value (-1). -data LookupRes a = Absent | Present a !Int - -lookupResToMaybe :: LookupRes a -> Maybe a -lookupResToMaybe Absent = Nothing -lookupResToMaybe (Present x _) = Just x -{-# INLINE lookupResToMaybe #-} - --- Internal helper for lookup. This version takes the precomputed hash so --- that functions that make multiple calls to lookup and related functions --- (insert, delete) only need to calculate the hash once. --- --- It is used by 'alterF' so that hash computation and key comparison only needs --- to be performed once. With this information you can use the more optimized --- versions of insert ('insertNewKey', 'insertKeyExists') and delete --- ('deleteKeyExists') --- --- Outcomes: --- Key not in map => Absent --- Key in map, no collision => Present v (-1) --- Key in map, collision => Present v position -lookupRecordCollision :: Eq k => Hash -> k -> HashMap k v -> LookupRes v -lookupRecordCollision h k m = case lookupRecordCollision# h k m of - (# (# #) | #) -> Absent - (# | (# a, i #) #) -> Present a (I# i) -- GHC will eliminate the I# -{-# INLINE lookupRecordCollision #-} - --- Why do we produce an Int# instead of an Int? Unfortunately, GHC is not --- yet any good at unboxing things *inside* products, let alone sums. That --- may be changing in GHC 8.6 or so (there is some work in progress), but --- for now we use Int# explicitly here. We don't need to push the Int# --- into lookupCont because inlining takes care of that. -lookupRecordCollision# :: Eq k => Hash -> k -> HashMap k v -> (# (# #) | (# v, Int# #) #) -lookupRecordCollision# h k m = - lookupCont (\_ -> (# (# #) | #)) (\v (I# i) -> (# | (# v, i #) #)) h k 0 m --- INLINABLE to specialize to the Eq instance. -{-# INLINABLE lookupRecordCollision# #-} - --- A two-continuation version of lookupRecordCollision. This lets us --- share source code between lookup and lookupRecordCollision without --- risking any performance degradation. --- --- The absent continuation has type @((# #) -> r)@ instead of just @r@ --- so we can be representation-polymorphic in the result type. Since --- this whole thing is always inlined, we don't have to worry about --- any extra CPS overhead. --- --- The @Int@ argument is the offset of the subkey in the hash. When looking up --- keys at the top-level of a hashmap, the offset should be 0. When looking up --- keys at level @n@ of a hashmap, the offset should be @n * bitsPerSubkey@. -lookupCont :: - forall rep (r :: TYPE rep) k v. - Eq k - => ((# #) -> r) -- Absent continuation - -> (v -> Int -> r) -- Present continuation - -> Hash -- The hash of the key - -> k - -> Int -- The offset of the subkey in the hash. - -> HashMap k v -> r -lookupCont absent present !h0 !k0 !s0 !m0 = go h0 k0 s0 m0 - where - go :: Eq k => Hash -> k -> Int -> HashMap k v -> r - go !_ !_ !_ Empty = absent (# #) - go h k _ (Leaf hx (L kx x)) - | h == hx && k == kx = present x (-1) - | otherwise = absent (# #) - go h k s (BitmapIndexed b v) - | b .&. m == 0 = absent (# #) - | otherwise = - go h k (nextShift s) (A.index v (sparseIndex b m)) - where m = mask h s - go h k s (Full v) = - go h k (nextShift s) (A.index v (index h s)) - go h k _ (Collision hx v) - | h == hx = lookupInArrayCont absent present k v - | otherwise = absent (# #) -{-# INLINE lookupCont #-} - --- | \(O(\log n)\) Return the value to which the specified key is mapped, --- or 'Nothing' if this map contains no mapping for the key. --- --- This is a flipped version of 'lookup'. --- --- @since 0.2.11 -(!?) :: (Eq k, Hashable k) => HashMap k v -> k -> Maybe v -(!?) m k = lookup k m -{-# INLINE (!?) #-} - - --- | \(O(\log n)\) Return the value to which the specified key is mapped, --- or the default value if this map contains no mapping for the key. --- --- @since 0.2.11 -findWithDefault :: (Eq k, Hashable k) - => v -- ^ Default value to return. - -> k -> HashMap k v -> v -findWithDefault def k t = case lookup k t of - Just v -> v - _ -> def -{-# INLINABLE findWithDefault #-} - - --- | \(O(\log n)\) Return the value to which the specified key is mapped, --- or the default value if this map contains no mapping for the key. --- --- DEPRECATED: lookupDefault is deprecated as of version 0.2.11, replaced --- by 'findWithDefault'. -lookupDefault :: (Eq k, Hashable k) - => v -- ^ Default value to return. - -> k -> HashMap k v -> v -lookupDefault = findWithDefault -{-# INLINE lookupDefault #-} - --- | \(O(\log n)\) Return the value to which the specified key is mapped. --- Calls 'error' if this map contains no mapping for the key. -(!) :: (Eq k, Hashable k, HasCallStack) => HashMap k v -> k -> v -(!) m k = case lookup k m of - Just v -> v - Nothing -> error "Data.HashMap.Internal.(!): key not found" -{-# INLINABLE (!) #-} - -infixl 9 ! - --- | Create a 'Collision' value with two 'Leaf' values. -collision :: Hash -> Leaf k v -> Leaf k v -> HashMap k v -collision h !e1 !e2 = - let v = A.run $ do mary <- A.new 2 e1 - A.write mary 1 e2 - return mary - in Collision h v -{-# INLINE collision #-} - --- | Create a 'BitmapIndexed' or 'Full' node. -bitmapIndexedOrFull :: Bitmap -> A.Array (HashMap k v) -> HashMap k v --- The strictness in @ary@ helps achieve a nice code size reduction in --- @unionWith[Key]@ with GHC 9.2.2. See the Core diffs in --- https://github.com/haskell-unordered-containers/unordered-containers/pull/376. -bitmapIndexedOrFull b !ary - | b == fullBitmap = Full ary - | otherwise = BitmapIndexed b ary -{-# INLINE bitmapIndexedOrFull #-} - --- | \(O(\log n)\) Associate the specified value with the specified --- key in this map. If this map previously contained a mapping for --- the key, the old value is replaced. -insert :: (Eq k, Hashable k) => k -> v -> HashMap k v -> HashMap k v -insert k v m = insert' (hash k) k v m -{-# INLINABLE insert #-} - -insert' :: Eq k => Hash -> k -> v -> HashMap k v -> HashMap k v -insert' h0 k0 v0 m0 = go h0 k0 v0 0 m0 - where - go !h !k x !_ Empty = Leaf h (L k x) - go h k x s t@(Leaf hy l@(L ky y)) - | hy == h = if ky == k - then if x `ptrEq` y - then t - else Leaf h (L k x) - else collision h l (L k x) - | otherwise = runST (two s h k x hy t) - go h k x s t@(BitmapIndexed b ary) - | b .&. m == 0 = - let !ary' = A.insert ary i $! Leaf h (L k x) - in bitmapIndexedOrFull (b .|. m) ary' - | otherwise = - let !st = A.index ary i - !st' = go h k x (nextShift s) st - in if st' `ptrEq` st - then t - else BitmapIndexed b (A.update ary i st') - where m = mask h s - i = sparseIndex b m - go h k x s t@(Full ary) = - let !st = A.index ary i - !st' = go h k x (nextShift s) st - in if st' `ptrEq` st - then t - else Full (updateFullArray ary i st') - where i = index h s - go h k x s t@(Collision hy v) - | h == hy = Collision h (updateOrSnocWith (\a _ -> (# a #)) k x v) - | otherwise = go h k x s $ BitmapIndexed (mask hy s) (A.singleton t) -{-# INLINABLE insert' #-} - --- Insert optimized for the case when we know the key is not in the map. --- --- It is only valid to call this when the key does not exist in the map. --- --- We can skip: --- - the key equality check on a Leaf --- - check for its existence in the array for a hash collision -insertNewKey :: Hash -> k -> v -> HashMap k v -> HashMap k v -insertNewKey !h0 !k0 x0 !m0 = go h0 k0 x0 0 m0 - where - go !h !k x !_ Empty = Leaf h (L k x) - go h k x s t@(Leaf hy l) - | hy == h = collision h l (L k x) - | otherwise = runST (two s h k x hy t) - go h k x s (BitmapIndexed b ary) - | b .&. m == 0 = - let !ary' = A.insert ary i $! Leaf h (L k x) - in bitmapIndexedOrFull (b .|. m) ary' - | otherwise = - let !st = A.index ary i - !st' = go h k x (nextShift s) st - in BitmapIndexed b (A.update ary i st') - where m = mask h s - i = sparseIndex b m - go h k x s (Full ary) = - let !st = A.index ary i - !st' = go h k x (nextShift s) st - in Full (updateFullArray ary i st') - where i = index h s - go h k x s t@(Collision hy v) - | h == hy = Collision h (A.snoc v (L k x)) - | otherwise = - go h k x s $ BitmapIndexed (mask hy s) (A.singleton t) -{-# NOINLINE insertNewKey #-} - - --- Insert optimized for the case when we know the key is in the map. --- --- It is only valid to call this when the key exists in the map and you know the --- hash collision position if there was one. This information can be obtained --- from 'lookupRecordCollision'. If there is no collision, pass (-1) as collPos --- (first argument). -insertKeyExists :: Int -> Hash -> k -> v -> HashMap k v -> HashMap k v -insertKeyExists !collPos0 !h0 !k0 x0 !m0 = go collPos0 h0 k0 x0 m0 - where - go !_collPos !_shiftedHash !k x (Leaf h _kx) - = Leaf h (L k x) - go collPos shiftedHash k x (BitmapIndexed b ary) = - let !st = A.index ary i - !st' = go collPos (shiftHash shiftedHash) k x st - in BitmapIndexed b (A.update ary i st') - where m = mask' shiftedHash - i = sparseIndex b m - go collPos shiftedHash k x (Full ary) = - let !st = A.index ary i - !st' = go collPos (shiftHash shiftedHash) k x st - in Full (updateFullArray ary i st') - where i = index' shiftedHash - go collPos _shiftedHash k x (Collision h v) - | collPos >= 0 = Collision h (setAtPosition collPos k x v) - | otherwise = Empty -- error "Internal error: go {collPos negative}" - go _ _ _ _ Empty = Empty -- error "Internal error: go Empty" - - -- Customized version of 'index' that doesn't require a 'Shift'. - index' :: Hash -> Int - index' w = fromIntegral $ w .&. subkeyMask - {-# INLINE index' #-} - - -- Customized version of 'mask' that doesn't require a 'Shift'. - mask' :: Word -> Bitmap - mask' w = 1 `unsafeShiftL` index' w - {-# INLINE mask' #-} - - shiftHash h = h `unsafeShiftR` bitsPerSubkey - {-# INLINE shiftHash #-} - -{-# NOINLINE insertKeyExists #-} - --- Replace the ith Leaf with Leaf k v. --- --- This does not check that @i@ is within bounds of the array. -setAtPosition :: Int -> k -> v -> A.Array (Leaf k v) -> A.Array (Leaf k v) -setAtPosition i k x ary = A.update ary i (L k x) -{-# INLINE setAtPosition #-} - - --- | In-place update version of insert -unsafeInsert :: (Eq k, Hashable k) => k -> v -> HashMap k v -> HashMap k v -unsafeInsert k0 v0 m0 = runST (go h0 k0 v0 0 m0) - where - h0 = hash k0 - go !h !k x !_ Empty = return $! Leaf h (L k x) - go h k x s t@(Leaf hy l@(L ky y)) - | hy == h = if ky == k - then if x `ptrEq` y - then return t - else return $! Leaf h (L k x) - else return $! collision h l (L k x) - | otherwise = two s h k x hy t - go h k x s t@(BitmapIndexed b ary) - | b .&. m == 0 = do - ary' <- A.insertM ary i $! Leaf h (L k x) - return $! bitmapIndexedOrFull (b .|. m) ary' - | otherwise = do - st <- A.indexM ary i - st' <- go h k x (nextShift s) st - A.unsafeUpdateM ary i st' - return t - where m = mask h s - i = sparseIndex b m - go h k x s t@(Full ary) = do - st <- A.indexM ary i - st' <- go h k x (nextShift s) st - A.unsafeUpdateM ary i st' - return t - where i = index h s - go h k x s t@(Collision hy v) - | h == hy = return $! Collision h (updateOrSnocWith (\a _ -> (# a #)) k x v) - | otherwise = go h k x s $ BitmapIndexed (mask hy s) (A.singleton t) -{-# INLINABLE unsafeInsert #-} - --- | Create a map from two key-value pairs which hashes don't collide. To --- enhance sharing, the second key-value pair is represented by the hash of its --- key and a singleton HashMap pairing its key with its value. --- --- Note: to avoid silly thunks, this function must be strict in the --- key. See issue #232. We don't need to force the HashMap argument --- because it's already in WHNF (having just been matched) and we --- just put it directly in an array. -two :: Shift -> Hash -> k -> v -> Hash -> HashMap k v -> ST s (HashMap k v) -two = go - where - go s h1 k1 v1 h2 t2 - | bp1 == bp2 = do - st <- go (nextShift s) h1 k1 v1 h2 t2 - ary <- A.singletonM st - return $ BitmapIndexed bp1 ary - | otherwise = do - mary <- A.new 2 $! Leaf h1 (L k1 v1) - A.write mary idx2 t2 - ary <- A.unsafeFreeze mary - return $ BitmapIndexed (bp1 .|. bp2) ary - where - bp1 = mask h1 s - bp2 = mask h2 s - !(I# i1) = index h1 s - !(I# i2) = index h2 s - idx2 = I# (i1 Exts.<# i2) - -- This way of computing idx2 saves us a branch compared to the previous approach: - -- - -- idx2 | index h1 s < index h2 s = 1 - -- | otherwise = 0 - -- - -- See https://github.com/haskell-unordered-containers/unordered-containers/issues/75#issuecomment-1128419337 -{-# INLINE two #-} - --- | \(O(\log n)\) Associate the value with the key in this map. If --- this map previously contained a mapping for the key, the old value --- is replaced by the result of applying the given function to the new --- and old value. Example: --- --- > insertWith f k v map --- > where f new old = new + old -insertWith :: (Eq k, Hashable k) => (v -> v -> v) -> k -> v -> HashMap k v - -> HashMap k v --- We're not going to worry about allocating a function closure --- to pass to insertModifying. See comments at 'adjust'. -insertWith f k new m = insertModifying new (\old -> (# f new old #)) k m -{-# INLINE insertWith #-} - --- | @insertModifying@ is a lot like insertWith; we use it to implement alterF. --- It takes a value to insert when the key is absent and a function --- to apply to calculate a new value when the key is present. Thanks --- to the unboxed unary tuple, we avoid introducing any unnecessary --- thunks in the tree. -insertModifying :: (Eq k, Hashable k) => v -> (v -> (# v #)) -> k -> HashMap k v - -> HashMap k v -insertModifying x f k0 m0 = go h0 k0 0 m0 - where - !h0 = hash k0 - go !h !k !_ Empty = Leaf h (L k x) - go h k s t@(Leaf hy l@(L ky y)) - | hy == h = if ky == k - then case f y of - (# v' #) | ptrEq y v' -> t - | otherwise -> Leaf h (L k v') - else collision h l (L k x) - | otherwise = runST (two s h k x hy t) - go h k s t@(BitmapIndexed b ary) - | b .&. m == 0 = - let ary' = A.insert ary i $! Leaf h (L k x) - in bitmapIndexedOrFull (b .|. m) ary' - | otherwise = - let !st = A.index ary i - !st' = go h k (nextShift s) st - ary' = A.update ary i $! st' - in if ptrEq st st' - then t - else BitmapIndexed b ary' - where m = mask h s - i = sparseIndex b m - go h k s t@(Full ary) = - let !st = A.index ary i - !st' = go h k (nextShift s) st - ary' = updateFullArray ary i $! st' - in if ptrEq st st' - then t - else Full ary' - where i = index h s - go h k s t@(Collision hy v) - | h == hy = - let !v' = insertModifyingArr x f k v - in if A.unsafeSameArray v v' - then t - else Collision h v' - | otherwise = go h k s $ BitmapIndexed (mask hy s) (A.singleton t) -{-# INLINABLE insertModifying #-} - --- Like insertModifying for arrays; used to implement insertModifying -insertModifyingArr :: Eq k => v -> (v -> (# v #)) -> k -> A.Array (Leaf k v) - -> A.Array (Leaf k v) -insertModifyingArr x f k0 ary0 = go k0 ary0 0 (A.length ary0) - where - go !k !ary !i !n - -- Not found, append to the end. - | i >= n = A.snoc ary $ L k x - | otherwise = case A.index ary i of - (L kx y) | k == kx -> case f y of - (# y' #) -> if ptrEq y y' - then ary - else A.update ary i (L k y') - | otherwise -> go k ary (i+1) n -{-# INLINE insertModifyingArr #-} - --- | In-place update version of insertWith -unsafeInsertWith :: forall k v. (Eq k, Hashable k) - => (v -> v -> v) -> k -> v -> HashMap k v - -> HashMap k v -unsafeInsertWith f k0 v0 m0 = unsafeInsertWithKey (\_ a b -> (# f a b #)) k0 v0 m0 -{-# INLINABLE unsafeInsertWith #-} - -unsafeInsertWithKey :: forall k v. (Eq k, Hashable k) - => (k -> v -> v -> (# v #)) -> k -> v -> HashMap k v - -> HashMap k v -unsafeInsertWithKey f k0 v0 m0 = runST (go h0 k0 v0 0 m0) - where - h0 = hash k0 - go :: Hash -> k -> v -> Shift -> HashMap k v -> ST s (HashMap k v) - go !h !k x !_ Empty = return $! Leaf h (L k x) - go h k x s t@(Leaf hy l@(L ky y)) - | hy == h = if ky == k - then case f k x y of - (# v #) -> return $! Leaf h (L k v) - else return $! collision h l (L k x) - | otherwise = two s h k x hy t - go h k x s t@(BitmapIndexed b ary) - | b .&. m == 0 = do - ary' <- A.insertM ary i $! Leaf h (L k x) - return $! bitmapIndexedOrFull (b .|. m) ary' - | otherwise = do - st <- A.indexM ary i - st' <- go h k x (nextShift s) st - A.unsafeUpdateM ary i st' - return t - where m = mask h s - i = sparseIndex b m - go h k x s t@(Full ary) = do - st <- A.indexM ary i - st' <- go h k x (nextShift s) st - A.unsafeUpdateM ary i st' - return t - where i = index h s - go h k x s t@(Collision hy v) - | h == hy = return $! Collision h (updateOrSnocWithKey f k x v) - | otherwise = go h k x s $ BitmapIndexed (mask hy s) (A.singleton t) -{-# INLINABLE unsafeInsertWithKey #-} - --- | \(O(\log n)\) Remove the mapping for the specified key from this map --- if present. -delete :: (Eq k, Hashable k) => k -> HashMap k v -> HashMap k v -delete k m = delete' (hash k) k m -{-# INLINABLE delete #-} - -delete' :: Eq k => Hash -> k -> HashMap k v -> HashMap k v -delete' h0 k0 m0 = go h0 k0 0 m0 - where - go !_ !_ !_ Empty = Empty - go h k _ t@(Leaf hy (L ky _)) - | hy == h && ky == k = Empty - | otherwise = t - go h k s t@(BitmapIndexed b ary) - | b .&. m == 0 = t - | otherwise = - let !st = A.index ary i - !st' = go h k (nextShift s) st - in if st' `ptrEq` st - then t - else case st' of - Empty | A.length ary == 1 -> Empty - | A.length ary == 2 -> - case (i, A.index ary 0, A.index ary 1) of - (0, _, l) | isLeafOrCollision l -> l - (1, l, _) | isLeafOrCollision l -> l - _ -> bIndexed - | otherwise -> bIndexed - where - bIndexed = BitmapIndexed (b .&. complement m) (A.delete ary i) - l | isLeafOrCollision l && A.length ary == 1 -> l - _ -> BitmapIndexed b (A.update ary i st') - where m = mask h s - i = sparseIndex b m - go h k s t@(Full ary) = - let !st = A.index ary i - !st' = go h k (nextShift s) st - in if st' `ptrEq` st - then t - else case st' of - Empty -> - let ary' = A.delete ary i - bm = fullBitmap .&. complement (1 `unsafeShiftL` i) - in BitmapIndexed bm ary' - _ -> Full (A.update ary i st') - where i = index h s - go h k _ t@(Collision hy v) - | h == hy = case indexOf k v of - Just i - | A.length v == 2 -> - if i == 0 - then Leaf h (A.index v 1) - else Leaf h (A.index v 0) - | otherwise -> Collision h (A.delete v i) - Nothing -> t - | otherwise = t -{-# INLINABLE delete' #-} - --- | Delete optimized for the case when we know the key is in the map. --- --- It is only valid to call this when the key exists in the map and you know the --- hash collision position if there was one. This information can be obtained --- from 'lookupRecordCollision'. If there is no collision, pass (-1) as collPos. -deleteKeyExists :: Int -> Hash -> k -> HashMap k v -> HashMap k v -deleteKeyExists !collPos0 !h0 !k0 !m0 = go collPos0 h0 k0 m0 - where - go :: Int -> Word -> k -> HashMap k v -> HashMap k v - go !_collPos !_shiftedHash !_k (Leaf _ _) = Empty - go collPos shiftedHash k (BitmapIndexed b ary) = - let !st = A.index ary i - !st' = go collPos (shiftHash shiftedHash) k st - in case st' of - Empty | A.length ary == 1 -> Empty - | A.length ary == 2 -> - case (i, A.index ary 0, A.index ary 1) of - (0, _, l) | isLeafOrCollision l -> l - (1, l, _) | isLeafOrCollision l -> l - _ -> bIndexed - | otherwise -> bIndexed - where - bIndexed = BitmapIndexed (b .&. complement m) (A.delete ary i) - l | isLeafOrCollision l && A.length ary == 1 -> l - _ -> BitmapIndexed b (A.update ary i st') - where m = mask' shiftedHash - i = sparseIndex b m - go collPos shiftedHash k (Full ary) = - let !st = A.index ary i - !st' = go collPos (shiftHash shiftedHash) k st - in case st' of - Empty -> - let ary' = A.delete ary i - bm = fullBitmap .&. complement (1 `unsafeShiftL` i) - in BitmapIndexed bm ary' - _ -> Full (A.update ary i st') - where i = index' shiftedHash - go collPos _shiftedHash _k (Collision h v) - | A.length v == 2 - = if collPos == 0 - then Leaf h (A.index v 1) - else Leaf h (A.index v 0) - | otherwise = Collision h (A.delete v collPos) - go !_ !_ !_ Empty = Empty -- error "Internal error: deleteKeyExists empty" - - -- Customized version of 'index' that doesn't require a 'Shift'. - index' :: Hash -> Int - index' w = fromIntegral $ w .&. subkeyMask - {-# INLINE index' #-} - - -- Customized version of 'mask' that doesn't require a 'Shift'. - mask' :: Word -> Bitmap - mask' w = 1 `unsafeShiftL` index' w - {-# INLINE mask' #-} - - shiftHash h = h `unsafeShiftR` bitsPerSubkey - {-# INLINE shiftHash #-} - -{-# NOINLINE deleteKeyExists #-} - --- | \(O(\log n)\) Adjust the value tied to a given key in this map only --- if it is present. Otherwise, leave the map alone. -adjust :: (Eq k, Hashable k) => (v -> v) -> k -> HashMap k v -> HashMap k v --- This operation really likes to leak memory, so using this --- indirect implementation shouldn't hurt much. Furthermore, it allows --- GHC to avoid a leak when the function is lazy. In particular, --- --- adjust (const x) k m --- ==> adjust# (\v -> (# const x v #)) k m --- ==> adjust# (\_ -> (# x #)) k m -adjust f k m = adjust# (\v -> (# f v #)) k m -{-# INLINE adjust #-} - --- | Much like 'adjust', but not inherently leaky. -adjust# :: (Eq k, Hashable k) => (v -> (# v #)) -> k -> HashMap k v -> HashMap k v -adjust# f k0 m0 = go h0 k0 0 m0 - where - h0 = hash k0 - go !_ !_ !_ Empty = Empty - go h k _ t@(Leaf hy (L ky y)) - | hy == h && ky == k = case f y of - (# y' #) | ptrEq y y' -> t - | otherwise -> Leaf h (L k y') - | otherwise = t - go h k s t@(BitmapIndexed b ary) - | b .&. m == 0 = t - | otherwise = let !st = A.index ary i - !st' = go h k (nextShift s) st - ary' = A.update ary i $! st' - in if ptrEq st st' - then t - else BitmapIndexed b ary' - where m = mask h s - i = sparseIndex b m - go h k s t@(Full ary) = - let i = index h s - !st = A.index ary i - !st' = go h k (nextShift s) st - ary' = updateFullArray ary i $! st' - in if ptrEq st st' - then t - else Full ary' - go h k _ t@(Collision hy v) - | h == hy = let !v' = updateWith# f k v - in if A.unsafeSameArray v v' - then t - else Collision h v' - | otherwise = t -{-# INLINABLE adjust# #-} - --- | \(O(\log n)\) The expression @('update' f k map)@ updates the value @x@ at @k@ --- (if it is in the map). If @(f x)@ is 'Nothing', the element is deleted. --- If it is @('Just' y)@, the key @k@ is bound to the new value @y@. -update :: (Eq k, Hashable k) => (a -> Maybe a) -> k -> HashMap k a -> HashMap k a -update f = alter (>>= f) -{-# INLINABLE update #-} - - --- | \(O(\log n)\) The expression @('alter' f k map)@ alters the value @x@ at @k@, or --- absence thereof. --- --- 'alter' can be used to insert, delete, or update a value in a map. In short: --- --- @ --- 'lookup' k ('alter' f k m) = f ('lookup' k m) --- @ -alter :: (Eq k, Hashable k) => (Maybe v -> Maybe v) -> k -> HashMap k v -> HashMap k v -alter f k m = - let !h = hash k - !lookupRes = lookupRecordCollision h k m - in case f (lookupResToMaybe lookupRes) of - Nothing -> case lookupRes of - Absent -> m - Present _ collPos -> deleteKeyExists collPos h k m - Just v' -> case lookupRes of - Absent -> insertNewKey h k v' m - Present v collPos -> - if v `ptrEq` v' - then m - else insertKeyExists collPos h k v' m -{-# INLINABLE alter #-} - --- | \(O(\log n)\) The expression @('alterF' f k map)@ alters the value @x@ at --- @k@, or absence thereof. --- --- 'alterF' can be used to insert, delete, or update a value in a map. --- --- Note: 'alterF' is a flipped version of the 'at' combinator from --- . --- --- @since 0.2.10 -alterF :: (Functor f, Eq k, Hashable k) - => (Maybe v -> f (Maybe v)) -> k -> HashMap k v -> f (HashMap k v) --- We only calculate the hash once, but unless this is rewritten --- by rules we may test for key equality multiple times. --- We force the value of the map for consistency with the rewritten --- version; otherwise someone could tell the difference using a lazy --- @f@ and a functor that is similar to Const but not actually Const. -alterF f = \ !k !m -> - let - !h = hash k - mv = lookup' h k m - in (<$> f mv) $ \case - Nothing -> maybe m (const (delete' h k m)) mv - Just v' -> insert' h k v' m - --- We unconditionally rewrite alterF in RULES, but we expose an --- unfolding just in case it's used in some way that prevents the --- rule from firing. -{-# INLINABLE [0] alterF #-} - --- This is just a bottom value. See the comment on the "alterFWeird" --- rule. -test_bottom :: a -test_bottom = error "Data.HashMap.alterF internal error: hit test_bottom" - --- We use this as an error result in RULES to ensure we don't get --- any useless CallStack nonsense. -bogus# :: (# #) -> (# a #) -bogus# _ = error "Data.HashMap.alterF internal error: hit bogus#" - -{-# RULES --- We probe the behavior of @f@ by applying it to Nothing and to --- Just test_bottom. Based on the results, and how they relate to --- each other, we choose the best implementation. - -"alterFWeird" forall f. alterF f = - alterFWeird (f Nothing) (f (Just test_bottom)) f - --- This rule covers situations where alterF is used to simply insert or --- delete in Identity (most likely via Control.Lens.At). We recognize here --- (through the repeated @x@ on the LHS) that --- --- @f Nothing = f (Just bottom)@, --- --- which guarantees that @f@ doesn't care what its argument is, so --- we don't have to either. --- --- Why only Identity? A variant of this rule is actually valid regardless of --- the functor, but for some functors (e.g., []), it can lead to the --- same keys being compared multiple times, which is bad if they're --- ugly things like strings. This is unfortunate, since the rule is likely --- a good idea for almost all realistic uses, but I don't like nasty --- edge cases. -"alterFconstant" forall (f :: Maybe a -> Identity (Maybe a)) x. - alterFWeird x x f = \ !k !m -> - Identity (case runIdentity x of {Nothing -> delete k m; Just a -> insert k a m}) - --- This rule handles the case where 'alterF' is used to do 'insertWith'-like --- things. Whenever possible, GHC will get rid of the Maybe nonsense for us. --- We delay this rule to stage 1 so alterFconstant has a chance to fire. -"alterFinsertWith" [1] forall (f :: Maybe a -> Identity (Maybe a)) x y. - alterFWeird (coerce (Just x)) (coerce (Just y)) f = - coerce (insertModifying x (\mold -> case runIdentity (f (Just mold)) of - Nothing -> bogus# (# #) - Just new -> (# new #))) - --- Handle the case where someone uses 'alterF' instead of 'adjust'. This --- rule is kind of picky; it will only work if the function doesn't --- do anything between case matching on the Maybe and producing a result. -"alterFadjust" forall (f :: Maybe a -> Identity (Maybe a)) _y. - alterFWeird (coerce Nothing) (coerce (Just _y)) f = - coerce (adjust# (\x -> case runIdentity (f (Just x)) of - Just x' -> (# x' #) - Nothing -> bogus# (# #))) - --- The simple specialization to Const; in this case we can look up --- the key without caring what position it's in. This is only a tiny --- optimization. -"alterFlookup" forall _ign1 _ign2 (f :: Maybe a -> Const r (Maybe a)). - alterFWeird _ign1 _ign2 f = \ !k !m -> Const (getConst (f (lookup k m))) - #-} - --- This is a very unsafe version of alterF used for RULES. When calling --- alterFWeird x y f, the following *must* hold: --- --- x = f Nothing --- y = f (Just _|_) --- --- Failure to abide by these laws will make demons come out of your nose. -alterFWeird - :: (Functor f, Eq k, Hashable k) - => f (Maybe v) - -> f (Maybe v) - -> (Maybe v -> f (Maybe v)) -> k -> HashMap k v -> f (HashMap k v) -alterFWeird _ _ f = alterFEager f -{-# INLINE [0] alterFWeird #-} - --- | This is the default version of alterF that we use in most non-trivial --- cases. It's called "eager" because it looks up the given key in the map --- eagerly, whether or not the given function requires that information. -alterFEager :: (Functor f, Eq k, Hashable k) - => (Maybe v -> f (Maybe v)) -> k -> HashMap k v -> f (HashMap k v) -alterFEager f !k m = (<$> f mv) $ \case - - ------------------------------ - -- Delete the key from the map. - Nothing -> case lookupRes of - - -- Key did not exist in the map to begin with, no-op - Absent -> m - - -- Key did exist - Present _ collPos -> deleteKeyExists collPos h k m - - ------------------------------ - -- Update value - Just v' -> case lookupRes of - - -- Key did not exist before, insert v' under a new key - Absent -> insertNewKey h k v' m - - -- Key existed before - Present v collPos -> - if v `ptrEq` v' - -- If the value is identical, no-op - then m - -- If the value changed, update the value. - else insertKeyExists collPos h k v' m - - where !h = hash k - !lookupRes = lookupRecordCollision h k m - !mv = lookupResToMaybe lookupRes -{-# INLINABLE alterFEager #-} - --- | \(O(n \log m)\) Inclusion of maps. A map is included in another map if the keys --- are subsets and the corresponding values are equal: --- --- > isSubmapOf m1 m2 = keys m1 `isSubsetOf` keys m2 && --- > and [ v1 == v2 | (k1,v1) <- toList m1; let v2 = m2 ! k1 ] --- --- ==== __Examples__ --- --- >>> fromList [(1,'a')] `isSubmapOf` fromList [(1,'a'),(2,'b')] --- True --- --- >>> fromList [(1,'a'),(2,'b')] `isSubmapOf` fromList [(1,'a')] --- False --- --- @since 0.2.12 -isSubmapOf :: (Eq k, Hashable k, Eq v) => HashMap k v -> HashMap k v -> Bool -isSubmapOf = Exts.inline isSubmapOfBy (==) -{-# INLINABLE isSubmapOf #-} - --- | \(O(n \log m)\) Inclusion of maps with value comparison. A map is included in --- another map if the keys are subsets and if the comparison function is true --- for the corresponding values: --- --- > isSubmapOfBy cmpV m1 m2 = keys m1 `isSubsetOf` keys m2 && --- > and [ v1 `cmpV` v2 | (k1,v1) <- toList m1; let v2 = m2 ! k1 ] --- --- ==== __Examples__ --- --- >>> isSubmapOfBy (<=) (fromList [(1,'a')]) (fromList [(1,'b'),(2,'c')]) --- True --- --- >>> isSubmapOfBy (<=) (fromList [(1,'b')]) (fromList [(1,'a'),(2,'c')]) --- False --- --- @since 0.2.12 -isSubmapOfBy :: (Eq k, Hashable k) => (v1 -> v2 -> Bool) -> HashMap k v1 -> HashMap k v2 -> Bool --- For maps without collisions the complexity is O(n*log m), where n is the size --- of m1 and m the size of m2: the inclusion operation visits every leaf in m1 at least once. --- For each leaf in m1, it looks up the key in m2. --- --- The worst case complexity is O(n*m). The worst case is when both hashmaps m1 --- and m2 are collision nodes for the same hash. Since collision nodes are --- unsorted arrays, it requires for every key in m1 a linear search to to find a --- matching key in m2, hence O(n*m). -isSubmapOfBy comp !m1 !m2 = go 0 m1 m2 - where - -- An empty map is always a submap of any other map. - go _ Empty _ = True - - -- If the second map is empty and the first is not, it cannot be a submap. - go _ _ Empty = False - - -- If the first map contains only one entry, lookup the key in the second map. - go s (Leaf h1 (L k1 v1)) t2 = lookupCont (\_ -> False) (\v2 _ -> comp v1 v2) h1 k1 s t2 - - -- In this case, we need to check that for each x in ls1, there is a y in - -- ls2 such that x `comp` y. This is the worst case complexity-wise since it - -- requires a O(m*n) check. - go _ (Collision h1 ls1) (Collision h2 ls2) = - h1 == h2 && subsetArray comp ls1 ls2 - - -- In this case, we only need to check the entries in ls2 with the hash h1. - go s t1@(Collision h1 _) (BitmapIndexed b ls2) - | b .&. m == 0 = False - | otherwise = - go (nextShift s) t1 (A.index ls2 (sparseIndex b m)) - where m = mask h1 s - - -- Similar to the previous case we need to traverse l2 at the index for the hash h1. - go s t1@(Collision h1 _) (Full ls2) = - go (nextShift s) t1 (A.index ls2 (index h1 s)) - - -- In cases where the first and second map are BitmapIndexed or Full, - -- traverse down the tree at the appropriate indices. - go s (BitmapIndexed b1 ls1) (BitmapIndexed b2 ls2) = - submapBitmapIndexed (go (nextShift s)) b1 ls1 b2 ls2 - go s (BitmapIndexed b1 ls1) (Full ls2) = - submapBitmapIndexed (go (nextShift s)) b1 ls1 fullBitmap ls2 - go s (Full ls1) (Full ls2) = - submapBitmapIndexed (go (nextShift s)) fullBitmap ls1 fullBitmap ls2 - - -- Collision and Full nodes always contain at least two entries. Hence it - -- cannot be a map of a leaf. - go _ (Collision {}) (Leaf {}) = False - go _ (BitmapIndexed {}) (Leaf {}) = False - go _ (Full {}) (Leaf {}) = False - go _ (BitmapIndexed {}) (Collision {}) = False - go _ (Full {}) (Collision {}) = False - go _ (Full {}) (BitmapIndexed {}) = False -{-# INLINABLE isSubmapOfBy #-} - --- | \(O(\min n m))\) Checks if a bitmap indexed node is a submap of another. -submapBitmapIndexed :: (HashMap k v1 -> HashMap k v2 -> Bool) -> Bitmap -> A.Array (HashMap k v1) -> Bitmap -> A.Array (HashMap k v2) -> Bool -submapBitmapIndexed comp !b1 !ary1 !b2 !ary2 = subsetBitmaps && go 0 0 (b1Orb2 .&. negate b1Orb2) - where - go :: Int -> Int -> Bitmap -> Bool - go !i !j !m - - -- Note: m can overflow to 0 when maxChildren == WORD_SIZE_IN_BITS. See - -- #491. In that case there needs to be a check '| m == 0 = True' - | m > b1Orb2 = True - - -- In case a key is both in ary1 and ary2, check ary1[i] <= ary2[j] and - -- increment the indices i and j. - | b1Andb2 .&. m /= 0 = comp (A.index ary1 i) (A.index ary2 j) && - go (i+1) (j+1) (m `unsafeShiftL` 1) - - -- In case a key occurs in ary1, but not ary2, only increment index j. - | b2 .&. m /= 0 = go i (j+1) (m `unsafeShiftL` 1) - - -- In case a key neither occurs in ary1 nor ary2, continue. - | otherwise = go i j (m `unsafeShiftL` 1) - - b1Andb2 = b1 .&. b2 - b1Orb2 = b1 .|. b2 - subsetBitmaps = b1Orb2 == b2 -{-# INLINABLE submapBitmapIndexed #-} - ------------------------------------------------------------------------- --- * Combine - --- | \(O(n+m)\) The union of two maps. If a key occurs in both maps, the --- mapping from the first will be the mapping in the result. --- --- ==== __Examples__ --- --- >>> union (fromList [(1,'a'),(2,'b')]) (fromList [(2,'c'),(3,'d')]) --- fromList [(1,'a'),(2,'b'),(3,'d')] -union :: Eq k => HashMap k v -> HashMap k v -> HashMap k v -union = unionWith const -{-# INLINABLE union #-} - --- | \(O(n+m)\) The union of two maps. If a key occurs in both maps, --- the provided function (first argument) will be used to compute the --- result. -unionWith :: Eq k => (v -> v -> v) -> HashMap k v -> HashMap k v - -> HashMap k v -unionWith f = unionWithKey (const f) -{-# INLINE unionWith #-} - --- | \(O(n+m)\) The union of two maps. If a key occurs in both maps, --- the provided function (first argument) will be used to compute the --- result. -unionWithKey :: Eq k => (k -> v -> v -> v) -> HashMap k v -> HashMap k v - -> HashMap k v -unionWithKey f = go 0 - where - -- empty vs. anything - go !_ t1 Empty = t1 - go _ Empty t2 = t2 - -- leaf vs. leaf - go s t1@(Leaf h1 l1@(L k1 v1)) t2@(Leaf h2 l2@(L k2 v2)) - | h1 == h2 = if k1 == k2 - then Leaf h1 (L k1 (f k1 v1 v2)) - else collision h1 l1 l2 - | otherwise = goDifferentHash s h1 h2 t1 t2 - go s t1@(Leaf h1 (L k1 v1)) t2@(Collision h2 ls2) - | h1 == h2 = Collision h1 (updateOrSnocWithKey (\k a b -> (# f k a b #)) k1 v1 ls2) - | otherwise = goDifferentHash s h1 h2 t1 t2 - go s t1@(Collision h1 ls1) t2@(Leaf h2 (L k2 v2)) - | h1 == h2 = Collision h1 (updateOrSnocWithKey (\k a b -> (# f k b a #)) k2 v2 ls1) - | otherwise = goDifferentHash s h1 h2 t1 t2 - go s t1@(Collision h1 ls1) t2@(Collision h2 ls2) - | h1 == h2 = Collision h1 (updateOrConcatWithKey (\k a b -> (# f k a b #)) ls1 ls2) - | otherwise = goDifferentHash s h1 h2 t1 t2 - -- branch vs. branch - go s (BitmapIndexed b1 ary1) (BitmapIndexed b2 ary2) = - let b' = b1 .|. b2 - ary' = unionArrayBy (go (nextShift s)) b1 b2 ary1 ary2 - in bitmapIndexedOrFull b' ary' - go s (BitmapIndexed b1 ary1) (Full ary2) = - let ary' = unionArrayBy (go (nextShift s)) b1 fullBitmap ary1 ary2 - in Full ary' - go s (Full ary1) (BitmapIndexed b2 ary2) = - let ary' = unionArrayBy (go (nextShift s)) fullBitmap b2 ary1 ary2 - in Full ary' - go s (Full ary1) (Full ary2) = - let ary' = unionArrayBy (go (nextShift s)) fullBitmap fullBitmap - ary1 ary2 - in Full ary' - -- leaf vs. branch - go s (BitmapIndexed b1 ary1) t2 - | b1 .&. m2 == 0 = let ary' = A.insert ary1 i t2 - b' = b1 .|. m2 - in bitmapIndexedOrFull b' ary' - | otherwise = let ary' = A.updateWith' ary1 i $ \st1 -> - go (nextShift s) st1 t2 - in BitmapIndexed b1 ary' - where - h2 = leafHashCode t2 - m2 = mask h2 s - i = sparseIndex b1 m2 - go s t1 (BitmapIndexed b2 ary2) - | b2 .&. m1 == 0 = let ary' = A.insert ary2 i $! t1 - b' = b2 .|. m1 - in bitmapIndexedOrFull b' ary' - | otherwise = let ary' = A.updateWith' ary2 i $ \st2 -> - go (nextShift s) t1 st2 - in BitmapIndexed b2 ary' - where - h1 = leafHashCode t1 - m1 = mask h1 s - i = sparseIndex b2 m1 - go s (Full ary1) t2 = - let h2 = leafHashCode t2 - i = index h2 s - ary' = updateFullArrayWith' ary1 i $ \st1 -> go (nextShift s) st1 t2 - in Full ary' - go s t1 (Full ary2) = - let h1 = leafHashCode t1 - i = index h1 s - ary' = updateFullArrayWith' ary2 i $ \st2 -> go (nextShift s) t1 st2 - in Full ary' - - leafHashCode (Leaf h _) = h - leafHashCode (Collision h _) = h - leafHashCode _ = error "leafHashCode" - - goDifferentHash s h1 h2 t1 t2 - | m1 == m2 = BitmapIndexed m1 (A.singleton $! goDifferentHash (nextShift s) h1 h2 t1 t2) - | m1 < m2 = BitmapIndexed (m1 .|. m2) (A.pair t1 t2) - | otherwise = BitmapIndexed (m1 .|. m2) (A.pair t2 t1) - where - m1 = mask h1 s - m2 = mask h2 s -{-# INLINE unionWithKey #-} - --- | Strict in the result of @f@. -unionArrayBy :: (a -> a -> a) -> Bitmap -> Bitmap -> A.Array a -> A.Array a - -> A.Array a --- The manual forcing of @b1@, @b2@, @ary1@ and @ary2@ results in handsome --- Core size reductions with GHC 9.2.2. See the Core diffs in --- https://github.com/haskell-unordered-containers/unordered-containers/pull/376. -unionArrayBy f !b1 !b2 !ary1 !ary2 = A.run $ do - let bCombined = b1 .|. b2 - mary <- A.new_ (popCount bCombined) - -- iterate over nonzero bits of b1 .|. b2 - let go !i !i1 !i2 !b - | b == 0 = return () - | testBit (b1 .&. b2) = do - x1 <- A.indexM ary1 i1 - x2 <- A.indexM ary2 i2 - A.write mary i $! f x1 x2 - go (i+1) (i1+1) (i2+1) b' - | testBit b1 = do - A.write mary i =<< A.indexM ary1 i1 - go (i+1) (i1+1) i2 b' - | otherwise = do - A.write mary i =<< A.indexM ary2 i2 - go (i+1) i1 (i2+1) b' - where - m = 1 `unsafeShiftL` countTrailingZeros b - testBit x = x .&. m /= 0 - b' = b .&. complement m - go 0 0 0 bCombined - return mary - -- TODO: For the case where b1 .&. b2 == b1, i.e. when one is a - -- subset of the other, we could use a slightly simpler algorithm, - -- where we copy one array, and then update. -{-# INLINE unionArrayBy #-} - --- TODO: Figure out the time complexity of 'unions'. - --- | Construct a set containing all elements from a list of sets. -unions :: Eq k => [HashMap k v] -> HashMap k v -unions = List.foldl' union empty -{-# INLINE unions #-} - - ------------------------------------------------------------------------- --- * Compose - --- | Given maps @bc@ and @ab@, relate the keys of @ab@ to the values of @bc@, --- by using the values of @ab@ as keys for lookups in @bc@. --- --- Complexity: \( O (n * \log(m)) \), where \(m\) is the size of the first argument --- --- >>> compose (fromList [('a', "A"), ('b', "B")]) (fromList [(1,'a'),(2,'b'),(3,'z')]) --- fromList [(1,"A"),(2,"B")] --- --- @ --- ('compose' bc ab '!?') = (bc '!?') <=< (ab '!?') --- @ --- --- @since 0.2.13.0 -compose :: (Eq b, Hashable b) => HashMap b c -> HashMap a b -> HashMap a c -compose bc !ab - | null bc = empty - | otherwise = mapMaybe (bc !?) ab - ------------------------------------------------------------------------- --- * Transformations - --- | \(O(n)\) Transform this map by applying a function to every value. -mapWithKey :: (k -> v1 -> v2) -> HashMap k v1 -> HashMap k v2 -mapWithKey f = go - where - go Empty = Empty - go (Leaf h (L k v)) = Leaf h $ L k (f k v) - go (BitmapIndexed b ary) = BitmapIndexed b $ A.map go ary - go (Full ary) = Full $ A.map go ary - -- Why map strictly over collision arrays? Because there's no - -- point suspending the O(1) work this does for each leaf. - go (Collision h ary) = Collision h $ - A.map' (\ (L k v) -> L k (f k v)) ary -{-# INLINE mapWithKey #-} - --- | \(O(n)\) Transform this map by applying a function to every value. -map :: (v1 -> v2) -> HashMap k v1 -> HashMap k v2 -map f = mapWithKey (const f) -{-# INLINE map #-} - --- | \(O(n)\) Perform an 'Applicative' action for each key-value pair --- in a 'HashMap' and produce a 'HashMap' of all the results. --- --- Note: the order in which the actions occur is unspecified. In particular, --- when the map contains hash collisions, the order in which the actions --- associated with the keys involved will depend in an unspecified way on --- their insertion order. -traverseWithKey - :: Applicative f - => (k -> v1 -> f v2) - -> HashMap k v1 -> f (HashMap k v2) -traverseWithKey f = go - where - go Empty = pure Empty - go (Leaf h (L k v)) = Leaf h . L k <$> f k v - go (BitmapIndexed b ary) = BitmapIndexed b <$> A.traverse go ary - go (Full ary) = Full <$> A.traverse go ary - go (Collision h ary) = - Collision h <$> A.traverse' (\ (L k v) -> L k <$> f k v) ary -{-# INLINE traverseWithKey #-} - --- | \(O(n)\). --- @'mapKeys' f s@ is the map obtained by applying @f@ to each key of @s@. --- --- The size of the result may be smaller if @f@ maps two or more distinct --- keys to the same new key. In this case there is no guarantee which of the --- associated values is chosen for the conflicting key. --- --- >>> mapKeys (+ 1) (fromList [(5,"a"), (3,"b")]) --- fromList [(4,"b"),(6,"a")] --- >>> mapKeys (\ _ -> 1) (fromList [(1,"b"), (2,"a"), (3,"d"), (4,"c")]) --- fromList [(1,"c")] --- >>> mapKeys (\ _ -> 3) (fromList [(1,"b"), (2,"a"), (3,"d"), (4,"c")]) --- fromList [(3,"c")] --- --- @since 0.2.14.0 -mapKeys :: (Eq k2, Hashable k2) => (k1 -> k2) -> HashMap k1 v -> HashMap k2 v -mapKeys f = fromList . foldrWithKey (\k x xs -> (f k, x) : xs) [] - ------------------------------------------------------------------------- --- * Difference and intersection - --- | \(O(n \log m)\) Difference of two maps. Return elements of the first map --- not existing in the second. -difference :: (Eq k, Hashable k) => HashMap k v -> HashMap k w -> HashMap k v -difference a b = foldlWithKey' go empty a - where - go m k v = case lookup k b of - Nothing -> unsafeInsert k v m - _ -> m -{-# INLINABLE difference #-} - --- | \(O(n \log m)\) Difference with a combining function. When two equal keys are --- encountered, the combining function is applied to the values of these keys. --- 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) => (v -> w -> Maybe v) -> HashMap k v -> HashMap k w -> HashMap k v -differenceWith f a b = foldlWithKey' go empty a - where - go m k v = case lookup k b of - Nothing -> unsafeInsert k v m - Just w -> maybe m (\y -> unsafeInsert k y m) (f v w) -{-# INLINABLE differenceWith #-} - --- | \(O(n \log m)\) Intersection of two maps. Return elements of the first --- map for keys existing in the second. -intersection :: Eq k => HashMap k v -> HashMap k w -> HashMap k v -intersection = Exts.inline intersectionWith const -{-# INLINABLE intersection #-} - --- | \(O(n \log m)\) Intersection of two maps. If a key occurs in both maps --- the provided function is used to combine the values from the two --- maps. -intersectionWith :: Eq k => (v1 -> v2 -> v3) -> HashMap k v1 -> HashMap k v2 -> HashMap k v3 -intersectionWith f = Exts.inline intersectionWithKey $ const f -{-# INLINABLE intersectionWith #-} - --- | \(O(n \log m)\) Intersection of two maps. If a key occurs in both maps --- the provided function is used to combine the values from the two --- maps. -intersectionWithKey :: Eq k => (k -> v1 -> v2 -> v3) -> HashMap k v1 -> HashMap k v2 -> HashMap k v3 -intersectionWithKey f = intersectionWithKey# $ \k v1 v2 -> (# f k v1 v2 #) -{-# INLINABLE intersectionWithKey #-} - -intersectionWithKey# :: Eq k => (k -> v1 -> v2 -> (# v3 #)) -> HashMap k v1 -> HashMap k v2 -> HashMap k v3 -intersectionWithKey# f = go 0 - where - -- empty vs. anything - go !_ _ Empty = Empty - go _ Empty _ = Empty - -- leaf vs. anything - go s (Leaf h1 (L k1 v1)) t2 = - lookupCont - (\_ -> Empty) - (\v _ -> case f k1 v1 v of (# v' #) -> Leaf h1 $ L k1 v') - h1 k1 s t2 - go s t1 (Leaf h2 (L k2 v2)) = - lookupCont - (\_ -> Empty) - (\v _ -> case f k2 v v2 of (# v' #) -> Leaf h2 $ L k2 v') - h2 k2 s t1 - -- collision vs. collision - go _ (Collision h1 ls1) (Collision h2 ls2) = intersectionCollisions f h1 h2 ls1 ls2 - -- branch vs. branch - go s (BitmapIndexed b1 ary1) (BitmapIndexed b2 ary2) = - intersectionArrayBy (go (nextShift s)) b1 b2 ary1 ary2 - go s (BitmapIndexed b1 ary1) (Full ary2) = - intersectionArrayBy (go (nextShift s)) b1 fullBitmap ary1 ary2 - go s (Full ary1) (BitmapIndexed b2 ary2) = - intersectionArrayBy (go (nextShift s)) fullBitmap b2 ary1 ary2 - go s (Full ary1) (Full ary2) = - intersectionArrayBy (go (nextShift s)) fullBitmap fullBitmap ary1 ary2 - -- collision vs. branch - go s (BitmapIndexed b1 ary1) t2@(Collision h2 _ls2) - | b1 .&. m2 == 0 = Empty - | otherwise = go (nextShift s) (A.index ary1 i) t2 - where - m2 = mask h2 s - i = sparseIndex b1 m2 - go s t1@(Collision h1 _ls1) (BitmapIndexed b2 ary2) - | b2 .&. m1 == 0 = Empty - | otherwise = go (nextShift s) t1 (A.index ary2 i) - where - m1 = mask h1 s - i = sparseIndex b2 m1 - go s (Full ary1) t2@(Collision h2 _ls2) = go (nextShift s) (A.index ary1 i) t2 - where - i = index h2 s - go s t1@(Collision h1 _ls1) (Full ary2) = go (nextShift s) t1 (A.index ary2 i) - where - i = index h1 s -{-# INLINE intersectionWithKey# #-} - -intersectionArrayBy :: - ( HashMap k v1 -> - HashMap k v2 -> - HashMap k v3 - ) -> - Bitmap -> - Bitmap -> - A.Array (HashMap k v1) -> - A.Array (HashMap k v2) -> - HashMap k v3 -intersectionArrayBy f !b1 !b2 !ary1 !ary2 - | b1 .&. b2 == 0 = Empty - | otherwise = runST $ do - mary <- A.new_ $ popCount bIntersect - -- iterate over nonzero bits of b1 .|. b2 - let go !i !i1 !i2 !b !bFinal - | b == 0 = pure (i, bFinal) - | testBit $ b1 .&. b2 = do - x1 <- A.indexM ary1 i1 - x2 <- A.indexM ary2 i2 - case f x1 x2 of - Empty -> go i (i1 + 1) (i2 + 1) b' (bFinal .&. complement m) - _ -> do - A.write mary i $! f x1 x2 - go (i + 1) (i1 + 1) (i2 + 1) b' bFinal - | testBit b1 = go i (i1 + 1) i2 b' bFinal - | otherwise = go i i1 (i2 + 1) b' bFinal - where - m = 1 `unsafeShiftL` countTrailingZeros b - testBit x = x .&. m /= 0 - b' = b .&. complement m - (len, bFinal) <- go 0 0 0 bCombined bIntersect - case len of - 0 -> pure Empty - 1 -> do - l <- A.read mary 0 - if isLeafOrCollision l - then pure l - else BitmapIndexed bFinal <$> (A.unsafeFreeze =<< A.shrink mary 1) - _ -> bitmapIndexedOrFull bFinal <$> (A.unsafeFreeze =<< A.shrink mary len) - where - bCombined = b1 .|. b2 - bIntersect = b1 .&. b2 -{-# INLINE intersectionArrayBy #-} - -intersectionCollisions :: Eq k => (k -> v1 -> v2 -> (# v3 #)) -> Hash -> Hash -> A.Array (Leaf k v1) -> A.Array (Leaf k v2) -> HashMap k v3 -intersectionCollisions f h1 h2 ary1 ary2 - | h1 == h2 = runST $ do - mary2 <- A.thaw ary2 0 $ A.length ary2 - mary <- A.new_ $ min (A.length ary1) (A.length ary2) - let go i j - | i >= A.length ary1 || j >= A.lengthM mary2 = pure j - | otherwise = do - L k1 v1 <- A.indexM ary1 i - searchSwap k1 j mary2 >>= \case - Just (L _k2 v2) -> do - let !(# v3 #) = f k1 v1 v2 - A.write mary j $ L k1 v3 - go (i + 1) (j + 1) - Nothing -> do - go (i + 1) j - len <- go 0 0 - case len of - 0 -> pure Empty - 1 -> Leaf h1 <$> A.read mary 0 - _ -> Collision h1 <$> (A.unsafeFreeze =<< A.shrink mary len) - | otherwise = Empty -{-# INLINE intersectionCollisions #-} - --- | Say we have --- @ --- 1 2 3 4 --- @ --- and we search for @3@. Then we can mutate the array to --- @ --- undefined 2 1 4 --- @ --- We don't actually need to write undefined, we just have to make sure that the next search starts 1 after the current one. -searchSwap :: Eq k => k -> Int -> A.MArray s (Leaf k v) -> ST s (Maybe (Leaf k v)) -searchSwap toFind start = go start toFind start - where - go i0 k i mary - | i >= A.lengthM mary = pure Nothing - | otherwise = do - l@(L k' _v) <- A.read mary i - if k == k' - then do - A.write mary i =<< A.read mary i0 - pure $ Just l - else go i0 k (i + 1) mary -{-# INLINE searchSwap #-} - ------------------------------------------------------------------------- --- * Folds - --- | \(O(n)\) Reduce this map by applying a binary operator to all --- elements, using the given starting value (typically the --- left-identity of the operator). Each application of the operator --- is evaluated before using the result in the next application. --- This function is strict in the starting value. -foldl' :: (a -> v -> a) -> a -> HashMap k v -> a -foldl' f = foldlWithKey' (\ z _ v -> f z v) -{-# INLINE foldl' #-} - --- | \(O(n)\) Reduce this map by applying a binary operator to all --- elements, using the given starting value (typically the --- right-identity of the operator). Each application of the operator --- is evaluated before using the result in the next application. --- This function is strict in the starting value. -foldr' :: (v -> a -> a) -> a -> HashMap k v -> a -foldr' f = foldrWithKey' (\ _ v z -> f v z) -{-# INLINE foldr' #-} - --- | \(O(n)\) Reduce this map by applying a binary operator to all --- elements, using the given starting value (typically the --- left-identity of the operator). Each application of the operator --- is evaluated before using the result in the next application. --- This function is strict in the starting value. -foldlWithKey' :: (a -> k -> v -> a) -> a -> HashMap k v -> a -foldlWithKey' f = go - where - go !z Empty = z - go z (Leaf _ (L k v)) = f z k v - go z (BitmapIndexed _ ary) = A.foldl' go z ary - go z (Full ary) = A.foldl' go z ary - go z (Collision _ ary) = A.foldl' (\ z' (L k v) -> f z' k v) z ary -{-# INLINE foldlWithKey' #-} - --- | \(O(n)\) Reduce this map by applying a binary operator to all --- elements, using the given starting value (typically the --- right-identity of the operator). Each application of the operator --- is evaluated before using the result in the next application. --- This function is strict in the starting value. -foldrWithKey' :: (k -> v -> a -> a) -> a -> HashMap k v -> a -foldrWithKey' f = flip go - where - go Empty z = z - go (Leaf _ (L k v)) !z = f k v z - go (BitmapIndexed _ ary) !z = A.foldr' go z ary - go (Full ary) !z = A.foldr' go z ary - go (Collision _ ary) !z = A.foldr' (\ (L k v) z' -> f k v z') z ary -{-# INLINE foldrWithKey' #-} - --- | \(O(n)\) Reduce this map by applying a binary operator to all --- elements, using the given starting value (typically the --- right-identity of the operator). -foldr :: (v -> a -> a) -> a -> HashMap k v -> a -foldr f = foldrWithKey (const f) -{-# INLINE foldr #-} - --- | \(O(n)\) Reduce this map by applying a binary operator to all --- elements, using the given starting value (typically the --- left-identity of the operator). -foldl :: (a -> v -> a) -> a -> HashMap k v -> a -foldl f = foldlWithKey (\a _k v -> f a v) -{-# INLINE foldl #-} - --- | \(O(n)\) Reduce this map by applying a binary operator to all --- elements, using the given starting value (typically the --- right-identity of the operator). -foldrWithKey :: (k -> v -> a -> a) -> a -> HashMap k v -> a -foldrWithKey f = flip go - where - go Empty z = z - go (Leaf _ (L k v)) z = f k v z - go (BitmapIndexed _ ary) z = A.foldr go z ary - go (Full ary) z = A.foldr go z ary - go (Collision _ ary) z = A.foldr (\ (L k v) z' -> f k v z') z ary -{-# INLINE foldrWithKey #-} - --- | \(O(n)\) Reduce this map by applying a binary operator to all --- elements, using the given starting value (typically the --- left-identity of the operator). -foldlWithKey :: (a -> k -> v -> a) -> a -> HashMap k v -> a -foldlWithKey f = go - where - go z Empty = z - go z (Leaf _ (L k v)) = f z k v - go z (BitmapIndexed _ ary) = A.foldl go z ary - go z (Full ary) = A.foldl go z ary - go z (Collision _ ary) = A.foldl (\ z' (L k v) -> f z' k v) z ary -{-# INLINE foldlWithKey #-} - --- | \(O(n)\) Reduce the map by applying a function to each element --- and combining the results with a monoid operation. -foldMapWithKey :: Monoid m => (k -> v -> m) -> HashMap k v -> m -foldMapWithKey f = go - where - go Empty = mempty - go (Leaf _ (L k v)) = f k v - go (BitmapIndexed _ ary) = A.foldMap go ary - go (Full ary) = A.foldMap go ary - go (Collision _ ary) = A.foldMap (\ (L k v) -> f k v) ary -{-# INLINE foldMapWithKey #-} - ------------------------------------------------------------------------- --- * Filter - --- | \(O(n)\) Transform this map by applying a function to every value --- and retaining only some of them. -mapMaybeWithKey :: (k -> v1 -> Maybe v2) -> HashMap k v1 -> HashMap k v2 -mapMaybeWithKey f = filterMapAux onLeaf onColl - where onLeaf (Leaf h (L k v)) | Just v' <- f k v = Just (Leaf h (L k v')) - onLeaf _ = Nothing - - onColl (L k v) | Just v' <- f k v = Just (L k v') - | otherwise = Nothing -{-# INLINE mapMaybeWithKey #-} - --- | \(O(n)\) Transform this map by applying a function to every value --- and retaining only some of them. -mapMaybe :: (v1 -> Maybe v2) -> HashMap k v1 -> HashMap k v2 -mapMaybe f = mapMaybeWithKey (const f) -{-# INLINE mapMaybe #-} - --- | \(O(n)\) Filter this map by retaining only elements satisfying a --- predicate. -filterWithKey :: forall k v. (k -> v -> Bool) -> HashMap k v -> HashMap k v -filterWithKey pred = filterMapAux onLeaf onColl - where onLeaf t@(Leaf _ (L k v)) | pred k v = Just t - onLeaf _ = Nothing - - onColl el@(L k v) | pred k v = Just el - onColl _ = Nothing -{-# INLINE filterWithKey #-} - - --- | Common implementation for 'filterWithKey' and 'mapMaybeWithKey', --- allowing the former to former to reuse terms. -filterMapAux :: forall k v1 v2 - . (HashMap k v1 -> Maybe (HashMap k v2)) - -> (Leaf k v1 -> Maybe (Leaf k v2)) - -> HashMap k v1 - -> HashMap k v2 -filterMapAux onLeaf onColl = go - where - go Empty = Empty - go t@Leaf{} - | Just t' <- onLeaf t = t' - | otherwise = Empty - go (BitmapIndexed b ary) = filterA ary b - go (Full ary) = filterA ary fullBitmap - go (Collision h ary) = filterC ary h - - filterA ary0 b0 = - let !n = A.length ary0 - in runST $ do - mary <- A.new_ n - step ary0 mary b0 0 0 1 n - where - step :: A.Array (HashMap k v1) -> A.MArray s (HashMap k v2) - -> Bitmap -> Int -> Int -> Bitmap -> Int - -> ST s (HashMap k v2) - step !ary !mary !b i !j !bi n - | i >= n = case j of - 0 -> return Empty - 1 -> do - ch <- A.read mary 0 - case ch of - t | isLeafOrCollision t -> return t - _ -> BitmapIndexed b <$> (A.unsafeFreeze =<< A.shrink mary 1) - _ -> do - ary2 <- A.unsafeFreeze =<< A.shrink mary j - return $! if j == maxChildren - then Full ary2 - else BitmapIndexed b ary2 - | bi .&. b == 0 = step ary mary b i j (bi `unsafeShiftL` 1) n - | otherwise = case go (A.index ary i) of - Empty -> step ary mary (b .&. complement bi) (i+1) j - (bi `unsafeShiftL` 1) n - t -> do A.write mary j t - step ary mary b (i+1) (j+1) (bi `unsafeShiftL` 1) n - - filterC ary0 h = - let !n = A.length ary0 - in runST $ do - mary <- A.new_ n - step ary0 mary 0 0 n - where - step :: A.Array (Leaf k v1) -> A.MArray s (Leaf k v2) - -> Int -> Int -> Int - -> ST s (HashMap k v2) - step !ary !mary i !j n - | i >= n = case j of - 0 -> return Empty - 1 -> do l <- A.read mary 0 - return $! Leaf h l - _ | i == j -> do ary2 <- A.unsafeFreeze mary - return $! Collision h ary2 - | otherwise -> do ary2 <- A.unsafeFreeze =<< A.shrink mary j - return $! Collision h ary2 - | Just el <- onColl $! A.index ary i - = A.write mary j el >> step ary mary (i+1) (j+1) n - | otherwise = step ary mary (i+1) j n -{-# INLINE filterMapAux #-} - --- | \(O(n)\) Filter this map by retaining only elements which values --- satisfy a predicate. -filter :: (v -> Bool) -> HashMap k v -> HashMap k v -filter p = filterWithKey (\_ v -> p v) -{-# INLINE filter #-} - ------------------------------------------------------------------------- --- * Conversions - --- TODO: Improve fusion rules by modelled them after the Prelude ones --- on lists. - --- | \(O(n)\) Return a list of this map's keys. The list is produced --- lazily. -keys :: HashMap k v -> [k] -keys = List.map fst . toList -{-# INLINE keys #-} - --- | \(O(n)\) Return a list of this map's values. The list is produced --- lazily. -elems :: HashMap k v -> [v] -elems = List.map snd . toList -{-# INLINE elems #-} - ------------------------------------------------------------------------- --- ** Lists - --- | \(O(n)\) Return a list of this map's elements. The list is --- produced lazily. The order of its elements is unspecified, and it may --- change from version to version of either this package or of @hashable@. -toList :: HashMap k v -> [(k, v)] -toList t = Exts.build (\ c z -> foldrWithKey (curry c) z t) -{-# INLINE toList #-} - --- | \(O(n \log n)\) Construct a map with the supplied mappings. If the list --- contains duplicate mappings, the later mappings take precedence. -fromList :: (Eq k, Hashable k) => [(k, v)] -> HashMap k v -fromList = List.foldl' (\ m (k, v) -> unsafeInsert k v m) empty -{-# INLINABLE fromList #-} - --- | \(O(n \log n)\) Construct a map from a list of elements. Uses --- the provided function @f@ to merge duplicate entries with --- @(f newVal oldVal)@. --- --- === Examples --- --- Given a list @xs@, create a map with the number of occurrences of each --- element in @xs@: --- --- > let xs = ['a', 'b', 'a'] --- > in fromListWith (+) [ (x, 1) | x <- xs ] --- > --- > = fromList [('a', 2), ('b', 1)] --- --- Given a list of key-value pairs @xs :: [(k, v)]@, group all values by their --- keys and return a @HashMap k [v]@. --- --- > let xs = [('a', 1), ('b', 2), ('a', 3)] --- > in fromListWith (++) [ (k, [v]) | (k, v) <- xs ] --- > --- > = fromList [('a', [3, 1]), ('b', [2])] --- --- Note that the lists in the resulting map contain elements in reverse order --- from their occurrences in the original list. --- --- More generally, duplicate entries are accumulated as follows; --- this matters when @f@ is not commutative or not associative. --- --- > fromListWith f [(k, a), (k, b), (k, c), (k, d)] --- > = fromList [(k, f d (f c (f b a)))] -fromListWith :: (Eq k, Hashable k) => (v -> v -> v) -> [(k, v)] -> HashMap k v -fromListWith f = List.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 --- the provided function to merge duplicate entries. --- --- === Examples --- --- Given a list of key-value pairs where the keys are of different flavours, e.g: --- --- > data Key = Div | Sub --- --- and the values need to be combined differently when there are duplicates, --- depending on the key: --- --- > combine Div = div --- > combine Sub = (-) --- --- then @fromListWithKey@ can be used as follows: --- --- > fromListWithKey combine [(Div, 2), (Div, 6), (Sub, 2), (Sub, 3)] --- > = fromList [(Div, 3), (Sub, 1)] --- --- More generally, duplicate entries are accumulated as follows; --- --- > fromListWith f [(k, a), (k, b), (k, c), (k, d)] --- > = fromList [(k, f k d (f k c (f k b a)))] --- --- @since 0.2.11 -fromListWithKey :: (Eq k, Hashable k) => (k -> v -> v -> v) -> [(k, v)] -> HashMap k v -fromListWithKey f = List.foldl' (\ m (k, v) -> unsafeInsertWithKey (\k' a b -> (# f k' a b #)) k v m) empty -{-# INLINE fromListWithKey #-} - ------------------------------------------------------------------------- --- Array operations - --- | \(O(n)\) Look up the value associated with the given key in an --- array. -lookupInArrayCont :: - forall rep (r :: TYPE rep) k v. - Eq k => ((# #) -> r) -> (v -> Int -> r) -> k -> A.Array (Leaf k v) -> r -lookupInArrayCont absent present k0 ary0 = go k0 ary0 0 (A.length ary0) - where - go :: Eq k => k -> A.Array (Leaf k v) -> Int -> Int -> r - go !k !ary !i !n - | i >= n = absent (# #) - | otherwise = case A.index ary i of - (L kx v) - | k == kx -> present v i - | otherwise -> go k ary (i+1) n -{-# INLINE lookupInArrayCont #-} - --- | \(O(n)\) Lookup the value associated with the given key in this --- array. Returns 'Nothing' if the key wasn't found. -indexOf :: Eq k => k -> A.Array (Leaf k v) -> Maybe Int -indexOf k0 ary0 = go k0 ary0 0 (A.length ary0) - where - go !k !ary !i !n - | i >= n = Nothing - | otherwise = case A.index ary i of - (L kx _) - | k == kx -> Just i - | otherwise -> go k ary (i+1) n -{-# INLINABLE indexOf #-} - -updateWith# :: Eq k => (v -> (# v #)) -> k -> A.Array (Leaf k v) -> A.Array (Leaf k v) -updateWith# f k0 ary0 = go k0 ary0 0 (A.length ary0) - where - go !k !ary !i !n - | i >= n = ary - | otherwise = case A.index ary i of - (L kx y) | k == kx -> case f y of - (# y' #) - | ptrEq y y' -> ary - | otherwise -> A.update ary i (L k y') - | otherwise -> go k ary (i+1) n -{-# INLINABLE updateWith# #-} - -updateOrSnocWith :: Eq k => (v -> v -> (# v #)) -> k -> v -> A.Array (Leaf k v) - -> A.Array (Leaf k v) -updateOrSnocWith f = updateOrSnocWithKey (const f) -{-# INLINABLE updateOrSnocWith #-} - -updateOrSnocWithKey :: Eq k => (k -> v -> v -> (# v #)) -> k -> v -> A.Array (Leaf k v) - -> A.Array (Leaf k v) -updateOrSnocWithKey f k0 v0 ary0 = go k0 v0 ary0 0 (A.length ary0) - where - go !k v !ary !i !n - -- Not found, append to the end. - | i >= n = A.snoc ary $ L k v - | L kx y <- A.index ary i - , k == kx - , (# v2 #) <- f k v y - = A.update ary i (L k v2) - | otherwise - = go k v ary (i+1) n -{-# INLINABLE updateOrSnocWithKey #-} - -updateOrConcatWithKey :: Eq k => (k -> v -> v -> (# v #)) -> A.Array (Leaf k v) -> A.Array (Leaf k v) -> A.Array (Leaf k v) -updateOrConcatWithKey f ary1 ary2 = A.run $ do - -- TODO: instead of mapping and then folding, should we traverse? - -- We'll have to be careful to avoid allocating pairs or similar. - - -- first: look up the position of each element of ary2 in ary1 - let indices = A.map' (\(L k _) -> indexOf k ary1) ary2 - -- that tells us how large the overlap is: - -- count number of Nothing constructors - let nOnly2 = A.foldl' (\n -> maybe (n+1) (const n)) 0 indices - let n1 = A.length ary1 - let n2 = A.length ary2 - -- copy over all elements from ary1 - mary <- A.new_ (n1 + nOnly2) - A.copy ary1 0 mary 0 n1 - -- append or update all elements from ary2 - let go !iEnd !i2 - | i2 >= n2 = return () - | otherwise = case A.index indices i2 of - Just i1 -> do -- key occurs in both arrays, store combination in position i1 - L k v1 <- A.indexM ary1 i1 - L _ v2 <- A.indexM ary2 i2 - case f k v1 v2 of (# v3 #) -> A.write mary i1 (L k v3) - go iEnd (i2+1) - Nothing -> do -- key is only in ary2, append to end - A.write mary iEnd =<< A.indexM ary2 i2 - go (iEnd+1) (i2+1) - go n1 0 - return mary -{-# INLINABLE updateOrConcatWithKey #-} - --- | \(O(n*m)\) Check if the first array is a subset of the second array. -subsetArray :: Eq k => (v1 -> v2 -> Bool) -> A.Array (Leaf k v1) -> A.Array (Leaf k v2) -> Bool -subsetArray cmpV ary1 ary2 = A.length ary1 <= A.length ary2 && A.all inAry2 ary1 - where - inAry2 (L k1 v1) = lookupInArrayCont (\_ -> False) (\v2 _ -> cmpV v1 v2) k1 ary2 - {-# INLINE inAry2 #-} - ------------------------------------------------------------------------- --- Manually unrolled loops - --- | \(O(n)\) Update the element at the given position in this array. -updateFullArray :: A.Array e -> Int -> e -> A.Array e -updateFullArray ary idx b = runST (updateFullArrayM ary idx b) -{-# INLINE updateFullArray #-} - --- | \(O(n)\) Update the element at the given position in this array. -updateFullArrayM :: A.Array e -> Int -> e -> ST s (A.Array e) -updateFullArrayM ary idx b = do - mary <- clone ary - A.write mary idx b - A.unsafeFreeze mary -{-# INLINE updateFullArrayM #-} - --- | \(O(n)\) Update the element at the given position in this array, by applying a function to it. -updateFullArrayWith' :: A.Array e -> Int -> (e -> e) -> A.Array e -updateFullArrayWith' ary idx f - | (# x #) <- A.index# ary idx - = updateFullArray ary idx $! f x -{-# INLINE updateFullArrayWith' #-} - --- | Unsafely clone an array of (2^bitsPerSubkey) elements. The length of the input --- array is not checked. -clone :: A.Array e -> ST s (A.MArray s e) -clone ary = - A.thaw ary 0 (2^bitsPerSubkey) - ------------------------------------------------------------------------- --- Bit twiddling - --- TODO: Name this 'bitsPerLevel'?! What is a "subkey"? --- https://github.com/haskell-unordered-containers/unordered-containers/issues/425 - --- | Number of bits that are inspected at each level of the hash tree. --- --- This constant is named /t/ in the original /Ideal Hash Trees/ paper. --- --- Note that this constant is platform-dependent. On 32-bit platforms we use --- '4', because bitmaps using '2^5' bits turned out to be prone to integer --- overflow bugs. See #491 for instance. -bitsPerSubkey :: Int -#if WORD_SIZE_IN_BITS < 64 -bitsPerSubkey = 4 -#else -bitsPerSubkey = 5 -#endif - --- | The size of a 'Full' node, i.e. @2 ^ 'bitsPerSubkey'@. -maxChildren :: Int -maxChildren = 1 `unsafeShiftL` bitsPerSubkey - --- | Bit mask with the lowest 'bitsPerSubkey' bits set, i.e. @0b11111@. -subkeyMask :: Word -subkeyMask = 1 `unsafeShiftL` bitsPerSubkey - 1 - --- | Given a 'Hash' and a 'Shift' that indicates the level in the tree, compute --- the index into a 'Full' node or into the bitmap of a `BitmapIndexed` node. --- --- >>> index 0b0010_0010 0 --- 0b0000_0010 -index :: Hash -> Shift -> Int -index w s = fromIntegral $ unsafeShiftR w s .&. subkeyMask -{-# INLINE index #-} - --- | Given a 'Hash' and a 'Shift' that indicates the level in the tree, compute --- the bitmap that contains only the 'index' of the hash at this level. --- --- The result can be used for constructing one-element 'BitmapIndexed' nodes or --- to check whether a 'BitmapIndexed' node may possibly contain the given 'Hash'. --- --- >>> mask 0b0010_0010 0 --- 0b0100 -mask :: Hash -> Shift -> Bitmap -mask w s = 1 `unsafeShiftL` index w s -{-# INLINE mask #-} - --- | This array index is computed by counting the number of 1-bits below the --- 'index' represented by the mask. --- --- >>> sparseIndex 0b0110_0110 0b0010_0000 --- 2 -sparseIndex - :: Bitmap - -- ^ Bitmap of a 'BitmapIndexed' node - -> Bitmap - -- ^ One-bit 'mask' corresponding to the 'index' of a hash - -> Int - -- ^ Index into the array of the 'BitmapIndexed' node -sparseIndex b m = popCount (b .&. (m - 1)) -{-# INLINE sparseIndex #-} - --- | A bitmap with the 'maxChildren' least significant bits set, i.e. --- @0xFF_FF_FF_FF@. -fullBitmap :: Bitmap --- This needs to use 'shiftL' instead of 'unsafeShiftL', to avoid UB. --- See issue #412. -fullBitmap = complement (complement 0 `shiftL` maxChildren) -{-# INLINE fullBitmap #-} - --- | Increment a 'Shift' for use at the next deeper level. -nextShift :: Shift -> Shift -nextShift s = s + bitsPerSubkey -{-# INLINE nextShift #-} - ------------------------------------------------------------------------- --- Pointer equality - --- | Check if two the two arguments are the same value. N.B. This --- function might give false negatives (due to GC moving objects.) -ptrEq :: a -> a -> Bool -ptrEq x y = Exts.isTrue# (Exts.reallyUnsafePtrEquality# x y ==# 1#) -{-# INLINE ptrEq #-} - ------------------------------------------------------------------------- --- IsList instance -instance (Eq k, Hashable k) => Exts.IsList (HashMap k v) where - type Item (HashMap k v) = (k, v) - fromList = fromList - toList = toList +{-# LANGUAGE PolyKinds #-} +{-# LANGUAGE RoleAnnotations #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE StandaloneDeriving #-} +{-# LANGUAGE TemplateHaskellQuotes #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE UnboxedSums #-} +{-# LANGUAGE UnboxedTuples #-} +{-# OPTIONS_GHC -fno-full-laziness -funbox-strict-fields #-} +{-# OPTIONS_HADDOCK not-home #-} + +#include "MachDeps.h" + +-- | = WARNING +-- +-- This module is considered __internal__. +-- +-- The Package Versioning Policy __does not apply__. +-- +-- The contents of this module may change __in any way whatsoever__ +-- and __without any warning__ between minor versions of this package. +-- +-- Authors importing this module are expected to track development +-- closely. + +module Data.HashMap.Internal + ( + HashMap(..) + , Leaf(..) + + -- * Construction + , empty + , singleton + + -- * Basic interface + , null + , size + , member + , lookup + , (!?) + , findWithDefault + , lookupDefault + , (!) + , lookupKey + , insert + , insertWith + , unsafeInsert + , delete + , adjust + , update + , alter + , alterF + , isSubmapOf + , isSubmapOfBy + + -- * Combine + -- ** Union + , union + , unionWith + , unionWithKey + , unions + + -- ** Compose + , compose + + -- * Transformations + , map + , mapWithKey + , traverseWithKey + , mapKeys + + -- * Difference and intersection + , difference + , differenceWith + , differenceWithKey + , intersection + , intersectionWith + , intersectionWithKey + , intersectionWithKey# + , disjoint + + -- * Folds + , foldr' + , foldl' + , foldrWithKey' + , foldlWithKey' + , foldr + , foldl + , foldrWithKey + , foldlWithKey + , foldMapWithKey + + -- * Filter + , mapMaybe + , mapMaybeWithKey + , filter + , filterWithKey + + -- * Conversions + , keys + , elems + + -- ** Lists + , toList + , fromList + , fromListWith + , fromListWithKey + + -- ** Internals used by the strict version + , Hash + , Bitmap + , Shift + , bitmapIndexedOrFull + , collision + , hash + , mask + , index + , bitsPerSubkey + , maxChildren + , isLeafOrCollision + , fullBitmap + , subkeyMask + , nextShift + , sparseIndex + , two + , unionArrayBy + , updateFullArray + , updateFullArrayM + , updateFullArrayWith' + , updateOrConcatWithKey + , filterMapAux + , equalKeys + , equalKeys1 + , lookupRecordCollision + , LookupRes(..) + , lookupResToMaybe + , insert' + , delete' + , lookup' + , insertNewKey + , insertKeyExists + , deleteKeyExists + , insertModifying + , ptrEq + , adjust# + ) where + +import Data.Traversable -- MicroHs needs this since its Prelude does not have Foldable&Traversable. + -- It's harmless for GHC, and putting it first avoid a warning. + +import Control.Applicative (Const (..)) +import Control.DeepSeq (NFData (..), NFData1 (..), NFData2 (..)) +import Control.Monad.ST (ST, runST) +import Data.Bifoldable (Bifoldable (..)) +import Data.Bits (complement, countTrailingZeros, popCount, + shiftL, unsafeShiftL, unsafeShiftR, (.&.), + (.|.)) +import Data.Coerce (coerce) +import Data.Data (Constr, Data (..), DataType) +import Data.Functor.Classes (Eq1 (..), Eq2 (..), Ord1 (..), Ord2 (..), + Read1 (..), Show1 (..), Show2 (..)) +import Data.Functor.Identity (Identity (..)) +import Data.Hashable (Hashable) +import Data.Hashable.Lifted (Hashable1, Hashable2) +import Data.HashMap.Internal.List (isPermutationBy, unorderedCompare) +import Data.Maybe (isNothing) +import Data.Semigroup (Semigroup (..), stimesIdempotentMonoid) +import GHC.Exts (Int (..), Int#, TYPE, (==#)) +import GHC.Stack (HasCallStack) +import Prelude hiding (Foldable (..), filter, lookup, map, + pred) +import Text.Read hiding (step) + +import qualified Data.Data as Data +import qualified Data.Foldable as Foldable +import qualified Data.Functor.Classes as FC +import qualified Data.Hashable as H +import qualified Data.Hashable.Lifted as H +import qualified Data.HashMap.Internal.Array as A +import qualified Data.List as List +import qualified GHC.Exts as Exts +import qualified Language.Haskell.TH.Syntax as TH + +-- | Convenience function. Compute a hash value for the given value. +hash :: H.Hashable a => a -> Hash +hash = fromIntegral . H.hash + +data Leaf k v = L !k v + deriving (Eq) + +instance (NFData k, NFData v) => NFData (Leaf k v) where + rnf (L k v) = rnf k `seq` rnf v + +#if defined(__GLASGOW_HASKELL__) +-- | @since 0.2.17.0 +instance (TH.Lift k, TH.Lift v) => TH.Lift (Leaf k v) where + liftTyped (L k v) = [|| L k $! v ||] +#endif + +-- | @since 0.2.14.0 +instance NFData k => NFData1 (Leaf k) where + liftRnf = liftRnf2 rnf + +-- | @since 0.2.14.0 +instance NFData2 Leaf where + liftRnf2 rnf1 rnf2 (L k v) = rnf1 k `seq` rnf2 v + +-- | A map from keys to values. A map cannot contain duplicate keys; +-- each key can map to at most one value. +data HashMap k v + = Empty + -- ^ Invariants: + -- + -- * 'Empty' is not a valid sub-node. It can only appear at the root. (INV1) + | BitmapIndexed !Bitmap !(A.Array (HashMap k v)) + -- ^ Invariants: + -- + -- * Only the lower @maxChildren@ bits of the 'Bitmap' may be set. The + -- remaining upper bits must be 0. (INV2) + -- * The array of a 'BitmapIndexed' node stores at least 1 and at most + -- @'maxChildren' - 1@ sub-nodes. (INV3) + -- * The number of sub-nodes is equal to the number of 1-bits in its + -- 'Bitmap'. (INV4) + -- * If a 'BitmapIndexed' node has only one sub-node, this sub-node must + -- be a 'BitmapIndexed' or a 'Full' node. (INV5) + | Leaf !Hash !(Leaf k v) + -- ^ Invariants: + -- + -- * The location of a 'Leaf' or 'Collision' node in the tree must be + -- compatible with its 'Hash'. (INV6) + -- (TODO: Document this properly (#425)) + -- * The 'Hash' of a 'Leaf' node must be the 'hash' of its key. (INV7) + | Full !(A.Array (HashMap k v)) + -- ^ Invariants: + -- + -- * The array of a 'Full' node stores exactly 'maxChildren' sub-nodes. (INV8) + | Collision !Hash !(A.Array (Leaf k v)) + -- ^ Invariants: + -- + -- * The location of a 'Leaf' or 'Collision' node in the tree must be + -- compatible with its 'Hash'. (INV6) + -- (TODO: Document this properly (#425)) + -- * The array of a 'Collision' node must contain at least two sub-nodes. (INV9) + -- * The 'hash' of each key in a 'Collision' node must be the one stored in + -- the node. (INV7) + -- * No two keys stored in a 'Collision' can be equal according to their + -- 'Eq' instance. (INV10) + +type role HashMap nominal representational + +-- | @since 0.2.17.0 +deriving instance (TH.Lift k, TH.Lift v) => TH.Lift (HashMap k v) + +instance (NFData k, NFData v) => NFData (HashMap k v) where + rnf Empty = () + rnf (BitmapIndexed _ ary) = rnf ary + rnf (Leaf _ l) = rnf l + rnf (Full ary) = rnf ary + rnf (Collision _ ary) = rnf ary + +-- | @since 0.2.14.0 +instance NFData k => NFData1 (HashMap k) where + liftRnf = liftRnf2 rnf + +-- | @since 0.2.14.0 +instance NFData2 HashMap where + liftRnf2 _ _ Empty = () + liftRnf2 rnf1 rnf2 (BitmapIndexed _ ary) = liftRnf (liftRnf2 rnf1 rnf2) ary + liftRnf2 rnf1 rnf2 (Leaf _ l) = liftRnf2 rnf1 rnf2 l + liftRnf2 rnf1 rnf2 (Full ary) = liftRnf (liftRnf2 rnf1 rnf2) ary + liftRnf2 rnf1 rnf2 (Collision _ ary) = liftRnf (liftRnf2 rnf1 rnf2) ary + +instance Functor (HashMap k) where + fmap = map + +instance Foldable.Foldable (HashMap k) where + foldMap f = foldMapWithKey (\ _k v -> f v) + {-# INLINE foldMap #-} + foldr = foldr + {-# INLINE foldr #-} + foldl = foldl + {-# INLINE foldl #-} + foldr' = foldr' + {-# INLINE foldr' #-} + foldl' = foldl' + {-# INLINE foldl' #-} + null = null + {-# INLINE null #-} + length = size + {-# INLINE length #-} + +-- | @since 0.2.11 +instance Bifoldable HashMap where + bifoldMap f g = foldMapWithKey (\ k v -> f k `mappend` g v) + {-# INLINE bifoldMap #-} + bifoldr f g = foldrWithKey (\ k v acc -> k `f` (v `g` acc)) + {-# INLINE bifoldr #-} + bifoldl f g = foldlWithKey (\ acc k v -> (acc `f` k) `g` v) + {-# INLINE bifoldl #-} + +-- | '<>' = 'union' +-- +-- If a key occurs in both maps, the mapping from the first will be the mapping in the result. +-- +-- ==== __Examples__ +-- +-- >>> fromList [(1,'a'),(2,'b')] <> fromList [(2,'c'),(3,'d')] +-- fromList [(1,'a'),(2,'b'),(3,'d')] +instance Hashable k => Semigroup (HashMap k v) where + (<>) = union + {-# INLINE (<>) #-} + stimes = stimesIdempotentMonoid + {-# INLINE stimes #-} + +-- | 'mempty' = 'empty' +-- +-- 'mappend' = 'union' +-- +-- If a key occurs in both maps, the mapping from the first will be the mapping in the result. +-- +-- ==== __Examples__ +-- +-- >>> mappend (fromList [(1,'a'),(2,'b')]) (fromList [(2,'c'),(3,'d')]) +-- fromList [(1,'a'),(2,'b'),(3,'d')] +instance Hashable k => Monoid (HashMap k v) where + mempty = empty + {-# INLINE mempty #-} + mappend = (<>) + {-# INLINE mappend #-} + +instance (Data k, Data v, Hashable k) => Data (HashMap k v) where + gfoldl f z m = z fromList `f` toList m + toConstr _ = fromListConstr + gunfold k z c = case Data.constrIndex c of + 1 -> k (z fromList) + _ -> error "gunfold" + dataTypeOf _ = hashMapDataType + dataCast1 f = Data.gcast1 f + dataCast2 f = Data.gcast2 f + +fromListConstr :: Constr +fromListConstr = Data.mkConstr hashMapDataType "fromList" [] Data.Prefix + +hashMapDataType :: DataType +hashMapDataType = Data.mkDataType "Data.HashMap.Internal.HashMap" [fromListConstr] + +-- | This type is used to store the hash of a key, as produced with 'hash'. +type Hash = Word + +-- | A bitmap as contained by a 'BitmapIndexed' node, or a 'fullBitmap' +-- corresponding to a 'Full' node. +-- +-- Only the lower 'maxChildren' bits are used. The remaining bits must be zeros. +type Bitmap = Word + +-- | A 'Shift' value is the offset of the subkey in the hash and corresponds +-- to the level of the tree that we're currently operating at. At the root +-- level the 'Shift' is @0@. For the subsequent levels the 'Shift' values are +-- 'bitsPerSubkey', @2*'bitsPerSubkey'@ etc. +-- +-- Valid values are non-negative and less than @bitSize (0 :: Word)@. +type Shift = Int + +instance Show2 HashMap where + liftShowsPrec2 spk slk spv slv d m = + FC.showsUnaryWith (liftShowsPrec sp sl) "fromList" d (toList m) + where + sp = liftShowsPrec2 spk slk spv slv + sl = liftShowList2 spk slk spv slv + +instance Show k => Show1 (HashMap k) where + liftShowsPrec = liftShowsPrec2 showsPrec showList + +instance (Hashable k, Read k) => Read1 (HashMap k) where + liftReadsPrec rp rl = FC.readsData $ + FC.readsUnaryWith (liftReadsPrec rp' rl') "fromList" fromList + where + rp' = liftReadsPrec rp rl + rl' = liftReadList rp rl + +instance (Hashable k, Read k, Read e) => Read (HashMap k e) where + readPrec = parens $ prec 10 $ do + Ident "fromList" <- lexP + fromList <$> readPrec + + readListPrec = readListPrecDefault + +instance (Show k, Show v) => Show (HashMap k v) where + showsPrec d m = showParen (d > 10) $ + showString "fromList " . shows (toList m) + +instance Traversable (HashMap k) where + traverse f = traverseWithKey (const f) + {-# INLINABLE traverse #-} + +instance Eq2 HashMap where + liftEq2 = equal2 + +instance Eq k => Eq1 (HashMap k) where + liftEq = equal1 + +-- | Note that, in the presence of hash collisions, equal @HashMap@s may +-- behave differently, i.e. extensionality may be violated: +-- +-- >>> data D = A | B deriving (Eq, Show) +-- >>> instance Hashable D where hashWithSalt salt _d = salt +-- +-- >>> x = fromList [(A,1), (B,2)] +-- >>> y = fromList [(B,2), (A,1)] +-- +-- >>> x == y +-- True +-- >>> toList x +-- [(A,1),(B,2)] +-- >>> toList y +-- [(B,2),(A,1)] +-- +-- In general, the lack of extensionality can be observed with any function +-- that depends on the key ordering, such as folds and traversals. +instance (Eq k, Eq v) => Eq (HashMap k v) where + (==) = equal1 (==) + +equal1 :: Eq k + => (v -> v' -> Bool) + -> HashMap k v -> HashMap k v' -> Bool +equal1 eq = go + where + go Empty Empty = True + go (BitmapIndexed bm1 ary1) (BitmapIndexed bm2 ary2) + = bm1 == bm2 && A.sameArray1 go ary1 ary2 + go (Leaf h1 l1) (Leaf h2 l2) = h1 == h2 && leafEq l1 l2 + go (Full ary1) (Full ary2) = A.sameArray1 go ary1 ary2 + go (Collision h1 ary1) (Collision h2 ary2) + = h1 == h2 && isPermutationBy leafEq (A.toList ary1) (A.toList ary2) + go _ _ = False + + leafEq (L k1 v1) (L k2 v2) = k1 == k2 && eq v1 v2 + +equal2 :: (k -> k' -> Bool) -> (v -> v' -> Bool) + -> HashMap k v -> HashMap k' v' -> Bool +equal2 eqk eqv t1 t2 = go (leavesAndCollisions t1 []) (leavesAndCollisions t2 []) + where + -- If the two trees are the same, then their lists of 'Leaf's and + -- 'Collision's read from left to right should be the same (modulo the + -- order of elements in 'Collision'). + + go (Leaf k1 l1 : tl1) (Leaf k2 l2 : tl2) + | k1 == k2 && + leafEq l1 l2 + = go tl1 tl2 + go (Collision h1 ary1 : tl1) (Collision h2 ary2 : tl2) + | h1 == h2 && + A.length ary1 == A.length ary2 && + isPermutationBy leafEq (A.toList ary1) (A.toList ary2) + = go tl1 tl2 + go [] [] = True + go _ _ = False + + leafEq (L k v) (L k' v') = eqk k k' && eqv v v' + +instance Ord2 HashMap where + liftCompare2 = cmp + +instance Ord k => Ord1 (HashMap k) where + liftCompare = cmp compare + +-- | The ordering is total and consistent with the `Eq` instance. However, +-- nothing else about the ordering is specified, and it may change from +-- version to version of either this package or of @hashable@. +instance (Ord k, Ord v) => Ord (HashMap k v) where + compare = cmp compare compare + +cmp :: (k -> k' -> Ordering) -> (v -> v' -> Ordering) + -> HashMap k v -> HashMap k' v' -> Ordering +cmp cmpk cmpv t1 t2 = go (leavesAndCollisions t1 []) (leavesAndCollisions t2 []) + where + go (Leaf k1 l1 : tl1) (Leaf k2 l2 : tl2) + = compare k1 k2 `mappend` + leafCompare l1 l2 `mappend` + go tl1 tl2 + go (Collision h1 ary1 : tl1) (Collision h2 ary2 : tl2) + = compare h1 h2 `mappend` + compare (A.length ary1) (A.length ary2) `mappend` + unorderedCompare leafCompare (A.toList ary1) (A.toList ary2) `mappend` + go tl1 tl2 + go (Leaf _ _ : _) (Collision _ _ : _) = LT + go (Collision _ _ : _) (Leaf _ _ : _) = GT + go [] [] = EQ + go [] _ = LT + go _ [] = GT + go _ _ = error "cmp: Should never happen, leavesAndCollisions includes non Leaf / Collision" + + leafCompare (L k v) (L k' v') = cmpk k k' `mappend` cmpv v v' + +-- | Same as 'equal2' but doesn't compare the values. +equalKeys1 :: (k -> k' -> Bool) -> HashMap k v -> HashMap k' v' -> Bool +equalKeys1 eq t1 t2 = go (leavesAndCollisions t1 []) (leavesAndCollisions t2 []) + where + go (Leaf k1 l1 : tl1) (Leaf k2 l2 : tl2) + | k1 == k2 && leafEq l1 l2 + = go tl1 tl2 + go (Collision h1 ary1 : tl1) (Collision h2 ary2 : tl2) + | h1 == h2 && A.length ary1 == A.length ary2 && + isPermutationBy leafEq (A.toList ary1) (A.toList ary2) + = go tl1 tl2 + go [] [] = True + go _ _ = False + + leafEq (L k _) (L k' _) = eq k k' + +-- | Same as 'equal1' but doesn't compare the values. +equalKeys :: Eq k => HashMap k v -> HashMap k v' -> Bool +equalKeys = go + where + go :: Eq k => HashMap k v -> HashMap k v' -> Bool + go Empty Empty = True + go (BitmapIndexed bm1 ary1) (BitmapIndexed bm2 ary2) + = bm1 == bm2 && A.sameArray1 go ary1 ary2 + go (Leaf h1 l1) (Leaf h2 l2) = h1 == h2 && leafEq l1 l2 + go (Full ary1) (Full ary2) = A.sameArray1 go ary1 ary2 + go (Collision h1 ary1) (Collision h2 ary2) + = h1 == h2 && isPermutationBy leafEq (A.toList ary1) (A.toList ary2) + go _ _ = False + + leafEq (L k1 _) (L k2 _) = k1 == k2 + +instance Hashable2 HashMap where + liftHashWithSalt2 hk hv salt hm = go salt (leavesAndCollisions hm []) + where + -- go :: Int -> [HashMap k v] -> Int + go s [] = s + go s (Leaf _ l : tl) + = s `hashLeafWithSalt` l `go` tl + -- For collisions we hashmix hash value + -- and then array of values' hashes sorted + go s (Collision h a : tl) + = (s `H.hashWithSalt` h) `hashCollisionWithSalt` a `go` tl + go s (_ : tl) = s `go` tl + + -- hashLeafWithSalt :: Int -> Leaf k v -> Int + hashLeafWithSalt s (L k v) = (s `hk` k) `hv` v + + -- hashCollisionWithSalt :: Int -> A.Array (Leaf k v) -> Int + hashCollisionWithSalt s + = List.foldl' H.hashWithSalt s . arrayHashesSorted s + + -- arrayHashesSorted :: Int -> A.Array (Leaf k v) -> [Int] + arrayHashesSorted s = List.sort . List.map (hashLeafWithSalt s) . A.toList + +instance (Hashable k) => Hashable1 (HashMap k) where + liftHashWithSalt = H.liftHashWithSalt2 H.hashWithSalt + +instance (Hashable k, Hashable v) => Hashable (HashMap k v) where + hashWithSalt salt hm = go salt hm + where + go :: Int -> HashMap k v -> Int + go !s Empty = s + go s (BitmapIndexed _ a) = A.foldl' go s a + go s (Leaf h (L _ v)) + = s `H.hashWithSalt` h `H.hashWithSalt` v + -- For collisions we hashmix hash value + -- and then array of values' hashes sorted + go s (Full a) = A.foldl' go s a + go s (Collision h a) + = (s `H.hashWithSalt` h) `hashCollisionWithSalt` a + + hashLeafWithSalt :: Int -> Leaf k v -> Int + hashLeafWithSalt s (L k v) = s `H.hashWithSalt` k `H.hashWithSalt` v + + hashCollisionWithSalt :: Int -> A.Array (Leaf k v) -> Int + hashCollisionWithSalt s + = List.foldl' H.hashWithSalt s . arrayHashesSorted s + + arrayHashesSorted :: Int -> A.Array (Leaf k v) -> [Int] + arrayHashesSorted s = List.sort . List.map (hashLeafWithSalt s) . A.toList + +-- | Helper to get 'Leaf's and 'Collision's as a list. +leavesAndCollisions :: HashMap k v -> [HashMap k v] -> [HashMap k v] +leavesAndCollisions (BitmapIndexed _ ary) a = A.foldr leavesAndCollisions a ary +leavesAndCollisions (Full ary) a = A.foldr leavesAndCollisions a ary +leavesAndCollisions l@(Leaf _ _) a = l : a +leavesAndCollisions c@(Collision _ _) a = c : a +leavesAndCollisions Empty a = a + +-- | Helper function to detect 'Leaf's and 'Collision's. +isLeafOrCollision :: HashMap k v -> Bool +isLeafOrCollision (Leaf _ _) = True +isLeafOrCollision (Collision _ _) = True +isLeafOrCollision _ = False + +------------------------------------------------------------------------ +-- * Construction + +-- | \(O(1)\) Construct an empty map. +empty :: HashMap k v +empty = Empty + +-- | \(O(1)\) Construct a map with a single element. +singleton :: (Hashable k) => k -> v -> HashMap k v +singleton k v = Leaf (hash k) (L k v) + +------------------------------------------------------------------------ +-- * Basic interface + +-- | \(O(1)\) Return 'True' if this map is empty, 'False' otherwise. +null :: HashMap k v -> Bool +null Empty = True +null _ = False + +-- | \(O(n)\) Return the number of key-value mappings in this map. +size :: HashMap k v -> Int +size t = go t 0 + where + go Empty !n = n + go (Leaf _ _) n = n + 1 + go (BitmapIndexed _ ary) n = A.foldl' (flip go) n ary + go (Full ary) n = A.foldl' (flip go) n ary + go (Collision _ ary) n = n + A.length ary + +-- | \(O(\log n)\) Return 'True' if the specified key is present in the +-- map, 'False' otherwise. +member :: Hashable k => k -> HashMap k a -> Bool +member k m = case lookup k m of + Nothing -> False + Just _ -> True +{-# INLINABLE member #-} + +-- | \(O(\log n)\) Return the value to which the specified key is mapped, +-- or 'Nothing' if this map contains no mapping for the key. +lookup :: Hashable k => k -> HashMap k v -> Maybe v +-- GHC does not yet perform a worker-wrapper transformation on +-- unboxed sums automatically. That seems likely to happen at some +-- point (possibly as early as GHC 8.6) but for now we do it manually. +lookup k m = case lookup# k m of + (# (# #) | #) -> Nothing + (# | a #) -> Just a +{-# INLINE lookup #-} + +lookup# :: Hashable k => k -> HashMap k v -> (# (# #) | v #) +lookup# k m = lookupCont (\_ -> (# (# #) | #)) (\v _i -> (# | v #)) (hash k) k 0 m +{-# INLINABLE lookup# #-} + +-- | lookup' is a version of lookup that takes the hash separately. +-- It is used to implement alterF. +lookup' :: Eq k => Hash -> k -> HashMap k v -> Maybe v +-- GHC does not yet perform a worker-wrapper transformation on +-- unboxed sums automatically. That seems likely to happen at some +-- point (possibly as early as GHC 8.6) but for now we do it manually. +-- lookup' would probably prefer to be implemented in terms of its own +-- lookup'#, but it's not important enough and we don't want too much +-- code. +lookup' h k m = case lookupRecordCollision# h k m of + (# (# #) | #) -> Nothing + (# | (# a, _i #) #) -> Just a +{-# INLINE lookup' #-} + +-- | The result of a lookup, keeping track of if a hash collision occurred. +-- If a collision did not occur then it will have the Int value (-1). +data LookupRes a = Absent | Present a !Int + +lookupResToMaybe :: LookupRes a -> Maybe a +lookupResToMaybe Absent = Nothing +lookupResToMaybe (Present x _) = Just x +{-# INLINE lookupResToMaybe #-} + +-- | Internal helper for lookup. This version takes the precomputed hash so +-- that functions that make multiple calls to lookup and related functions +-- (insert, delete) only need to calculate the hash once. +-- +-- It is used by 'alterF' so that hash computation and key comparison only needs +-- to be performed once. With this information you can use the more optimized +-- versions of insert ('insertNewKey', 'insertKeyExists') and delete +-- ('deleteKeyExists') +-- +-- Outcomes: +-- Key not in map => Absent +-- Key in map, no collision => Present v (-1) +-- Key in map, collision => Present v position +lookupRecordCollision :: Eq k => Hash -> k -> HashMap k v -> LookupRes v +lookupRecordCollision h k m = case lookupRecordCollision# h k m of + (# (# #) | #) -> Absent + (# | (# a, i #) #) -> Present a (I# i) -- GHC will eliminate the I# +{-# INLINE lookupRecordCollision #-} + +-- | Why do we produce an Int# instead of an Int? Unfortunately, GHC is not +-- yet any good at unboxing things *inside* products, let alone sums. That +-- may be changing in GHC 8.6 or so (there is some work in progress), but +-- for now we use Int# explicitly here. We don't need to push the Int# +-- into lookupCont because inlining takes care of that. +lookupRecordCollision# :: Eq k => Hash -> k -> HashMap k v -> (# (# #) | (# v, Int# #) #) +lookupRecordCollision# h k m = + lookupCont (\_ -> (# (# #) | #)) (\v (I# i) -> (# | (# v, i #) #)) h k 0 m +-- INLINABLE to specialize to the Eq instance. +{-# INLINABLE lookupRecordCollision# #-} + +-- | A two-continuation version of lookupRecordCollision. This lets us +-- share source code between lookup and lookupRecordCollision without +-- risking any performance degradation. +-- +-- The absent continuation has type @((# #) -> r)@ instead of just @r@ +-- so we can be representation-polymorphic in the result type. Since +-- this whole thing is always inlined, we don't have to worry about +-- any extra CPS overhead. +lookupCont :: +#if defined(__GLASGOW_HASKELL__) + forall rep (r :: TYPE rep) k v. +#else + forall r k v. +#endif + Eq k + => ((# #) -> r) -- Absent continuation + -> (v -> Int -> r) -- Present continuation + -> Hash -- The hash of the key + -> k + -> Shift + -> HashMap k v -> r +lookupCont absent present !h0 !k0 !s0 m0 = lookupCont_ h0 k0 s0 m0 + where + lookupCont_ :: Eq k => Hash -> k -> Shift -> HashMap k v -> r + lookupCont_ !_ !_ !_ Empty = absent (# #) + lookupCont_ h k _ (Leaf hx (L kx x)) + | h == hx && k == kx = present x (-1) + | otherwise = absent (# #) + lookupCont_ h k s (BitmapIndexed b v) + | b .&. m == 0 = absent (# #) + | otherwise = + case A.index# v (sparseIndex b m) of + (# st #) -> lookupCont_ h k (nextShift s) st + where m = mask h s + lookupCont_ h k s (Full v) = + case A.index# v (index h s) of + (# st #) -> lookupCont_ h k (nextShift s) st + lookupCont_ h k _ (Collision hx v) + | h == hx = lookupInArrayCont absent present k v + | otherwise = absent (# #) +{-# INLINE lookupCont #-} + +-- | \(O(\log n)\) Return the value to which the specified key is mapped, +-- or 'Nothing' if this map contains no mapping for the key. +-- +-- This is a flipped version of 'lookup'. +-- +-- @since 0.2.11 +(!?) :: Hashable k => HashMap k v -> k -> Maybe v +(!?) m k = lookup k m +{-# INLINE (!?) #-} + + +-- | \(O(\log n)\) Return the value to which the specified key is mapped, +-- or the default value if this map contains no mapping for the key. +-- +-- @since 0.2.11 +findWithDefault :: Hashable k + => v -- ^ Default value to return. + -> k -> HashMap k v -> v +findWithDefault def k t = case lookup k t of + Just v -> v + _ -> def +{-# INLINABLE findWithDefault #-} + + +-- | \(O(\log n)\) Return the value to which the specified key is mapped, +-- or the default value if this map contains no mapping for the key. +-- +-- DEPRECATED: lookupDefault is deprecated as of version 0.2.11, replaced +-- by 'findWithDefault'. +lookupDefault :: Hashable k + => v -- ^ Default value to return. + -> k -> HashMap k v -> v +lookupDefault = findWithDefault +{-# INLINE lookupDefault #-} + +-- | \(O(\log n)\) Return the value to which the specified key is mapped. +-- Calls 'error' if this map contains no mapping for the key. +(!) :: (Hashable k, HasCallStack) => HashMap k v -> k -> v +(!) m k = case lookup k m of + Just v -> v + Nothing -> error "Data.HashMap.Internal.(!): key not found" +{-# INLINABLE (!) #-} + +infixl 9 ! + +-- | \(O(\log n)\) For a given key, return the equal key stored in the map, +-- if present, otherwise return 'Nothing'. +-- +-- This function can be used for /interning/, i.e. to reduce memory usage. +-- +-- @since 0.2.21 +lookupKey :: Hashable k => k -> HashMap k v -> Maybe k +lookupKey k = \m -> fromMaybe# (lookupKeyInSubtree# 0 (hash k) k m) + where + fromMaybe# (# (##) | #) = Nothing + fromMaybe# (# | a #) = Just a +{-# INLINE lookupKey #-} + +lookupKeyInSubtree# :: Eq k => Shift -> Hash -> k -> HashMap k v -> (# (##) | k #) +lookupKeyInSubtree# !s !hx kx = \case + Empty -> (# (##) | #) + Leaf hy (L ky _) + | hx == hy && kx == ky -> (# | ky #) + | otherwise -> (# (##) | #) + BitmapIndexed b ary + | m .&. b == 0 -> (# (##) | #) + | otherwise -> case A.index# ary i of + (# st #) -> lookupKeyInSubtree# (nextShift s) hx kx st + where + m = mask hx s + i = sparseIndex b m + Full ary -> case A.index# ary (index hx s) of + (# st #) -> lookupKeyInSubtree# (nextShift s) hx kx st + Collision hy ary + | hx == hy + , Just i <- indexOf kx ary + , (# L ky _ #) <- A.index# ary i + -> (# | ky #) + | otherwise -> (# (##) | #) +{-# INLINABLE lookupKeyInSubtree# #-} + +-- | Create a 'Collision' value with two 'Leaf' values. +collision :: Hash -> Leaf k v -> Leaf k v -> HashMap k v +collision h !e1 !e2 = + let v = A.run $ do mary <- A.new 2 e1 + A.write mary 1 e2 + return mary + in Collision h v +{-# INLINE collision #-} + +-- | Create a 'BitmapIndexed' or 'Full' node. +bitmapIndexedOrFull :: Bitmap -> A.Array (HashMap k v) -> HashMap k v +-- The strictness in @ary@ helps achieve a nice code size reduction in +-- @unionWith[Key]@ with GHC 9.2.2. See the Core diffs in +-- https://github.com/haskell-unordered-containers/unordered-containers/pull/376. +bitmapIndexedOrFull b !ary + | b == fullBitmap = Full ary + | otherwise = BitmapIndexed b ary +{-# INLINE bitmapIndexedOrFull #-} + +-- | \(O(\log n)\) Associate the specified value with the specified +-- key in this map. If this map previously contained a mapping for +-- the key, the old value is replaced. +insert :: Hashable k => k -> v -> HashMap k v -> HashMap k v +insert k v m = insert' (hash k) k v m +{-# INLINABLE insert #-} + +insert' :: Eq k => Hash -> k -> v -> HashMap k v -> HashMap k v +insert' h0 k0 v0 m0 = go h0 k0 v0 0 m0 + where + go !h !k x !_ Empty = Leaf h (L k x) + go h k x s t@(Leaf hy l@(L ky y)) + | hy == h = if ky == k + then if x `ptrEq` y + then t + else Leaf h (L k x) + else collision h l (L k x) + | otherwise = runST (two s h k x hy t) + go h k x s t@(BitmapIndexed b ary) + | b .&. m == 0 = + let !ary' = A.insert ary i $! Leaf h (L k x) + in bitmapIndexedOrFull (b .|. m) ary' + | otherwise = + case A.index# ary i of + (# !st #) -> + let !st' = go h k x (nextShift s) st + in if st' `ptrEq` st + then t + else BitmapIndexed b (A.update ary i st') + where m = mask h s + i = sparseIndex b m + go h k x s t@(Full ary) = + case A.index# ary i of + (# !st #) -> + let !st' = go h k x (nextShift s) st + in if st' `ptrEq` st + then t + else Full (updateFullArray ary i st') + where i = index h s + go h k x s t@(Collision hy v) + | h == hy = Collision h (updateOrSnocWith (\a _ -> (# a #)) k x v) + | otherwise = go h k x s $ BitmapIndexed (mask hy s) (A.singleton t) +{-# INLINABLE insert' #-} + +-- | Insert optimized for the case when we know the key is not in the map. +-- +-- It is only valid to call this when the key does not exist in the map. +-- +-- We can skip: +-- - the key equality check on a Leaf +-- - check for its existence in the array for a hash collision +insertNewKey :: Hash -> k -> v -> HashMap k v -> HashMap k v +insertNewKey !h0 !k0 x0 m0 = go h0 k0 x0 0 m0 + where + go !h !k x !_ Empty = Leaf h (L k x) + go h k x s t@(Leaf hy l) + | hy == h = collision h l (L k x) + | otherwise = runST (two s h k x hy t) + go h k x s (BitmapIndexed b ary) + | b .&. m == 0 = + let !ary' = A.insert ary i $! Leaf h (L k x) + in bitmapIndexedOrFull (b .|. m) ary' + | otherwise = + case A.index# ary i of + (# st #) -> + let !st' = go h k x (nextShift s) st + in BitmapIndexed b (A.update ary i st') + where m = mask h s + i = sparseIndex b m + go h k x s (Full ary) = + case A.index# ary i of + (# st #) -> + let !st' = go h k x (nextShift s) st + in Full (updateFullArray ary i st') + where i = index h s + go h k x s t@(Collision hy v) + | h == hy = Collision h (A.snoc v (L k x)) + | otherwise = + go h k x s $ BitmapIndexed (mask hy s) (A.singleton t) +{-# NOINLINE insertNewKey #-} + + +-- | Insert optimized for the case when we know the key is in the map. +-- +-- It is only valid to call this when the key exists in the map and you know the +-- hash collision position if there was one. This information can be obtained +-- from 'lookupRecordCollision'. If there is no collision, pass (-1) as collPos +-- (first argument). +insertKeyExists :: Int -> Hash -> k -> v -> HashMap k v -> HashMap k v +insertKeyExists !collPos0 !h0 !k0 x0 m0 = go collPos0 h0 k0 x0 m0 + where + go !_collPos !_shiftedHash !k x (Leaf h _kx) + = Leaf h (L k x) + go collPos shiftedHash k x (BitmapIndexed b ary) + = case A.index# ary i of + (# st #) -> + let !st' = go collPos (nextSH shiftedHash) k x st + in BitmapIndexed b (A.update ary i st') + where m = maskSH shiftedHash + i = sparseIndex b m + go collPos shiftedHash k x (Full ary) + = case A.index# ary i of + (# st #) -> + let !st' = go collPos (nextSH shiftedHash) k x st + in Full (updateFullArray ary i st') + where i = indexSH shiftedHash + go collPos _shiftedHash k x (Collision h v) + | collPos >= 0 = Collision h (setAtPosition collPos k x v) + | otherwise = Empty -- error "Internal error: go {collPos negative}" + go _ _ _ _ Empty = Empty -- error "Internal error: go Empty" +{-# NOINLINE insertKeyExists #-} + +-- | Replace the ith Leaf with Leaf k v. +-- +-- This does not check that @i@ is within bounds of the array. +setAtPosition :: Int -> k -> v -> A.Array (Leaf k v) -> A.Array (Leaf k v) +setAtPosition i k x ary = A.update ary i (L k x) +{-# INLINE setAtPosition #-} + + +-- | In-place update version of insert +unsafeInsert :: forall k v. Hashable k => k -> v -> HashMap k v -> HashMap k v +unsafeInsert k0 v0 m0 = runST (go h0 k0 v0 0 m0) + where + h0 = hash k0 + go :: forall s. Hash -> k -> v -> Shift -> HashMap k v -> ST s (HashMap k v) + go !h !k x !_ Empty = return $! Leaf h (L k x) + go h k x s t@(Leaf hy l@(L ky y)) + | hy == h = if ky == k + then if x `ptrEq` y + then return t + else return $! Leaf h (L k x) + else return $! collision h l (L k x) + | otherwise = two s h k x hy t + go h k x s t@(BitmapIndexed b ary) + | b .&. m == 0 = do + ary' <- A.insertM ary i $! Leaf h (L k x) + return $! bitmapIndexedOrFull (b .|. m) ary' + | otherwise = do + st <- A.indexM ary i + st' <- go h k x (nextShift s) st + A.unsafeUpdateM ary i st' + return t + where m = mask h s + i = sparseIndex b m + go h k x s t@(Full ary) = do + st <- A.indexM ary i + st' <- go h k x (nextShift s) st + A.unsafeUpdateM ary i st' + return t + where i = index h s + go h k x s t@(Collision hy v) + | h == hy = return $! Collision h (updateOrSnocWith (\a _ -> (# a #)) k x v) + | otherwise = go h k x s $ BitmapIndexed (mask hy s) (A.singleton t) +{-# INLINABLE unsafeInsert #-} + +-- | Create a map from two key-value pairs which hashes don't collide. To +-- enhance sharing, the second key-value pair is represented by the hash of its +-- key and a singleton HashMap pairing its key with its value. +-- +-- Note: to avoid silly thunks, this function must be strict in the +-- key. See issue #232. We don't need to force the HashMap argument +-- because it's already in WHNF (having just been matched) and we +-- just put it directly in an array. +two :: Shift -> Hash -> k -> v -> Hash -> HashMap k v -> ST s (HashMap k v) +two = go + where + go s h1 k1 v1 h2 t2 + | bp1 == bp2 = do + st <- go (nextShift s) h1 k1 v1 h2 t2 + ary <- A.singletonM st + return $ BitmapIndexed bp1 ary + | otherwise = do + mary <- A.new 2 $! Leaf h1 (L k1 v1) + A.write mary idx2 t2 + ary <- A.unsafeFreeze mary + return $ BitmapIndexed (bp1 .|. bp2) ary + where + bp1 = mask h1 s + bp2 = mask h2 s + !(I# i1) = index h1 s + !(I# i2) = index h2 s + idx2 = I# (i1 Exts.<# i2) + -- This way of computing idx2 saves us a branch compared to the previous approach: + -- + -- idx2 | index h1 s < index h2 s = 1 + -- | otherwise = 0 + -- + -- See https://github.com/haskell-unordered-containers/unordered-containers/issues/75#issuecomment-1128419337 +{-# INLINE two #-} + +-- | \(O(\log n)\) Associate the value with the key in this map. If +-- this map previously contained a mapping for the key, the old value +-- is replaced by the result of applying the given function to the new +-- and old value. Example: +-- +-- > insertWith f k v map +-- > where f new old = new + old +insertWith :: Hashable k => (v -> v -> v) -> k -> v -> HashMap k v + -> HashMap k v +-- We're not going to worry about allocating a function closure +-- to pass to insertModifying. See comments at 'adjust'. +insertWith f k new m = insertModifying new (\old -> (# f new old #)) k m +{-# INLINE insertWith #-} + +-- | @insertModifying@ is a lot like insertWith; we use it to implement alterF. +-- It takes a value to insert when the key is absent and a function +-- to apply to calculate a new value when the key is present. Thanks +-- to the unboxed unary tuple, we avoid introducing any unnecessary +-- thunks in the tree. +insertModifying :: Hashable k => v -> (v -> (# v #)) -> k -> HashMap k v + -> HashMap k v +insertModifying x f k0 m0 = go h0 k0 0 m0 + where + !h0 = hash k0 + go !h !k !_ Empty = Leaf h (L k x) + go h k s t@(Leaf hy l@(L ky y)) + | hy == h = if ky == k + then case f y of + (# v' #) | ptrEq y v' -> t + | otherwise -> Leaf h (L k v') + else collision h l (L k x) + | otherwise = runST (two s h k x hy t) + go h k s t@(BitmapIndexed b ary) + | b .&. m == 0 = + let ary' = A.insert ary i $! Leaf h (L k x) + in bitmapIndexedOrFull (b .|. m) ary' + | otherwise = + case A.index# ary i of + (# !st #) -> + let !st' = go h k (nextShift s) st + ary' = A.update ary i st' + in if ptrEq st st' + then t + else BitmapIndexed b ary' + where m = mask h s + i = sparseIndex b m + go h k s t@(Full ary) = + case A.index# ary i of + (# !st #) -> + let !st' = go h k (nextShift s) st + ary' = updateFullArray ary i st' + in if ptrEq st st' + then t + else Full ary' + where i = index h s + go h k s t@(Collision hy v) + | h == hy = + let !v' = insertModifyingArr x f k v + in if A.unsafeSameArray v v' + then t + else Collision h v' + | otherwise = go h k s $ BitmapIndexed (mask hy s) (A.singleton t) +{-# INLINABLE insertModifying #-} + +-- | Like insertModifying for arrays; used to implement insertModifying +insertModifyingArr :: Eq k => v -> (v -> (# v #)) -> k -> A.Array (Leaf k v) + -> A.Array (Leaf k v) +insertModifyingArr x f k0 ary0 = go k0 ary0 0 (A.length ary0) + where + go !k !ary !i !n + -- Not found, append to the end. + | i >= n = A.snoc ary $ L k x + | otherwise = case A.index# ary i of + (# L kx y #) + | k == kx -> + case f y of + (# y' #) -> if ptrEq y y' + then ary + else A.update ary i (L k y') + | otherwise -> go k ary (i+1) n +{-# INLINE insertModifyingArr #-} + +-- | In-place update version of insertWith +unsafeInsertWith :: forall k v. Hashable k + => (v -> v -> v) -> k -> v -> HashMap k v + -> HashMap k v +unsafeInsertWith f k0 v0 m0 = unsafeInsertWithKey (\_ a b -> (# f a b #)) k0 v0 m0 +{-# INLINABLE unsafeInsertWith #-} + +unsafeInsertWithKey :: forall k v. Hashable k + => (k -> v -> v -> (# v #)) -> k -> v -> HashMap k v + -> HashMap k v +unsafeInsertWithKey f k0 v0 m0 = runST (go h0 k0 v0 0 m0) + where + h0 = hash k0 + go :: Hash -> k -> v -> Shift -> HashMap k v -> ST s (HashMap k v) + go !h !k x !_ Empty = return $! Leaf h (L k x) + go h k x s t@(Leaf hy l@(L ky y)) + | hy == h = if ky == k + then case f k x y of + (# v #) -> return $! Leaf h (L k v) + else return $! collision h l (L k x) + | otherwise = two s h k x hy t + go h k x s t@(BitmapIndexed b ary) + | b .&. m == 0 = do + ary' <- A.insertM ary i $! Leaf h (L k x) + return $! bitmapIndexedOrFull (b .|. m) ary' + | otherwise = do + st <- A.indexM ary i + st' <- go h k x (nextShift s) st + A.unsafeUpdateM ary i st' + return t + where m = mask h s + i = sparseIndex b m + go h k x s t@(Full ary) = do + st <- A.indexM ary i + st' <- go h k x (nextShift s) st + A.unsafeUpdateM ary i st' + return t + where i = index h s + go h k x s t@(Collision hy v) + | h == hy = return $! Collision h (updateOrSnocWithKey f k x v) + | otherwise = go h k x s $ BitmapIndexed (mask hy s) (A.singleton t) +{-# INLINABLE unsafeInsertWithKey #-} + +-- | \(O(\log n)\) Remove the mapping for the specified key from this map +-- if present. +delete :: Hashable k => k -> HashMap k v -> HashMap k v +delete k = delete' (hash k) k +{-# INLINE delete #-} + +delete' :: Eq k => Hash -> k -> HashMap k v -> HashMap k v +delete' = deleteFromSubtree 0 +{-# INLINE delete' #-} + +-- | This version of 'delete' can be used on a subtree when the +-- corresponding 'Shift' argument is supplied. +deleteFromSubtree :: Eq k => Shift -> Hash -> k -> HashMap k v -> HashMap k v +deleteFromSubtree !s !h !k = \case + Empty -> Empty + t@(Leaf hy (L ky _)) + | hy == h && ky == k -> Empty + | otherwise -> t + t@(BitmapIndexed b ary) + | b .&. m == 0 -> t + | otherwise -> case A.index# ary i of + (# !st #) -> + case deleteFromSubtree (nextShift s) h k st of + Empty | A.length ary == 2 + , (# l #) <- A.index# ary (otherOfOneOrZero i) + , isLeafOrCollision l + -> l + | otherwise + -> BitmapIndexed (b .&. complement m) (A.delete ary i) + st' | st' `ptrEq` st -> t + | isLeafOrCollision st' && A.length ary == 1 -> st' + | otherwise -> BitmapIndexed b (A.update ary i st') + where m = mask h s + i = sparseIndex b m + t@(Full ary) -> + case A.index# ary i of + (# !st #) -> + case deleteFromSubtree (nextShift s) h k st of + Empty -> + let ary' = A.delete ary i + bm = fullBitmap .&. complement (1 `unsafeShiftL` i) + in BitmapIndexed bm ary' + st' | st' `ptrEq` st -> t + | otherwise -> Full (updateFullArray ary i st') + where i = index h s + t@(Collision hy ary) + | h == hy + , Just i <- indexOf k ary + -> if A.length ary == 2 + then case A.index# ary (otherOfOneOrZero i) of + (# l #) -> Leaf h l + else Collision h (A.delete ary i) + | otherwise -> t +{-# INLINABLE deleteFromSubtree #-} + +-- | Delete optimized for the case when we know the key is in the map. +-- +-- It is only valid to call this when the key exists in the map and you know the +-- hash collision position if there was one. This information can be obtained +-- from 'lookupRecordCollision'. If there is no collision, pass (-1) as collPos. +deleteKeyExists :: Int -> Hash -> k -> HashMap k v -> HashMap k v +deleteKeyExists !collPos0 !h0 !k0 m0 = go collPos0 h0 k0 m0 + where + go :: Int -> ShiftedHash -> k -> HashMap k v -> HashMap k v + go !_collPos !_shiftedHash !_k (Leaf _ _) = Empty + go collPos shiftedHash k (BitmapIndexed b ary) = + case A.index# ary i of + (# st #) -> case go collPos (nextSH shiftedHash) k st of + Empty | A.length ary == 2 + , (# l #) <- A.index# ary (otherOfOneOrZero i) + , isLeafOrCollision l + -> l + | otherwise + -> BitmapIndexed (b .&. complement m) (A.delete ary i) + st' | isLeafOrCollision st' && A.length ary == 1 -> st' + | otherwise -> BitmapIndexed b (A.update ary i st') + where m = maskSH shiftedHash + i = sparseIndex b m + go collPos shiftedHash k (Full ary) = + case A.index# ary i of + (# st #) -> case go collPos (nextSH shiftedHash) k st of + Empty -> + let ary' = A.delete ary i + bm = fullBitmap .&. complement (1 `unsafeShiftL` i) + in BitmapIndexed bm ary' + st' -> Full (updateFullArray ary i st') + where i = indexSH shiftedHash + go collPos _shiftedHash _k (Collision h v) + | A.length v == 2 + = case A.index# v (otherOfOneOrZero collPos) of + (# l #) -> Leaf h l + | otherwise = Collision h (A.delete v collPos) + go !_ !_ !_ Empty = Empty -- error "Internal error: deleteKeyExists empty" +{-# NOINLINE deleteKeyExists #-} + +-- | \(O(\log n)\) Adjust the value tied to a given key in this map only +-- if it is present. Otherwise, leave the map alone. +adjust :: Hashable k => (v -> v) -> k -> HashMap k v -> HashMap k v +-- This operation really likes to leak memory, so using this +-- indirect implementation shouldn't hurt much. Furthermore, it allows +-- GHC to avoid a leak when the function is lazy. In particular, +-- +-- adjust (const x) k m +-- ==> adjust# (\v -> (# const x v #)) k m +-- ==> adjust# (\_ -> (# x #)) k m +adjust f k m = adjust# (\v -> (# f v #)) k m +{-# INLINE adjust #-} + +-- | Much like 'adjust', but not inherently leaky. +adjust# :: Hashable k => (v -> (# v #)) -> k -> HashMap k v -> HashMap k v +adjust# f k0 m0 = go h0 k0 0 m0 + where + h0 = hash k0 + go !_ !_ !_ Empty = Empty + go h k _ t@(Leaf hy (L ky y)) + | hy == h && ky == k = case f y of + (# y' #) | ptrEq y y' -> t + | otherwise -> Leaf h (L k y') + | otherwise = t + go h k s t@(BitmapIndexed b ary) + | b .&. m == 0 = t + | otherwise = + case A.index# ary i of + (# !st #) -> + let !st' = go h k (nextShift s) st + ary' = A.update ary i st' + in if ptrEq st st' + then t + else BitmapIndexed b ary' + where m = mask h s + i = sparseIndex b m + go h k s t@(Full ary) = + case A.index# ary i of + (# !st #) -> + let !st' = go h k (nextShift s) st + ary' = updateFullArray ary i st' + in if ptrEq st st' + then t + else Full ary' + where i = index h s + go h k _ t@(Collision hy v) + | h == hy = let !v' = updateWith# f k v + in if A.unsafeSameArray v v' + then t + else Collision h v' + | otherwise = t +{-# INLINABLE adjust# #-} + +-- | \(O(\log n)\) The expression @('update' f k map)@ updates the value @x@ at @k@ +-- (if it is in the map). If @(f x)@ is 'Nothing', the element is deleted. +-- If it is @('Just' y)@, the key @k@ is bound to the new value @y@. +update :: Hashable k => (a -> Maybe a) -> k -> HashMap k a -> HashMap k a +update f = alter (>>= f) +{-# INLINABLE update #-} + + +-- | \(O(\log n)\) The expression @('alter' f k map)@ alters the value @x@ at @k@, or +-- absence thereof. +-- +-- 'alter' can be used to insert, delete, or update a value in a map. In short: +-- +-- @ +-- 'lookup' k ('alter' f k m) = f ('lookup' k m) +-- @ +alter :: Hashable k => (Maybe v -> Maybe v) -> k -> HashMap k v -> HashMap k v +alter f k m = + let !h = hash k + !lookupRes = lookupRecordCollision h k m + in case f (lookupResToMaybe lookupRes) of + Nothing -> case lookupRes of + Absent -> m + Present _ collPos -> deleteKeyExists collPos h k m + Just v' -> case lookupRes of + Absent -> insertNewKey h k v' m + Present v collPos -> + if v `ptrEq` v' + then m + else insertKeyExists collPos h k v' m +{-# INLINABLE alter #-} + +-- | \(O(\log n)\) The expression @('alterF' f k map)@ alters the value @x@ at +-- @k@, or absence thereof. +-- +-- 'alterF' can be used to insert, delete, or update a value in a map. +-- +-- Note: 'alterF' is a flipped version of the 'at' combinator from +-- . +-- +-- @since 0.2.10 +alterF :: (Functor f, Hashable k) + => (Maybe v -> f (Maybe v)) -> k -> HashMap k v -> f (HashMap k v) +-- We only calculate the hash once, but unless this is rewritten +-- by rules we may test for key equality multiple times. +-- We force the value of the map for consistency with the rewritten +-- version; otherwise someone could tell the difference using a lazy +-- @f@ and a functor that is similar to Const but not actually Const. +alterF f = \ !k !m -> + let + !h = hash k + mv = lookup' h k m + in (<$> f mv) $ \case + Nothing -> maybe m (const (delete' h k m)) mv + Just v' -> insert' h k v' m + +-- We unconditionally rewrite alterF in RULES, but we expose an +-- unfolding just in case it's used in some way that prevents the +-- rule from firing. +{-# INLINABLE [0] alterF #-} + +-- | This is just a bottom value. See the comment on the "alterFWeird" +-- rule. +test_bottom :: a +test_bottom = error "Data.HashMap.alterF internal error: hit test_bottom" + +-- | We use this as an error result in RULES to ensure we don't get +-- any useless CallStack nonsense. +bogus# :: (# #) -> (# a #) +bogus# _ = error "Data.HashMap.alterF internal error: hit bogus#" + +{-# RULES +-- We probe the behavior of @f@ by applying it to Nothing and to +-- Just test_bottom. Based on the results, and how they relate to +-- each other, we choose the best implementation. + +"alterFWeird" forall f. alterF f = + alterFWeird (f Nothing) (f (Just test_bottom)) f + +-- This rule covers situations where alterF is used to simply insert or +-- delete in Identity (most likely via Control.Lens.At). We recognize here +-- (through the repeated @x@ on the LHS) that +-- +-- @f Nothing = f (Just bottom)@, +-- +-- which guarantees that @f@ doesn't care what its argument is, so +-- we don't have to either. +-- +-- Why only Identity? A variant of this rule is actually valid regardless of +-- the functor, but for some functors (e.g., []), it can lead to the +-- same keys being compared multiple times, which is bad if they're +-- ugly things like strings. This is unfortunate, since the rule is likely +-- a good idea for almost all realistic uses, but I don't like nasty +-- edge cases. +"alterFconstant" forall (f :: Maybe a -> Identity (Maybe a)) x. + alterFWeird x x f = \ !k !m -> + Identity (case runIdentity x of {Nothing -> delete k m; Just a -> insert k a m}) + +-- This rule handles the case where 'alterF' is used to do 'insertWith'-like +-- things. Whenever possible, GHC will get rid of the Maybe nonsense for us. +-- We delay this rule to stage 1 so alterFconstant has a chance to fire. +"alterFinsertWith" [1] forall (f :: Maybe a -> Identity (Maybe a)) x y. + alterFWeird (coerce (Just x)) (coerce (Just y)) f = + coerce (insertModifying x (\mold -> case runIdentity (f (Just mold)) of + Nothing -> bogus# (# #) + Just new -> (# new #))) + +-- Handle the case where someone uses 'alterF' instead of 'adjust'. This +-- rule is kind of picky; it will only work if the function doesn't +-- do anything between case matching on the Maybe and producing a result. +"alterFadjust" forall (f :: Maybe a -> Identity (Maybe a)) _y. + alterFWeird (coerce Nothing) (coerce (Just _y)) f = + coerce (adjust# (\x -> case runIdentity (f (Just x)) of + Just x' -> (# x' #) + Nothing -> bogus# (# #))) + +-- The simple specialization to Const; in this case we can look up +-- the key without caring what position it's in. This is only a tiny +-- optimization. +"alterFlookup" forall _ign1 _ign2 (f :: Maybe a -> Const r (Maybe a)). + alterFWeird _ign1 _ign2 f = \ !k !m -> Const (getConst (f (lookup k m))) + #-} + +-- | This is a very unsafe version of alterF used for RULES. When calling +-- alterFWeird x y f, the following *must* hold: +-- +-- x = f Nothing +-- y = f (Just _|_) +-- +-- Failure to abide by these laws will make demons come out of your nose. +alterFWeird + :: (Functor f, Hashable k) + => f (Maybe v) + -> f (Maybe v) + -> (Maybe v -> f (Maybe v)) -> k -> HashMap k v -> f (HashMap k v) +alterFWeird _ _ f = alterFEager f +{-# INLINE [0] alterFWeird #-} + +-- | This is the default version of alterF that we use in most non-trivial +-- cases. It's called "eager" because it looks up the given key in the map +-- eagerly, whether or not the given function requires that information. +alterFEager :: (Functor f, Hashable k) + => (Maybe v -> f (Maybe v)) -> k -> HashMap k v -> f (HashMap k v) +alterFEager f !k m = (<$> f mv) $ \case + + ------------------------------ + -- Delete the key from the map. + Nothing -> case lookupRes of + + -- Key did not exist in the map to begin with, no-op + Absent -> m + + -- Key did exist + Present _ collPos -> deleteKeyExists collPos h k m + + ------------------------------ + -- Update value + Just v' -> case lookupRes of + + -- Key did not exist before, insert v' under a new key + Absent -> insertNewKey h k v' m + + -- Key existed before + Present v collPos -> + if v `ptrEq` v' + -- If the value is identical, no-op + then m + -- If the value changed, update the value. + else insertKeyExists collPos h k v' m + + where !h = hash k + !lookupRes = lookupRecordCollision h k m + !mv = lookupResToMaybe lookupRes +{-# INLINABLE alterFEager #-} + +-- | \(O(n \log m)\) Inclusion of maps. A map is included in another map if the keys +-- are subsets and the corresponding values are equal: +-- +-- > isSubmapOf m1 m2 = keys m1 `isSubsetOf` keys m2 && +-- > and [ v1 == v2 | (k1,v1) <- toList m1; let v2 = m2 ! k1 ] +-- +-- ==== __Examples__ +-- +-- >>> fromList [(1,'a')] `isSubmapOf` fromList [(1,'a'),(2,'b')] +-- True +-- +-- >>> fromList [(1,'a'),(2,'b')] `isSubmapOf` fromList [(1,'a')] +-- False +-- +-- @since 0.2.12 +isSubmapOf :: (Hashable k, Eq v) => HashMap k v -> HashMap k v -> Bool +isSubmapOf = Exts.inline isSubmapOfBy (==) +{-# INLINABLE isSubmapOf #-} + +-- | \(O(n \log m)\) Inclusion of maps with value comparison. A map is included in +-- another map if the keys are subsets and if the comparison function is true +-- for the corresponding values: +-- +-- > isSubmapOfBy cmpV m1 m2 = keys m1 `isSubsetOf` keys m2 && +-- > and [ v1 `cmpV` v2 | (k1,v1) <- toList m1; let v2 = m2 ! k1 ] +-- +-- ==== __Examples__ +-- +-- >>> isSubmapOfBy (<=) (fromList [(1,'a')]) (fromList [(1,'b'),(2,'c')]) +-- True +-- +-- >>> isSubmapOfBy (<=) (fromList [(1,'b')]) (fromList [(1,'a'),(2,'c')]) +-- False +-- +-- @since 0.2.12 +isSubmapOfBy :: Hashable k => (v1 -> v2 -> Bool) -> HashMap k v1 -> HashMap k v2 -> Bool +-- For maps without collisions the complexity is O(n*log m), where n is the size +-- of m1 and m the size of m2: the inclusion operation visits every leaf in m1 at least once. +-- For each leaf in m1, it looks up the key in m2. +-- +-- The worst case complexity is O(n*m). The worst case is when both hashmaps m1 +-- and m2 are collision nodes for the same hash. Since collision nodes are +-- unsorted arrays, it requires for every key in m1 a linear search to to find a +-- matching key in m2, hence O(n*m). +isSubmapOfBy comp !m1 !m2 = go 0 m1 m2 + where + -- An empty map is always a submap of any other map. + go _ Empty _ = True + + -- If the second map is empty and the first is not, it cannot be a submap. + go _ _ Empty = False + + -- If the first map contains only one entry, lookup the key in the second map. + go s (Leaf h1 (L k1 v1)) t2 = lookupCont (\_ -> False) (\v2 _ -> comp v1 v2) h1 k1 s t2 + + -- In this case, we need to check that for each x in ls1, there is a y in + -- ls2 such that x `comp` y. This is the worst case complexity-wise since it + -- requires a O(m*n) check. + go _ (Collision h1 ls1) (Collision h2 ls2) = + h1 == h2 && subsetArray comp ls1 ls2 + + -- In this case, we only need to check the entries in ls2 with the hash h1. + go s t1@(Collision h1 _) (BitmapIndexed b ls2) + | b .&. m == 0 = False + | otherwise = + case A.index# ls2 (sparseIndex b m) of + (# st2 #) -> go (nextShift s) t1 st2 + where m = mask h1 s + + -- Similar to the previous case we need to traverse l2 at the index for the hash h1. + go s t1@(Collision h1 _) (Full ls2) = + case A.index# ls2 (index h1 s) of + (# st2 #) -> go (nextShift s) t1 st2 + + -- In cases where the first and second map are BitmapIndexed or Full, + -- traverse down the tree at the appropriate indices. + go s (BitmapIndexed b1 ls1) (BitmapIndexed b2 ls2) = + submapBitmapIndexed (go (nextShift s)) b1 ls1 b2 ls2 + go s (BitmapIndexed b1 ls1) (Full ls2) = + submapBitmapIndexed (go (nextShift s)) b1 ls1 fullBitmap ls2 + go s (Full ls1) (Full ls2) = + submapBitmapIndexed (go (nextShift s)) fullBitmap ls1 fullBitmap ls2 + + -- Collision and Full nodes always contain at least two entries. Hence it + -- cannot be a map of a leaf. + go _ (Collision {}) (Leaf {}) = False + go _ (BitmapIndexed {}) (Leaf {}) = False + go _ (Full {}) (Leaf {}) = False + go _ (BitmapIndexed {}) (Collision {}) = False + go _ (Full {}) (Collision {}) = False + go _ (Full {}) (BitmapIndexed {}) = False +{-# INLINABLE isSubmapOfBy #-} + +-- | \(O(\min n m))\) Checks if a bitmap indexed node is a submap of another. +submapBitmapIndexed :: (HashMap k v1 -> HashMap k v2 -> Bool) -> Bitmap -> A.Array (HashMap k v1) -> Bitmap -> A.Array (HashMap k v2) -> Bool +submapBitmapIndexed comp !b1 !ary1 !b2 !ary2 = subsetBitmaps && go 0 0 (b1Orb2 .&. negate b1Orb2) + where + go :: Int -> Int -> Bitmap -> Bool + go !i !j !m + + -- Note: m can overflow to 0 when maxChildren == WORD_SIZE_IN_BITS. See + -- #491. In that case there needs to be a check '| m == 0 = True' + | m > b1Orb2 = True + + -- In case a key is both in ary1 and ary2, check ary1[i] <= ary2[j] and + -- increment the indices i and j. + | b1Andb2 .&. m /= 0 + , (# st1 #) <- A.index# ary1 i + , (# st2 #) <- A.index# ary2 j + = comp st1 st2 && go (i+1) (j+1) (m `unsafeShiftL` 1) + + -- In case a key occurs in ary1, but not ary2, only increment index j. + | b2 .&. m /= 0 = go i (j+1) (m `unsafeShiftL` 1) + + -- In case a key neither occurs in ary1 nor ary2, continue. + | otherwise = go i j (m `unsafeShiftL` 1) + + b1Andb2 = b1 .&. b2 + b1Orb2 = b1 .|. b2 + subsetBitmaps = b1Orb2 == b2 +{-# INLINABLE submapBitmapIndexed #-} + +------------------------------------------------------------------------ +-- * Combine + +-- | \(O(n+m)\) The union of two maps. If a key occurs in both maps, the +-- mapping from the first will be the mapping in the result. +-- +-- ==== __Examples__ +-- +-- >>> union (fromList [(1,'a'),(2,'b')]) (fromList [(2,'c'),(3,'d')]) +-- fromList [(1,'a'),(2,'b'),(3,'d')] +union :: Eq k => HashMap k v -> HashMap k v -> HashMap k v +union = unionWith const +{-# INLINABLE union #-} + +-- | \(O(n+m)\) The union of two maps. If a key occurs in both maps, +-- the provided function (first argument) will be used to compute the +-- result. +unionWith :: Eq k => (v -> v -> v) -> HashMap k v -> HashMap k v + -> HashMap k v +unionWith f = unionWithKey (const f) +{-# INLINE unionWith #-} + +-- | \(O(n+m)\) The union of two maps. If a key occurs in both maps, +-- the provided function (first argument) will be used to compute the +-- result. +unionWithKey :: Eq k => (k -> v -> v -> v) -> HashMap k v -> HashMap k v + -> HashMap k v +unionWithKey f = go 0 + where + -- empty vs. anything + go !_ t1 Empty = t1 + go _ Empty t2 = t2 + -- leaf vs. leaf + go s t1@(Leaf h1 l1@(L k1 v1)) t2@(Leaf h2 l2@(L k2 v2)) + | h1 == h2 = if k1 == k2 + then Leaf h1 (L k1 (f k1 v1 v2)) + else collision h1 l1 l2 + | otherwise = goDifferentHash s h1 h2 t1 t2 + go s t1@(Leaf h1 (L k1 v1)) t2@(Collision h2 ls2) + | h1 == h2 = Collision h1 (updateOrSnocWithKey (\k a b -> (# f k a b #)) k1 v1 ls2) + | otherwise = goDifferentHash s h1 h2 t1 t2 + go s t1@(Collision h1 ls1) t2@(Leaf h2 (L k2 v2)) + | h1 == h2 = Collision h1 (updateOrSnocWithKey (\k a b -> (# f k b a #)) k2 v2 ls1) + | otherwise = goDifferentHash s h1 h2 t1 t2 + go s t1@(Collision h1 ls1) t2@(Collision h2 ls2) + | h1 == h2 = Collision h1 (updateOrConcatWithKey (\k a b -> (# f k a b #)) ls1 ls2) + | otherwise = goDifferentHash s h1 h2 t1 t2 + -- branch vs. branch + go s (BitmapIndexed b1 ary1) (BitmapIndexed b2 ary2) = + let b' = b1 .|. b2 + ary' = unionArrayBy (go (nextShift s)) b1 b2 ary1 ary2 + in bitmapIndexedOrFull b' ary' + go s (BitmapIndexed b1 ary1) (Full ary2) = + let ary' = unionArrayBy (go (nextShift s)) b1 fullBitmap ary1 ary2 + in Full ary' + go s (Full ary1) (BitmapIndexed b2 ary2) = + let ary' = unionArrayBy (go (nextShift s)) fullBitmap b2 ary1 ary2 + in Full ary' + go s (Full ary1) (Full ary2) = + let ary' = unionArrayBy (go (nextShift s)) fullBitmap fullBitmap + ary1 ary2 + in Full ary' + -- leaf vs. branch + go s (BitmapIndexed b1 ary1) t2 + | b1 .&. m2 == 0 = let ary' = A.insert ary1 i t2 + b' = b1 .|. m2 + in bitmapIndexedOrFull b' ary' + | otherwise = let ary' = A.updateWith' ary1 i $ \st1 -> + go (nextShift s) st1 t2 + in BitmapIndexed b1 ary' + where + h2 = leafHashCode t2 + m2 = mask h2 s + i = sparseIndex b1 m2 + go s t1 (BitmapIndexed b2 ary2) + | b2 .&. m1 == 0 = let ary' = A.insert ary2 i $! t1 + b' = b2 .|. m1 + in bitmapIndexedOrFull b' ary' + | otherwise = let ary' = A.updateWith' ary2 i $ \st2 -> + go (nextShift s) t1 st2 + in BitmapIndexed b2 ary' + where + h1 = leafHashCode t1 + m1 = mask h1 s + i = sparseIndex b2 m1 + go s (Full ary1) t2 = + let h2 = leafHashCode t2 + i = index h2 s + ary' = updateFullArrayWith' ary1 i $ \st1 -> go (nextShift s) st1 t2 + in Full ary' + go s t1 (Full ary2) = + let h1 = leafHashCode t1 + i = index h1 s + ary' = updateFullArrayWith' ary2 i $ \st2 -> go (nextShift s) t1 st2 + in Full ary' + + leafHashCode (Leaf h _) = h + leafHashCode (Collision h _) = h + leafHashCode _ = error "leafHashCode" + + goDifferentHash s h1 h2 t1 t2 + | m1 == m2 = BitmapIndexed m1 (A.singleton $! goDifferentHash (nextShift s) h1 h2 t1 t2) + | m1 < m2 = BitmapIndexed (m1 .|. m2) (A.pair t1 t2) + | otherwise = BitmapIndexed (m1 .|. m2) (A.pair t2 t1) + where + m1 = mask h1 s + m2 = mask h2 s +{-# INLINE unionWithKey #-} + +-- | Strict in the result of @f@. +unionArrayBy :: (a -> a -> a) -> Bitmap -> Bitmap -> A.Array a -> A.Array a + -> A.Array a +-- The manual forcing of @b1@, @b2@, @ary1@ and @ary2@ results in handsome +-- Core size reductions with GHC 9.2.2. See the Core diffs in +-- https://github.com/haskell-unordered-containers/unordered-containers/pull/376. +unionArrayBy f !b1 !b2 !ary1 !ary2 = A.run $ do + let bCombined = b1 .|. b2 + mary <- A.new_ (popCount bCombined) + -- iterate over nonzero bits of b1 .|. b2 + let go !i !i1 !i2 !b + | b == 0 = return () + | testBit (b1 .&. b2) = do + x1 <- A.indexM ary1 i1 + x2 <- A.indexM ary2 i2 + A.write mary i $! f x1 x2 + go (i+1) (i1+1) (i2+1) b' + | testBit b1 = do + A.write mary i =<< A.indexM ary1 i1 + go (i+1) (i1+1) i2 b' + | otherwise = do + A.write mary i =<< A.indexM ary2 i2 + go (i+1) i1 (i2+1) b' + where + m = 1 `unsafeShiftL` countTrailingZeros b + testBit x = x .&. m /= 0 + b' = b .&. complement m + go 0 0 0 bCombined + return mary + -- TODO: For the case where b1 .&. b2 == b1, i.e. when one is a + -- subset of the other, we could use a slightly simpler algorithm, + -- where we copy one array, and then update. +{-# INLINE unionArrayBy #-} + +-- TODO: Figure out the time complexity of 'unions'. + +-- | Construct a set containing all elements from a list of sets. +unions :: Eq k => [HashMap k v] -> HashMap k v +unions = List.foldl' union empty +{-# INLINE unions #-} + + +------------------------------------------------------------------------ +-- * Compose + +-- | Given maps @bc@ and @ab@, relate the keys of @ab@ to the values of @bc@, +-- by using the values of @ab@ as keys for lookups in @bc@. +-- +-- Complexity: \( O (n * \log(m)) \), where \(m\) is the size of the first argument +-- +-- >>> compose (fromList [('a', "A"), ('b', "B")]) (fromList [(1,'a'),(2,'b'),(3,'z')]) +-- fromList [(1,"A"),(2,"B")] +-- +-- @ +-- ('compose' bc ab '!?') = (bc '!?') <=< (ab '!?') +-- @ +-- +-- @since 0.2.13.0 +compose :: Hashable b => HashMap b c -> HashMap a b -> HashMap a c +compose bc !ab + | null bc = empty + | otherwise = mapMaybe (bc !?) ab + +------------------------------------------------------------------------ +-- * Transformations + +-- | \(O(n)\) Transform this map by applying a function to every value. +mapWithKey :: (k -> v1 -> v2) -> HashMap k v1 -> HashMap k v2 +mapWithKey f = go + where + go Empty = Empty + go (Leaf h (L k v)) = Leaf h $ L k (f k v) + go (BitmapIndexed b ary) = BitmapIndexed b $ A.map go ary + go (Full ary) = Full $ A.map go ary + -- Why map strictly over collision arrays? Because there's no + -- point suspending the O(1) work this does for each leaf. + go (Collision h ary) = Collision h $ + A.map' (\ (L k v) -> L k (f k v)) ary +{-# INLINE mapWithKey #-} + +-- | \(O(n)\) Transform this map by applying a function to every value. +map :: (v1 -> v2) -> HashMap k v1 -> HashMap k v2 +map f = mapWithKey (const f) +{-# INLINE map #-} + +-- | \(O(n)\) Perform an 'Applicative' action for each key-value pair +-- in a 'HashMap' and produce a 'HashMap' of all the results. +-- +-- Note: the order in which the actions occur is unspecified. In particular, +-- when the map contains hash collisions, the order in which the actions +-- associated with the keys involved will depend in an unspecified way on +-- their insertion order. +traverseWithKey + :: Applicative f + => (k -> v1 -> f v2) + -> HashMap k v1 -> f (HashMap k v2) +traverseWithKey f = go + where + go Empty = pure Empty + go (Leaf h (L k v)) = Leaf h . L k <$> f k v + go (BitmapIndexed b ary) = BitmapIndexed b <$> A.traverse go ary + go (Full ary) = Full <$> A.traverse go ary + go (Collision h ary) = + Collision h <$> A.traverse' (\ (L k v) -> L k <$> f k v) ary +{-# INLINE traverseWithKey #-} + +-- | \(O(n)\). +-- @'mapKeys' f s@ is the map obtained by applying @f@ to each key of @s@. +-- +-- The size of the result may be smaller if @f@ maps two or more distinct +-- keys to the same new key. In this case there is no guarantee which of the +-- associated values is chosen for the conflicting key. +-- +-- >>> mapKeys (+ 1) (fromList [(5,"a"), (3,"b")]) +-- fromList [(4,"b"),(6,"a")] +-- >>> mapKeys (\ _ -> 1) (fromList [(1,"b"), (2,"a"), (3,"d"), (4,"c")]) +-- fromList [(1,"c")] +-- >>> mapKeys (\ _ -> 3) (fromList [(1,"b"), (2,"a"), (3,"d"), (4,"c")]) +-- fromList [(3,"c")] +-- +-- @since 0.2.14.0 +mapKeys :: Hashable k2 => (k1 -> k2) -> HashMap k1 v -> HashMap k2 v +mapKeys f = fromList . foldrWithKey (\k x xs -> (f k, x) : xs) [] + +------------------------------------------------------------------------ +-- * Difference and intersection + +-- | \(O(n \log m)\) Difference of two maps. Return elements of the first map +-- not existing in the second. +difference :: Hashable k => HashMap k v -> HashMap k w -> HashMap k v +difference = go_difference 0 + where + go_difference !_s Empty _ = Empty + go_difference s t1@(Leaf h1 (L k1 _)) t2 + = lookupCont (\_ -> t1) (\_ _ -> Empty) h1 k1 s t2 + go_difference _ t1 Empty = t1 + go_difference s t1 (Leaf h2 (L k2 _)) = deleteFromSubtree s h2 k2 t1 + + go_difference s t1@(BitmapIndexed b1 ary1) (BitmapIndexed b2 ary2) + = differenceArrays s b1 ary1 t1 b2 ary2 + go_difference s t1@(Full ary1) (BitmapIndexed b2 ary2) + = differenceArrays s fullBitmap ary1 t1 b2 ary2 + go_difference s t1@(BitmapIndexed b1 ary1) (Full ary2) + = differenceArrays s b1 ary1 t1 fullBitmap ary2 + go_difference s t1@(Full ary1) (Full ary2) + = differenceArrays s fullBitmap ary1 t1 fullBitmap ary2 + + go_difference s t1@(Collision h1 _) (BitmapIndexed b2 ary2) + | b2 .&. m == 0 = t1 + | otherwise = + case A.index# ary2 (sparseIndex b2 m) of + (# st2 #) -> go_difference (nextShift s) t1 st2 + where m = mask h1 s + go_difference s t1@(Collision h1 _) (Full ary2) + = case A.index# ary2 (index h1 s) of + (# st2 #) -> go_difference (nextShift s) t1 st2 + + go_difference s t1@(BitmapIndexed b1 ary1) t2@(Collision h2 _) + | b1 .&. m == 0 = t1 + | otherwise = + case A.index# ary1 i1 of + (# !st #) -> + case go_difference (nextShift s) st t2 of + Empty | A.length ary1 == 2 + , (# l #) <- A.index# ary1 (otherOfOneOrZero i1) + , isLeafOrCollision l + -> l + | otherwise + -> BitmapIndexed (b1 .&. complement m) (A.delete ary1 i1) + st' | isLeafOrCollision st' && A.length ary1 == 1 -> st' + | st `ptrEq` st' -> t1 + | otherwise -> BitmapIndexed b1 (A.update ary1 i1 st') + where + m = mask h2 s + i1 = sparseIndex b1 m + go_difference s t1@(Full ary1) t2@(Collision h2 _) + = case A.index# ary1 i of + (# !st #) -> case go_difference (nextShift s) st t2 of + Empty -> + let ary1' = A.delete ary1 i + bm = fullBitmap .&. complement (1 `unsafeShiftL` i) + in BitmapIndexed bm ary1' + st' | st `ptrEq` st' -> t1 + | otherwise -> Full (updateFullArray ary1 i st') + where i = index h2 s + + go_difference _ t1@(Collision h1 ary1) (Collision h2 ary2) + = differenceCollisions h1 ary1 t1 h2 ary2 + + -- TODO: If we keep 'Full' (#399), differenceArrays could be optimized for + -- each combination of 'Full' and 'BitmapIndexed`. + differenceArrays !s !b1 !ary1 t1 !b2 !ary2 + | b1 .&. b2 == 0 = t1 + | A.unsafeSameArray ary1 ary2 = Empty + | otherwise = runST $ do + mary <- A.new_ $ A.length ary1 + + -- TODO: i == popCount bResult. Not sure if that would be faster. + -- Also i1 is in some relation with b1' + let goDA !i !i1 !b1' !bResult !nChanges + | b1' == 0 = pure (bResult, nChanges) + | otherwise = do + !st1 <- A.indexM ary1 i1 + case m .&. b2 of + 0 -> do + A.write mary i st1 + goDA (i + 1) (i1 + 1) nextB1' (bResult .|. m) nChanges + _ -> do + !st2 <- A.indexM ary2 (sparseIndex b2 m) + case go_difference (nextShift s) st1 st2 of + Empty -> goDA i (i1 + 1) nextB1' bResult (nChanges + 1) + st -> do + A.write mary i st + let same = I# (Exts.reallyUnsafePtrEquality# st st1) + let nChanges' = nChanges + (1 - same) + goDA (i + 1) (i1 + 1) nextB1' (bResult .|. m) nChanges' + where + m = b1' .&. negate b1' + nextB1' = b1' .&. complement m + + (bResult, nChanges) <- goDA 0 0 b1 0 0 + if nChanges == 0 + then pure t1 + else case popCount bResult of + 0 -> pure Empty + 1 -> do + l <- A.read mary 0 + if isLeafOrCollision l + then pure l + else BitmapIndexed bResult <$> (A.unsafeFreeze =<< A.shrink mary 1) + n -> bitmapIndexedOrFull bResult <$> (A.unsafeFreeze =<< A.shrink mary n) +{-# INLINABLE difference #-} + +-- TODO: This could be faster if we would keep track of which elements of ary2 +-- we've already matched. Those could be skipped when we check the following +-- elements of ary1. +differenceCollisions :: Eq k => Hash -> A.Array (Leaf k v1) -> HashMap k v1 -> Hash -> A.Array (Leaf k v2) -> HashMap k v1 +differenceCollisions !h1 !ary1 t1 !h2 !ary2 + | h1 == h2 = + if A.unsafeSameArray ary1 ary2 + then Empty + else let ary = A.filter (\(L k1 _) -> isNothing (indexOf k1 ary2)) ary1 + in case A.length ary of + 0 -> Empty + 1 -> case A.index# ary 0 of + (# l #) -> Leaf h1 l + n | A.length ary1 == n -> t1 + | otherwise -> Collision h1 ary + | otherwise = t1 +{-# INLINABLE differenceCollisions #-} + +-- | \(O(n \log m)\) Difference with a combining function. When two equal keys are +-- encountered, the combining function is applied to the values of these keys. +-- 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 :: Hashable k => (v -> w -> Maybe v) -> HashMap k v -> HashMap k w -> HashMap k v +differenceWith f = differenceWithKey (const f) +{-# INLINE differenceWith #-} + +-- | \(O(n \log m)\) Difference with a combining function. When two equal keys are +-- encountered, the combining function is applied to the values of these keys. +-- 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@. +-- +-- @since 0.2.21 +differenceWithKey :: Eq k => (k -> v -> w -> Maybe v) -> HashMap k v -> HashMap k w -> HashMap k v +differenceWithKey f = go_differenceWithKey 0 + where + go_differenceWithKey !_s Empty _tB = Empty + go_differenceWithKey _s a Empty = a + go_differenceWithKey s a@(Leaf hA (L kA vA)) b + = lookupCont + (\_ -> a) + (\vB _ -> case f kA vA vB of + Nothing -> Empty + Just v | v `ptrEq` vA -> a + | otherwise -> Leaf hA (L kA v)) + hA kA s b + go_differenceWithKey _s a@(Collision hA aryA) (Leaf hB (L kB vB)) + | hA == hB = updateCollision (\vA -> f kB vA vB) hA kB aryA a + | otherwise = a + go_differenceWithKey s a@(BitmapIndexed bA aryA) b@(Leaf hB _) + | bA .&. m == 0 = a + | otherwise = case A.index# aryA i of + (# !stA #) -> case go_differenceWithKey (nextShift s) stA b of + Empty | A.length aryA == 2 + , (# l #) <- A.index# aryA (otherOfOneOrZero i) + , isLeafOrCollision l + -> l + | otherwise + -> BitmapIndexed (bA .&. complement m) (A.delete aryA i) + stA' | isLeafOrCollision stA' && A.length aryA == 1 -> stA' + | stA `ptrEq` stA' -> a + | otherwise -> BitmapIndexed bA (A.update aryA i stA') + where + m = mask hB s + i = sparseIndex bA m + go_differenceWithKey s a@(BitmapIndexed bA aryA) b@(Collision hB _) + | bA .&. m == 0 = a + | otherwise = + case A.index# aryA i of + (# !st #) -> case go_differenceWithKey (nextShift s) st b of + Empty | A.length aryA == 2 + , (# l #) <- A.index# aryA (otherOfOneOrZero i) + , isLeafOrCollision l + -> l + | otherwise + -> BitmapIndexed (bA .&. complement m) (A.delete aryA i) + st' | isLeafOrCollision st' && A.length aryA == 1 -> st' + | st `ptrEq` st' -> a + | otherwise -> BitmapIndexed bA (A.update aryA i st') + where + m = mask hB s + i = sparseIndex bA m + go_differenceWithKey s a@(Full aryA) b@(Leaf hB _) + = case A.index# aryA i of + (# !stA #) -> case go_differenceWithKey (nextShift s) stA b of + Empty -> + let aryA' = A.delete aryA i + bm = fullBitmap .&. complement (1 `unsafeShiftL` i) + in BitmapIndexed bm aryA' + stA' | stA `ptrEq` stA' -> a + | otherwise -> Full (updateFullArray aryA i stA') + where i = index hB s + go_differenceWithKey s a@(Full aryA) b@(Collision hB _) + = case A.index# aryA i of + (# !stA #) -> case go_differenceWithKey (nextShift s) stA b of + Empty -> + let aryA' = A.delete aryA i + bm = fullBitmap .&. complement (1 `unsafeShiftL` i) + in BitmapIndexed bm aryA' + stA' | stA `ptrEq` stA' -> a + | otherwise -> Full (updateFullArray aryA i stA') + where i = index hB s + go_differenceWithKey s a@(Collision hA _) (BitmapIndexed bB aryB) + | bB .&. m == 0 = a + | otherwise = + case A.index# aryB (sparseIndex bB m) of + (# stB #) -> go_differenceWithKey (nextShift s) a stB + where m = mask hA s + go_differenceWithKey s a@(Collision hA _) (Full aryB) + = case A.index# aryB (index hA s) of + (# stB #) -> go_differenceWithKey (nextShift s) a stB + go_differenceWithKey s a@(BitmapIndexed bA aryA) (BitmapIndexed bB aryB) + = differenceWithKey_Arrays s bA aryA a bB aryB + go_differenceWithKey s a@(Full aryA) (BitmapIndexed bB aryB) + = differenceWithKey_Arrays s fullBitmap aryA a bB aryB + go_differenceWithKey s a@(BitmapIndexed bA aryA) (Full aryB) + = differenceWithKey_Arrays s bA aryA a fullBitmap aryB + go_differenceWithKey s a@(Full aryA) (Full aryB) + = differenceWithKey_Arrays s fullBitmap aryA a fullBitmap aryB + go_differenceWithKey _s a@(Collision hA aryA) (Collision hB aryB) + = differenceWithKey_Collisions f hA aryA a hB aryB + + differenceWithKey_Arrays !s !bA !aryA tA !bB !aryB + | bA .&. bB == 0 = tA + | otherwise = runST $ do + mary <- A.new_ $ A.length aryA + + -- TODO: i == popCount bResult. Not sure if that would be faster. + -- Also iA is in some relation with bA' + let go_dWKA !i !iA !bA' !bResult !nChanges + | bA' == 0 = pure (bResult, nChanges) + | otherwise = do + !stA <- A.indexM aryA iA + case m .&. bB of + 0 -> do + A.write mary i stA + go_dWKA (i + 1) (iA + 1) nextBA' (bResult .|. m) nChanges + _ -> do + !stB <- A.indexM aryB (sparseIndex bB m) + case go_differenceWithKey (nextShift s) stA stB of + Empty -> go_dWKA i (iA + 1) nextBA' bResult (nChanges + 1) + st -> do + A.write mary i st + let same = I# (Exts.reallyUnsafePtrEquality# st stA) + let nChanges' = nChanges + (1 - same) + go_dWKA (i + 1) (iA + 1) nextBA' (bResult .|. m) nChanges' + where + m = bA' .&. negate bA' + nextBA' = bA' .&. complement m + + (bResult, nChanges) <- go_dWKA 0 0 bA 0 0 + if nChanges == 0 + then pure tA + else case popCount bResult of + 0 -> pure Empty + 1 -> do + l <- A.read mary 0 + if isLeafOrCollision l + then pure l + else BitmapIndexed bResult <$> (A.unsafeFreeze =<< A.shrink mary 1) + n -> bitmapIndexedOrFull bResult <$> (A.unsafeFreeze =<< A.shrink mary n) +{-# INLINE differenceWithKey #-} + +-- | 'update', specialized to 'Collision' nodes. +updateCollision + :: Eq k + => (v -> Maybe v) + -> Hash + -> k + -> A.Array (Leaf k v) + -> HashMap k v + -- ^ The original Collision node which will be re-used if the array is unchanged. + -> HashMap k v +updateCollision f !h k !ary orig = + lookupInArrayCont + (\_ -> orig) + (\v i -> case f v of + Nothing | A.length ary == 2 + , (# l #) <- A.index# ary (otherOfOneOrZero i) + -> Leaf h l + | otherwise -> Collision h (A.delete ary i) + Just v' | v' `ptrEq` v -> orig + | otherwise -> Collision h (A.update ary i (L k v'))) + k ary +{-# INLINABLE updateCollision #-} + +-- TODO: This could be faster if we would keep track of which elements of ary2 +-- we've already matched. Those could be skipped when we check the following +-- elements of ary1. +-- TODO: Return tA when the array is unchanged. +differenceWithKey_Collisions :: Eq k => (k -> v -> w -> Maybe v) -> Word -> A.Array (Leaf k v) -> HashMap k v -> Word -> A.Array (Leaf k w) -> HashMap k v +differenceWithKey_Collisions f !hA !aryA !tA !hB !aryB + | hA == hB = + let f' l@(L kA vA) = + lookupInArrayCont + (\_ -> Just l) + (\vB _ -> L kA <$> f kA vA vB) + kA aryB + ary = A.mapMaybe f' aryA + in case A.length ary of + 0 -> Empty + 1 -> case A.index# ary 0 of + (# l #) -> Leaf hA l + _ -> Collision hA ary + | otherwise = tA +{-# INLINABLE differenceWithKey_Collisions #-} + +-- | \(O(n \log m)\) Intersection of two maps. Return elements of the first +-- map for keys existing in the second. +intersection :: Eq k => HashMap k v -> HashMap k w -> HashMap k v +intersection = Exts.inline intersectionWith const +{-# INLINABLE intersection #-} + +-- | \(O(n \log m)\) Intersection of two maps. If a key occurs in both maps +-- the provided function is used to combine the values from the two +-- maps. +intersectionWith :: Eq k => (v1 -> v2 -> v3) -> HashMap k v1 -> HashMap k v2 -> HashMap k v3 +intersectionWith f = Exts.inline intersectionWithKey $ const f +{-# INLINABLE intersectionWith #-} + +-- | \(O(n \log m)\) Intersection of two maps. If a key occurs in both maps +-- the provided function is used to combine the values from the two +-- maps. +intersectionWithKey :: Eq k => (k -> v1 -> v2 -> v3) -> HashMap k v1 -> HashMap k v2 -> HashMap k v3 +intersectionWithKey f = intersectionWithKey# $ \k v1 v2 -> (# f k v1 v2 #) +{-# INLINABLE intersectionWithKey #-} + +intersectionWithKey# :: Eq k => (k -> v1 -> v2 -> (# v3 #)) -> HashMap k v1 -> HashMap k v2 -> HashMap k v3 +intersectionWithKey# f = go 0 + where + -- empty vs. anything + go !_ _ Empty = Empty + go _ Empty _ = Empty + -- leaf vs. anything + go s (Leaf h1 (L k1 v1)) t2 = + lookupCont + (\_ -> Empty) + (\v _ -> case f k1 v1 v of (# v' #) -> Leaf h1 $ L k1 v') + h1 k1 s t2 + go s t1 (Leaf h2 (L k2 v2)) = + lookupCont + (\_ -> Empty) + (\v _ -> case f k2 v v2 of (# v' #) -> Leaf h2 $ L k2 v') + h2 k2 s t1 + -- collision vs. collision + go _ (Collision h1 ls1) (Collision h2 ls2) = intersectionCollisions f h1 h2 ls1 ls2 + -- branch vs. branch + go s (BitmapIndexed b1 ary1) (BitmapIndexed b2 ary2) = + intersectionArrayBy (go (nextShift s)) b1 b2 ary1 ary2 + go s (BitmapIndexed b1 ary1) (Full ary2) = + intersectionArrayBy (go (nextShift s)) b1 fullBitmap ary1 ary2 + go s (Full ary1) (BitmapIndexed b2 ary2) = + intersectionArrayBy (go (nextShift s)) fullBitmap b2 ary1 ary2 + go s (Full ary1) (Full ary2) = + intersectionArrayBy (go (nextShift s)) fullBitmap fullBitmap ary1 ary2 + -- collision vs. branch + go s (BitmapIndexed b1 ary1) t2@(Collision h2 _ls2) + | b1 .&. m2 == 0 = Empty + | otherwise = + case A.index# ary1 i of + (# st1 #) -> go (nextShift s) st1 t2 + where + m2 = mask h2 s + i = sparseIndex b1 m2 + go s t1@(Collision h1 _ls1) (BitmapIndexed b2 ary2) + | b2 .&. m1 == 0 = Empty + | otherwise = + case A.index# ary2 i of + (# st2 #) -> go (nextShift s) t1 st2 + where + m1 = mask h1 s + i = sparseIndex b2 m1 + go s (Full ary1) t2@(Collision h2 _ls2) = + case A.index# ary1 i of + (# st1 #)-> go (nextShift s) st1 t2 + where + i = index h2 s + go s t1@(Collision h1 _ls1) (Full ary2) = + case A.index# ary2 i of + (# st2 #) -> go (nextShift s) t1 st2 + where + i = index h1 s +{-# INLINE intersectionWithKey# #-} + +intersectionArrayBy :: + ( HashMap k v1 -> + HashMap k v2 -> + HashMap k v3 + ) -> + Bitmap -> + Bitmap -> + A.Array (HashMap k v1) -> + A.Array (HashMap k v2) -> + HashMap k v3 +intersectionArrayBy f !b1 !b2 !ary1 !ary2 + | b1 .&. b2 == 0 = Empty + | otherwise = runST $ do + mary <- A.new_ $ popCount bIntersect + -- iterate over nonzero bits of b1 .|. b2 + let go !i !i1 !i2 !b !bFinal + | b == 0 = pure (i, bFinal) + | testBit $ b1 .&. b2 = do + x1 <- A.indexM ary1 i1 + x2 <- A.indexM ary2 i2 + case f x1 x2 of + Empty -> go i (i1 + 1) (i2 + 1) b' (bFinal .&. complement m) + _ -> do + A.write mary i $! f x1 x2 + go (i + 1) (i1 + 1) (i2 + 1) b' bFinal + | testBit b1 = go i (i1 + 1) i2 b' bFinal + | otherwise = go i i1 (i2 + 1) b' bFinal + where + m = 1 `unsafeShiftL` countTrailingZeros b + testBit x = x .&. m /= 0 + b' = b .&. complement m + (len, bFinal) <- go 0 0 0 bCombined bIntersect + case len of + 0 -> pure Empty + 1 -> do + l <- A.read mary 0 + if isLeafOrCollision l + then pure l + else BitmapIndexed bFinal <$> (A.unsafeFreeze =<< A.shrink mary 1) + _ -> bitmapIndexedOrFull bFinal <$> (A.unsafeFreeze =<< A.shrink mary len) + where + bCombined = b1 .|. b2 + bIntersect = b1 .&. b2 +{-# INLINE intersectionArrayBy #-} + +intersectionCollisions :: Eq k => (k -> v1 -> v2 -> (# v3 #)) -> Hash -> Hash -> A.Array (Leaf k v1) -> A.Array (Leaf k v2) -> HashMap k v3 +intersectionCollisions f h1 h2 ary1 ary2 + | h1 == h2 = runST $ do + let !n2 = A.length ary2 + mary2 <- A.thaw ary2 0 n2 + mary <- A.new_ $ min (A.length ary1) n2 + let go i j + | i >= A.length ary1 || j >= n2 = pure j + | otherwise = do + L k1 v1 <- A.indexM ary1 i + searchSwap mary2 n2 k1 j >>= \case + Just (L _k2 v2) -> do + let !(# v3 #) = f k1 v1 v2 + A.write mary j $ L k1 v3 + go (i + 1) (j + 1) + Nothing -> do + go (i + 1) j + len <- go 0 0 + case len of + 0 -> pure Empty + 1 -> Leaf h1 <$> A.read mary 0 + _ -> Collision h1 <$> (A.unsafeFreeze =<< A.shrink mary len) + | otherwise = Empty +{-# INLINE intersectionCollisions #-} + +-- | Say we have +-- @ +-- 1 2 3 4 +-- @ +-- and we search for @3@. Then we can mutate the array to +-- @ +-- undefined 2 1 4 +-- @ +-- We don't actually need to write undefined, we just have to make sure that the next search starts 1 after the current one. +searchSwap :: Eq k => A.MArray s (Leaf k v) -> Int -> k -> Int -> ST s (Maybe (Leaf k v)) +searchSwap mary n toFind start = go start toFind start + where + go i0 k i + | i >= n = pure Nothing + | otherwise = do + l@(L k' _v) <- A.read mary i + if k == k' + then do + A.write mary i =<< A.read mary i0 + pure $ Just l + else go i0 k (i + 1) +{-# INLINE searchSwap #-} + +-- | \(O(n \log m)\) Check whether the key sets of two maps are disjoint +-- (i.e., their 'intersection' is empty). +-- +-- @ +-- xs ``disjoint`` ys = null (xs ``intersection`` ys) +-- @ +-- +-- @since 0.2.21 +disjoint :: Eq k => HashMap k a -> HashMap k b -> Bool +disjoint = disjointSubtrees 0 +{-# INLINE disjoint #-} + +-- Note that as of GHC 9.12, SpecConstr creates a specialized worker for +-- handling the Collision vs. {BitmapIndexed,Full} and vice-versa cases, +-- but this worker fails to be properly specialized for different key +-- types. See https://gitlab.haskell.org/ghc/ghc/-/issues/26615. +disjointSubtrees :: Eq k => Shift -> HashMap k a -> HashMap k b -> Bool +disjointSubtrees !_s Empty _b = True +disjointSubtrees s (Leaf hA (L kA _)) b = + lookupCont (\_ -> True) (\_ _ -> False) hA kA s b +disjointSubtrees s (BitmapIndexed bmA aryA) (BitmapIndexed bmB aryB) = + -- We could do a pointer equality check here but it's probably not worth it + -- since it would save only O(1) extra work: + -- + -- not (aryA `A.unsafeSameArray` aryB) && + disjointArrays s bmA aryA bmB aryB +disjointSubtrees s (BitmapIndexed bmA aryA) (Full aryB) = + disjointArrays s bmA aryA fullBitmap aryB +disjointSubtrees s (Full aryA) (BitmapIndexed bmB aryB) = + disjointArrays s fullBitmap aryA bmB aryB +disjointSubtrees s (Full aryA) (Full aryB) = + -- We could do a pointer equality check here but it's probably not worth it + -- since it would save only O(1) extra work: + -- + -- not (aryA `A.unsafeSameArray` aryB) && + go (maxChildren - 1) + where + go i + | i < 0 = True + | otherwise = case A.index# aryA i of + (# stA #) -> case A.index# aryB i of + (# stB #) -> + disjointSubtrees (nextShift s) stA stB && + go (i - 1) +disjointSubtrees s a@(Collision hA _) (BitmapIndexed bmB aryB) + | m .&. bmB == 0 = True + | otherwise = case A.index# aryB i of + (# stB #) -> disjointSubtrees (nextShift s) a stB + where + m = mask hA s + i = sparseIndex bmB m +disjointSubtrees s a@(Collision hA _) (Full aryB) = + case A.index# aryB (index hA s) of + (# stB #) -> disjointSubtrees (nextShift s) a stB +disjointSubtrees _ (Collision hA aryA) (Collision hB aryB) = + disjointCollisions hA aryA hB aryB +disjointSubtrees _s _a Empty = True +disjointSubtrees s a (Leaf hB (L kB _)) = + lookupCont (\_ -> True) (\_ _ -> False) hB kB s a +disjointSubtrees s a b@Collision{} = disjointSubtrees s b a +{-# INLINABLE disjointSubtrees #-} + +disjointArrays :: Eq k => Shift -> Bitmap -> A.Array (HashMap k a) -> Bitmap -> A.Array (HashMap k b) -> Bool +disjointArrays !s !bmA !aryA !bmB !aryB = go (bmA .&. bmB) + where + go 0 = True + go bm = case A.index# aryA iA of + (# stA #) -> case A.index# aryB iB of + (# stB #) -> + disjointSubtrees (nextShift s) stA stB && + go (bm .&. complement m) + where + m = bm .&. negate bm + iA = sparseIndex bmA m + iB = sparseIndex bmB m +{-# INLINE disjointArrays #-} + +-- TODO: GHC 9.12.2 inlines disjointCollisions into `disjoint @Int`. +-- How do you prevent this while preserving specialization? +-- https://stackoverflow.com/questions/79838305/ensuring-specialization-while-preventing-inlining +disjointCollisions :: Eq k => Hash -> A.Array (Leaf k a) -> Hash -> A.Array (Leaf k b) -> Bool +disjointCollisions !hA !aryA !hB !aryB + | hA == hB = A.all predicate aryA + | otherwise = True + where + predicate (L kA _) = lookupInArrayCont (\_ -> True) (\_ _ -> False) kA aryB +{-# INLINABLE disjointCollisions #-} + +------------------------------------------------------------------------ +-- * Folds + +-- | \(O(n)\) Reduce this map by applying a binary operator to all +-- elements, using the given starting value (typically the +-- left-identity of the operator). Each application of the operator +-- is evaluated before using the result in the next application. +-- This function is strict in the starting value. +foldl' :: (a -> v -> a) -> a -> HashMap k v -> a +foldl' f = foldlWithKey' (\ z _ v -> f z v) +{-# INLINE foldl' #-} + +-- | \(O(n)\) Reduce this map by applying a binary operator to all +-- elements, using the given starting value (typically the +-- right-identity of the operator). Each application of the operator +-- is evaluated before using the result in the next application. +-- This function is strict in the starting value. +foldr' :: (v -> a -> a) -> a -> HashMap k v -> a +foldr' f = foldrWithKey' (\ _ v z -> f v z) +{-# INLINE foldr' #-} + +-- | \(O(n)\) Reduce this map by applying a binary operator to all +-- elements, using the given starting value (typically the +-- left-identity of the operator). Each application of the operator +-- is evaluated before using the result in the next application. +-- This function is strict in the starting value. +foldlWithKey' :: (a -> k -> v -> a) -> a -> HashMap k v -> a +foldlWithKey' f = go + where + go !z Empty = z + go z (Leaf _ (L k v)) = f z k v + go z (BitmapIndexed _ ary) = A.foldl' go z ary + go z (Full ary) = A.foldl' go z ary + go z (Collision _ ary) = A.foldl' (\ z' (L k v) -> f z' k v) z ary +{-# INLINE foldlWithKey' #-} + +-- | \(O(n)\) Reduce this map by applying a binary operator to all +-- elements, using the given starting value (typically the +-- right-identity of the operator). Each application of the operator +-- is evaluated before using the result in the next application. +-- This function is strict in the starting value. +foldrWithKey' :: (k -> v -> a -> a) -> a -> HashMap k v -> a +foldrWithKey' f = flip go + where + go Empty z = z + go (Leaf _ (L k v)) !z = f k v z + go (BitmapIndexed _ ary) !z = A.foldr' go z ary + go (Full ary) !z = A.foldr' go z ary + go (Collision _ ary) !z = A.foldr' (\ (L k v) z' -> f k v z') z ary +{-# INLINE foldrWithKey' #-} + +-- | \(O(n)\) Reduce this map by applying a binary operator to all +-- elements, using the given starting value (typically the +-- right-identity of the operator). +foldr :: (v -> a -> a) -> a -> HashMap k v -> a +foldr f = foldrWithKey (const f) +{-# INLINE foldr #-} + +-- | \(O(n)\) Reduce this map by applying a binary operator to all +-- elements, using the given starting value (typically the +-- left-identity of the operator). +foldl :: (a -> v -> a) -> a -> HashMap k v -> a +foldl f = foldlWithKey (\a _k v -> f a v) +{-# INLINE foldl #-} + +-- | \(O(n)\) Reduce this map by applying a binary operator to all +-- elements, using the given starting value (typically the +-- right-identity of the operator). +foldrWithKey :: (k -> v -> a -> a) -> a -> HashMap k v -> a +foldrWithKey f = flip go + where + go Empty z = z + go (Leaf _ (L k v)) z = f k v z + go (BitmapIndexed _ ary) z = A.foldr go z ary + go (Full ary) z = A.foldr go z ary + go (Collision _ ary) z = A.foldr (\ (L k v) z' -> f k v z') z ary +{-# INLINE foldrWithKey #-} + +-- | \(O(n)\) Reduce this map by applying a binary operator to all +-- elements, using the given starting value (typically the +-- left-identity of the operator). +foldlWithKey :: (a -> k -> v -> a) -> a -> HashMap k v -> a +foldlWithKey f = go + where + go z Empty = z + go z (Leaf _ (L k v)) = f z k v + go z (BitmapIndexed _ ary) = A.foldl go z ary + go z (Full ary) = A.foldl go z ary + go z (Collision _ ary) = A.foldl (\ z' (L k v) -> f z' k v) z ary +{-# INLINE foldlWithKey #-} + +-- | \(O(n)\) Reduce the map by applying a function to each element +-- and combining the results with a monoid operation. +foldMapWithKey :: Monoid m => (k -> v -> m) -> HashMap k v -> m +foldMapWithKey f = go + where + go Empty = mempty + go (Leaf _ (L k v)) = f k v + go (BitmapIndexed _ ary) = A.foldMap go ary + go (Full ary) = A.foldMap go ary + go (Collision _ ary) = A.foldMap (\ (L k v) -> f k v) ary +{-# INLINE foldMapWithKey #-} + +------------------------------------------------------------------------ +-- * Filter + +-- | \(O(n)\) Transform this map by applying a function to every value +-- and retaining only some of them. +mapMaybeWithKey :: (k -> v1 -> Maybe v2) -> HashMap k v1 -> HashMap k v2 +mapMaybeWithKey f = filterMapAux onLeaf onColl + where onLeaf (Leaf h (L k v)) | Just v' <- f k v = Just (Leaf h (L k v')) + onLeaf _ = Nothing + + onColl (L k v) | Just v' <- f k v = Just (L k v') + | otherwise = Nothing +{-# INLINE mapMaybeWithKey #-} + +-- | \(O(n)\) Transform this map by applying a function to every value +-- and retaining only some of them. +mapMaybe :: (v1 -> Maybe v2) -> HashMap k v1 -> HashMap k v2 +mapMaybe f = mapMaybeWithKey (const f) +{-# INLINE mapMaybe #-} + +-- | \(O(n)\) Filter this map by retaining only elements satisfying a +-- predicate. +filterWithKey :: forall k v. (k -> v -> Bool) -> HashMap k v -> HashMap k v +filterWithKey pred = filterMapAux onLeaf onColl + where onLeaf t@(Leaf _ (L k v)) | pred k v = Just t + onLeaf _ = Nothing + + onColl el@(L k v) | pred k v = Just el + onColl _ = Nothing +{-# INLINE filterWithKey #-} + + +-- | Common implementation for 'filterWithKey' and 'mapMaybeWithKey', +-- allowing the former to former to reuse terms. +filterMapAux :: forall k v1 v2 + . (HashMap k v1 -> Maybe (HashMap k v2)) + -> (Leaf k v1 -> Maybe (Leaf k v2)) + -> HashMap k v1 + -> HashMap k v2 +filterMapAux onLeaf onColl = go + where + go Empty = Empty + go t@Leaf{} + | Just t' <- onLeaf t = t' + | otherwise = Empty + go (BitmapIndexed b ary) = filterA ary b + go (Full ary) = filterA ary fullBitmap + go (Collision h ary) = filterC ary h + + filterA ary0 b0 = + let !n = A.length ary0 + in runST $ do + mary <- A.new_ n + step ary0 mary b0 0 0 1 n + where + step :: A.Array (HashMap k v1) -> A.MArray s (HashMap k v2) + -> Bitmap -> Int -> Int -> Bitmap -> Int + -> ST s (HashMap k v2) + step !ary !mary !b i !j !bi n + | i >= n = case j of + 0 -> return Empty + 1 -> do + ch <- A.read mary 0 + case ch of + t | isLeafOrCollision t -> return t + _ -> BitmapIndexed b <$> (A.unsafeFreeze =<< A.shrink mary 1) + _ -> do + ary2 <- A.unsafeFreeze =<< A.shrink mary j + return $! if j == maxChildren + then Full ary2 + else BitmapIndexed b ary2 + | bi .&. b == 0 = step ary mary b i j (bi `unsafeShiftL` 1) n + | otherwise = do + st <- A.indexM ary i + case go st of + Empty -> + step ary mary (b .&. complement bi) (i+1) j (bi `unsafeShiftL` 1) n + t -> do + A.write mary j t + step ary mary b (i+1) (j+1) (bi `unsafeShiftL` 1) n + + filterC ary0 h = + let !n = A.length ary0 + in runST $ do + mary <- A.new_ n + step ary0 mary 0 0 n + where + step :: A.Array (Leaf k v1) -> A.MArray s (Leaf k v2) + -> Int -> Int -> Int + -> ST s (HashMap k v2) + step !ary !mary i !j n + | i >= n = case j of + 0 -> return Empty + 1 -> do l <- A.read mary 0 + return $! Leaf h l + _ | i == j -> do ary2 <- A.unsafeFreeze mary + return $! Collision h ary2 + | otherwise -> do ary2 <- A.unsafeFreeze =<< A.shrink mary j + return $! Collision h ary2 + | (# l #) <- A.index# ary i + , Just el <- onColl l + = A.write mary j el >> step ary mary (i+1) (j+1) n + | otherwise = step ary mary (i+1) j n +{-# INLINE filterMapAux #-} + +-- | \(O(n)\) Filter this map by retaining only elements which values +-- satisfy a predicate. +filter :: (v -> Bool) -> HashMap k v -> HashMap k v +filter p = filterWithKey (\_ v -> p v) +{-# INLINE filter #-} + +------------------------------------------------------------------------ +-- * Conversions + +-- TODO: Improve fusion rules by modelled them after the Prelude ones +-- on lists. + +-- | \(O(n)\) Return a list of this map's keys. The list is produced +-- lazily. +keys :: HashMap k v -> [k] +keys = List.map fst . toList +{-# INLINE keys #-} + +-- | \(O(n)\) Return a list of this map's values. The list is produced +-- lazily. +elems :: HashMap k v -> [v] +elems = List.map snd . toList +{-# INLINE elems #-} + +------------------------------------------------------------------------ +-- ** Lists + +-- | \(O(n)\) Return a list of this map's elements. The list is +-- produced lazily. The order of its elements is unspecified, and it may +-- change from version to version of either this package or of @hashable@. +toList :: HashMap k v -> [(k, v)] +toList t = Exts.build (\ c z -> foldrWithKey (curry c) z t) +{-# INLINE toList #-} + +-- | \(O(n \log n)\) Construct a map with the supplied mappings. If the list +-- contains duplicate mappings, the later mappings take precedence. +fromList :: Hashable k => [(k, v)] -> HashMap k v +fromList = List.foldl' (\ m (k, v) -> unsafeInsert k v m) empty +{-# INLINABLE fromList #-} + +-- | \(O(n \log n)\) Construct a map from a list of elements. Uses +-- the provided function @f@ to merge duplicate entries with +-- @(f newVal oldVal)@. +-- +-- === Examples +-- +-- Given a list @xs@, create a map with the number of occurrences of each +-- element in @xs@: +-- +-- > let xs = ['a', 'b', 'a'] +-- > in fromListWith (+) [ (x, 1) | x <- xs ] +-- > +-- > = fromList [('a', 2), ('b', 1)] +-- +-- Given a list of key-value pairs @xs :: [(k, v)]@, group all values by their +-- keys and return a @HashMap k [v]@. +-- +-- > let xs = [('a', 1), ('b', 2), ('a', 3)] +-- > in fromListWith (++) [ (k, [v]) | (k, v) <- xs ] +-- > +-- > = fromList [('a', [3, 1]), ('b', [2])] +-- +-- Note that the lists in the resulting map contain elements in reverse order +-- from their occurrences in the original list. +-- +-- More generally, duplicate entries are accumulated as follows; +-- this matters when @f@ is not commutative or not associative. +-- +-- > fromListWith f [(k, a), (k, b), (k, c), (k, d)] +-- > = fromList [(k, f d (f c (f b a)))] +fromListWith :: Hashable k => (v -> v -> v) -> [(k, v)] -> HashMap k v +fromListWith f = List.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 +-- the provided function to merge duplicate entries. +-- +-- === Examples +-- +-- Given a list of key-value pairs where the keys are of different flavours, e.g: +-- +-- > data Key = Div | Sub +-- +-- and the values need to be combined differently when there are duplicates, +-- depending on the key: +-- +-- > combine Div = div +-- > combine Sub = (-) +-- +-- then @fromListWithKey@ can be used as follows: +-- +-- > fromListWithKey combine [(Div, 2), (Div, 6), (Sub, 2), (Sub, 3)] +-- > = fromList [(Div, 3), (Sub, 1)] +-- +-- More generally, duplicate entries are accumulated as follows; +-- +-- > fromListWith f [(k, a), (k, b), (k, c), (k, d)] +-- > = fromList [(k, f k d (f k c (f k b a)))] +-- +-- @since 0.2.11 +fromListWithKey :: Hashable k => (k -> v -> v -> v) -> [(k, v)] -> HashMap k v +fromListWithKey f = List.foldl' (\ m (k, v) -> unsafeInsertWithKey (\k' a b -> (# f k' a b #)) k v m) empty +{-# INLINE fromListWithKey #-} + +------------------------------------------------------------------------ +-- Array operations + +-- | \(O(n)\) Look up the value associated with the given key in an +-- array. +lookupInArrayCont :: +#if defined(__GLASGOW_HASKELL__) + forall rep (r :: TYPE rep) k v. +#else + forall r k v. +#endif + Eq k => ((# #) -> r) -> (v -> Int -> r) -> k -> A.Array (Leaf k v) -> r +lookupInArrayCont absent present k0 ary0 = + lookupInArrayCont_ k0 ary0 0 (A.length ary0) + where + lookupInArrayCont_ :: Eq k => k -> A.Array (Leaf k v) -> Int -> Int -> r + lookupInArrayCont_ !k !ary !i !n + | i >= n = absent (# #) + | otherwise = case A.index# ary i of + (# L kx v #) + | k == kx -> present v i + | otherwise -> lookupInArrayCont_ k ary (i+1) n +{-# INLINE lookupInArrayCont #-} + +-- | \(O(n)\) Lookup the value associated with the given key in this +-- array. Returns 'Nothing' if the key wasn't found. +indexOf :: Eq k => k -> A.Array (Leaf k v) -> Maybe Int +indexOf k0 ary0 = go k0 ary0 0 (A.length ary0) + where + go !k !ary !i !n + | i >= n = Nothing + | otherwise = case A.index# ary i of + (# L kx _ #) + | k == kx -> Just i + | otherwise -> go k ary (i+1) n +{-# INLINABLE indexOf #-} + +updateWith# :: Eq k => (v -> (# v #)) -> k -> A.Array (Leaf k v) -> A.Array (Leaf k v) +updateWith# f k0 ary0 = go k0 ary0 0 (A.length ary0) + where + go !k !ary !i !n + | i >= n = ary + | otherwise = case A.index# ary i of + (# L kx y #) | k == kx -> case f y of + (# y' #) + | ptrEq y y' -> ary + | otherwise -> A.update ary i (L k y') + | otherwise -> go k ary (i+1) n +{-# INLINABLE updateWith# #-} + +updateOrSnocWith :: Eq k => (v -> v -> (# v #)) -> k -> v -> A.Array (Leaf k v) + -> A.Array (Leaf k v) +updateOrSnocWith f = updateOrSnocWithKey (const f) +{-# INLINABLE updateOrSnocWith #-} + +updateOrSnocWithKey :: Eq k => (k -> v -> v -> (# v #)) -> k -> v -> A.Array (Leaf k v) + -> A.Array (Leaf k v) +updateOrSnocWithKey f k0 v0 ary0 = go k0 v0 ary0 0 (A.length ary0) + where + go !k v !ary !i !n + -- Not found, append to the end. + | i >= n = A.snoc ary $ L k v + | otherwise + = case A.index# ary i of + (# L kx y #) | k == kx -> case f k v y of + (# v2 #) -> A.update ary i (L k v2) + | otherwise -> go k v ary (i+1) n +{-# INLINABLE updateOrSnocWithKey #-} + +updateOrConcatWithKey :: Eq k => (k -> v -> v -> (# v #)) -> A.Array (Leaf k v) -> A.Array (Leaf k v) -> A.Array (Leaf k v) +updateOrConcatWithKey f ary1 ary2 = A.run $ do + -- TODO: instead of mapping and then folding, should we traverse? + -- We'll have to be careful to avoid allocating pairs or similar. + + -- first: look up the position of each element of ary2 in ary1 + let indices = A.map' (\(L k _) -> indexOf k ary1) ary2 + -- that tells us how large the overlap is: + -- count number of Nothing constructors + let nOnly2 = A.foldl' (\n -> maybe (n+1) (const n)) 0 indices + let n1 = A.length ary1 + let n2 = A.length ary2 + -- copy over all elements from ary1 + mary <- A.new_ (n1 + nOnly2) + A.copy ary1 0 mary 0 n1 + -- append or update all elements from ary2 + let go !iEnd !i2 + | i2 >= n2 = return () + | (# Just i1 #) <- A.index# indices i2 = do + -- key occurs in both arrays, store combination in position i1 + L k v1 <- A.indexM ary1 i1 + L _ v2 <- A.indexM ary2 i2 + case f k v1 v2 of (# v3 #) -> A.write mary i1 (L k v3) + go iEnd (i2+1) + | otherwise = do + -- key is only in ary2, append to end + A.write mary iEnd =<< A.indexM ary2 i2 + go (iEnd+1) (i2+1) + go n1 0 + return mary +{-# INLINABLE updateOrConcatWithKey #-} + +-- | \(O(n*m)\) Check if the first array is a subset of the second array. +subsetArray :: Eq k => (v1 -> v2 -> Bool) -> A.Array (Leaf k v1) -> A.Array (Leaf k v2) -> Bool +subsetArray cmpV ary1 ary2 = A.length ary1 <= A.length ary2 && A.all inAry2 ary1 + where + inAry2 (L k1 v1) = lookupInArrayCont (\_ -> False) (\v2 _ -> cmpV v1 v2) k1 ary2 + {-# INLINE inAry2 #-} + +------------------------------------------------------------------------ +-- Manually unrolled loops + +-- | \(O(n)\) Update the element at the given position in this array. +updateFullArray :: A.Array e -> Int -> e -> A.Array e +updateFullArray ary idx b = runST (updateFullArrayM ary idx b) +{-# INLINE updateFullArray #-} + +-- | \(O(n)\) Update the element at the given position in this array. +updateFullArrayM :: A.Array e -> Int -> e -> ST s (A.Array e) +updateFullArrayM ary idx b = do + mary <- clone ary + A.write mary idx b + A.unsafeFreeze mary +{-# INLINE updateFullArrayM #-} + +-- | \(O(n)\) Update the element at the given position in this array, by applying a function to it. +updateFullArrayWith' :: A.Array e -> Int -> (e -> e) -> A.Array e +updateFullArrayWith' ary idx f = + case A.index# ary idx of + (# x #) -> updateFullArray ary idx $! f x +{-# INLINE updateFullArrayWith' #-} + +-- | Unsafely clone an array of (2^bitsPerSubkey) elements. The length of the input +-- array is not checked. +clone :: A.Array e -> ST s (A.MArray s e) +clone ary = + A.thaw ary 0 (2^bitsPerSubkey) + +------------------------------------------------------------------------ +-- Bit twiddling + +-- TODO: Name this 'bitsPerLevel'?! What is a "subkey"? +-- https://github.com/haskell-unordered-containers/unordered-containers/issues/425 + +-- | Number of bits that are inspected at each level of the hash tree. +-- +-- This constant is named /t/ in the original /Ideal Hash Trees/ paper. +-- +-- Note that this constant is platform-dependent. On 32-bit platforms we use +-- '4', because bitmaps using '2^5' bits turned out to be prone to integer +-- overflow bugs. See #491 for instance. +bitsPerSubkey :: Int +#if WORD_SIZE_IN_BITS < 64 +bitsPerSubkey = 4 +#else +bitsPerSubkey = 5 +#endif + +-- | The size of a 'Full' node, i.e. @2 ^ 'bitsPerSubkey'@. +maxChildren :: Int +maxChildren = 1 `unsafeShiftL` bitsPerSubkey + +-- | Bit mask with the lowest 'bitsPerSubkey' bits set, i.e. @0b11111@. +subkeyMask :: Word +subkeyMask = 1 `unsafeShiftL` bitsPerSubkey - 1 + +-- | Given a 'Hash' and a 'Shift' that indicates the level in the tree, compute +-- the index into a 'Full' node or into the bitmap of a `BitmapIndexed` node. +-- +-- >>> index 0b0010_0010 0 +-- 0b0000_0010 +index :: Hash -> Shift -> Int +index w s = fromIntegral $ unsafeShiftR w s .&. subkeyMask +{-# INLINE index #-} + +-- | Given a 'Hash' and a 'Shift' that indicates the level in the tree, compute +-- the bitmap that contains only the 'index' of the hash at this level. +-- +-- The result can be used for constructing one-element 'BitmapIndexed' nodes or +-- to check whether a 'BitmapIndexed' node may possibly contain the given 'Hash'. +-- +-- >>> mask 0b0010_0010 0 +-- 0b0100 +mask :: Hash -> Shift -> Bitmap +mask w s = 1 `unsafeShiftL` index w s +{-# INLINE mask #-} + +-- | This array index is computed by counting the number of 1-bits below the +-- 'index' represented by the mask. +-- +-- >>> sparseIndex 0b0110_0110 0b0010_0000 +-- 2 +sparseIndex + :: Bitmap + -- ^ Bitmap of a 'BitmapIndexed' node + -> Bitmap + -- ^ One-bit 'mask' corresponding to the 'index' of a hash + -> Int + -- ^ Index into the array of the 'BitmapIndexed' node +sparseIndex b m = popCount (b .&. (m - 1)) +{-# INLINE sparseIndex #-} + +-- | A bitmap with the 'maxChildren' least significant bits set, i.e. +-- @0xFF_FF_FF_FF@. +fullBitmap :: Bitmap +-- This needs to use 'shiftL' instead of 'unsafeShiftL', to avoid UB. +-- See issue #412. +fullBitmap = complement (complement 0 `shiftL` maxChildren) +{-# INLINE fullBitmap #-} + +-- | Increment a 'Shift' for use at the next deeper level. +nextShift :: Shift -> Shift +nextShift s = s + bitsPerSubkey +{-# INLINE nextShift #-} + +------------------------------------------------------------------------ +-- ShiftedHash + +-- | Sometimes it's more efficient to right-shift the hashes directly instead +-- of keeping track of an additional 'Shift' value. +type ShiftedHash = Hash + +{- +-- | Construct a 'ShiftedHash' from a 'Shift' and a 'Hash'. +shiftHash :: Shift -> Hash -> ShiftedHash +shiftHash s h = h `unsafeShiftR` s +{-# INLINE shiftHash #-} +-} + +-- | Update a 'ShiftedHash' for the next level of the tree. +nextSH :: ShiftedHash -> ShiftedHash +nextSH sh = sh `unsafeShiftR` bitsPerSubkey +{-# INLINE nextSH #-} + +-- | Version of 'index' for use with @'ShiftedHash'es@. +indexSH :: ShiftedHash -> Int +indexSH sh = fromIntegral $ sh .&. subkeyMask +{-# INLINE indexSH #-} + +-- | Version of 'mask' for use with @'ShiftedHash'es@. +maskSH :: ShiftedHash -> Bitmap +maskSH sh = 1 `unsafeShiftL` indexSH sh +{-# INLINE maskSH #-} + +------------------------------------------------------------------------ +-- Pointer equality + +-- | Check if two the two arguments are the same value. N.B. This +-- function might give false negatives (due to GC moving objects.) +ptrEq :: a -> a -> Bool +ptrEq x y = Exts.isTrue# (Exts.reallyUnsafePtrEquality# x y ==# 1#) +{-# INLINE ptrEq #-} + +------------------------------------------------------------------------ +-- Array index arithmetic + +-- | +-- >>> otherOfOneOrZero 0 +-- 1 +-- >>> otherOfOneOrZero 1 +-- 0 +otherOfOneOrZero :: Int -> Int +otherOfOneOrZero i = 1 - i +{-# INLINE otherOfOneOrZero #-} + +#if defined(__GLASGOW_HASKELL__) +------------------------------------------------------------------------ +-- IsList instance +instance Hashable k => Exts.IsList (HashMap k v) where + type Item (HashMap k v) = (k, v) + fromList = fromList + toList = toList +#endif diff --git a/Data/HashMap/Internal/Array.hs b/Data/HashMap/Internal/Array.hs --- a/Data/HashMap/Internal/Array.hs +++ b/Data/HashMap/Internal/Array.hs @@ -42,7 +42,6 @@ , lengthM , read , write - , index , indexM , index# , update @@ -72,6 +71,8 @@ , thaw , map , map' + , filter + , mapMaybe , traverse , traverse' , toList @@ -80,26 +81,28 @@ , shrink ) where -import Control.Applicative (liftA2) +import Control.Applicative (Applicative (..)) import Control.DeepSeq (NFData (..), NFData1 (..)) import Control.Monad ((>=>)) import Control.Monad.ST (runST, stToIO) import GHC.Exts (Int (..), SmallArray#, SmallMutableArray#, cloneSmallMutableArray#, copySmallArray#, - copySmallMutableArray#, indexSmallArray#, - newSmallArray#, readSmallArray#, + copySmallMutableArray#, getSizeofSmallMutableArray#, + indexSmallArray#, newSmallArray#, readSmallArray#, reallyUnsafePtrEquality#, sizeofSmallArray#, - sizeofSmallMutableArray#, tagToEnum#, - thawSmallArray#, unsafeCoerce#, + tagToEnum#, thawSmallArray#, unsafeCoerce#, unsafeFreezeSmallArray#, unsafeThawSmallArray#, writeSmallArray#) import GHC.ST (ST (..)) -import Prelude hiding (Foldable(..), all, filter, +import Prelude hiding (Applicative (..), Foldable (..), all, filter, map, read, traverse) import qualified GHC.Exts as Exts import qualified Language.Haskell.TH.Syntax as TH + #if defined(ASSERTS) +import GHC.Exts (sizeofSmallMutableArray#) + import qualified Prelude #endif @@ -111,12 +114,14 @@ if (_k_) < 0 || (_k_) >= (_len_) then error ("Data.HashMap.Internal.Array." ++ (_func_) ++ ": bounds error, offset " ++ show (_k_) ++ ", length " ++ show (_len_)) else # define CHECK_OP(_func_,_op_,_lhs_,_rhs_) \ if not ((_lhs_) _op_ (_rhs_)) then error ("Data.HashMap.Internal.Array." ++ (_func_) ++ ": Check failed: _lhs_ _op_ _rhs_ (" ++ show (_lhs_) ++ " vs. " ++ show (_rhs_) ++ ")") else +# define CHECK_GE(_func_,_lhs_,_rhs_) CHECK_OP(_func_,>=,_lhs_,_rhs_) # define CHECK_GT(_func_,_lhs_,_rhs_) CHECK_OP(_func_,>,_lhs_,_rhs_) # define CHECK_LE(_func_,_lhs_,_rhs_) CHECK_OP(_func_,<=,_lhs_,_rhs_) # define CHECK_EQ(_func_,_lhs_,_rhs_) CHECK_OP(_func_,==,_lhs_,_rhs_) #else # define CHECK_BOUNDS(_func_,_len_,_k_) # define CHECK_OP(_func_,_op_,_lhs_,_rhs_) +# define CHECK_GE(_func_,_lhs_,_rhs_) # define CHECK_GT(_func_,_lhs_,_rhs_) # define CHECK_LE(_func_,_lhs_,_rhs_) # define CHECK_EQ(_func_,_lhs_,_rhs_) @@ -158,10 +163,19 @@ unMArray :: !(SmallMutableArray# s a) } -lengthM :: MArray s a -> Int -lengthM mary = I# (sizeofSmallMutableArray# (unMArray mary)) +lengthM :: MArray s a -> ST s Int +lengthM (MArray ary) = ST $ \s -> + case getSizeofSmallMutableArray# ary s of + (# s', n #) -> (# s', I# n #) {-# INLINE lengthM #-} +#if defined(ASSERTS) +-- | Unsafe. Only for use in the @CHECK_*@ pragmas. +unsafeLengthM :: MArray s a -> Int +unsafeLengthM mary = I# (sizeofSmallMutableArray# (unMArray mary)) +{-# INLINE unsafeLengthM #-} +#endif + ------------------------------------------------------------------------ instance NFData a => NFData (Array a) where @@ -207,18 +221,13 @@ new_ :: Int -> ST s (MArray s a) new_ n = new n undefinedElem --- | When 'Exts.shrinkSmallMutableArray#' is available, the returned array is the same as the array given, as it is shrunk in place. --- Otherwise a copy is made. +-- | The returned array is the same as the array given, as it is shrunk in place. shrink :: MArray s a -> Int -> ST s (MArray s a) -#if __GLASGOW_HASKELL__ >= 810 shrink mary _n@(I# n#) = - CHECK_GT("shrink", _n, (0 :: Int)) - CHECK_LE("shrink", _n, (lengthM mary)) + CHECK_GE("shrink", _n, (0 :: Int)) + CHECK_LE("shrink", _n, (unsafeLengthM mary)) ST $ \s -> case Exts.shrinkSmallMutableArray# (unMArray mary) n# s of s' -> (# s', mary #) -#else -shrink mary n = cloneM mary 0 n -#endif {-# INLINE shrink #-} singleton :: a -> Array a @@ -247,23 +256,22 @@ read :: MArray s a -> Int -> ST s a read ary _i@(I# i#) = ST $ \ s -> - CHECK_BOUNDS("read", lengthM ary, _i) + CHECK_BOUNDS("read", unsafeLengthM ary, _i) readSmallArray# (unMArray ary) i# s {-# INLINE read #-} write :: MArray s a -> Int -> a -> ST s () write ary _i@(I# i#) b = ST $ \ s -> - CHECK_BOUNDS("write", lengthM ary, _i) + CHECK_BOUNDS("write", unsafeLengthM ary, _i) case writeSmallArray# (unMArray ary) i# b s of s' -> (# s' , () #) {-# INLINE write #-} -index :: Array a -> Int -> a -index ary _i@(I# i#) = - CHECK_BOUNDS("index", length ary, _i) - case indexSmallArray# (unArray ary) i# of (# b #) -> b -{-# INLINE index #-} - +-- | Note that we don't have an 'index' function with type +-- +-- > Array a -> Int -> a +-- +-- We used to have it, but it was prone to creating thunks. See #538. index# :: Array a -> Int -> (# a #) index# ary _i@(I# i#) = CHECK_BOUNDS("index#", length ary, _i) @@ -296,7 +304,7 @@ copy :: Array e -> Int -> MArray s e -> Int -> Int -> ST s () copy !src !_sidx@(I# sidx#) !dst !_didx@(I# didx#) _n@(I# n#) = CHECK_LE("copy", _sidx + _n, length src) - CHECK_LE("copy", _didx + _n, lengthM dst) + CHECK_LE("copy", _didx + _n, unsafeLengthM dst) ST $ \ s# -> case copySmallArray# (unArray src) sidx# (unMArray dst) didx# n# s# of s2 -> (# s2, () #) @@ -304,16 +312,16 @@ -- | Unsafely copy the elements of an array. Array bounds are not checked. copyM :: MArray s e -> Int -> MArray s e -> Int -> Int -> ST s () copyM !src !_sidx@(I# sidx#) !dst !_didx@(I# didx#) _n@(I# n#) = - CHECK_BOUNDS("copyM: src", lengthM src, _sidx + _n - 1) - CHECK_BOUNDS("copyM: dst", lengthM dst, _didx + _n - 1) + CHECK_BOUNDS("copyM: src", unsafeLengthM src, _sidx + _n - 1) + CHECK_BOUNDS("copyM: dst", unsafeLengthM dst, _didx + _n - 1) ST $ \ s# -> case copySmallMutableArray# (unMArray src) sidx# (unMArray dst) didx# n# s# of s2 -> (# s2, () #) cloneM :: MArray s a -> Int -> Int -> ST s (MArray s a) cloneM _mary@(MArray mary#) _off@(I# off#) _len@(I# len#) = - CHECK_BOUNDS("cloneM_off", lengthM _mary, _off) - CHECK_BOUNDS("cloneM_end", lengthM _mary, _off + _len - 1) + CHECK_BOUNDS("cloneM_off", unsafeLengthM _mary, _off) + CHECK_BOUNDS("cloneM_end", unsafeLengthM _mary, _off + _len - 1) ST $ \ s -> case cloneSmallMutableArray# mary# off# len# s of (# s', mary'# #) -> (# s', MArray mary'# #) @@ -372,13 +380,13 @@ {-# INLINE unsafeUpdateM #-} foldl' :: (b -> a -> b) -> b -> Array a -> b -foldl' f = \ z0 ary0 -> go ary0 (length ary0) 0 z0 +foldl' f = \ z0 ary0 -> foldl'_ ary0 (length ary0) 0 z0 where - go ary n i !z + foldl'_ !ary n i !z | i >= n = z | otherwise = case index# ary i of - (# x #) -> go ary n (i+1) (f z x) + (# x #) -> foldl'_ ary n (i+1) (f z x) {-# INLINE foldl' #-} foldr' :: (a -> b -> b) -> b -> Array a -> b @@ -391,13 +399,13 @@ {-# INLINE foldr' #-} foldr :: (a -> b -> b) -> b -> Array a -> b -foldr f = \ z0 ary0 -> go ary0 (length ary0) 0 z0 +foldr f = \ z0 ary0 -> foldr_ ary0 (length ary0) 0 z0 where - go ary n i z + foldr_ !ary n i z | i >= n = z | otherwise = case index# ary i of - (# x #) -> f x (go ary n (i+1) z) + (# x #) -> f x (foldr_ ary n (i+1) z) {-# INLINE foldr #-} foldl :: (b -> a -> b) -> b -> Array a -> b @@ -457,7 +465,7 @@ where !count = length ary {-# INLINE deleteM #-} -map :: (a -> b) -> Array a -> Array b +map :: forall a b . (a -> b) -> Array a -> Array b map f = \ ary -> let !n = length ary in run $ do @@ -465,6 +473,7 @@ go ary mary 0 n return mary where + go :: forall s. Array a -> MArray s b -> Int -> Int -> ST s () go ary mary i n | i >= n = return () | otherwise = do @@ -474,7 +483,7 @@ {-# INLINE map #-} -- | Strict version of 'map'. -map' :: (a -> b) -> Array a -> Array b +map' :: forall a b . (a -> b) -> Array a -> Array b map' f = \ ary -> let !n = length ary in run $ do @@ -482,6 +491,7 @@ go ary mary 0 n return mary where + go :: forall s . Array a -> MArray s b -> Int -> Int -> ST s () go ary mary i n | i >= n = return () | otherwise = do @@ -490,7 +500,50 @@ go ary mary (i+1) n {-# INLINE map' #-} -fromList :: Int -> [a] -> Array a +filter :: forall a . (a -> Bool) -> Array a -> Array a +filter f = \ ary -> + let !n = length ary + in run $ do + mary <- new_ n + len <- go_filter ary mary 0 0 n + shrink mary len + where + -- Without the @!@ on @ary@ we end up reboxing the array when using + -- 'differenceCollisions'. See + -- https://gitlab.haskell.org/ghc/ghc/-/issues/26525. + go_filter :: forall s . Array a -> MArray s a -> Int -> Int -> Int -> ST s Int + go_filter !ary !mary !iAry !iMary !n + | iAry >= n = return iMary + | otherwise = do + x <- indexM ary iAry + if f x + then do + write mary iMary x + go_filter ary mary (iAry + 1) (iMary + 1) n + else go_filter ary mary (iAry + 1) iMary n +{-# INLINE filter #-} + +mapMaybe :: forall a b . (a -> Maybe b) -> Array a -> Array b +mapMaybe f = \ ary -> + let !n = length ary + in run $ do + mary <- new_ n + len <- go_mapMaybe ary mary 0 0 n + shrink mary len + where + go_mapMaybe :: forall s . Array a -> MArray s b -> Int -> Int -> Int -> ST s Int + go_mapMaybe !ary !mary !iAry !iMary !n + | iAry >= n = return iMary + | otherwise = do + x <- indexM ary iAry + case f x of + Nothing -> go_mapMaybe ary mary (iAry + 1) iMary n + Just y -> do + write mary iMary y + go_mapMaybe ary mary (iAry + 1) (iMary + 1) n +{-# INLINE mapMaybe #-} + +fromList :: forall a . Int -> [a] -> Array a fromList n xs0 = CHECK_EQ("fromList", n, Prelude.length xs0) run $ do @@ -498,11 +551,12 @@ go xs0 mary 0 return mary where + go :: forall s . [a] -> MArray s a -> Int -> ST s () go [] !_ !_ = return () go (x:xs) mary i = do write mary i x go xs mary (i+1) -fromList' :: Int -> [a] -> Array a +fromList' :: forall a . Int -> [a] -> Array a fromList' n xs0 = CHECK_EQ("fromList'", n, Prelude.length xs0) run $ do @@ -510,20 +564,19 @@ go xs0 mary 0 return mary where + go :: forall s . [a] -> MArray s a -> Int -> ST s () go [] !_ !_ = return () go (!x:xs) mary i = do write mary i x go xs mary (i+1) +#if defined(__GLASGOW_HASKELL__) -- | @since 0.2.17.0 instance TH.Lift a => TH.Lift (Array a) where -#if MIN_VERSION_template_haskell(2,16,0) liftTyped ar = [|| fromList' arlen arlist ||] -#else - lift ar = [| fromList' arlen arlist |] -#endif where arlen = length ar arlist = toList ar +#endif toList :: Array a -> [a] toList = foldr (:) [] diff --git a/Data/HashMap/Internal/Debug.hs b/Data/HashMap/Internal/Debug.hs --- a/Data/HashMap/Internal/Debug.hs +++ b/Data/HashMap/Internal/Debug.hs @@ -1,5 +1,7 @@ {-# LANGUAGE CPP #-} +{-# LANGUAGE MagicHash #-} {-# LANGUAGE TypeApplications #-} +{-# LANGUAGE UnboxedTuples #-} -- | = WARNING -- @@ -35,11 +37,6 @@ import qualified Data.HashMap.Internal.Array as A - -#if !MIN_VERSION_base(4,11,0) -import Data.Semigroup (Semigroup (..)) -#endif - data Validity k = Invalid (Error k) SubHashPath | Valid deriving (Eq, Show) @@ -130,12 +127,14 @@ validSubTrees p b ary | A.length ary == 1 - , isLeafOrCollision (A.index ary 0) + , (# st #) <- A.index# ary 0 + , isLeafOrCollision st = Invalid INV5_BitmapIndexed_invalid_single_subtree p | otherwise = go b where go 0 = Valid - go b' = validInternal (addSubHash p (fromIntegral c)) (A.index ary i) <> go b'' + go b' = case A.index# ary i of + (# st #) -> validInternal (addSubHash p (fromIntegral c)) st <> go b'' where c = countTrailingZeros b' m = 1 `unsafeShiftL` c diff --git a/Data/HashMap/Internal/List.hs b/Data/HashMap/Internal/List.hs --- a/Data/HashMap/Internal/List.hs +++ b/Data/HashMap/Internal/List.hs @@ -28,9 +28,6 @@ import Data.List (sortBy) import Data.Maybe (fromMaybe) -#if !MIN_VERSION_base(4,11,0) -import Data.Semigroup ((<>)) -#endif -- Note: previous implementation isPermutation = null (as // bs) -- was O(n^2) too. diff --git a/Data/HashMap/Internal/Strict.hs b/Data/HashMap/Internal/Strict.hs --- a/Data/HashMap/Internal/Strict.hs +++ b/Data/HashMap/Internal/Strict.hs @@ -1,10 +1,11 @@ -{-# LANGUAGE BangPatterns #-} -{-# LANGUAGE CPP #-} -{-# LANGUAGE LambdaCase #-} -{-# LANGUAGE MagicHash #-} -{-# LANGUAGE PatternGuards #-} -{-# LANGUAGE Trustworthy #-} -{-# LANGUAGE UnboxedTuples #-} +{-# LANGUAGE BangPatterns #-} +{-# LANGUAGE CPP #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE MagicHash #-} +{-# LANGUAGE PatternGuards #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE Trustworthy #-} +{-# LANGUAGE UnboxedTuples #-} {-# OPTIONS_HADDOCK not-home #-} ------------------------------------------------------------------------ @@ -61,6 +62,7 @@ , HM.findWithDefault , HM.lookupDefault , (HM.!) + , HM.lookupKey , insert , insertWith , HM.delete @@ -90,9 +92,11 @@ -- * Difference and intersection , HM.difference , differenceWith + , differenceWithKey , HM.intersection , intersectionWith , intersectionWithKey + , HM.disjoint -- * Folds , HM.foldMapWithKey @@ -123,15 +127,15 @@ ) where import Control.Applicative (Const (..)) -import Control.Monad.ST (runST) +import Control.Monad.ST (ST, runST) import Data.Bits ((.&.), (.|.)) import Data.Coerce (coerce) import Data.Functor.Identity (Identity (..)) -- See Note [Imports from Data.HashMap.Internal] import Data.Hashable (Hashable) import Data.HashMap.Internal (Hash, HashMap (..), Leaf (..), LookupRes (..), - fullBitmap, hash, index, mask, nextShift, ptrEq, - sparseIndex) + Shift, fullBitmap, hash, index, mask, nextShift, + ptrEq, sparseIndex) import Prelude hiding (lookup, map) -- See Note [Imports from Data.HashMap.Internal] @@ -175,7 +179,7 @@ -- | \(O(\log n)\) Associate the specified value with the specified -- key in this map. If this map previously contained a mapping for -- the key, the old value is replaced. -insert :: (Eq k, Hashable k) => k -> v -> HashMap k v -> HashMap k v +insert :: Hashable k => k -> v -> HashMap k v -> HashMap k v insert k !v = HM.insert k v {-# INLINABLE insert #-} @@ -186,7 +190,7 @@ -- -- > insertWith f k v map -- > where f new old = new + old -insertWith :: (Eq k, Hashable k) => (v -> v -> v) -> k -> v -> HashMap k v +insertWith :: Hashable k => (v -> v -> v) -> k -> v -> HashMap k v -> HashMap k v insertWith f k0 v0 m0 = go h0 k0 v0 0 m0 where @@ -202,17 +206,19 @@ let ary' = A.insert ary i $! leaf h k x in HM.bitmapIndexedOrFull (b .|. m) ary' | otherwise = - let st = A.index ary i - st' = go h k x (nextShift s) st - ary' = A.update ary i $! st' - in BitmapIndexed b ary' + case A.index# ary i of + (# st #) -> + let !st' = go h k x (nextShift s) st + ary' = A.update ary i st' + in BitmapIndexed b ary' where m = mask h s i = sparseIndex b m go h k x s (Full ary) = - let st = A.index ary i - st' = go h k x (nextShift s) st - ary' = HM.updateFullArray ary i $! st' - in Full ary' + case A.index# ary i of + (# st #) -> + let !st' = go h k x (nextShift s) st + ary' = HM.updateFullArray ary i st' + in Full ary' where i = index h s go h k x s t@(Collision hy v) | h == hy = Collision h (updateOrSnocWith f k x v) @@ -220,16 +226,17 @@ {-# INLINABLE insertWith #-} -- | In-place update version of insertWith -unsafeInsertWith :: (Eq k, Hashable k) => (v -> v -> v) -> k -> v -> HashMap k v +unsafeInsertWith :: Hashable k => (v -> v -> v) -> k -> v -> HashMap k v -> HashMap k v unsafeInsertWith f k0 v0 m0 = unsafeInsertWithKey (const f) k0 v0 m0 {-# INLINABLE unsafeInsertWith #-} -unsafeInsertWithKey :: (Eq k, Hashable k) => (k -> v -> v -> v) -> k -> v -> HashMap k v +unsafeInsertWithKey :: forall k v. Hashable k => (k -> v -> v -> v) -> k -> v -> HashMap k v -> HashMap k v unsafeInsertWithKey f k0 v0 m0 = runST (go h0 k0 v0 0 m0) where h0 = hash k0 + go :: forall s. Hash -> k -> v -> Shift -> HashMap k v -> ST s (HashMap k v) go !h !k x !_ Empty = return $! leaf h k x go h k x s t@(Leaf hy l@(L ky y)) | hy == h = if ky == k @@ -262,7 +269,7 @@ -- | \(O(\log n)\) Adjust the value tied to a given key in this map only -- if it is present. Otherwise, leave the map alone. -adjust :: (Eq k, Hashable k) => (v -> v) -> k -> HashMap k v -> HashMap k v +adjust :: Hashable k => (v -> v) -> k -> HashMap k v -> HashMap k v adjust f k0 m0 = go h0 k0 0 m0 where h0 = hash k0 @@ -272,18 +279,21 @@ | otherwise = t go h k s t@(BitmapIndexed b ary) | b .&. m == 0 = t - | otherwise = let st = A.index ary i - st' = go h k (nextShift s) st - ary' = A.update ary i $! st' - in BitmapIndexed b ary' + | otherwise = + case A.index# ary i of + (# st #) -> + let !st' = go h k (nextShift s) st + ary' = A.update ary i st' + in BitmapIndexed b ary' where m = mask h s i = sparseIndex b m go h k s (Full ary) = - let i = index h s - st = A.index ary i - st' = go h k (nextShift s) st - ary' = HM.updateFullArray ary i $! st' - in Full ary' + case A.index# ary i of + (# st #) -> + let !st' = go h k (nextShift s) st + ary' = HM.updateFullArray ary i st' + in Full ary' + where i = index h s go h k _ t@(Collision hy v) | h == hy = Collision h (updateWith f k v) | otherwise = t @@ -292,7 +302,7 @@ -- | \(O(\log n)\) The expression @('update' f k map)@ updates the value @x@ at @k@ -- (if it is in the map). If @(f x)@ is 'Nothing', the element is deleted. -- If it is @('Just' y)@, the key @k@ is bound to the new value @y@. -update :: (Eq k, Hashable k) => (a -> Maybe a) -> k -> HashMap k a -> HashMap k a +update :: Hashable k => (a -> Maybe a) -> k -> HashMap k a -> HashMap k a update f = alter (>>= f) {-# INLINABLE update #-} @@ -304,7 +314,7 @@ -- @ -- 'lookup' k ('alter' f k m) = f ('lookup' k m) -- @ -alter :: (Eq k, Hashable k) => (Maybe v -> Maybe v) -> k -> HashMap k v -> HashMap k v +alter :: Hashable k => (Maybe v -> Maybe v) -> k -> HashMap k v -> HashMap k v alter f k m = let !h = hash k !lookupRes = HM.lookupRecordCollision h k m @@ -329,7 +339,7 @@ -- . -- -- @since 0.2.10 -alterF :: (Functor f, Eq k, Hashable k) +alterF :: (Functor f, Hashable k) => (Maybe v -> f (Maybe v)) -> k -> HashMap k v -> f (HashMap k v) -- Special care is taken to only calculate the hash once. When we rewrite -- with RULES, we also ensure that we only compare the key for equality @@ -396,7 +406,7 @@ -- -- Failure to abide by these laws will make demons come out of your nose. alterFWeird - :: (Functor f, Eq k, Hashable k) + :: (Functor f, Hashable k) => f (Maybe v) -> f (Maybe v) -> (Maybe v -> f (Maybe v)) -> k -> HashMap k v -> f (HashMap k v) @@ -406,7 +416,7 @@ -- | This is the default version of alterF that we use in most non-trivial -- cases. It's called "eager" because it looks up the given key in the map -- eagerly, whether or not the given function requires that information. -alterFEager :: (Functor f, Eq k, Hashable k) +alterFEager :: (Functor f, Hashable k) => (Maybe v -> f (Maybe v)) -> k -> HashMap k v -> f (HashMap k v) alterFEager f !k !m = (<$> f mv) $ \fres -> case fres of @@ -611,14 +621,26 @@ -- encountered, the combining function is applied to the values of these keys. -- 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) => (v -> w -> Maybe v) -> HashMap k v -> HashMap k w -> HashMap k v -differenceWith f a b = HM.foldlWithKey' go HM.empty a - where - go m k v = case HM.lookup k b of - Nothing -> v `seq` HM.unsafeInsert k v m - Just w -> maybe m (\ !y -> HM.unsafeInsert k y m) (f v w) -{-# INLINABLE differenceWith #-} +differenceWith :: Hashable k => (v -> w -> Maybe v) -> HashMap k v -> HashMap k w -> HashMap k v +differenceWith f = HM.differenceWithKey $ + \_k vA vB -> case f vA vB of + Nothing -> Nothing + x@(Just v) -> v `seq` x +{-# INLINE differenceWith #-} +-- | \(O(n \log m)\) Difference with a combining function. When two equal keys are +-- encountered, the combining function is applied to the values of these keys. +-- 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@. +-- +-- @since 0.2.21 +differenceWithKey :: Eq k => (k -> v -> w -> Maybe v) -> HashMap k v -> HashMap k w -> HashMap k v +differenceWithKey f = HM.differenceWithKey $ + \k vA vB -> case f k vA vB of + Nothing -> Nothing + x@(Just v) -> v `seq` x +{-# INLINE differenceWithKey #-} + -- | \(O(n+m)\) Intersection of two maps. If a key occurs in both maps -- the provided function is used to combine the values from the two -- maps. @@ -641,7 +663,7 @@ -- | \(O(n \log n)\) Construct a map with the supplied mappings. If the -- list contains duplicate mappings, the later mappings take -- precedence. -fromList :: (Eq k, Hashable k) => [(k, v)] -> HashMap k v +fromList :: Hashable k => [(k, v)] -> HashMap k v fromList = List.foldl' (\ m (k, !v) -> HM.unsafeInsert k v m) HM.empty {-# INLINABLE fromList #-} @@ -675,7 +697,7 @@ -- -- > fromListWith f [(k, a), (k, b), (k, c), (k, d)] -- > = fromList [(k, f d (f c (f b a)))] -fromListWith :: (Eq k, Hashable k) => (v -> v -> v) -> [(k, v)] -> HashMap k v +fromListWith :: Hashable k => (v -> v -> v) -> [(k, v)] -> HashMap k v fromListWith f = List.foldl' (\ m (k, v) -> unsafeInsertWith f k v m) HM.empty {-# INLINE fromListWith #-} @@ -705,7 +727,7 @@ -- > = fromList [(k, f k d (f k c (f k b a)))] -- -- @since 0.2.11 -fromListWithKey :: (Eq k, Hashable k) => (k -> v -> v -> v) -> [(k, v)] -> HashMap k v +fromListWithKey :: Hashable k => (k -> v -> v -> v) -> [(k, v)] -> HashMap k v fromListWithKey f = List.foldl' (\ m (k, v) -> unsafeInsertWithKey f k v m) HM.empty {-# INLINE fromListWithKey #-} @@ -717,9 +739,9 @@ where go !k !ary !i !n | i >= n = ary - | otherwise = case A.index ary i of - (L kx y) | k == kx -> let !v' = f y in A.update ary i (L k v') - | otherwise -> go k ary (i+1) n + | otherwise = case A.index# ary i of + (# L kx y #) | k == kx -> let !v' = f y in A.update ary i (L k v') + | otherwise -> go k ary (i+1) n {-# INLINABLE updateWith #-} -- | Append the given key and value to the array. If the key is @@ -744,9 +766,9 @@ go !k v !ary !i !n -- Not found, append to the end. | i >= n = A.snoc ary $! L k $! v - | otherwise = case A.index ary i of - (L kx y) | k == kx -> let !v' = f k v y in A.update ary i (L k v') - | otherwise -> go k v ary (i+1) n + | otherwise = case A.index# ary i of + (# L kx y #) | k == kx -> let !v' = f k v y in A.update ary i (L k v') + | otherwise -> go k v ary (i+1) n {-# INLINABLE updateOrSnocWithKey #-} ------------------------------------------------------------------------ diff --git a/Data/HashMap/Lazy.hs b/Data/HashMap/Lazy.hs --- a/Data/HashMap/Lazy.hs +++ b/Data/HashMap/Lazy.hs @@ -42,6 +42,7 @@ , findWithDefault , lookupDefault , (!) + , lookupKey , insert , insertWith , delete @@ -71,9 +72,11 @@ -- * Difference and intersection , difference , differenceWith + , differenceWithKey , intersection , intersectionWith , intersectionWithKey + , disjoint -- * Folds , foldMapWithKey diff --git a/Data/HashMap/Strict.hs b/Data/HashMap/Strict.hs --- a/Data/HashMap/Strict.hs +++ b/Data/HashMap/Strict.hs @@ -41,6 +41,7 @@ , findWithDefault , lookupDefault , (!) + , lookupKey , insert , insertWith , delete @@ -70,9 +71,11 @@ -- * Difference and intersection , difference , differenceWith + , differenceWithKey , intersection , intersectionWith , intersectionWithKey + , disjoint -- * Folds , foldMapWithKey diff --git a/Data/HashSet.hs b/Data/HashSet.hs --- a/Data/HashSet.hs +++ b/Data/HashSet.hs @@ -107,6 +107,7 @@ , null , size , member + , lookupElement , insert , delete , isSubsetOf @@ -117,6 +118,7 @@ -- * Difference and intersection , difference , intersection + , disjoint -- * Folds , foldl' diff --git a/Data/HashSet/Internal.hs b/Data/HashSet/Internal.hs --- a/Data/HashSet/Internal.hs +++ b/Data/HashSet/Internal.hs @@ -52,6 +52,7 @@ , null , size , member + , lookupElement , insert , delete , isSubsetOf @@ -66,6 +67,7 @@ -- * Difference and intersection , difference , intersection + , disjoint -- * Folds , foldr @@ -144,7 +146,7 @@ -- -- In general, the lack of extensionality can be observed with any function -- that depends on the key ordering, such as folds and traversals. -instance (Eq a) => Eq (HashSet a) where +instance Eq a => Eq (HashSet a) where HashSet a == HashSet b = equalKeys a b {-# INLINE (==) #-} @@ -186,7 +188,7 @@ -- -- >>> fromList [1,2] <> fromList [2,3] -- fromList [1,2,3] -instance (Hashable a, Eq a) => Semigroup (HashSet a) where +instance Hashable a => Semigroup (HashSet a) where (<>) = union {-# INLINE (<>) #-} stimes = stimesIdempotentMonoid @@ -205,13 +207,13 @@ -- -- >>> mappend (fromList [1,2]) (fromList [2,3]) -- fromList [1,2,3] -instance (Hashable a, Eq a) => Monoid (HashSet a) where +instance Hashable a => Monoid (HashSet a) where mempty = empty {-# INLINE mempty #-} mappend = (<>) {-# INLINE mappend #-} -instance (Eq a, Hashable a, Read a) => Read (HashSet a) where +instance (Hashable a, Read a) => Read (HashSet a) where readPrec = parens $ prec 10 $ do Ident "fromList" <- lexP fromList <$> readPrec @@ -226,7 +228,7 @@ showsPrec d m = showParen (d > 10) $ showString "fromList " . shows (toList m) -instance (Data a, Eq a, Hashable a) => Data (HashSet a) where +instance (Data a, Hashable a) => Data (HashSet a) where gfoldl f z m = z fromList `f` toList m toConstr _ = fromListConstr gunfold k z c = case Data.constrIndex c of @@ -296,7 +298,7 @@ -- False -- -- @since 0.2.12 -isSubsetOf :: (Eq a, Hashable a) => HashSet a -> HashSet a -> Bool +isSubsetOf :: Hashable a => HashSet a -> HashSet a -> Bool isSubsetOf s1 s2 = H.isSubmapOfBy (\_ _ -> True) (asMap s1) (asMap s2) -- | \(O(n+m)\) Construct a set containing all elements from both sets. @@ -344,17 +346,27 @@ -- True -- >>> HashSet.member 1 (Hashset.fromList [4,5,6]) -- False -member :: (Eq a, Hashable a) => a -> HashSet a -> Bool +member :: Hashable a => a -> HashSet a -> Bool member a s = case H.lookup a (asMap s) of Just _ -> True _ -> False {-# INLINABLE member #-} +-- | \(O(\log n)\) For a given value, return the equal element in the set if +-- present, otherwise return 'Nothing'. +-- +-- This is useful for /interning/, i.e. to reduce memory usage. +-- +-- @since 0.2.21 +lookupElement :: Hashable a => a -> HashSet a -> Maybe a +lookupElement a = H.lookupKey a . asMap +{-# INLINE lookupElement #-} + -- | \(O(\log n)\) Add the specified value to this set. -- -- >>> HashSet.insert 1 HashSet.empty -- fromList [1] -insert :: (Eq a, Hashable a) => a -> HashSet a -> HashSet a +insert :: Hashable a => a -> HashSet a -> HashSet a insert a = HashSet . H.insert a () . asMap {-# INLINABLE insert #-} @@ -364,29 +376,29 @@ -- fromList [2,3] -- >>> HashSet.delete 1 (HashSet.fromList [4,5,6]) -- fromList [4,5,6] -delete :: (Eq a, Hashable a) => a -> HashSet a -> HashSet a +delete :: Hashable a => a -> HashSet a -> HashSet a delete a = HashSet . H.delete a . asMap {-# INLINABLE delete #-} --- | \(O(n)\) Transform this set by applying a function to every value. +-- | \(O(n \log n)\) Transform this set by applying a function to every value. -- The resulting set may be smaller than the source. -- -- >>> HashSet.map show (HashSet.fromList [1,2,3]) -- HashSet.fromList ["1","2","3"] -map :: (Hashable b, Eq b) => (a -> b) -> HashSet a -> HashSet b +map :: Hashable b => (a -> b) -> HashSet a -> HashSet b map f = fromList . List.map f . toList {-# INLINE map #-} --- | \(O(n)\) Difference of two sets. Return elements of the first set +-- | \(O(n \log m)\) Difference of two sets. Return elements of the first set -- not existing in the second. -- -- >>> HashSet.difference (HashSet.fromList [1,2,3]) (HashSet.fromList [2,3,4]) -- fromList [1] -difference :: (Eq a, Hashable a) => HashSet a -> HashSet a -> HashSet a +difference :: Hashable a => HashSet a -> HashSet a -> HashSet a difference (HashSet a) (HashSet b) = HashSet (H.difference a b) {-# INLINABLE difference #-} --- | \(O(n)\) Intersection of two sets. Return elements present in both +-- | \(O(n \log m)\) Intersection of two sets. Return elements present in both -- the first set and the second. -- -- >>> HashSet.intersection (HashSet.fromList [1,2,3]) (HashSet.fromList [2,3,4]) @@ -395,6 +407,18 @@ intersection (HashSet a) (HashSet b) = HashSet (H.intersection a b) {-# INLINABLE intersection #-} +-- | \(O(n \log m)\) Check whether two sets are disjoint (i.e., their +-- intersection is empty). +-- +-- @ +-- xs ``disjoint`` ys = null (xs ``intersection`` ys) +-- @ +-- +-- @since 0.2.21 +disjoint :: Eq k => HashSet k -> HashSet k -> Bool +disjoint (HashSet a) (HashSet b) = H.disjoint a b +{-# INLINE disjoint #-} + -- | \(O(n)\) Reduce this set by applying a binary operator to all -- elements, using the given starting value (typically the -- left-identity of the operator). Each application of the operator @@ -445,12 +469,14 @@ toList t = Exts.build (\ c z -> foldrWithKey (const . c) z (asMap t)) {-# INLINE toList #-} --- | \(O(n \min(W, n))\) Construct a set from a list of elements. -fromList :: (Eq a, Hashable a) => [a] -> HashSet a -fromList = HashSet . List.foldl' (\ m k -> H.insert k () m) H.empty +-- | \(O(n \log n)\) Construct a set from a list of elements. +fromList :: Hashable a => [a] -> HashSet a +fromList = HashSet . List.foldl' (\ m k -> H.unsafeInsert k () m) H.empty {-# INLINE fromList #-} -instance (Eq a, Hashable a) => Exts.IsList (HashSet a) where +#if defined(__GLASGOW_HASKELL__) +instance Hashable a => Exts.IsList (HashSet a) where type Item (HashSet a) = a fromList = fromList toList = toList +#endif diff --git a/benchmarks/Benchmarks.hs b/benchmarks/Benchmarks.hs --- a/benchmarks/Benchmarks.hs +++ b/benchmarks/Benchmarks.hs @@ -9,12 +9,12 @@ import Control.DeepSeq (NFData (..)) import Data.Bits ((.&.)) +import Data.Foldable (Foldable (..)) import Data.Functor.Identity (Identity (..)) import Data.Hashable (Hashable, hash) -import Data.List (foldl') import Data.Maybe (fromMaybe) import GHC.Generics (Generic) -import Prelude hiding (lookup) +import Prelude hiding (Foldable (..), lookup) import Test.Tasty.Bench (bench, bgroup, defaultMain, env, nf, whnf) import qualified Data.ByteString as BS @@ -382,14 +382,14 @@ ------------------------------------------------------------------------ -- * HashMap -lookup :: (Eq k, Hashable k) => [k] -> HM.HashMap k Int -> Int +lookup :: Hashable k => [k] -> HM.HashMap k Int -> Int lookup xs m = foldl' (\z k -> fromMaybe z (HM.lookup k m)) 0 xs {-# SPECIALIZE lookup :: [Int] -> HM.HashMap Int Int -> Int #-} {-# SPECIALIZE lookup :: [String] -> HM.HashMap String Int -> Int #-} {-# SPECIALIZE lookup :: [BS.ByteString] -> HM.HashMap BS.ByteString Int -> Int #-} -insert :: (Eq k, Hashable k) => [(k, Int)] -> HM.HashMap k Int +insert :: Hashable k => [(k, Int)] -> HM.HashMap k Int -> HM.HashMap k Int insert xs m0 = foldl' (\m (k, v) -> HM.insert k v m) m0 xs {-# SPECIALIZE insert :: [(Int, Int)] -> HM.HashMap Int Int @@ -399,7 +399,7 @@ {-# SPECIALIZE insert :: [(BS.ByteString, Int)] -> HM.HashMap BS.ByteString Int -> HM.HashMap BS.ByteString Int #-} -delete :: (Eq k, Hashable k) => [k] -> HM.HashMap k Int -> HM.HashMap k Int +delete :: Hashable k => [k] -> HM.HashMap k Int -> HM.HashMap k Int delete xs m0 = foldl' (\m k -> HM.delete k m) m0 xs {-# SPECIALIZE delete :: [Int] -> HM.HashMap Int Int -> HM.HashMap Int Int #-} {-# SPECIALIZE delete :: [String] -> HM.HashMap String Int @@ -407,7 +407,7 @@ {-# SPECIALIZE delete :: [BS.ByteString] -> HM.HashMap BS.ByteString Int -> HM.HashMap BS.ByteString Int #-} -alterInsert :: (Eq k, Hashable k) => [(k, Int)] -> HM.HashMap k Int +alterInsert :: Hashable k => [(k, Int)] -> HM.HashMap k Int -> HM.HashMap k Int alterInsert xs m0 = foldl' (\m (k, v) -> HM.alter (const . Just $ v) k m) m0 xs @@ -418,7 +418,7 @@ {-# SPECIALIZE alterInsert :: [(BS.ByteString, Int)] -> HM.HashMap BS.ByteString Int -> HM.HashMap BS.ByteString Int #-} -alterDelete :: (Eq k, Hashable k) => [k] -> HM.HashMap k Int +alterDelete :: Hashable k => [k] -> HM.HashMap k Int -> HM.HashMap k Int alterDelete xs m0 = foldl' (\m k -> HM.alter (const Nothing) k m) m0 xs @@ -429,7 +429,7 @@ {-# SPECIALIZE alterDelete :: [BS.ByteString] -> HM.HashMap BS.ByteString Int -> HM.HashMap BS.ByteString Int #-} -alterFInsert :: (Eq k, Hashable k) => [(k, Int)] -> HM.HashMap k Int +alterFInsert :: Hashable k => [(k, Int)] -> HM.HashMap k Int -> HM.HashMap k Int alterFInsert xs m0 = foldl' (\m (k, v) -> runIdentity $ HM.alterF (const . Identity . Just $ v) k m) m0 xs @@ -440,7 +440,7 @@ {-# SPECIALIZE alterFInsert :: [(BS.ByteString, Int)] -> HM.HashMap BS.ByteString Int -> HM.HashMap BS.ByteString Int #-} -alterFDelete :: (Eq k, Hashable k) => [k] -> HM.HashMap k Int +alterFDelete :: Hashable k => [k] -> HM.HashMap k Int -> HM.HashMap k Int alterFDelete xs m0 = foldl' (\m k -> runIdentity $ HM.alterF (const . Identity $ Nothing) k m) m0 xs @@ -451,7 +451,7 @@ {-# SPECIALIZE alterFDelete :: [BS.ByteString] -> HM.HashMap BS.ByteString Int -> HM.HashMap BS.ByteString Int #-} -isSubmapOfNaive :: (Eq k, Hashable k) => HM.HashMap k Int -> HM.HashMap k Int -> Bool +isSubmapOfNaive :: Hashable k => HM.HashMap k Int -> HM.HashMap k Int -> Bool isSubmapOfNaive m1 m2 = and [ Just v1 == HM.lookup k1 m2 | (k1,v1) <- HM.toList m1 ] {-# SPECIALIZE isSubmapOfNaive :: HM.HashMap Int Int -> HM.HashMap Int Int -> Bool #-} {-# SPECIALIZE isSubmapOfNaive :: HM.HashMap String Int -> HM.HashMap String Int -> Bool #-} @@ -484,13 +484,13 @@ ------------------------------------------------------------------------ -- * Map from the hashmap package -lookupIHM :: (Eq k, Hashable k, Ord k) => [k] -> IHM.Map k Int -> Int +lookupIHM :: (Hashable k, Ord k) => [k] -> IHM.Map k Int -> Int lookupIHM xs m = foldl' (\z k -> fromMaybe z (IHM.lookup k m)) 0 xs {-# SPECIALIZE lookupIHM :: [String] -> IHM.Map String Int -> Int #-} {-# SPECIALIZE lookupIHM :: [BS.ByteString] -> IHM.Map BS.ByteString Int -> Int #-} -insertIHM :: (Eq k, Hashable k, Ord k) => [(k, Int)] -> IHM.Map k Int +insertIHM :: (Hashable k, Ord k) => [(k, Int)] -> IHM.Map k Int -> IHM.Map k Int insertIHM xs m0 = foldl' (\m (k, v) -> IHM.insert k v m) m0 xs {-# SPECIALIZE insertIHM :: [(String, Int)] -> IHM.Map String Int @@ -498,7 +498,7 @@ {-# SPECIALIZE insertIHM :: [(BS.ByteString, Int)] -> IHM.Map BS.ByteString Int -> IHM.Map BS.ByteString Int #-} -deleteIHM :: (Eq k, Hashable k, Ord k) => [k] -> IHM.Map k Int -> IHM.Map k Int +deleteIHM :: (Hashable k, Ord k) => [k] -> IHM.Map k Int -> IHM.Map k Int deleteIHM xs m0 = foldl' (\m k -> IHM.delete k m) m0 xs {-# SPECIALIZE deleteIHM :: [String] -> IHM.Map String Int -> IHM.Map String Int #-} diff --git a/benchmarks/FineGrained.hs b/benchmarks/FineGrained.hs new file mode 100644 --- /dev/null +++ b/benchmarks/FineGrained.hs @@ -0,0 +1,608 @@ +-- This file is formatted with https://hackage.haskell.org/package/ormolu +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE NumericUnderscores #-} +{-# LANGUAGE TupleSections #-} +{-# LANGUAGE TypeApplications #-} + +module Main where + +import Control.DeepSeq (NFData) +import Control.Monad (replicateM) +import Data.Bifunctor (second) +import Data.Bits (testBit) +import Data.HashMap.Strict (HashMap) +import qualified Data.HashMap.Strict as HM +import qualified Data.HashSet +import Data.Hashable +import Data.List +import Key.Bytes +import System.Random.Stateful +import Test.Tasty.Bench +import Prelude hiding (Foldable (..), lookup) + +main :: IO () +main = + defaultMain + [ bgroup + "HashMap.Strict" + [ bFromList, + bLookup, + bInsert, + bUpdate, + bAlter, + bDelete, + bUnion, + bUnions, + bIntersection, + bDifference, + bDifferenceWith + ], + bgroup "HashSet" [bSetFromList] + ] + +defaultSizes :: [Int] +defaultSizes = [0, 1, 10, 100, 1000, 10_000, 100_000] + +-- | Length of a 'Bytes' key in bytes. +-- +-- For comparison: A SHA256 hash is 32 bytes long. +bytesLength :: Int +bytesLength = 32 + +-- | Pseudo-random generator for keys etc. +-- +-- Change the seed to generate different random elements. +defaultGen :: StdGen +defaultGen = mkStdGen 42 + +bFromList :: Benchmark +bFromList = + bgroup + "fromList" + [ bgroup' "Bytes" setupBytes b, + bgroup' "Int" genInts b + ] + where + setupBytes s gen = genNBytes s bytesLength gen + b s = bench (show s) . whnf (HM.fromList . map (,())) + +-- 1000 lookups each, so we get more precise timings +bLookup :: Benchmark +bLookup = + bgroup + "lookup (1000x)" + [ bgroup "presentKey" bLookupPresentKey, + bgroup "absentKey" bLookupAbsentKey + ] + +bLookupPresentKey :: [Benchmark] +bLookupPresentKey = + [ bgroup'WithSizes sizes "Bytes" setupBytes b, + bgroup'WithSizes sizes "Int" setupInts b + ] + where + sizes = filter (/= 0) defaultSizes + b s = + bench (show s) + . whnf (\(m, ks) -> foldl' (\() k -> HM.lookup k m `seq` ()) () ks) + toKs = take 1000 . Data.List.cycle . HM.keys + setupBytes size gen = do + m <- genBytesMap size gen + return (m, toKs m) + setupInts size gen = do + m <- genIntMap size gen + return (m, toKs m) + +bLookupAbsentKey :: [Benchmark] +bLookupAbsentKey = + [ bgroup' "Bytes" setupBytes b, + bgroup' "Int" setupInts b + ] + where + b s = + bench (show s) + . whnf (\(m, ks) -> foldl' (\() k -> HM.lookup k m `seq` ()) () ks) + setupBytes size gen = do + m <- genBytesMap size gen + ks0 <- genNBytes 2000 bytesLength gen + let ks1 = take 1000 $ Data.List.cycle $ filter (not . flip HM.member m) ks0 + return (m, ks1) + setupInts size gen = do + m <- genIntMap size gen + ks0 <- genInts 2000 gen + let ks1 = take 1000 $ Data.List.cycle $ filter (not . flip HM.member m) ks0 + return (m, ks1) + +-- 1000 insertions each, so we get more precise timings +bInsert :: Benchmark +bInsert = + bgroup + "insert (1000x)" + [ bgroup + "presentKey" + [ bgroup "sameValue" bInsertPresentKeySameValue, + bgroup "differentValue" bInsertPresentKeyDifferentValue + ], + bgroup "absentKey" bInsertAbsentKey + ] + +bInsertPresentKeySameValue :: [Benchmark] +bInsertPresentKeySameValue = + [ bgroup'WithSizes sizes "Bytes" setupBytes b, + bgroup'WithSizes sizes "Int" setupInts b + ] + where + sizes = filter (/= 0) defaultSizes + b s = + bench (show s) + . whnf (\(m, kvs) -> foldl' (\() (k, v) -> HM.insert k v m `seq` ()) () kvs) + toKVs = take 1000 . Data.List.cycle . HM.toList + setupBytes size gen = do + m <- genBytesMap size gen + return (m, toKVs m) + setupInts size gen = do + m <- genIntMap size gen + return (m, toKVs m) + +bInsertPresentKeyDifferentValue :: [Benchmark] +bInsertPresentKeyDifferentValue = + [ bgroup'WithSizes sizes "Bytes" setupBytes b, + bgroup'WithSizes sizes "Int" setupInts b + ] + where + sizes = filter (/= 0) defaultSizes + b s = + bench (show s) + . whnf (\(m, kvs) -> foldl' (\() (k, v) -> HM.insert k v m `seq` ()) () kvs) + toKVs = take 1000 . Data.List.cycle . map (second (+ 1)) . HM.toList + setupBytes size gen = do + m <- genBytesMap size gen + return (m, toKVs m) + setupInts size gen = do + m <- genIntMap size gen + return (m, toKVs m) + +bInsertAbsentKey :: [Benchmark] +bInsertAbsentKey = + [ bgroup' "Bytes" setupBytes b, + bgroup' "Int" setupInts b + ] + where + b s = + bench (show s) + . whnf (\(m, kvs) -> foldl' (\() (k, v) -> HM.insert k v m `seq` ()) () kvs) + setupBytes size gen = do + m <- genBytesMap size gen + ks <- genNBytes 2000 bytesLength gen + let kvs = take 1000 $ Data.List.cycle $ map (,1) $ filter (not . flip HM.member m) ks + return (m, kvs) + setupInts size gen = do + m <- genIntMap size gen + ks <- genInts 2000 gen + let kvs = take 1000 $ Data.List.cycle $ map (,1) $ filter (not . flip HM.member m) ks + return (m, kvs) + +bUpdate :: Benchmark +bUpdate = + bgroup + "update (1000x)" + [ bgroup "presentKey" bUpdatePresentKey, + bgroup "absentKey" bUpdateAbsentKey + ] + +updateF :: Int -> Maybe Int +updateF x + | intPredicate x = Nothing + | x `mod` 3 == 0 = Just (x + 1) + | otherwise = Just x + +bUpdateAbsentKey :: [Benchmark] +bUpdateAbsentKey = + [ bgroup' "Bytes" setupBytes b, + bgroup' "Int" setupInts b + ] + where + b s = + bench (show s) + . whnf (\(m, ks) -> foldl' (\() k -> HM.update updateF k m `seq` ()) () ks) + setupBytes size gen = do + m <- genBytesMap size gen + ks <- genNBytes 2000 bytesLength gen + let ks' = take 1000 $ Data.List.cycle $ filter (not . flip HM.member m) ks + return (m, ks') + setupInts size gen = do + m <- genIntMap size gen + ks <- genInts 2000 gen + let ks' = take 1000 $ Data.List.cycle $ filter (not . flip HM.member m) ks + return (m, ks') + +bUpdatePresentKey :: [Benchmark] +bUpdatePresentKey = + [ bgroup'WithSizes sizes "Bytes" setupBytes b, + bgroup'WithSizes sizes "Int" setupInts b + ] + where + sizes = filter (/= 0) defaultSizes + b s = + bench (show s) + . whnf (\(m, ks) -> foldl' (\() k -> HM.update updateF k m `seq` ()) () ks) + toKs = take 1000 . Data.List.cycle . HM.keys + setupBytes size gen = do + m <- genBytesMap size gen + return (m, toKs m) + setupInts size gen = do + m <- genIntMap size gen + return (m, toKs m) + +bAlter :: Benchmark +bAlter = + bgroup + "alter (1000x)" + [ bgroup "presentKey" bAlterPresentKey, + bgroup "absentKey" bAlterAbsentKey + ] + +alterF' :: (Hashable k) => k -> Maybe Int -> Maybe Int +alterF' k Nothing + | intPredicate (hash k) = Nothing + | otherwise = Just (hash k) +alterF' k (Just v) + | odd n = Nothing + | intPredicate n = Just (n + 1) + | otherwise = Just v + where + n = hash k + v + +bAlterAbsentKey :: [Benchmark] +bAlterAbsentKey = + [ bgroup' "Bytes" setupBytes b, + bgroup' "Int" setupInts b + ] + where + b s = + bench (show s) + . whnf (\(m, ks) -> foldl' (\() k -> HM.alter (alterF' k) k m `seq` ()) () ks) + setupBytes size gen = do + m <- genBytesMap size gen + ks <- genNBytes 2000 bytesLength gen + let ks' = take 1000 $ Data.List.cycle $ filter (not . flip HM.member m) ks + return (m, ks') + setupInts size gen = do + m <- genIntMap size gen + ks <- genInts 2000 gen + let ks' = take 1000 $ Data.List.cycle $ filter (not . flip HM.member m) ks + return (m, ks') + +bAlterPresentKey :: [Benchmark] +bAlterPresentKey = + [ bgroup'WithSizes sizes "Bytes" setupBytes b, + bgroup'WithSizes sizes "Int" setupInts b + ] + where + sizes = filter (/= 0) defaultSizes + b s = + bench (show s) + . whnf (\(m, ks) -> foldl' (\() k -> HM.alter (alterF' k) k m `seq` ()) () ks) + toKs = take 1000 . Data.List.cycle . HM.keys + setupBytes size gen = do + m <- genBytesMap size gen + return (m, toKs m) + setupInts size gen = do + m <- genIntMap size gen + return (m, toKs m) + +-- 1000 deletions each, so we get more precise timings +bDelete :: Benchmark +bDelete = + bgroup + "delete (1000x)" + [ bgroup "presentKey" bDeletePresentKey, + bgroup "absentKey" bDeleteAbsentKey + ] + +bDeletePresentKey :: [Benchmark] +bDeletePresentKey = + [ bgroup'WithSizes sizes "Bytes" setupBytes b, + bgroup'WithSizes sizes "Int" setupInts b + ] + where + sizes = filter (/= 0) defaultSizes + b s = + bench (show s) + . whnf (\(m, ks) -> foldl' (\() k -> HM.delete k m `seq` ()) () ks) + toKs = take 1000 . Data.List.cycle . HM.keys + setupBytes size gen = do + m <- genBytesMap size gen + return (m, toKs m) + setupInts size gen = do + m <- genIntMap size gen + return (m, toKs m) + +bDeleteAbsentKey :: [Benchmark] +bDeleteAbsentKey = + [ bgroup' "Bytes" setupBytes b, + bgroup' "Int" setupInts b + ] + where + b s = + bench (show s) + . whnf (\(m, ks) -> foldl' (\() k -> HM.delete k m `seq` ()) () ks) + setupBytes size gen = do + m <- genBytesMap size gen + ks0 <- genNBytes 2000 bytesLength gen + let ks1 = take 1000 $ Data.List.cycle $ filter (not . flip HM.member m) ks0 + return (m, ks1) + setupInts size gen = do + m <- genIntMap size gen + ks0 <- genInts 2000 gen + let ks1 = take 1000 $ Data.List.cycle $ filter (not . flip HM.member m) ks0 + return (m, ks1) + +-- TODO: For the "overlap" and "equal" cases, it would be interesting to +-- have separate benchmarks both with and without shared subtrees, +-- so we can make use of pointer equality. +bUnion :: Benchmark +bUnion = + bgroup + "union" + [ bgroup "disjoint" bUnionDisjoint, + bgroup "overlap" bUnionOverlap, + bgroup "equal" bUnionEqual + ] + +bUnionDisjoint :: [Benchmark] +bUnionDisjoint = + [ bgroup' "Bytes" genBytesMapsDisjoint b, + bgroup' "Int" genIntMapsDisjoint b + ] + where + b s = bench (show s) . whnf (\(as, bs) -> HM.union as bs) + +bUnionOverlap :: [Benchmark] +bUnionOverlap = + [ bgroup' "Bytes" genBytesMapsOverlap b, + bgroup' "Int" genIntMapsOverlap b + ] + where + b s = bench (show s) . whnf (\(as, bs) -> HM.union as bs) + +bUnionEqual :: [Benchmark] +bUnionEqual = + [ bgroup' "Bytes" genBytesMap b, + bgroup' "Int" genIntMap b + ] + where + b size = bench (show size) . whnf (\m -> HM.union m m) + +bUnions :: Benchmark +bUnions = + bgroup + "unions" + [ bgroup'WithSizes sizes "Bytes" setupBytes b, + bgroup'WithSizes sizes "Int" setupInts b + ] + where + sizes = filter (>= 10) defaultSizes + b size = bench (show size) . whnf (\ms -> HM.unions ms) + setupBytes s gen = replicateM 10 (genBytesMap (s `div` 10) gen) + setupInts s gen = replicateM 10 (genBytesMap (s `div` 10) gen) + +-- TODO: For the "overlap" and "equal" cases, it would be interesting to +-- have separate benchmarks both with and without shared subtrees, +-- so we can make use of pointer equality. +bIntersection :: Benchmark +bIntersection = + bgroup + "intersection" + [ bgroup "disjoint" bIntersectionDisjoint, + bgroup "overlap" bIntersectionOverlap, + bgroup "equal" bIntersectionEqual + ] + +bIntersectionDisjoint :: [Benchmark] +bIntersectionDisjoint = + [ bgroup' "Bytes" genBytesMapsDisjoint b, + bgroup' "Int" genIntMapsDisjoint b + ] + where + b size = bench (show size) . whnf (\(xs, ys) -> HM.intersection xs ys) + +bIntersectionOverlap :: [Benchmark] +bIntersectionOverlap = + [ bgroup' "Bytes" genBytesMapsOverlap b, + bgroup' "Int" genIntMapsOverlap b + ] + where + b size = bench (show size) . whnf (\(xs, ys) -> HM.intersection xs ys) + +bIntersectionEqual :: [Benchmark] +bIntersectionEqual = + [ bgroup' "Bytes" genBytesMap b, + bgroup' "Int" genIntMap b + ] + where + b size = bench (show size) . whnf (\m -> HM.intersection m m) + +-- TODO: For the "overlap" and "equal" cases, it would be interesting to +-- have separate benchmarks both with and without shared subtrees, +-- so we can make use of pointer equality. +bDifference :: Benchmark +bDifference = + bgroup + "difference" + [ bgroup "disjoint" bDifferenceDisjoint, + bgroup "overlap" bDifferenceOverlap, + bgroup "equal" bDifferenceEqual + ] + +bDifferenceDisjoint :: [Benchmark] +bDifferenceDisjoint = + [ bgroup' "Bytes" genBytesMapsDisjoint b, + bgroup' "Int" genIntMapsDisjoint b + ] + where + b size = bench (show size) . whnf (\(xs, ys) -> HM.difference xs ys) + +bDifferenceOverlap :: [Benchmark] +bDifferenceOverlap = + [ bgroup' "Bytes" genBytesMapsOverlap b, + bgroup' "Int" genIntMapsOverlap b + ] + where + b size = bench (show size) . whnf (\(xs, ys) -> HM.difference xs ys) + +bDifferenceEqual :: [Benchmark] +bDifferenceEqual = + [ bgroup' "Bytes" genBytesMap b, + bgroup' "Int" genIntMap b + ] + where + b size = bench (show size) . whnf (\m -> HM.difference m m) + +bDifferenceWith :: Benchmark +bDifferenceWith = + bgroup + "differenceWith" + [ bgroup "disjoint" bDifferenceWithDisjoint, + bgroup "overlap" bDifferenceWithOverlap, + bgroup "equal" bDifferenceWithEqual + ] + +differenceWithF :: Int -> Int -> Maybe Int +differenceWithF x y = Just (x + y) + +bDifferenceWithDisjoint :: [Benchmark] +bDifferenceWithDisjoint = + [ bgroup' "Bytes" genBytesMapsDisjoint b, + bgroup' "Int" genIntMapsDisjoint b + ] + where + b size = bench (show size) . whnf (\(xs, ys) -> HM.differenceWith differenceWithF xs ys) + +bDifferenceWithOverlap :: [Benchmark] +bDifferenceWithOverlap = + [ bgroup' "Bytes" genBytesMapsOverlap b, + bgroup' "Int" genIntMapsOverlap b + ] + where + b size = bench (show size) . whnf (\(xs, ys) -> HM.differenceWith differenceWithF xs ys) + +bDifferenceWithEqual :: [Benchmark] +bDifferenceWithEqual = + [ bgroup' "Bytes" genBytesMap b, + bgroup' "Int" genIntMap b + ] + where + b size = bench (show size) . whnf (\m -> HM.differenceWith differenceWithF m m) + +bSetFromList :: Benchmark +bSetFromList = + bgroup + "fromList" + [ bgroup' "Bytes" (\s gen -> genNBytes s bytesLength gen) b, + bgroup' "Int" genInts b + ] + where + b size = bench (show size) . whnf Data.HashSet.fromList + +------------------------------------------------------------------------------- +-- Boilerplate + +bgroup' :: + (NFData env) => + String -> + (Int -> IOGenM StdGen -> IO env) -> + (Int -> env -> Benchmark) -> + Benchmark +bgroup' = bgroup'WithSizes defaultSizes + +bgroup'WithSizes :: + (NFData env) => + [Int] -> + String -> + (Int -> IOGenM StdGen -> IO env) -> + (Int -> env -> Benchmark) -> + Benchmark +bgroup'WithSizes sizes name setup b = bgroup name [env' setup b s | s <- sizes] + +env' :: + (NFData env) => + (Int -> IOGenM StdGen -> IO env) -> + (Int -> env -> Benchmark) -> + Int -> + Benchmark +env' setup b size = + env + ( do + gen <- newIOGenM defaultGen + setup size gen + ) + (b size) + +------------------------------------------------------------------------------- +-- Generators + +keysToMap :: (Hashable k) => [k] -> HashMap k Int +keysToMap = HM.fromList . map (\k -> (k, hashWithSalt 123 k)) + +genInts :: + (StatefulGen g m) => + Int -> + g -> + m [Int] +genInts n = replicateM n . uniformM + +genBytesMap :: (StatefulGen g m) => Int -> g -> m (HashMap Bytes Int) +genBytesMap s gen = do + ks <- Key.Bytes.genNBytes s bytesLength gen + return (keysToMap ks) + +genIntMap :: (StatefulGen g m) => Int -> g -> m (HashMap Int Int) +genIntMap s gen = do + ks <- genInts s gen + return (keysToMap ks) + +genBytesMapsOverlap :: + (StatefulGen g m) => + Int -> g -> m (HashMap Bytes Int, HashMap Bytes Int) +genBytesMapsOverlap s gen = do + (trues, falses) <- Key.Bytes.genDisjoint s bytesLength gen + let (a_sep, b_sep) = splitAt (s `div` 4) trues + return + ( keysToMap falses `HM.union` keysToMap a_sep, + keysToMap falses `HM.union` keysToMap b_sep + ) + +genIntMapsOverlap :: + (StatefulGen g m) => + Int -> g -> m (HashMap Int Int, HashMap Int Int) +genIntMapsOverlap s gen = do + let s_overlap = s `div` 2 + let s_a_sep = (s - s_overlap) `div` 2 + let s_b_sep = s - s_overlap - s_a_sep + overlap <- genInts s_overlap gen + a_sep <- genInts s_a_sep gen + b_sep <- genInts s_b_sep gen + return + ( keysToMap overlap `HM.union` keysToMap a_sep, + keysToMap overlap `HM.union` keysToMap b_sep + ) + +genIntMapsDisjoint :: + (StatefulGen g m) => + Int -> g -> m (HashMap Int Int, HashMap Int Int) +genIntMapsDisjoint s gen = do + ints <- genInts s gen + let (trues, falses) = Data.List.partition intPredicate ints + return (keysToMap trues, keysToMap falses) + +genBytesMapsDisjoint :: + (StatefulGen g m) => + Int -> g -> m (HashMap Bytes Int, HashMap Bytes Int) +genBytesMapsDisjoint s gen = do + (trues, falses) <- Key.Bytes.genDisjoint s bytesLength gen + return (keysToMap trues, keysToMap falses) + +intPredicate :: Int -> Bool +intPredicate n = testBit n 31 diff --git a/benchmarks/Key/Bytes.hs b/benchmarks/Key/Bytes.hs new file mode 100644 --- /dev/null +++ b/benchmarks/Key/Bytes.hs @@ -0,0 +1,46 @@ +{-# LANGUAGE GeneralizedNewtypeDeriving #-} + +module Key.Bytes where + +import Control.DeepSeq +import Control.Monad (replicateM) +import Data.ByteString.Short +import Data.Hashable +import Data.List +import System.Random.Stateful + +newtype Bytes = Bytes {unBytes :: ShortByteString} + deriving (Eq, Hashable, Show, NFData) + +genBytes :: + (StatefulGen g m) => + Int -> + g -> + m Bytes +genBytes len gen = Bytes <$> uniformShortByteStringM len gen + +genNBytes :: + (StatefulGen g m) => + Int -> + Int -> + g -> + m [Bytes] +genNBytes n len = replicateM n . genBytes len + +-- | @genDisjoint n len gen@ generates @n@ 'Bytes' in total. The returned lists +-- each contain roughly half of the total. +genDisjoint :: + (StatefulGen g m) => + Int -> + -- | Must be positive + Int -> + g -> + m ([Bytes], [Bytes]) +genDisjoint n len gen = Data.List.partition predicate <$> genNBytes n len gen + where + predicate (Bytes sbs) = even (Data.ByteString.Short.head sbs) + +{- +instance Uniform Bytes where + uniformM = genBytes 32 +-} diff --git a/tests/Main.hs b/tests/Main.hs --- a/tests/Main.hs +++ b/tests/Main.hs @@ -1,7 +1,7 @@ module Main (main) where import GHC.IO.Encoding (setLocaleEncoding, utf8) -import Test.Tasty (defaultMain, testGroup) +import Test.Tasty (defaultMain, testGroup) import qualified Properties import qualified Regressions diff --git a/tests/Properties/HashMapLazy.hs b/tests/Properties/HashMapLazy.hs --- a/tests/Properties/HashMapLazy.hs +++ b/tests/Properties/HashMapLazy.hs @@ -24,6 +24,7 @@ import Data.Functor.Identity (Identity (..)) import Data.Hashable (Hashable (hashWithSalt)) import Data.HashMap.Internal.Debug (Validity (..), valid) +import Data.Maybe (isJust) import Data.Ord (comparing) import Test.QuickCheck (Arbitrary (..), Fun, Property, pattern Fn, pattern Fn2, pattern Fn3, (===), (==>)) @@ -46,7 +47,7 @@ import qualified Data.Map.Lazy as M #endif -instance (Eq k, Hashable k, Arbitrary k, Arbitrary v) => Arbitrary (HashMap k v) where +instance (Hashable k, Arbitrary k, Arbitrary v) => Arbitrary (HashMap k v) where arbitrary = HM.fromList <$> arbitrary shrink = fmap HM.fromList . shrink . HM.toList @@ -62,7 +63,7 @@ toOrdMap :: Ord k => HashMap k v -> M.Map k v toOrdMap = M.fromList . HM.toList -isValid :: (Eq k, Hashable k, Show k) => HashMap k v -> Property +isValid :: (Hashable k, Show k) => HashMap k v -> Property isValid m = valid m === Valid -- The free magma is used to test that operations are applied in the @@ -173,6 +174,10 @@ \(k :: Key) (m :: HMKI) -> HM.lookup k m === M.lookup k (toOrdMap m) , testProperty "!?" $ \(k :: Key) (m :: HMKI) -> m HM.!? k === M.lookup k (toOrdMap m) + , testGroup "lookupKey" $ + [ testProperty "isJust (lookupKey k m) == member k m" $ + \(k :: Key) (m :: HMKI) -> isJust (HM.lookupKey k m) === HM.member k m + ] , testGroup "insert" [ testProperty "model" $ \(k :: Key) (v :: Int) x -> @@ -182,7 +187,7 @@ \(k :: Key) (v :: Int) x -> isValid (HM.insert k v x) ] , testGroup "insertWith" - [ testProperty "insertWith" $ + [ testProperty "model" $ \(Fn2 f) k v (x :: HMKI) -> toOrdMap (HM.insertWith f k v x) === M.insertWith f k v (toOrdMap x) , testProperty "valid" $ @@ -256,19 +261,8 @@ \(x :: HMKI) y -> HM.isSubmapOf x y === M.isSubmapOf (toOrdMap x) (toOrdMap y) , testProperty "m ⊆ m" $ \(x :: HMKI) -> HM.isSubmapOf x x - , testProperty "m1 ⊆ m1 ∪ m2" $ - \(x :: HMKI) y -> HM.isSubmapOf x (HM.union x y) - , testProperty "m1\\m2 ⊆ m1" $ - \(m1 :: HMKI) (m2 :: HMKI) -> HM.isSubmapOf (HM.difference m1 m2) m1 - , testProperty "m1 ∩ m2 ≠ ∅ ⇒ m1 ⊈ m1\\m2 " $ - \(m1 :: HMKI) (m2 :: HMKI) -> - not (HM.null (HM.intersection m1 m2)) ==> - not (HM.isSubmapOf m1 (HM.difference m1 m2)) , testProperty "delete k m ⊆ m" $ - \(m :: HMKI) -> - not (HM.null m) ==> - QC.forAll (QC.elements (HM.keys m)) $ \k -> - HM.isSubmapOf (HM.delete k m) m + \k (m :: HMKI) -> HM.isSubmapOf (HM.delete k m) m , testProperty "m ⊈ delete k m " $ \(m :: HMKI) -> not (HM.null m) ==> @@ -321,7 +315,22 @@ toOrdMap (HM.differenceWith f x y) === M.differenceWith f (toOrdMap x) (toOrdMap y) , testProperty "valid" $ \(Fn2 f) (x :: HMK A) (y :: HMK B) -> isValid (HM.differenceWith f x y) + , testProperty "differenceWith (\\x y -> Just $ f x y) xs ys == intersectionWith f xs ys `union` xs" $ + \(Fn2 f) (x :: HMK A) (y :: HMK B) -> + HM.differenceWith (\a b -> Just $ f a b) x y + === HM.intersectionWith f x y `HM.union` x ] + , testGroup "differenceWithKey" + [ testProperty "model" $ + \(Fn3 f) (x :: HMK A) (y :: HMK B) -> + toOrdMap (HM.differenceWithKey f x y) === M.differenceWithKey f (toOrdMap x) (toOrdMap y) + , testProperty "valid" $ + \(Fn3 f) (x :: HMK A) (y :: HMK B) -> isValid (HM.differenceWithKey f x y) + , testProperty "differenceWithKey (\\k x y -> Just $ f k x y) xs ys == intersectionWithKey f xs ys `union` xs" $ + \(Fn3 f) (x :: HMK A) (y :: HMK B) -> + HM.differenceWithKey (\k a b -> Just $ f k a b) x y + === HM.intersectionWithKey f x y `HM.union` x + ] , testGroup "intersection" [ testProperty "model" $ \(x :: HMKI) (y :: HMKI) -> @@ -348,6 +357,11 @@ \(Fn3 f :: Fun (Key, A, B) C) (x :: HMK A) (y :: HMK B) -> isValid (HM.intersectionWithKey f x y) ] + , testGroup "disjoint" + [ testProperty "model" $ + \(x :: HMKI) (y :: HMKI) -> + HM.disjoint x y === M.disjoint (toOrdMap x) (toOrdMap y) + ] , testGroup "compose" [ testProperty "valid" $ \(x :: HMK Int) (y :: HMK Key) -> isValid (HM.compose x y) @@ -360,12 +374,12 @@ \(Fn f :: Fun A B) (m :: HMK A) -> isValid (HM.map f m) ] , testGroup "traverseWithKey" - [ testProperty "model" $ QC.mapSize (\s -> s `div` 8) $ + [ testProperty "model" $ QC.mapSize (\s -> min 18 $ div s 8) $ \(x :: HMKI) -> let f k v = [keyToInt k + v + 1, keyToInt k + v + 2] ys = HM.traverseWithKey f x in List.sort (fmap toOrdMap ys) === List.sort (M.traverseWithKey f (toOrdMap x)) - , testProperty "valid" $ QC.mapSize (\s -> s `div` 8) $ + , testProperty "valid" $ QC.mapSize (\s -> min 18 $ div s 8) $ \(x :: HMKI) -> let f k v = [keyToInt k + v + 1, keyToInt k + v + 2] ys = HM.traverseWithKey f x diff --git a/tests/Properties/HashSet.hs b/tests/Properties/HashSet.hs --- a/tests/Properties/HashSet.hs +++ b/tests/Properties/HashSet.hs @@ -27,11 +27,11 @@ import qualified Data.Set as S import qualified Test.QuickCheck as QC -instance (Eq k, Hashable k, Arbitrary k, Arbitrary v) => Arbitrary (HashMap k v) where +instance (Hashable k, Arbitrary k, Arbitrary v) => Arbitrary (HashMap k v) where arbitrary = HM.fromList <$> arbitrary shrink = fmap HM.fromList . shrink . HM.toList -instance (Eq a, Hashable a, Arbitrary a) => Arbitrary (HashSet a) where +instance (Hashable a, Arbitrary a) => Arbitrary (HashSet a) where arbitrary = HS.fromMap <$> arbitrary shrink = fmap HS.fromMap . shrink . HS.toMap diff --git a/tests/Regressions.hs b/tests/Regressions.hs --- a/tests/Regressions.hs +++ b/tests/Regressions.hs @@ -4,6 +4,7 @@ {-# LANGUAGE ScopedTypeVariables #-} {-# LANGUAGE TypeApplications #-} {-# LANGUAGE UnboxedTuples #-} +{-# OPTIONS_GHC -Wno-x-partial #-} module Regressions (tests) where import Control.Exception (evaluate) @@ -29,12 +30,8 @@ import qualified Data.HashSet as HS import qualified Test.Tasty as Tasty -#if MIN_VERSION_base(4,12,0) --- nothunks requires base >= 4.12 -#define HAVE_NOTHUNKS import qualified Data.Foldable as Foldable import NoThunks.Class (noThunksInValues) -#endif issue32 :: Assertion issue32 = assert $ isJust $ HMS.lookup 7 m' @@ -141,7 +138,6 @@ ------------------------------------------------------------------------ -- Issue #379 -#ifdef HAVE_NOTHUNKS issue379Union :: Assertion issue379Union = do @@ -167,8 +163,6 @@ mThunkInfo <- noThunksInValues mempty (Foldable.toList u) assert $ isNothing mThunkInfo -#endif - -- Another key type that always collides. -- -- Note (sjakobi): The KC newtype of Int somehow can't be used to demonstrate @@ -196,8 +190,6 @@ ------------------------------------------------------------------------ -- Issue #381 -#ifdef HAVE_NOTHUNKS - issue381mapMaybe :: Assertion issue381mapMaybe = do let m0 = HMS.fromList [(KC 1, 10), (KC 2, 20 :: Int)] @@ -212,8 +204,6 @@ mThunkInfo <- noThunksInValues mempty (Foldable.toList m1) assert $ isNothing mThunkInfo -#endif - ------------------------------------------------------------------------ -- Issue #382 @@ -234,8 +224,6 @@ ------------------------------------------------------------------------ -- Issue #383 -#ifdef HAVE_NOTHUNKS - -- Custom Functor to prevent interference from alterF rules newtype MyIdentity a = MyIdentity a instance Functor MyIdentity where @@ -250,8 +238,6 @@ mThunkInfo <- noThunksInValues mempty (Foldable.toList m) assert $ isNothing mThunkInfo -#endif - ------------------------------------------------------------------------ -- Issue #420 @@ -288,22 +274,16 @@ , testCase "issue254 strict" issue254Strict , testGroup "issue379" [ testCase "Lazy.unionWith" issue379LazyUnionWith -#ifdef HAVE_NOTHUNKS , testCase "union" issue379Union , testCase "Strict.unionWith" issue379StrictUnionWith , testCase "Strict.unionWithKey" issue379StrictUnionWithKey -#endif ] -#ifdef HAVE_NOTHUNKS , testGroup "issue381" [ testCase "mapMaybe" issue381mapMaybe , testCase "mapMaybeWithKey" issue381mapMaybeWithKey ] -#endif , testCase "issue382" issue382 -#ifdef HAVE_NOTHUNKS , testCase "issue383" issue383 -#endif , testCase "issue420" issue420 , issue491 ] diff --git a/tests/Strictness.hs b/tests/Strictness.hs --- a/tests/Strictness.hs +++ b/tests/Strictness.hs @@ -4,7 +4,7 @@ import Control.Arrow (second) import Control.Monad (guard) -import Data.Foldable (foldl') +import Data.Foldable (Foldable (..)) import Data.Hashable (Hashable) import Data.HashMap.Strict (HashMap) import Data.Maybe (fromMaybe, isJust) @@ -17,9 +17,11 @@ import Text.Show.Functions () import Util.Key (Key) +import Prelude hiding (Foldable (..)) + import qualified Data.HashMap.Strict as HM -instance (Eq k, Hashable k, Arbitrary k, Arbitrary v) => Arbitrary (HashMap k v) where +instance (Hashable k, Arbitrary k, Arbitrary v) => Arbitrary (HashMap k v) where arbitrary = HM.fromList <$> arbitrary shrink = fmap HM.fromList . shrink . HM.toList diff --git a/tests/Util/Key.hs b/tests/Util/Key.hs --- a/tests/Util/Key.hs +++ b/tests/Util/Key.hs @@ -1,5 +1,6 @@ {-# LANGUAGE DeriveAnyClass #-} {-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE MagicHash #-} {-# LANGUAGE TypeApplications #-} module Util.Key (Key(..), keyToInt, incKey, collisionAtHash) where @@ -7,6 +8,7 @@ import Data.Bits (bit, (.&.)) import Data.Hashable (Hashable (hashWithSalt)) import Data.Word (Word16) +import GHC.Exts (Int (..), bitReverse#, int2Word#, word2Int#) import GHC.Generics (Generic) import Test.QuickCheck (Arbitrary (..), CoArbitrary (..), Function, Gen, Large) @@ -51,8 +53,8 @@ , (1, QC.elements [-1, 0xFF, 0xFFF]) ] i <- QC.frequency gens - moreCollisions' <- QC.elements [moreCollisions, id] - pure (moreCollisions' i) + transform <- QC.elements [id, moreCollisions, bitReverse] + pure (transform i) -- | Mask out most bits to produce more collisions moreCollisions :: Int -> Int @@ -61,6 +63,11 @@ -- | Bitmask for @moreCollisions@ moreCollisionsMask :: Int moreCollisionsMask = sum [bit n | n <- [0, 3, 8, 14, 61]] + +-- | Reverse order of bits, in order to generate variation in the +-- high bits, resulting in HashMap trees of greater height. +bitReverse :: Int -> Int +bitReverse (I# i) = I# (word2Int# (bitReverse# (int2Word# i))) keyToInt :: Key -> Int keyToInt (K h x) = h * fromEnum x diff --git a/unordered-containers.cabal b/unordered-containers.cabal --- a/unordered-containers.cabal +++ b/unordered-containers.cabal @@ -1,5 +1,5 @@ name: unordered-containers -version: 0.2.20.1 +version: 0.2.21 synopsis: Efficient hashing-based container types description: Efficient hashing-based container types. The containers have been @@ -13,7 +13,7 @@ . This package currently provides no defenses against hash collision attacks such as HashDoS. - Users who need to store input from untrusted sources are advised to use + Users who need to store keys derived from untrusted input are advised to use @Data.Map@ or @Data.Set@ from the @containers@ package instead. license: BSD3 license-file: LICENSE @@ -37,10 +37,6 @@ || ==9.2.8 || ==9.0.2 || ==8.10.7 - || ==8.8.4 - || ==8.6.5 - || ==8.4.4 - || ==8.2.2 flag debug description: Enable debug support @@ -59,10 +55,12 @@ Data.HashSet.Internal build-depends: - base >= 4.10 && < 5, + base >= 4.14 && < 5, deepseq >= 1.4.3, - hashable >= 1.4 && < 1.6, - template-haskell < 2.24 + hashable >= 1.4 && < 1.6 + if impl(ghc) + build-depends: + template-haskell >= 2.16 && < 2.24 default-language: Haskell2010 @@ -75,11 +73,6 @@ ghc-options: -Wall -O2 -fwarn-tabs -ferror-spans - -- For dumping the generated code: - -- ghc-options: -ddump-simpl -ddump-stg-final -ddump-cmm -ddump-asm -ddump-to-file - -- ghc-options: -dsuppress-coercions -dsuppress-unfoldings -dsuppress-module-prefixes - -- ghc-options: -dsuppress-uniques -dsuppress-timestamps - if flag(debug) cpp-options: -DASSERTS @@ -104,21 +97,18 @@ hashable, HUnit, QuickCheck >= 2.4.0.1, + nothunks >= 0.1.3, random, tasty >= 1.4.0.3, tasty-hunit >= 0.10.0.3, tasty-quickcheck >= 0.10.1.2, unordered-containers - if impl(ghc >= 8.6) - build-depends: - nothunks >= 0.1.3 - default-language: Haskell2010 ghc-options: -Wall -threaded -rtsopts -with-rtsopts=-N cpp-options: -DASSERTS -benchmark benchmarks +benchmark package-comparisons hs-source-dirs: benchmarks main-is: Benchmarks.hs type: exitcode-stdio-1.0 @@ -135,16 +125,33 @@ deepseq, hashable, hashmap, - mtl, random, tasty-bench >= 0.3.1, unordered-containers default-language: Haskell2010 - ghc-options: -Wall -O2 -rtsopts -with-rtsopts=-A32m - if impl(ghc >= 8.10) - ghc-options: "-with-rtsopts=-A32m --nonmoving-gc" + ghc-options: -Wall -O2 -rtsopts "-with-rtsopts=-A32m" -fproc-alignment=64 -- cpp-options: -DBENCH_containers_Map -DBENCH_containers_IntMap -DBENCH_hashmap_Map + +benchmark fine-grained + hs-source-dirs: benchmarks + main-is: FineGrained.hs + type: exitcode-stdio-1.0 + + other-modules: + Key.Bytes + + build-depends: + base, + bytestring >= 0.11.3, + deepseq, + hashable, + random, + tasty-bench, + unordered-containers + + default-language: Haskell2010 + ghc-options: -Wall -O2 -rtsopts "-with-rtsopts=-A64m" -fproc-alignment=64 source-repository head type: git