2 % (c) The AQUA Project, Glasgow University, 1994-1996
4 \section[FiniteMap]{An implementation of finite maps}
6 ``Finite maps'' are the heart of the compiler's
7 lookup-tables/environments and its implementation of sets. Important
10 This code is derived from that in the paper:
13 "Efficient sets: a balancing act"
14 Journal of functional programming 3(4) Oct 1993, pp553-562
17 The code is SPECIALIZEd to various highly-desirable types (e.g., Id)
18 near the end (only \tr{#ifdef COMPILING_GHC}).
22 #include "HsVersions.h"
23 #define IF_NOT_GHC(a) {--}
25 #define ASSERT(e) {--}
26 #define IF_NOT_GHC(a) a
30 #if defined(COMPILING_GHC) && defined(DEBUG_FINITEMAPS)/* NB NB NB */
31 #define OUTPUTABLE_key , Outputable key
33 #define OUTPUTABLE_key {--}
37 FiniteMap, -- abstract type
39 emptyFM, unitFM, listToFM,
45 IF_NOT_GHC(delFromFM COMMA)
53 IF_NOT_GHC(intersectFM COMMA)
54 IF_NOT_GHC(intersectFM_C COMMA)
55 IF_NOT_GHC(mapFM COMMA filterFM COMMA)
57 sizeFM, isEmptyFM, elemFM, lookupFM, lookupWithDefaultFM,
59 fmToList, keysFM, eltsFM
63 , FiniteSet(..), emptySet, mkSet, isEmptySet
64 , elementOf, setToList, union, minusSet
75 import Bag ( foldBag )
76 #if ! OMIT_NATIVE_CODEGEN
79 #define IF_NCG(a) {--}
83 -- SIGH: but we use unboxed "sizes"...
84 #if __GLASGOW_HASKELL__
92 %************************************************************************
94 \subsection{The signature of the module}
96 %************************************************************************
100 emptyFM :: FiniteMap key elt
101 unitFM :: key -> elt -> FiniteMap key elt
102 listToFM :: (Ord key OUTPUTABLE_key) => [(key,elt)] -> FiniteMap key elt
103 -- In the case of duplicates, the last is taken
105 bagToFM :: (Ord key OUTPUTABLE_key) => Bag (key,elt) -> FiniteMap key elt
106 -- In the case of duplicates, who knows which is taken
109 -- ADDING AND DELETING
110 -- Throws away any previous binding
111 -- In the list case, the items are added starting with the
112 -- first one in the list
113 addToFM :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> key -> elt -> FiniteMap key elt
114 addListToFM :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> [(key,elt)] -> FiniteMap key elt
116 -- Combines with previous binding
117 addToFM_C :: (Ord key OUTPUTABLE_key) => (elt -> elt -> elt)
118 -> FiniteMap key elt -> key -> elt
120 addListToFM_C :: (Ord key OUTPUTABLE_key) => (elt -> elt -> elt)
121 -> FiniteMap key elt -> [(key,elt)]
124 -- Deletion doesn't complain if you try to delete something
126 delFromFM :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> key -> FiniteMap key elt
127 delListFromFM :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> [key] -> FiniteMap key elt
130 -- Bindings in right argument shadow those in the left
131 plusFM :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> FiniteMap key elt
134 -- Combines bindings for the same thing with the given function
135 plusFM_C :: (Ord key OUTPUTABLE_key) => (elt -> elt -> elt)
136 -> FiniteMap key elt -> FiniteMap key elt -> FiniteMap key elt
138 minusFM :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> FiniteMap key elt -> FiniteMap key elt
139 -- (minusFM a1 a2) deletes from a1 any bindings which are bound in a2
141 intersectFM :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> FiniteMap key elt -> FiniteMap key elt
142 intersectFM_C :: (Ord key OUTPUTABLE_key) => (elt -> elt -> elt)
143 -> FiniteMap key elt -> FiniteMap key elt -> FiniteMap key elt
145 -- MAPPING, FOLDING, FILTERING
146 foldFM :: (key -> elt -> a -> a) -> a -> FiniteMap key elt -> a
147 mapFM :: (key -> elt1 -> elt2) -> FiniteMap key elt1 -> FiniteMap key elt2
148 filterFM :: (Ord key OUTPUTABLE_key) => (key -> elt -> Bool)
149 -> FiniteMap key elt -> FiniteMap key elt
152 sizeFM :: FiniteMap key elt -> Int
153 isEmptyFM :: FiniteMap key elt -> Bool
155 elemFM :: (Ord key OUTPUTABLE_key) => key -> FiniteMap key elt -> Bool
156 lookupFM :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> key -> Maybe elt
158 :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> elt -> key -> elt
159 -- lookupWithDefaultFM supplies a "default" elt
160 -- to return for an unmapped key
163 fmToList :: FiniteMap key elt -> [(key,elt)]
164 keysFM :: FiniteMap key elt -> [key]
165 eltsFM :: FiniteMap key elt -> [elt]
168 %************************************************************************
170 \subsection{The @FiniteMap@ data type, and building of same}
172 %************************************************************************
174 Invariants about @FiniteMap@:
177 all keys in a FiniteMap are distinct
179 all keys in left subtree are $<$ key in Branch and
180 all keys in right subtree are $>$ key in Branch
182 size field of a Branch gives number of Branch nodes in the tree
184 size of left subtree is differs from size of right subtree by a
185 factor of at most \tr{sIZE_RATIO}
189 data FiniteMap key elt
191 | Branch key elt -- Key and elt stored here
192 IF_GHC(Int#,Int{-STRICT-}) -- Size >= 1
193 (FiniteMap key elt) -- Children
201 = Branch bottom bottom IF_GHC(0#,0) bottom bottom
203 bottom = panic "emptyFM"
206 -- #define EmptyFM (Branch _ _ IF_GHC(0#,0) _ _)
208 unitFM key elt = Branch key elt IF_GHC(1#,1) emptyFM emptyFM
210 listToFM = addListToFM emptyFM
213 bagToFM = foldBag plusFM (\ (k,v) -> unitFM k v) emptyFM
217 %************************************************************************
219 \subsection{Adding to and deleting from @FiniteMaps@}
221 %************************************************************************
224 addToFM fm key elt = addToFM_C (\ old new -> new) fm key elt
226 addToFM_C combiner EmptyFM key elt = unitFM key elt
227 addToFM_C combiner (Branch key elt size fm_l fm_r) new_key new_elt
228 #ifdef __GLASGOW_HASKELL__
229 = case _tagCmp new_key key of
230 _LT -> mkBalBranch key elt (addToFM_C combiner fm_l new_key new_elt) fm_r
231 _GT -> mkBalBranch key elt fm_l (addToFM_C combiner fm_r new_key new_elt)
232 _EQ -> Branch new_key (combiner elt new_elt) size fm_l fm_r
234 | new_key < key = mkBalBranch key elt (addToFM_C combiner fm_l new_key new_elt) fm_r
235 | new_key > key = mkBalBranch key elt fm_l (addToFM_C combiner fm_r new_key new_elt)
236 | otherwise = Branch new_key (combiner elt new_elt) size fm_l fm_r
239 addListToFM fm key_elt_pairs = addListToFM_C (\ old new -> new) fm key_elt_pairs
241 addListToFM_C combiner fm key_elt_pairs
242 = foldl add fm key_elt_pairs -- foldl adds from the left
244 add fmap (key,elt) = addToFM_C combiner fmap key elt
248 delFromFM EmptyFM del_key = emptyFM
249 delFromFM (Branch key elt size fm_l fm_r) del_key
250 #ifdef __GLASGOW_HASKELL__
251 = case _tagCmp del_key key of
252 _GT -> mkBalBranch key elt fm_l (delFromFM fm_r del_key)
253 _LT -> mkBalBranch key elt (delFromFM fm_l del_key) fm_r
254 _EQ -> glueBal fm_l fm_r
257 = mkBalBranch key elt fm_l (delFromFM fm_r del_key)
260 = mkBalBranch key elt (delFromFM fm_l del_key) fm_r
266 delListFromFM fm keys = foldl delFromFM fm keys
269 %************************************************************************
271 \subsection{Combining @FiniteMaps@}
273 %************************************************************************
276 plusFM_C combiner EmptyFM fm2 = fm2
277 plusFM_C combiner fm1 EmptyFM = fm1
278 plusFM_C combiner fm1 (Branch split_key elt2 _ left right)
279 = mkVBalBranch split_key new_elt
280 (plusFM_C combiner lts left)
281 (plusFM_C combiner gts right)
283 lts = splitLT fm1 split_key
284 gts = splitGT fm1 split_key
285 new_elt = case lookupFM fm1 split_key of
287 Just elt1 -> combiner elt1 elt2
289 -- It's worth doing plusFM specially, because we don't need
290 -- to do the lookup in fm1.
292 plusFM EmptyFM fm2 = fm2
293 plusFM fm1 EmptyFM = fm1
294 plusFM fm1 (Branch split_key elt1 _ left right)
295 = mkVBalBranch split_key elt1 (plusFM lts left) (plusFM gts right)
297 lts = splitLT fm1 split_key
298 gts = splitGT fm1 split_key
300 minusFM EmptyFM fm2 = emptyFM
301 minusFM fm1 EmptyFM = fm1
302 minusFM fm1 (Branch split_key elt _ left right)
303 = glueVBal (minusFM lts left) (minusFM gts right)
304 -- The two can be way different, so we need glueVBal
306 lts = splitLT fm1 split_key -- NB gt and lt, so the equal ones
307 gts = splitGT fm1 split_key -- are not in either.
309 intersectFM fm1 fm2 = intersectFM_C (\ left right -> right) fm1 fm2
311 intersectFM_C combiner fm1 EmptyFM = emptyFM
312 intersectFM_C combiner EmptyFM fm2 = emptyFM
313 intersectFM_C combiner fm1 (Branch split_key elt2 _ left right)
315 | maybeToBool maybe_elt1 -- split_elt *is* in intersection
316 = mkVBalBranch split_key (combiner elt1 elt2) (intersectFM_C combiner lts left)
317 (intersectFM_C combiner gts right)
319 | otherwise -- split_elt is *not* in intersection
320 = glueVBal (intersectFM_C combiner lts left) (intersectFM_C combiner gts right)
323 lts = splitLT fm1 split_key -- NB gt and lt, so the equal ones
324 gts = splitGT fm1 split_key -- are not in either.
326 maybe_elt1 = lookupFM fm1 split_key
327 Just elt1 = maybe_elt1
330 %************************************************************************
332 \subsection{Mapping, folding, and filtering with @FiniteMaps@}
334 %************************************************************************
337 foldFM k z EmptyFM = z
338 foldFM k z (Branch key elt _ fm_l fm_r)
339 = foldFM k (k key elt (foldFM k z fm_r)) fm_l
341 mapFM f EmptyFM = emptyFM
342 mapFM f (Branch key elt size fm_l fm_r)
343 = Branch key (f key elt) size (mapFM f fm_l) (mapFM f fm_r)
345 filterFM p EmptyFM = emptyFM
346 filterFM p (Branch key elt _ fm_l fm_r)
347 | p key elt -- Keep the item
348 = mkVBalBranch key elt (filterFM p fm_l) (filterFM p fm_r)
350 | otherwise -- Drop the item
351 = glueVBal (filterFM p fm_l) (filterFM p fm_r)
354 %************************************************************************
356 \subsection{Interrogating @FiniteMaps@}
358 %************************************************************************
361 --{-# INLINE sizeFM #-}
363 sizeFM (Branch _ _ size _ _) = IF_GHC(I# size, size)
365 isEmptyFM fm = sizeFM fm == 0
367 lookupFM EmptyFM key = Nothing
368 lookupFM (Branch key elt _ fm_l fm_r) key_to_find
369 #ifdef __GLASGOW_HASKELL__
370 = case _tagCmp key_to_find key of
371 _LT -> lookupFM fm_l key_to_find
372 _GT -> lookupFM fm_r key_to_find
375 | key_to_find < key = lookupFM fm_l key_to_find
376 | key_to_find > key = lookupFM fm_r key_to_find
377 | otherwise = Just elt
381 = case (lookupFM fm key) of { Nothing -> False; Just elt -> True }
383 lookupWithDefaultFM fm deflt key
384 = case (lookupFM fm key) of { Nothing -> deflt; Just elt -> elt }
387 %************************************************************************
389 \subsection{Listifying @FiniteMaps@}
391 %************************************************************************
394 fmToList fm = foldFM (\ key elt rest -> (key,elt) : rest) [] fm
395 keysFM fm = foldFM (\ key elt rest -> key : rest) [] fm
396 eltsFM fm = foldFM (\ key elt rest -> elt : rest) [] fm
400 %************************************************************************
402 \subsection{The implementation of balancing}
404 %************************************************************************
406 %************************************************************************
408 \subsubsection{Basic construction of a @FiniteMap@}
410 %************************************************************************
412 @mkBranch@ simply gets the size component right. This is the ONLY
413 (non-trivial) place the Branch object is built, so the ASSERTion
414 recursively checks consistency. (The trivial use of Branch is in
421 mkBranch :: (Ord key OUTPUTABLE_key) -- Used for the assertion checking only
424 -> FiniteMap key elt -> FiniteMap key elt
427 mkBranch which key elt fm_l fm_r
428 = --ASSERT( left_ok && right_ok && balance_ok )
429 #if defined(COMPILING_GHC) && defined(DEBUG_FINITEMAPS)
430 if not ( left_ok && right_ok && balance_ok ) then
431 pprPanic ("mkBranch:"++show which) (ppAboves [ppr PprDebug [left_ok, right_ok, balance_ok],
438 result = Branch key elt (unbox (1 + left_size + right_size)) fm_l fm_r
440 -- if sizeFM result <= 8 then
443 -- pprTrace ("mkBranch:"++(show which)) (ppr PprDebug result) (
447 left_ok = case fm_l of
449 Branch left_key _ _ _ _ -> let
450 biggest_left_key = fst (findMax fm_l)
452 biggest_left_key < key
453 right_ok = case fm_r of
455 Branch right_key _ _ _ _ -> let
456 smallest_right_key = fst (findMin fm_r)
458 key < smallest_right_key
459 balance_ok = True -- sigh
462 = -- Both subtrees have one or no elements...
463 (left_size + right_size <= 1)
464 -- NO || left_size == 0 -- ???
465 -- NO || right_size == 0 -- ???
466 -- ... or the number of elements in a subtree does not exceed
467 -- sIZE_RATIO times the number of elements in the other subtree
468 || (left_size * sIZE_RATIO >= right_size &&
469 right_size * sIZE_RATIO >= left_size)
472 left_size = sizeFM fm_l
473 right_size = sizeFM fm_r
475 #ifdef __GLASGOW_HASKELL__
477 unbox (I# size) = size
484 %************************************************************************
486 \subsubsection{{\em Balanced} construction of a @FiniteMap@}
488 %************************************************************************
490 @mkBalBranch@ rebalances, assuming that the subtrees aren't too far
494 mkBalBranch :: (Ord key OUTPUTABLE_key)
496 -> FiniteMap key elt -> FiniteMap key elt
499 mkBalBranch key elt fm_L fm_R
501 | size_l + size_r < 2
502 = mkBranch 1{-which-} key elt fm_L fm_R
504 | size_r > sIZE_RATIO * size_l -- Right tree too big
506 Branch _ _ _ fm_rl fm_rr
507 | sizeFM fm_rl < 2 * sizeFM fm_rr -> single_L fm_L fm_R
508 | otherwise -> double_L fm_L fm_R
509 -- Other case impossible
511 | size_l > sIZE_RATIO * size_r -- Left tree too big
513 Branch _ _ _ fm_ll fm_lr
514 | sizeFM fm_lr < 2 * sizeFM fm_ll -> single_R fm_L fm_R
515 | otherwise -> double_R fm_L fm_R
516 -- Other case impossible
518 | otherwise -- No imbalance
519 = mkBranch 2{-which-} key elt fm_L fm_R
525 single_L fm_l (Branch key_r elt_r _ fm_rl fm_rr)
526 = mkBranch 3{-which-} key_r elt_r (mkBranch 4{-which-} key elt fm_l fm_rl) fm_rr
528 double_L fm_l (Branch key_r elt_r _ (Branch key_rl elt_rl _ fm_rll fm_rlr) fm_rr)
529 = mkBranch 5{-which-} key_rl elt_rl (mkBranch 6{-which-} key elt fm_l fm_rll)
530 (mkBranch 7{-which-} key_r elt_r fm_rlr fm_rr)
532 single_R (Branch key_l elt_l _ fm_ll fm_lr) fm_r
533 = mkBranch 8{-which-} key_l elt_l fm_ll (mkBranch 9{-which-} key elt fm_lr fm_r)
535 double_R (Branch key_l elt_l _ fm_ll (Branch key_lr elt_lr _ fm_lrl fm_lrr)) fm_r
536 = mkBranch 10{-which-} key_lr elt_lr (mkBranch 11{-which-} key_l elt_l fm_ll fm_lrl)
537 (mkBranch 12{-which-} key elt fm_lrr fm_r)
542 mkVBalBranch :: (Ord key OUTPUTABLE_key)
544 -> FiniteMap key elt -> FiniteMap key elt
547 -- Assert: in any call to (mkVBalBranch_C comb key elt l r),
548 -- (a) all keys in l are < all keys in r
549 -- (b) all keys in l are < key
550 -- (c) all keys in r are > key
552 mkVBalBranch key elt EmptyFM fm_r = addToFM fm_r key elt
553 mkVBalBranch key elt fm_l EmptyFM = addToFM fm_l key elt
555 mkVBalBranch key elt fm_l@(Branch key_l elt_l _ fm_ll fm_lr)
556 fm_r@(Branch key_r elt_r _ fm_rl fm_rr)
557 | sIZE_RATIO * size_l < size_r
558 = mkBalBranch key_r elt_r (mkVBalBranch key elt fm_l fm_rl) fm_rr
560 | sIZE_RATIO * size_r < size_l
561 = mkBalBranch key_l elt_l fm_ll (mkVBalBranch key elt fm_lr fm_r)
564 = mkBranch 13{-which-} key elt fm_l fm_r
571 %************************************************************************
573 \subsubsection{Gluing two trees together}
575 %************************************************************************
577 @glueBal@ assumes its two arguments aren't too far out of whack, just
578 like @mkBalBranch@. But: all keys in first arg are $<$ all keys in
582 glueBal :: (Ord key OUTPUTABLE_key)
583 => FiniteMap key elt -> FiniteMap key elt
586 glueBal EmptyFM fm2 = fm2
587 glueBal fm1 EmptyFM = fm1
589 -- The case analysis here (absent in Adams' program) is really to deal
590 -- with the case where fm2 is a singleton. Then deleting the minimum means
591 -- we pass an empty tree to mkBalBranch, which breaks its invariant.
592 | sizeFM fm2 > sizeFM fm1
593 = mkBalBranch mid_key2 mid_elt2 fm1 (deleteMin fm2)
596 = mkBalBranch mid_key1 mid_elt1 (deleteMax fm1) fm2
598 (mid_key1, mid_elt1) = findMax fm1
599 (mid_key2, mid_elt2) = findMin fm2
602 @glueVBal@ copes with arguments which can be of any size.
603 But: all keys in first arg are $<$ all keys in second.
606 glueVBal :: (Ord key OUTPUTABLE_key)
607 => FiniteMap key elt -> FiniteMap key elt
610 glueVBal EmptyFM fm2 = fm2
611 glueVBal fm1 EmptyFM = fm1
612 glueVBal fm_l@(Branch key_l elt_l _ fm_ll fm_lr)
613 fm_r@(Branch key_r elt_r _ fm_rl fm_rr)
614 | sIZE_RATIO * size_l < size_r
615 = mkBalBranch key_r elt_r (glueVBal fm_l fm_rl) fm_rr
617 | sIZE_RATIO * size_r < size_l
618 = mkBalBranch key_l elt_l fm_ll (glueVBal fm_lr fm_r)
620 | otherwise -- We now need the same two cases as in glueBal above.
623 (mid_key_l,mid_elt_l) = findMax fm_l
624 (mid_key_r,mid_elt_r) = findMin fm_r
629 %************************************************************************
631 \subsection{Local utilities}
633 %************************************************************************
636 splitLT, splitGT :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> key -> FiniteMap key elt
638 -- splitLT fm split_key = fm restricted to keys < split_key
639 -- splitGT fm split_key = fm restricted to keys > split_key
641 splitLT EmptyFM split_key = emptyFM
642 splitLT (Branch key elt _ fm_l fm_r) split_key
643 #ifdef __GLASGOW_HASKELL__
644 = case _tagCmp split_key key of
645 _LT -> splitLT fm_l split_key
646 _GT -> mkVBalBranch key elt fm_l (splitLT fm_r split_key)
649 | split_key < key = splitLT fm_l split_key
650 | split_key > key = mkVBalBranch key elt fm_l (splitLT fm_r split_key)
654 splitGT EmptyFM split_key = emptyFM
655 splitGT (Branch key elt _ fm_l fm_r) split_key
656 #ifdef __GLASGOW_HASKELL__
657 = case _tagCmp split_key key of
658 _GT -> splitGT fm_r split_key
659 _LT -> mkVBalBranch key elt (splitGT fm_l split_key) fm_r
662 | split_key > key = splitGT fm_r split_key
663 | split_key < key = mkVBalBranch key elt (splitGT fm_l split_key) fm_r
667 findMin :: FiniteMap key elt -> (key,elt)
668 findMin (Branch key elt _ EmptyFM _) = (key,elt)
669 findMin (Branch key elt _ fm_l _) = findMin fm_l
671 deleteMin :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> FiniteMap key elt
672 deleteMin (Branch key elt _ EmptyFM fm_r) = fm_r
673 deleteMin (Branch key elt _ fm_l fm_r) = mkBalBranch key elt (deleteMin fm_l) fm_r
675 findMax :: FiniteMap key elt -> (key,elt)
676 findMax (Branch key elt _ _ EmptyFM) = (key,elt)
677 findMax (Branch key elt _ _ fm_r) = findMax fm_r
679 deleteMax :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> FiniteMap key elt
680 deleteMax (Branch key elt _ fm_l EmptyFM) = fm_l
681 deleteMax (Branch key elt _ fm_l fm_r) = mkBalBranch key elt fm_l (deleteMax fm_r)
684 %************************************************************************
686 \subsection{Output-ery}
688 %************************************************************************
691 #if defined(COMPILING_GHC) && defined(DEBUG_FINITEMAPS)
693 instance (Outputable key) => Outputable (FiniteMap key elt) where
694 ppr sty fm = pprX sty fm
696 pprX sty EmptyFM = ppChar '!'
697 pprX sty (Branch key elt sz fm_l fm_r)
698 = ppBesides [ppLparen, pprX sty fm_l, ppSP,
699 ppr sty key, ppSP, ppInt (IF_GHC(I# sz, sz)), ppSP,
700 pprX sty fm_r, ppRparen]
703 #ifndef COMPILING_GHC
704 instance (Eq key, Eq elt) => Eq (FiniteMap key elt) where
705 fm_1 == fm_2 = (sizeFM fm_1 == sizeFM fm_2) && -- quick test
706 (fmToList fm_1 == fmToList fm_2)
708 {- NO: not clear what The Right Thing to do is:
709 instance (Ord key, Ord elt) => Ord (FiniteMap key elt) where
710 fm_1 <= fm_2 = (sizeFM fm_1 <= sizeFM fm_2) && -- quick test
711 (fmToList fm_1 <= fmToList fm_2)
716 %************************************************************************
718 \subsection{FiniteSets---a thin veneer}
720 %************************************************************************
725 type FiniteSet key = FiniteMap key ()
726 emptySet :: FiniteSet key
727 mkSet :: (Ord key OUTPUTABLE_key) => [key] -> FiniteSet key
728 isEmptySet :: FiniteSet key -> Bool
729 elementOf :: (Ord key OUTPUTABLE_key) => key -> FiniteSet key -> Bool
730 minusSet :: (Ord key OUTPUTABLE_key) => FiniteSet key -> FiniteSet key -> FiniteSet key
731 setToList :: FiniteSet key -> [key]
732 union :: (Ord key OUTPUTABLE_key) => FiniteSet key -> FiniteSet key -> FiniteSet key
735 mkSet xs = listToFM [ (x, ()) | x <- xs]
736 isEmptySet = isEmptyFM
745 %************************************************************************
747 \subsection{Efficiency pragmas for GHC}
749 %************************************************************************
751 When the FiniteMap module is used in GHC, we specialise it for
752 \tr{Uniques}, for dastardly efficiency reasons.
755 #if defined(COMPILING_GHC) && __GLASGOW_HASKELL__ && !defined(REALLY_HASKELL_1_3)
757 {-# SPECIALIZE addListToFM
758 :: FiniteMap (FAST_STRING, FAST_STRING) elt -> [((FAST_STRING, FAST_STRING),elt)] -> FiniteMap (FAST_STRING, FAST_STRING) elt
759 IF_NCG(COMMA FiniteMap Reg elt -> [(Reg COMMA elt)] -> FiniteMap Reg elt)
761 {-# SPECIALIZE addListToFM_C
762 :: (elt -> elt -> elt) -> FiniteMap TyCon elt -> [(TyCon,elt)] -> FiniteMap TyCon elt,
763 (elt -> elt -> elt) -> FiniteMap FAST_STRING elt -> [(FAST_STRING,elt)] -> FiniteMap FAST_STRING elt
764 IF_NCG(COMMA (elt -> elt -> elt) -> FiniteMap Reg elt -> [(Reg COMMA elt)] -> FiniteMap Reg elt)
766 {-# SPECIALIZE addToFM
767 :: FiniteMap CLabel elt -> CLabel -> elt -> FiniteMap CLabel elt,
768 FiniteMap FAST_STRING elt -> FAST_STRING -> elt -> FiniteMap FAST_STRING elt,
769 FiniteMap (FAST_STRING, FAST_STRING) elt -> (FAST_STRING, FAST_STRING) -> elt -> FiniteMap (FAST_STRING, FAST_STRING) elt,
770 FiniteMap RdrName elt -> RdrName -> elt -> FiniteMap RdrName elt
771 IF_NCG(COMMA FiniteMap Reg elt -> Reg -> elt -> FiniteMap Reg elt)
773 {-# SPECIALIZE addToFM_C
774 :: (elt -> elt -> elt) -> FiniteMap (RdrName, RdrName) elt -> (RdrName, RdrName) -> elt -> FiniteMap (RdrName, RdrName) elt,
775 (elt -> elt -> elt) -> FiniteMap FAST_STRING elt -> FAST_STRING -> elt -> FiniteMap FAST_STRING elt
776 IF_NCG(COMMA (elt -> elt -> elt) -> FiniteMap Reg elt -> Reg -> elt -> FiniteMap Reg elt)
778 {-# SPECIALIZE bagToFM
779 :: Bag (FAST_STRING,elt) -> FiniteMap FAST_STRING elt
781 {-# SPECIALIZE delListFromFM
782 :: FiniteMap RdrName elt -> [RdrName] -> FiniteMap RdrName elt,
783 FiniteMap FAST_STRING elt -> [FAST_STRING] -> FiniteMap FAST_STRING elt
784 IF_NCG(COMMA FiniteMap Reg elt -> [Reg] -> FiniteMap Reg elt)
786 {-# SPECIALIZE listToFM
787 :: [([Char],elt)] -> FiniteMap [Char] elt,
788 [(FAST_STRING,elt)] -> FiniteMap FAST_STRING elt,
789 [((FAST_STRING,FAST_STRING),elt)] -> FiniteMap (FAST_STRING, FAST_STRING) elt
790 IF_NCG(COMMA [(Reg COMMA elt)] -> FiniteMap Reg elt)
792 {-# SPECIALIZE lookupFM
793 :: FiniteMap CLabel elt -> CLabel -> Maybe elt,
794 FiniteMap [Char] elt -> [Char] -> Maybe elt,
795 FiniteMap FAST_STRING elt -> FAST_STRING -> Maybe elt,
796 FiniteMap (FAST_STRING,FAST_STRING) elt -> (FAST_STRING,FAST_STRING) -> Maybe elt,
797 FiniteMap RdrName elt -> RdrName -> Maybe elt,
798 FiniteMap (RdrName,RdrName) elt -> (RdrName,RdrName) -> Maybe elt
799 IF_NCG(COMMA FiniteMap Reg elt -> Reg -> Maybe elt)
801 {-# SPECIALIZE lookupWithDefaultFM
802 :: FiniteMap FAST_STRING elt -> elt -> FAST_STRING -> elt
803 IF_NCG(COMMA FiniteMap Reg elt -> elt -> Reg -> elt)
805 {-# SPECIALIZE plusFM
806 :: FiniteMap RdrName elt -> FiniteMap RdrName elt -> FiniteMap RdrName elt,
807 FiniteMap FAST_STRING elt -> FiniteMap FAST_STRING elt -> FiniteMap FAST_STRING elt
808 IF_NCG(COMMA FiniteMap Reg elt -> FiniteMap Reg elt -> FiniteMap Reg elt)
810 {-# SPECIALIZE plusFM_C
811 :: (elt -> elt -> elt) -> FiniteMap FAST_STRING elt -> FiniteMap FAST_STRING elt -> FiniteMap FAST_STRING elt
812 IF_NCG(COMMA (elt -> elt -> elt) -> FiniteMap Reg elt -> FiniteMap Reg elt -> FiniteMap Reg elt)
815 #endif {- compiling for GHC -}