Moduleghc-10.0.0.20260917GHC2024

GHC.Types.Unique.DFM

1 type
53 values

Packageghc-10.0.0.20260917
Exports54
LanguageGHC2024
LicenceBSD-3-Clause
SourceDFM.hs

Unique-keyed deterministic mappings

1 declaration

datadata UniqDFM (key :: k) ele

Type of unique deterministic finite maps

The key is just here to keep us honest. It's always safe to use a single type as key. If two types don't overlap in their uniques it's also safe to index the same map at multiple key types. But this is very much discouraged.

Instances7Functor, Foldable, Traversable, TrieMap, Data, Outputable, …

Functor (UniqDFM key)Defined in ghc-10.0.0.20260917 · GHC.Types.Unique.DFM
Foldable (UniqDFM key)Defined in ghc-10.0.0.20260917 · GHC.Types.Unique.DFM
Deterministic, in O(n log n).
Traversable (UniqDFM key)Defined in ghc-10.0.0.20260917 · GHC.Types.Unique.DFM
Deterministic, in O(n log n).
Uniquable key => TrieMap (UniqDFM key)Defined in ghc-10.0.0.20260917 · GHC.Data.TrieMap
(Typeable key, Typeable k, Data ele) => Data (UniqDFM key ele)Defined in ghc-10.0.0.20260917 · GHC.Types.Unique.DFM
Outputable a => Outputable (UniqDFM key a)Defined in ghc-10.0.0.20260917 · GHC.Types.Unique.DFM
type Key (UniqDFM key) = keyDefined in ghc-10.0.0.20260917 · GHC.Data.TrieMap

Manipulating those mappings

valueemptyUDFM :: UniqDFM key elt

valueunitUDFM :: Uniquable key => key -> elt -> UniqDFM key elt

valueaddToUDFM

:: Uniquable key
=> UniqDFM key elt
-> key
-> elt
-> UniqDFM key elt

valueaddToUDFM_C

:: Uniquable key
=> elt -> elt -> elt
-> UniqDFM key elt
-> key
-> elt
-> UniqDFM key elt

valueaddToUDFM_C_Directly

:: elt -> elt -> elt
-> UniqDFM key elt
-> Unique
-> elt
-> UniqDFM key elt

valueaddToUDFM_Directly :: UniqDFM key elt -> Unique -> elt -> UniqDFM key elt

valueaddListToUDFM

:: Uniquable key
=> UniqDFM key elt
-> [(key, elt)]
-> UniqDFM key elt

valuedelFromUDFM :: Uniquable key => UniqDFM key elt -> key -> UniqDFM key elt

valuedelListFromUDFM

:: Uniquable key
=> UniqDFM key elt
-> [key]
-> UniqDFM key elt

Delete a list of elements from a UniqDFM

valueadjustUDFM

:: Uniquable key
=> elt -> elt
-> UniqDFM key elt
-> key
-> UniqDFM key elt

Apply a function to a particular element

valueadjustUDFM_Directly

:: elt -> elt
-> UniqDFM key elt
-> Unique
-> UniqDFM key elt

Apply a function to a particular element

valueupsertUDFM

:: Uniquable key
=> (Maybe elt -> elt)
How to adjust the element
-> UniqDFM key elt
Old UniqDFM
-> key
key of the element to adjust
-> UniqDFM key elt
New element at key and modified UniqDFM

The expression (upsertUDFM f map k) updates the value at k or inserts a new value if k is absent.

Updating an existing entry keeps its original tag, so its position in deterministic iteration order is unchanged and does not depend on update order.

valuealterUDFM

:: Uniquable key
=> (Maybe elt -> Maybe elt)
How to adjust the element
-> UniqDFM key elt
Old UniqDFM
-> key
key of the element to adjust
-> UniqDFM key elt
New element at key and modified UniqDFM

The expression (alterUDFM f map k) alters value x at k, or absence thereof. alterUDFM can be used to insert, delete, or update a value in UniqDFM. Use addToUDFM, delFromUDFM or adjustUDFM when possible, they are more efficient. Updating an existing key keeps its position in the deterministic iteration order.

alterUDFM is non-strict in k.

valuealterUDFM_L

:: Uniquable key
=> (Maybe elt -> Maybe elt)
How to adjust the element
-> UniqDFM key elt
Old UniqDFM
-> key
key of the element to adjust
-> (Maybe elt, UniqDFM key elt)
New element at key and modified UniqDFM

The expression (alterUDFM_L f map k) alters value x at k, or absence thereof and returns the new element at k if there is any. alterUDFM_L can be used to insert, delete, or update a value in UniqDFM. Use addToUDFM, delFromUDFM or adjustUDFM when possible, they are more efficient. Updating an existing key keeps its position in the deterministic iteration order.

Note, alterUDFM_L is strict in k.

valuemapUDFM :: (elt1 -> elt2) -> UniqDFM key elt1 -> UniqDFM key elt2

Map a function over every value in a UniqDFM

valuemapMaybeUDFM :: (elt1 -> Maybe elt2) -> UniqDFM key elt1 -> UniqDFM key elt2

valuemapMUDFM

:: Monad m
=> elt1 -> m elt2
-> UniqDFM key elt1
-> m (UniqDFM key elt2)

mapM for a UniqDFM.

valueplusUDFM :: UniqDFM key elt -> UniqDFM key elt -> UniqDFM key elt

valueplusUDFM_C

:: elt -> elt -> elt
-> UniqDFM key elt
-> UniqDFM key elt
-> UniqDFM key elt

valueplusUDFM_CK

:: Unique -> elt -> elt -> elt
-> UniqDFM key elt
-> UniqDFM key elt
-> UniqDFM key elt

Like plusUDFM_C but the combine function also receives the unique key

valuelookupUDFM :: Uniquable key => UniqDFM key elt -> key -> Maybe elt

valuelookupUDFM_Directly :: UniqDFM key elt -> Unique -> Maybe elt

valueelemUDFM :: Uniquable key => key -> UniqDFM key elt -> Bool

valuefoldUDFM :: (elt -> a -> a) -> a -> UniqDFM key elt -> a

Performs a deterministic fold over the UniqDFM. It's O(n log n) while the corresponding function on UniqFM is O(n).

valuefoldWithKeyUDFM :: (Unique -> elt -> a -> a) -> a -> UniqDFM key elt -> a

Like foldUDFM but the function also receives a key

valueeltsUDFM :: UniqDFM key elt -> [elt]

valuefilterUDFM :: (elt -> Bool) -> UniqDFM key elt -> UniqDFM key elt

valuefilterUDFM_Directly

:: Unique -> elt -> Bool
-> UniqDFM key elt
-> UniqDFM key elt

valueisNullUDFM :: UniqDFM key elt -> Bool

valuesizeUDFM :: UniqDFM key elt -> Int

valueintersectUDFM :: UniqDFM key elt -> UniqDFM key elt -> UniqDFM key elt

valueudfmIntersectUFM :: UniqDFM key elt1 -> UniqFM key elt2 -> UniqDFM key elt1

valuedisjointUDFM :: UniqDFM key elt -> UniqDFM key elt -> Bool

valuedisjointUdfmUfm :: UniqDFM key elt -> UniqFM key elt2 -> Bool

valueequalKeysUDFM :: UniqDFM key a -> UniqDFM key b -> Bool

valueminusUDFM :: UniqDFM key elt1 -> UniqDFM key elt2 -> UniqDFM key elt1

valuelistToUDFM :: Uniquable key => [(key, elt)] -> UniqDFM key elt

valuelistToUDFM_Directly :: [(Unique, elt)] -> UniqDFM key elt

valuelistToUDFM_C_Directly

:: elt -> elt -> elt
-> [(Unique, elt)]
-> UniqDFM key elt

valueudfmMinusUFM :: UniqDFM key elt1 -> UniqFM key elt2 -> UniqDFM key elt1

valueufmMinusUDFM :: UniqFM key elt1 -> UniqDFM key elt2 -> UniqFM key elt1

valuepartitionUDFM

:: elt -> Bool
-> UniqDFM key elt
-> (UniqDFM key elt, UniqDFM key elt)

Partition UniqDFM into two UniqDFMs according to the predicate

valueudfmRestrictKeys :: UniqDFM key elt -> UniqDFM key elt2 -> UniqDFM key elt

valueudfmRestrictKeysSet :: UniqDFM key elt -> Word64Set -> UniqDFM key elt

valueanyUDFM :: (elt -> Bool) -> UniqDFM key elt -> Bool

valueallUDFM :: (elt -> Bool) -> UniqDFM key elt -> Bool

valuepprUniqDFM :: (a -> SDoc) -> UniqDFM key a -> SDoc

valuepprUDFM

:: UniqDFM key a
The things to be pretty printed
-> ([a] -> SDoc)
The pretty printing function to use on the elements
-> SDoc
SDoc where the things have been pretty printed

valueudfmToList :: UniqDFM key elt -> [(Unique, elt)]

Converts UniqDFM to a list, with elements in deterministic order. It's O(n log n) while the corresponding function on UniqFM is O(n).

valueudfmToUfm :: UniqDFM key elt -> UniqFM key elt

This allows for lossy conversion from UniqDFM to UniqFM

valuenonDetStrictFoldUDFM :: (elt -> a -> a) -> a -> UniqDFM key elt -> a

Performs a nondeterministic strict fold over the UniqDFM. It's O(n), same as the corresponding function on UniqFM. If you use this please provide a justification why it doesn't introduce nondeterminism.

valueunsafeCastUDFMKey :: UniqDFM key1 elt -> UniqDFM key2 elt

Cast the key domain of a UniqFM.

As long as the domains don't overlap in their uniques this is safe.

valuealwaysUnsafeUfmToUdfm :: UniqFM key elt -> UniqDFM key elt