GHC.Types.Unique.FM

Unique-keyed mappings

data UniqFM key ele

A finite map from uniques of one type to elements in another type.

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.

Instances

Functor (UniqFM key)

Defined in GHC.Types.Unique.FM

Methods

fmap :: (a -> b) -> UniqFM key a -> UniqFM key b

(<$) :: a -> UniqFM key b -> UniqFM key a

(Data key, Data ele) => Data (UniqFM key ele)

Defined in GHC.Types.Unique.FM

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UniqFM key ele -> c (UniqFM key ele)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (UniqFM key ele)

toConstr :: UniqFM key ele -> Constr

dataTypeOf :: UniqFM key ele -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (UniqFM key ele))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (UniqFM key ele))

gmapT :: (forall b. Data b => b -> b) -> UniqFM key ele -> UniqFM key ele

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UniqFM key ele -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UniqFM key ele -> r

gmapQ :: (forall d. Data d => d -> u) -> UniqFM key ele -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UniqFM key ele -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UniqFM key ele -> m (UniqFM key ele)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UniqFM key ele -> m (UniqFM key ele)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UniqFM key ele -> m (UniqFM key ele)

Monoid (UniqFM key a)

Defined in GHC.Types.Unique.FM

Methods

mempty :: UniqFM key a

mappend :: UniqFM key a -> UniqFM key a -> UniqFM key a

mconcat :: [UniqFM key a] -> UniqFM key a

Semigroup (UniqFM key a)

Defined in GHC.Types.Unique.FM

Methods

(<>) :: UniqFM key a -> UniqFM key a -> UniqFM key a

sconcat :: NonEmpty (UniqFM key a) -> UniqFM key a

stimes :: Integral b => b -> UniqFM key a -> UniqFM key a

Outputable a => Outputable (UniqFM key a)

Defined in GHC.Types.Unique.FM

Methods

ppr :: UniqFM key a -> SDoc

Eq ele => Eq (UniqFM key ele)

Defined in GHC.Types.Unique.FM

Methods

(==) :: UniqFM key ele -> UniqFM key ele -> Bool

(/=) :: UniqFM key ele -> UniqFM key ele -> Bool

newtype NonDetUniqFM key ele

A wrapper around UniqFM with the sole purpose of informing call sites that the provided Foldable and Traversable instances are nondeterministic. If you use this please provide a justification why it doesn't introduce nondeterminism. See Note [Deterministic UniqFM] in GHC.Types.Unique.DFM to learn about determinism.

Constructors

NonDetUniqFM

Fields

• getNonDet :: UniqFM key ele

Instances

Foldable (NonDetUniqFM key)

Inherently nondeterministic. If you use this please provide a justification why it doesn't introduce nondeterminism. See Note [Deterministic UniqFM] in GHC.Types.Unique.DFM to learn about determinism.

Defined in GHC.Types.Unique.FM

Methods

fold :: Monoid m => NonDetUniqFM key m -> m

foldMap :: Monoid m => (a -> m) -> NonDetUniqFM key a -> m

foldMap' :: Monoid m => (a -> m) -> NonDetUniqFM key a -> m

foldr :: (a -> b -> b) -> b -> NonDetUniqFM key a -> b

foldr' :: (a -> b -> b) -> b -> NonDetUniqFM key a -> b

foldl :: (b -> a -> b) -> b -> NonDetUniqFM key a -> b

foldl' :: (b -> a -> b) -> b -> NonDetUniqFM key a -> b

foldr1 :: (a -> a -> a) -> NonDetUniqFM key a -> a

foldl1 :: (a -> a -> a) -> NonDetUniqFM key a -> a

toList :: NonDetUniqFM key a -> [a]

null :: NonDetUniqFM key a -> Bool

length :: NonDetUniqFM key a -> Int

elem :: Eq a => a -> NonDetUniqFM key a -> Bool

maximum :: Ord a => NonDetUniqFM key a -> a

minimum :: Ord a => NonDetUniqFM key a -> a

sum :: Num a => NonDetUniqFM key a -> a

product :: Num a => NonDetUniqFM key a -> a

Traversable (NonDetUniqFM key)

Inherently nondeterministic. If you use this please provide a justification why it doesn't introduce nondeterminism. See Note [Deterministic UniqFM] in GHC.Types.Unique.DFM to learn about determinism.

Defined in GHC.Types.Unique.FM

Methods

traverse :: Applicative f => (a -> f b) -> NonDetUniqFM key a -> f (NonDetUniqFM key b)

sequenceA :: Applicative f => NonDetUniqFM key (f a) -> f (NonDetUniqFM key a)

mapM :: Monad m => (a -> m b) -> NonDetUniqFM key a -> m (NonDetUniqFM key b)

sequence :: Monad m => NonDetUniqFM key (m a) -> m (NonDetUniqFM key a)

Functor (NonDetUniqFM key)

Defined in GHC.Types.Unique.FM

Methods

fmap :: (a -> b) -> NonDetUniqFM key a -> NonDetUniqFM key b

(<$) :: a -> NonDetUniqFM key b -> NonDetUniqFM key a

Manipulating those mappings

emptyUFM :: UniqFM key elt

unitUFM :: Uniquable key => key -> elt -> UniqFM key elt

unitDirectlyUFM :: Unique -> elt -> UniqFM key elt

zipToUFM :: Uniquable key => [key] -> [elt] -> UniqFM key elt

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

listToUFM_Directly :: [(Unique, elt)] -> UniqFM key elt

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

listToIdentityUFM :: Uniquable key => [key] -> UniqFM key key

addToUFM :: Uniquable key => UniqFM key elt -> key -> elt -> UniqFM key elt

addToUFM_C :: Uniquable key => (elt -> elt -> elt) -> UniqFM key elt -> key -> elt -> UniqFM key elt

addToUFM_Acc :: Uniquable key => (elt -> elts -> elts) -> (elt -> elts) -> UniqFM key elts -> key -> elt -> UniqFM key elts

addToUFM_L :: Uniquable key => (key -> elt -> elt -> elt) -> key -> elt -> UniqFM key elt -> (Maybe elt, UniqFM key elt)

Add an element, returns previous lookup result and new map. If old element doesn't exist, add the passed element directly, otherwise compute the element to add using the passed function.

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

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

Add elements to the map, combining existing values with inserted ones using the given function.

addToUFM_Directly :: UniqFM key elt -> Unique -> elt -> UniqFM key elt

addListToUFM_Directly :: UniqFM key elt -> [(Unique, elt)] -> UniqFM key elt

adjustUFM :: Uniquable key => (elt -> elt) -> UniqFM key elt -> key -> UniqFM key elt

alterUFM :: Uniquable key => (Maybe elt -> Maybe elt) -> UniqFM key elt -> key -> UniqFM key elt

adjustUFM_Directly :: (elt -> elt) -> UniqFM key elt -> Unique -> UniqFM key elt

delFromUFM :: Uniquable key => UniqFM key elt -> key -> UniqFM key elt

delFromUFM_Directly :: UniqFM key elt -> Unique -> UniqFM key elt

delListFromUFM :: Uniquable key => UniqFM key elt -> [key] -> UniqFM key elt

delListFromUFM_Directly :: UniqFM key elt -> [Unique] -> UniqFM key elt

plusUFM :: UniqFM key elt -> UniqFM key elt -> UniqFM key elt

plusUFM_C :: (elt -> elt -> elt) -> UniqFM key elt -> UniqFM key elt -> UniqFM key elt

plusUFM_CD :: (elta -> eltb -> eltc) -> UniqFM key elta -> elta -> UniqFM key eltb -> eltb -> UniqFM key eltc

`plusUFM_CD f m1 d1 m2 d2` merges the maps using f as the combinding function and d1 resp. d2 as the default value if there is no entry in m1 reps. m2. The domain is the union of the domains of m1 and m2.

IMPORTANT NOTE: This function strictly applies the modification function and forces the result unlike most the other functions in this module.

Representative example:

plusUFM_CD f {A: 1, B: 2} 23 {B: 3, C: 4} 42
   == {A: f 1 42, B: f 2 3, C: f 23 4 }

plusUFM_CD2 :: (Maybe elta -> Maybe eltb -> eltc) -> UniqFM key elta -> UniqFM key eltb -> UniqFM key eltc

`plusUFM_CD2 f m1 m2` merges the maps using f as the combining function. Unlike plusUFM_CD, a missing value is not defaulted: it is instead passed as Nothing to f. f can never have both its arguments be Nothing.

IMPORTANT NOTE: This function strictly applies the modification function and forces the result.

`plusUFM_CD2 f m1 m2` is the same as `plusUFM_CD f (mapUFM Just m1) Nothing (mapUFM Just m2) Nothing`.

mergeUFM :: (elta -> eltb -> Maybe eltc) -> (UniqFM key elta -> UniqFM key eltc) -> (UniqFM key eltb -> UniqFM key eltc) -> UniqFM key elta -> UniqFM key eltb -> UniqFM key eltc

plusMaybeUFM_C :: (elt -> elt -> Maybe elt) -> UniqFM key elt -> UniqFM key elt -> UniqFM key elt

plusUFMList :: [UniqFM key elt] -> UniqFM key elt

sequenceUFMList :: forall key elt. [UniqFM key elt] -> UniqFM key [elt]

minusUFM :: UniqFM key elt1 -> UniqFM key elt2 -> UniqFM key elt1

minusUFM_C :: (elt1 -> elt2 -> Maybe elt1) -> UniqFM key elt1 -> UniqFM key elt2 -> UniqFM key elt1

minusUFC_C f map1 map2 returns map1, except that every mapping key |-> value1 in map1 that shares a key with a mapping key |-> value2 in map2 is altered by f: value1 is replaced by f value1 value2, where Just means that the new value is used and Nothing means that the mapping is deleted.

intersectUFM :: UniqFM key elt1 -> UniqFM key elt2 -> UniqFM key elt1

intersectUFM_C :: (elt1 -> elt2 -> elt3) -> UniqFM key elt1 -> UniqFM key elt2 -> UniqFM key elt3

disjointUFM :: UniqFM key elt1 -> UniqFM key elt2 -> Bool

equalKeysUFM :: UniqFM key a -> UniqFM key b -> Bool

nonDetStrictFoldUFM :: (elt -> a -> a) -> a -> UniqFM key elt -> a

foldUFM :: (elt -> a -> a) -> a -> UniqFM key elt -> a

nonDetStrictFoldUFM_DirectlyM :: Monad m => (Unique -> b -> elt -> m b) -> b -> UniqFM key elt -> m b

In essence foldM See Note [Deterministic UniqFM] to learn about nondeterminism. If you use this please provide a justification why it doesn't introduce nondeterminism.

nonDetStrictFoldUFM_Directly :: (Unique -> elt -> a -> a) -> a -> UniqFM key elt -> a

anyUFM :: (elt -> Bool) -> UniqFM key elt -> Bool

allUFM :: (elt -> Bool) -> UniqFM key elt -> Bool

seqEltsUFM :: (elt -> ()) -> UniqFM key elt -> ()

mapUFM :: (elt1 -> elt2) -> UniqFM key elt1 -> UniqFM key elt2

mapUFM_Directly :: (Unique -> elt1 -> elt2) -> UniqFM key elt1 -> UniqFM key elt2

mapMaybeUFM :: (elt1 -> Maybe elt2) -> UniqFM key elt1 -> UniqFM key elt2

elemUFM :: Uniquable key => key -> UniqFM key elt -> Bool

elemUFM_Directly :: Unique -> UniqFM key elt -> Bool

filterUFM :: (elt -> Bool) -> UniqFM key elt -> UniqFM key elt

filterUFM_Directly :: (Unique -> elt -> Bool) -> UniqFM key elt -> UniqFM key elt

partitionUFM :: (elt -> Bool) -> UniqFM key elt -> (UniqFM key elt, UniqFM key elt)

sizeUFM :: UniqFM key elt -> Int

isNullUFM :: UniqFM key elt -> Bool

lookupUFM :: Uniquable key => UniqFM key elt -> key -> Maybe elt

lookupUFM_Directly :: UniqFM key elt -> Unique -> Maybe elt

lookupWithDefaultUFM :: Uniquable key => UniqFM key elt -> elt -> key -> elt

lookupWithDefaultUFM_Directly :: UniqFM key elt -> elt -> Unique -> elt

nonDetEltsUFM :: UniqFM key elt -> [elt]

nonDetKeysUFM :: UniqFM key elt -> [Unique]

ufmToSet_Directly :: UniqFM key elt -> IntSet

nonDetUFMToList :: UniqFM key elt -> [(Unique, elt)]

ufmToIntMap :: UniqFM key elt -> IntMap elt

unsafeIntMapToUFM :: IntMap elt -> UniqFM key elt

unsafeCastUFMKey :: UniqFM key1 elt -> UniqFM key2 elt

Cast the key domain of a UniqFM.

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

pprUniqFM :: (a -> SDoc) -> UniqFM key a -> SDoc

pprUFM

Arguments

:: UniqFM 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

Pretty-print a non-deterministic set. The order of variables is non-deterministic and for pretty-printing that shouldn't be a problem. Having this function helps contain the non-determinism created with nonDetEltsUFM.

pprUFMWithKeys

Arguments

:: UniqFM key a

The things to be pretty printed

-> ([(Unique, a)] -> SDoc)

The pretty printing function to use on the elements

-> SDoc

SDoc where the things have been pretty printed

Pretty-print a non-deterministic set. The order of variables is non-deterministic and for pretty-printing that shouldn't be a problem. Having this function helps contain the non-determinism created with nonDetUFMToList.

pluralUFM :: UniqFM key a -> SDoc

Determines the pluralisation suffix appropriate for the length of a set in the same way that plural from Outputable does for lists.