ghc/compiler/utils/FiniteMap.lhs

   1 %
   2 % (c) The AQUA Project, Glasgow University, 1994-1996
   3 %
   4 \section[FiniteMap]{An implementation of finite maps}
   5
   6 ``Finite maps'' are the heart of the compiler's
   7 lookup-tables/environments and its implementation of sets.  Important
   8 stuff!
   9
  10 This code is derived from that in the paper:
  11 \begin{display}
  12         S Adams
  13         "Efficient sets: a balancing act"
  14         Journal of functional programming 3(4) Oct 1993, pp553-562
  15 \end{display}
  16
  17 The code is SPECIALIZEd to various highly-desirable types (e.g., Id)
  18 near the end (only \tr{#ifdef COMPILING_GHC}).
  19
  20 \begin{code}
  21 #ifdef COMPILING_GHC
  22 #include "HsVersions.h"
  23 #define IF_NOT_GHC(a) {--}
  24 #else
  25 #define ASSERT(e) {--}
  26 #define IF_NOT_GHC(a) a
  27 #define COMMA ,
  28 #define _tagCmp compare
  29 #define _LT LT
  30 #define _GT GT
  31 #define _EQ EQ
  32 #endif
  33
  34 #if defined(COMPILING_GHC) && defined(DEBUG_FINITEMAPS)/* NB NB NB */
  35 #define OUTPUTABLE_key , Outputable key
  36 #else
  37 #define OUTPUTABLE_key {--}
  38 #endif
  39
  40 module FiniteMap (
  41         FiniteMap,              -- abstract type
  42
  43         emptyFM, unitFM, listToFM,
  44
  45         addToFM,
  46         addToFM_C,
  47         addListToFM,
  48         addListToFM_C,
  49         delFromFM,
  50         delListFromFM,
  51
  52         plusFM,
  53         plusFM_C,
  54         minusFM,
  55         foldFM,
  56
  57         intersectFM,
  58         intersectFM_C,
  59         mapFM, filterFM,
  60
  61         sizeFM, isEmptyFM, elemFM, lookupFM, lookupWithDefaultFM,
  62
  63         fmToList, keysFM, eltsFM
  64
  65 #ifdef COMPILING_GHC
  66         , bagToFM
  67         , SYN_IE(FiniteSet), emptySet, mkSet, isEmptySet
  68         , elementOf, setToList, union, minusSet
  69 #endif
  70     ) where
  71
  72 #if defined(__GLASGOW_HASKELL__) && __GLASGOW_HASKELL__ <= 201
  73 IMPORT_DELOOPER(SpecLoop)
  74 #else
  75 import {-# SOURCE #-} Name
  76 #endif
  77
  78 #if __GLASGOW_HASKELL__ >= 202
  79 import GlaExts
  80 #endif
  81 #if defined(USE_FAST_STRINGS)
  82 import FastString
  83 #endif
  84 import Maybes
  85 import Bag        ( Bag, foldrBag )
  86 import Outputable ( PprStyle, Outputable(..) )
  87 import Pretty   ( Doc )
  88
  89 #ifdef COMPILING_GHC
  90
  91 # if ! OMIT_NATIVE_CODEGEN
  92 #  define IF_NCG(a) a
  93 # else
  94 #  define IF_NCG(a) {--}
  95 # endif
  96 #endif
  97
  98 -- SIGH: but we use unboxed "sizes"...
  99 #if __GLASGOW_HASKELL__
 100 #define IF_GHC(a,b) a
 101 #else /* not GHC */
 102 #define IF_GHC(a,b) b
 103 #endif /* not GHC */
 104 \end{code}
 105
 106
 107 %************************************************************************
 108 %*                                                                      *
 109 \subsection{The signature of the module}
 110 %*                                                                      *
 111 %************************************************************************
 112
 113 \begin{code}
 114 --      BUILDING
 115 emptyFM         :: FiniteMap key elt
 116 unitFM          :: key -> elt -> FiniteMap key elt
 117 listToFM        :: (Ord key OUTPUTABLE_key) => [(key,elt)] -> FiniteMap key elt
 118                         -- In the case of duplicates, the last is taken
 119 #ifdef COMPILING_GHC
 120 bagToFM         :: (Ord key OUTPUTABLE_key) => Bag (key,elt) -> FiniteMap key elt
 121                         -- In the case of duplicates, who knows which is taken
 122 #endif
 123
 124 --      ADDING AND DELETING
 125                    -- Throws away any previous binding
 126                    -- In the list case, the items are added starting with the
 127                    -- first one in the list
 128 addToFM         :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> key -> elt  -> FiniteMap key elt
 129 addListToFM     :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> [(key,elt)] -> FiniteMap key elt
 130
 131                    -- Combines with previous binding
 132 addToFM_C       :: (Ord key OUTPUTABLE_key) => (elt -> elt -> elt)
 133                            -> FiniteMap key elt -> key -> elt
 134                            -> FiniteMap key elt
 135 addListToFM_C   :: (Ord key OUTPUTABLE_key) => (elt -> elt -> elt)
 136                            -> FiniteMap key elt -> [(key,elt)]
 137                            -> FiniteMap key elt
 138
 139                    -- Deletion doesn't complain if you try to delete something
 140                    -- which isn't there
 141 delFromFM       :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> key   -> FiniteMap key elt
 142 delListFromFM   :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> [key] -> FiniteMap key elt
 143
 144 --      COMBINING
 145                    -- Bindings in right argument shadow those in the left
 146 plusFM          :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> FiniteMap key elt
 147                            -> FiniteMap key elt
 148
 149                    -- Combines bindings for the same thing with the given function
 150 plusFM_C        :: (Ord key OUTPUTABLE_key) => (elt -> elt -> elt)
 151                            -> FiniteMap key elt -> FiniteMap key elt -> FiniteMap key elt
 152
 153 minusFM         :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> FiniteMap key elt -> FiniteMap key elt
 154                    -- (minusFM a1 a2) deletes from a1 any bindings which are bound in a2
 155
 156 intersectFM     :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> FiniteMap key elt -> FiniteMap key elt
 157 intersectFM_C   :: (Ord key OUTPUTABLE_key) => (elt -> elt -> elt2)
 158                            -> FiniteMap key elt -> FiniteMap key elt -> FiniteMap key elt2
 159
 160 --      MAPPING, FOLDING, FILTERING
 161 foldFM          :: (key -> elt -> a -> a) -> a -> FiniteMap key elt -> a
 162 mapFM           :: (key -> elt1 -> elt2) -> FiniteMap key elt1 -> FiniteMap key elt2
 163 filterFM        :: (Ord key OUTPUTABLE_key) => (key -> elt -> Bool)
 164                            -> FiniteMap key elt -> FiniteMap key elt
 165
 166 --      INTERROGATING
 167 sizeFM          :: FiniteMap key elt -> Int
 168 isEmptyFM       :: FiniteMap key elt -> Bool
 169
 170 elemFM          :: (Ord key OUTPUTABLE_key) => key -> FiniteMap key elt -> Bool
 171 lookupFM        :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> key -> Maybe elt
 172 lookupWithDefaultFM
 173                 :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> elt -> key -> elt
 174                 -- lookupWithDefaultFM supplies a "default" elt
 175                 -- to return for an unmapped key
 176
 177 --      LISTIFYING
 178 fmToList        :: FiniteMap key elt -> [(key,elt)]
 179 keysFM          :: FiniteMap key elt -> [key]
 180 eltsFM          :: FiniteMap key elt -> [elt]
 181 \end{code}
 182
 183 %************************************************************************
 184 %*                                                                      *
 185 \subsection{The @FiniteMap@ data type, and building of same}
 186 %*                                                                      *
 187 %************************************************************************
 188
 189 Invariants about @FiniteMap@:
 190 \begin{enumerate}
 191 \item
 192 all keys in a FiniteMap are distinct
 193 \item
 194 all keys in left  subtree are $<$ key in Branch and
 195 all keys in right subtree are $>$ key in Branch
 196 \item
 197 size field of a Branch gives number of Branch nodes in the tree
 198 \item
 199 size of left subtree is differs from size of right subtree by a
 200 factor of at most \tr{sIZE_RATIO}
 201 \end{enumerate}
 202
 203 \begin{code}
 204 data FiniteMap key elt
 205   = EmptyFM
 206   | Branch key elt              -- Key and elt stored here
 207     IF_GHC(Int#,Int{-STRICT-})  -- Size >= 1
 208     (FiniteMap key elt)         -- Children
 209     (FiniteMap key elt)
 210 \end{code}
 211
 212 \begin{code}
 213 emptyFM = EmptyFM
 214 {-
 215 emptyFM
 216   = Branch bottom bottom IF_GHC(0#,0) bottom bottom
 217   where
 218     bottom = panic "emptyFM"
 219 -}
 220
 221 -- #define EmptyFM (Branch _ _ IF_GHC(0#,0) _ _)
 222
 223 unitFM key elt = Branch key elt IF_GHC(1#,1) emptyFM emptyFM
 224
 225 listToFM = addListToFM emptyFM
 226
 227 #ifdef COMPILING_GHC
 228 bagToFM = foldrBag (\(k,v) fm -> addToFM fm k v) emptyFM
 229 #endif
 230 \end{code}
 231
 232 %************************************************************************
 233 %*                                                                      *
 234 \subsection{Adding to and deleting from @FiniteMaps@}
 235 %*                                                                      *
 236 %************************************************************************
 237
 238 \begin{code}
 239 addToFM fm key elt = addToFM_C (\ old new -> new) fm key elt
 240
 241 addToFM_C combiner EmptyFM key elt = unitFM key elt
 242 addToFM_C combiner (Branch key elt size fm_l fm_r) new_key new_elt
 243 #ifdef __GLASGOW_HASKELL__
 244   = case _tagCmp new_key key of
 245         _LT -> mkBalBranch key elt (addToFM_C combiner fm_l new_key new_elt) fm_r
 246         _GT -> mkBalBranch key elt fm_l (addToFM_C combiner fm_r new_key new_elt)
 247         _EQ -> Branch new_key (combiner elt new_elt) size fm_l fm_r
 248 #else
 249   | new_key < key = mkBalBranch key elt (addToFM_C combiner fm_l new_key new_elt) fm_r
 250   | new_key > key = mkBalBranch key elt fm_l (addToFM_C combiner fm_r new_key new_elt)
 251   | otherwise     = Branch new_key (combiner elt new_elt) size fm_l fm_r
 252 #endif
 253
 254 addListToFM fm key_elt_pairs = addListToFM_C (\ old new -> new) fm key_elt_pairs
 255
 256 addListToFM_C combiner fm key_elt_pairs
 257   = foldl add fm key_elt_pairs  -- foldl adds from the left
 258   where
 259     add fmap (key,elt) = addToFM_C combiner fmap key elt
 260 \end{code}
 261
 262 \begin{code}
 263 delFromFM EmptyFM del_key = emptyFM
 264 delFromFM (Branch key elt size fm_l fm_r) del_key
 265 #ifdef __GLASGOW_HASKELL__
 266   = case _tagCmp del_key key of
 267         _GT -> mkBalBranch key elt fm_l (delFromFM fm_r del_key)
 268         _LT -> mkBalBranch key elt (delFromFM fm_l del_key) fm_r
 269         _EQ -> glueBal fm_l fm_r
 270 #else
 271   | del_key > key
 272   = mkBalBranch key elt fm_l (delFromFM fm_r del_key)
 273
 274   | del_key < key
 275   = mkBalBranch key elt (delFromFM fm_l del_key) fm_r
 276
 277   | key == del_key
 278   = glueBal fm_l fm_r
 279 #endif
 280
 281 delListFromFM fm keys = foldl delFromFM fm keys
 282 \end{code}
 283
 284 %************************************************************************
 285 %*                                                                      *
 286 \subsection{Combining @FiniteMaps@}
 287 %*                                                                      *
 288 %************************************************************************
 289
 290 \begin{code}
 291 plusFM_C combiner EmptyFM fm2 = fm2
 292 plusFM_C combiner fm1 EmptyFM = fm1
 293 plusFM_C combiner fm1 (Branch split_key elt2 _ left right)
 294   = mkVBalBranch split_key new_elt
 295                  (plusFM_C combiner lts left)
 296                  (plusFM_C combiner gts right)
 297   where
 298     lts     = splitLT fm1 split_key
 299     gts     = splitGT fm1 split_key
 300     new_elt = case lookupFM fm1 split_key of
 301                 Nothing   -> elt2
 302                 Just elt1 -> combiner elt1 elt2
 303
 304 -- It's worth doing plusFM specially, because we don't need
 305 -- to do the lookup in fm1.
 306
 307 plusFM EmptyFM fm2 = fm2
 308 plusFM fm1 EmptyFM = fm1
 309 plusFM fm1 (Branch split_key elt1 _ left right)
 310   = mkVBalBranch split_key elt1 (plusFM lts left) (plusFM gts right)
 311   where
 312     lts     = splitLT fm1 split_key
 313     gts     = splitGT fm1 split_key
 314
 315 minusFM EmptyFM fm2 = emptyFM
 316 minusFM fm1 EmptyFM = fm1
 317 minusFM fm1 (Branch split_key elt _ left right)
 318   = glueVBal (minusFM lts left) (minusFM gts right)
 319         -- The two can be way different, so we need glueVBal
 320   where
 321     lts = splitLT fm1 split_key         -- NB gt and lt, so the equal ones
 322     gts = splitGT fm1 split_key         -- are not in either.
 323
 324 intersectFM fm1 fm2 = intersectFM_C (\ left right -> right) fm1 fm2
 325
 326 intersectFM_C combiner fm1 EmptyFM = emptyFM
 327 intersectFM_C combiner EmptyFM fm2 = emptyFM
 328 intersectFM_C combiner fm1 (Branch split_key elt2 _ left right)
 329
 330   | maybeToBool maybe_elt1      -- split_elt *is* in intersection
 331   = mkVBalBranch split_key (combiner elt1 elt2) (intersectFM_C combiner lts left)
 332                                                 (intersectFM_C combiner gts right)
 333
 334   | otherwise                   -- split_elt is *not* in intersection
 335   = glueVBal (intersectFM_C combiner lts left) (intersectFM_C combiner gts right)
 336
 337   where
 338     lts = splitLT fm1 split_key         -- NB gt and lt, so the equal ones
 339     gts = splitGT fm1 split_key         -- are not in either.
 340
 341     maybe_elt1 = lookupFM fm1 split_key
 342     Just elt1  = maybe_elt1
 343 \end{code}
 344
 345 %************************************************************************
 346 %*                                                                      *
 347 \subsection{Mapping, folding, and filtering with @FiniteMaps@}
 348 %*                                                                      *
 349 %************************************************************************
 350
 351 \begin{code}
 352 foldFM k z EmptyFM = z
 353 foldFM k z (Branch key elt _ fm_l fm_r)
 354   = foldFM k (k key elt (foldFM k z fm_r)) fm_l
 355
 356 mapFM f EmptyFM = emptyFM
 357 mapFM f (Branch key elt size fm_l fm_r)
 358   = Branch key (f key elt) size (mapFM f fm_l) (mapFM f fm_r)
 359
 360 filterFM p EmptyFM = emptyFM
 361 filterFM p (Branch key elt _ fm_l fm_r)
 362   | p key elt           -- Keep the item
 363   = mkVBalBranch key elt (filterFM p fm_l) (filterFM p fm_r)
 364
 365   | otherwise           -- Drop the item
 366   = glueVBal (filterFM p fm_l) (filterFM p fm_r)
 367 \end{code}
 368
 369 %************************************************************************
 370 %*                                                                      *
 371 \subsection{Interrogating @FiniteMaps@}
 372 %*                                                                      *
 373 %************************************************************************
 374
 375 \begin{code}
 376 --{-# INLINE sizeFM #-}
 377 sizeFM EmptyFM               = 0
 378 sizeFM (Branch _ _ size _ _) = IF_GHC(I# size, size)
 379
 380 isEmptyFM fm = sizeFM fm == 0
 381
 382 lookupFM EmptyFM key = Nothing
 383 lookupFM (Branch key elt _ fm_l fm_r) key_to_find
 384 #ifdef __GLASGOW_HASKELL__
 385   = case _tagCmp key_to_find key of
 386         _LT -> lookupFM fm_l key_to_find
 387         _GT -> lookupFM fm_r key_to_find
 388         _EQ -> Just elt
 389 #else
 390   | key_to_find < key = lookupFM fm_l key_to_find
 391   | key_to_find > key = lookupFM fm_r key_to_find
 392   | otherwise     = Just elt
 393 #endif
 394
 395 key `elemFM` fm
 396   = case (lookupFM fm key) of { Nothing -> False; Just elt -> True }
 397
 398 lookupWithDefaultFM fm deflt key
 399   = case (lookupFM fm key) of { Nothing -> deflt; Just elt -> elt }
 400 \end{code}
 401
 402 %************************************************************************
 403 %*                                                                      *
 404 \subsection{Listifying @FiniteMaps@}
 405 %*                                                                      *
 406 %************************************************************************
 407
 408 \begin{code}
 409 fmToList fm = foldFM (\ key elt rest -> (key,elt) : rest) [] fm
 410 keysFM fm   = foldFM (\ key elt rest -> key : rest)       [] fm
 411 eltsFM fm   = foldFM (\ key elt rest -> elt : rest)       [] fm
 412 \end{code}
 413
 414
 415 %************************************************************************
 416 %*                                                                      *
 417 \subsection{The implementation of balancing}
 418 %*                                                                      *
 419 %************************************************************************
 420
 421 %************************************************************************
 422 %*                                                                      *
 423 \subsubsection{Basic construction of a @FiniteMap@}
 424 %*                                                                      *
 425 %************************************************************************
 426
 427 @mkBranch@ simply gets the size component right.  This is the ONLY
 428 (non-trivial) place the Branch object is built, so the ASSERTion
 429 recursively checks consistency.  (The trivial use of Branch is in
 430 @unitFM@.)
 431
 432 \begin{code}
 433 sIZE_RATIO :: Int
 434 sIZE_RATIO = 5
 435
 436 mkBranch :: (Ord key OUTPUTABLE_key)            -- Used for the assertion checking only
 437          => Int
 438          -> key -> elt
 439          -> FiniteMap key elt -> FiniteMap key elt
 440          -> FiniteMap key elt
 441
 442 mkBranch which key elt fm_l fm_r
 443   = --ASSERT( left_ok && right_ok && balance_ok )
 444 #if defined(COMPILING_GHC) && defined(DEBUG_FINITEMAPS)
 445     if not ( left_ok && right_ok && balance_ok ) then
 446         pprPanic ("mkBranch:"++show which) (vcat [ppr PprDebug [left_ok, right_ok, balance_ok],
 447                                        ppr PprDebug key,
 448                                        ppr PprDebug fm_l,
 449                                        ppr PprDebug fm_r])
 450     else
 451 #endif
 452     let
 453         result = Branch key elt (unbox (1 + left_size + right_size)) fm_l fm_r
 454     in
 455 --    if sizeFM result <= 8 then
 456         result
 457 --    else
 458 --      pprTrace ("mkBranch:"++(show which)) (ppr PprDebug result) (
 459 --      result
 460 --      )
 461   where
 462     left_ok  = case fm_l of
 463                 EmptyFM                  -> True
 464                 Branch left_key _ _ _ _  -> let
 465                                                 biggest_left_key = fst (findMax fm_l)
 466                                             in
 467                                             biggest_left_key < key
 468     right_ok = case fm_r of
 469                 EmptyFM                  -> True
 470                 Branch right_key _ _ _ _ -> let
 471                                                 smallest_right_key = fst (findMin fm_r)
 472                                             in
 473                                             key < smallest_right_key
 474     balance_ok = True -- sigh
 475 {- LATER:
 476     balance_ok
 477       = -- Both subtrees have one or no elements...
 478         (left_size + right_size <= 1)
 479 -- NO         || left_size == 0  -- ???
 480 -- NO         || right_size == 0 -- ???
 481         -- ... or the number of elements in a subtree does not exceed
 482         -- sIZE_RATIO times the number of elements in the other subtree
 483       || (left_size  * sIZE_RATIO >= right_size &&
 484           right_size * sIZE_RATIO >= left_size)
 485 -}
 486
 487     left_size  = sizeFM fm_l
 488     right_size = sizeFM fm_r
 489
 490 #ifdef __GLASGOW_HASKELL__
 491     unbox :: Int -> Int#
 492     unbox (I# size) = size
 493 #else
 494     unbox :: Int -> Int
 495     unbox x = x
 496 #endif
 497 \end{code}
 498
 499 %************************************************************************
 500 %*                                                                      *
 501 \subsubsection{{\em Balanced} construction of a @FiniteMap@}
 502 %*                                                                      *
 503 %************************************************************************
 504
 505 @mkBalBranch@ rebalances, assuming that the subtrees aren't too far
 506 out of whack.
 507
 508 \begin{code}
 509 mkBalBranch :: (Ord key OUTPUTABLE_key)
 510             => key -> elt
 511             -> FiniteMap key elt -> FiniteMap key elt
 512             -> FiniteMap key elt
 513
 514 mkBalBranch key elt fm_L fm_R
 515
 516   | size_l + size_r < 2
 517   = mkBranch 1{-which-} key elt fm_L fm_R
 518
 519   | size_r > sIZE_RATIO * size_l        -- Right tree too big
 520   = case fm_R of
 521         Branch _ _ _ fm_rl fm_rr
 522                 | sizeFM fm_rl < 2 * sizeFM fm_rr -> single_L fm_L fm_R
 523                 | otherwise                       -> double_L fm_L fm_R
 524         -- Other case impossible
 525
 526   | size_l > sIZE_RATIO * size_r        -- Left tree too big
 527   = case fm_L of
 528         Branch _ _ _ fm_ll fm_lr
 529                 | sizeFM fm_lr < 2 * sizeFM fm_ll -> single_R fm_L fm_R
 530                 | otherwise                       -> double_R fm_L fm_R
 531         -- Other case impossible
 532
 533   | otherwise                           -- No imbalance
 534   = mkBranch 2{-which-} key elt fm_L fm_R
 535
 536   where
 537     size_l   = sizeFM fm_L
 538     size_r   = sizeFM fm_R
 539
 540     single_L fm_l (Branch key_r elt_r _ fm_rl fm_rr)
 541         = mkBranch 3{-which-} key_r elt_r (mkBranch 4{-which-} key elt fm_l fm_rl) fm_rr
 542
 543     double_L fm_l (Branch key_r elt_r _ (Branch key_rl elt_rl _ fm_rll fm_rlr) fm_rr)
 544         = mkBranch 5{-which-} key_rl elt_rl (mkBranch 6{-which-} key   elt   fm_l   fm_rll)
 545                                  (mkBranch 7{-which-} key_r elt_r fm_rlr fm_rr)
 546
 547     single_R (Branch key_l elt_l _ fm_ll fm_lr) fm_r
 548         = mkBranch 8{-which-} key_l elt_l fm_ll (mkBranch 9{-which-} key elt fm_lr fm_r)
 549
 550     double_R (Branch key_l elt_l _ fm_ll (Branch key_lr elt_lr _ fm_lrl fm_lrr)) fm_r
 551         = mkBranch 10{-which-} key_lr elt_lr (mkBranch 11{-which-} key_l elt_l fm_ll  fm_lrl)
 552                                  (mkBranch 12{-which-} key   elt   fm_lrr fm_r)
 553 \end{code}
 554
 555
 556 \begin{code}
 557 mkVBalBranch :: (Ord key OUTPUTABLE_key)
 558              => key -> elt
 559              -> FiniteMap key elt -> FiniteMap key elt
 560              -> FiniteMap key elt
 561
 562 -- Assert: in any call to (mkVBalBranch_C comb key elt l r),
 563 --         (a) all keys in l are < all keys in r
 564 --         (b) all keys in l are < key
 565 --         (c) all keys in r are > key
 566
 567 mkVBalBranch key elt EmptyFM fm_r = addToFM fm_r key elt
 568 mkVBalBranch key elt fm_l EmptyFM = addToFM fm_l key elt
 569
 570 mkVBalBranch key elt fm_l@(Branch key_l elt_l _ fm_ll fm_lr)
 571                      fm_r@(Branch key_r elt_r _ fm_rl fm_rr)
 572   | sIZE_RATIO * size_l < size_r
 573   = mkBalBranch key_r elt_r (mkVBalBranch key elt fm_l fm_rl) fm_rr
 574
 575   | sIZE_RATIO * size_r < size_l
 576   = mkBalBranch key_l elt_l fm_ll (mkVBalBranch key elt fm_lr fm_r)
 577
 578   | otherwise
 579   = mkBranch 13{-which-} key elt fm_l fm_r
 580
 581   where
 582     size_l = sizeFM fm_l
 583     size_r = sizeFM fm_r
 584 \end{code}
 585
 586 %************************************************************************
 587 %*                                                                      *
 588 \subsubsection{Gluing two trees together}
 589 %*                                                                      *
 590 %************************************************************************
 591
 592 @glueBal@ assumes its two arguments aren't too far out of whack, just
 593 like @mkBalBranch@.  But: all keys in first arg are $<$ all keys in
 594 second.
 595
 596 \begin{code}
 597 glueBal :: (Ord key OUTPUTABLE_key)
 598         => FiniteMap key elt -> FiniteMap key elt
 599         -> FiniteMap key elt
 600
 601 glueBal EmptyFM fm2 = fm2
 602 glueBal fm1 EmptyFM = fm1
 603 glueBal fm1 fm2
 604         -- The case analysis here (absent in Adams' program) is really to deal
 605         -- with the case where fm2 is a singleton. Then deleting the minimum means
 606         -- we pass an empty tree to mkBalBranch, which breaks its invariant.
 607   | sizeFM fm2 > sizeFM fm1
 608   = mkBalBranch mid_key2 mid_elt2 fm1 (deleteMin fm2)
 609
 610   | otherwise
 611   = mkBalBranch mid_key1 mid_elt1 (deleteMax fm1) fm2
 612   where
 613     (mid_key1, mid_elt1) = findMax fm1
 614     (mid_key2, mid_elt2) = findMin fm2
 615 \end{code}
 616
 617 @glueVBal@ copes with arguments which can be of any size.
 618 But: all keys in first arg are $<$ all keys in second.
 619
 620 \begin{code}
 621 glueVBal :: (Ord key OUTPUTABLE_key)
 622          => FiniteMap key elt -> FiniteMap key elt
 623          -> FiniteMap key elt
 624
 625 glueVBal EmptyFM fm2 = fm2
 626 glueVBal fm1 EmptyFM = fm1
 627 glueVBal fm_l@(Branch key_l elt_l _ fm_ll fm_lr)
 628          fm_r@(Branch key_r elt_r _ fm_rl fm_rr)
 629   | sIZE_RATIO * size_l < size_r
 630   = mkBalBranch key_r elt_r (glueVBal fm_l fm_rl) fm_rr
 631
 632   | sIZE_RATIO * size_r < size_l
 633   = mkBalBranch key_l elt_l fm_ll (glueVBal fm_lr fm_r)
 634
 635   | otherwise           -- We now need the same two cases as in glueBal above.
 636   = glueBal fm_l fm_r
 637   where
 638     (mid_key_l,mid_elt_l) = findMax fm_l
 639     (mid_key_r,mid_elt_r) = findMin fm_r
 640     size_l = sizeFM fm_l
 641     size_r = sizeFM fm_r
 642 \end{code}
 643
 644 %************************************************************************
 645 %*                                                                      *
 646 \subsection{Local utilities}
 647 %*                                                                      *
 648 %************************************************************************
 649
 650 \begin{code}
 651 splitLT, splitGT :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> key -> FiniteMap key elt
 652
 653 -- splitLT fm split_key  =  fm restricted to keys <  split_key
 654 -- splitGT fm split_key  =  fm restricted to keys >  split_key
 655
 656 splitLT EmptyFM split_key = emptyFM
 657 splitLT (Branch key elt _ fm_l fm_r) split_key
 658 #ifdef __GLASGOW_HASKELL__
 659   = case _tagCmp split_key key of
 660         _LT -> splitLT fm_l split_key
 661         _GT -> mkVBalBranch key elt fm_l (splitLT fm_r split_key)
 662         _EQ -> fm_l
 663 #else
 664   | split_key < key = splitLT fm_l split_key
 665   | split_key > key = mkVBalBranch key elt fm_l (splitLT fm_r split_key)
 666   | otherwise       = fm_l
 667 #endif
 668
 669 splitGT EmptyFM split_key = emptyFM
 670 splitGT (Branch key elt _ fm_l fm_r) split_key
 671 #ifdef __GLASGOW_HASKELL__
 672   = case _tagCmp split_key key of
 673         _GT -> splitGT fm_r split_key
 674         _LT -> mkVBalBranch key elt (splitGT fm_l split_key) fm_r
 675         _EQ -> fm_r
 676 #else
 677   | split_key > key = splitGT fm_r split_key
 678   | split_key < key = mkVBalBranch key elt (splitGT fm_l split_key) fm_r
 679   | otherwise       = fm_r
 680 #endif
 681
 682 findMin :: FiniteMap key elt -> (key,elt)
 683 findMin (Branch key elt _ EmptyFM _) = (key,elt)
 684 findMin (Branch key elt _ fm_l    _) = findMin fm_l
 685
 686 deleteMin :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> FiniteMap key elt
 687 deleteMin (Branch key elt _ EmptyFM fm_r) = fm_r
 688 deleteMin (Branch key elt _ fm_l    fm_r) = mkBalBranch key elt (deleteMin fm_l) fm_r
 689
 690 findMax :: FiniteMap key elt -> (key,elt)
 691 findMax (Branch key elt _ _ EmptyFM) = (key,elt)
 692 findMax (Branch key elt _ _    fm_r) = findMax fm_r
 693
 694 deleteMax :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> FiniteMap key elt
 695 deleteMax (Branch key elt _ fm_l EmptyFM) = fm_l
 696 deleteMax (Branch key elt _ fm_l    fm_r) = mkBalBranch key elt fm_l (deleteMax fm_r)
 697 \end{code}
 698
 699 %************************************************************************
 700 %*                                                                      *
 701 \subsection{Output-ery}
 702 %*                                                                      *
 703 %************************************************************************
 704
 705 \begin{code}
 706 #if defined(COMPILING_GHC) && defined(DEBUG_FINITEMAPS)
 707
 708 instance (Outputable key) => Outputable (FiniteMap key elt) where
 709     ppr sty fm = pprX sty fm
 710
 711 pprX sty EmptyFM = char '!'
 712 pprX sty (Branch key elt sz fm_l fm_r)
 713  = parens (hcat [pprX sty fm_l, space,
 714                       ppr sty key, space, int (IF_GHC(I# sz, sz)), space,
 715                       pprX sty fm_r])
 716 #endif
 717
 718 #ifndef COMPILING_GHC
 719 instance (Eq key, Eq elt) => Eq (FiniteMap key elt) where
 720   fm_1 == fm_2 = (sizeFM   fm_1 == sizeFM   fm_2) &&   -- quick test
 721                  (fmToList fm_1 == fmToList fm_2)
 722
 723 {- NO: not clear what The Right Thing to do is:
 724 instance (Ord key, Ord elt) => Ord (FiniteMap key elt) where
 725   fm_1 <= fm_2 = (sizeFM   fm_1 <= sizeFM   fm_2) &&   -- quick test
 726                  (fmToList fm_1 <= fmToList fm_2)
 727 -}
 728 #endif
 729 \end{code}
 730
 731 %************************************************************************
 732 %*                                                                      *
 733 \subsection{FiniteSets---a thin veneer}
 734 %*                                                                      *
 735 %************************************************************************
 736
 737 \begin{code}
 738 #ifdef COMPILING_GHC
 739
 740 type FiniteSet key = FiniteMap key ()
 741 emptySet        :: FiniteSet key
 742 mkSet           :: (Ord key OUTPUTABLE_key) => [key] -> FiniteSet key
 743 isEmptySet      :: FiniteSet key -> Bool
 744 elementOf       :: (Ord key OUTPUTABLE_key) => key -> FiniteSet key -> Bool
 745 minusSet        :: (Ord key OUTPUTABLE_key) => FiniteSet key -> FiniteSet key -> FiniteSet key
 746 setToList       :: FiniteSet key -> [key]
 747 union           :: (Ord key OUTPUTABLE_key) => FiniteSet key -> FiniteSet key -> FiniteSet key
 748
 749 emptySet = emptyFM
 750 mkSet xs = listToFM [ (x, ()) | x <- xs]
 751 isEmptySet = isEmptyFM
 752 elementOf = elemFM
 753 minusSet  = minusFM
 754 setToList = keysFM
 755 union = plusFM
 756
 757 #endif
 758 \end{code}
 759
 760 %************************************************************************
 761 %*                                                                      *
 762 \subsection{Efficiency pragmas for GHC}
 763 %*                                                                      *
 764 %************************************************************************
 765
 766 When the FiniteMap module is used in GHC, we specialise it for
 767 \tr{Uniques}, for dastardly efficiency reasons.
 768
 769 \begin{code}
 770 #if defined(COMPILING_GHC) && __GLASGOW_HASKELL__ && !defined(REALLY_HASKELL_1_3)
 771
 772 {-# SPECIALIZE addListToFM
 773                 :: FiniteMap (FAST_STRING, FAST_STRING) elt -> [((FAST_STRING, FAST_STRING),elt)] -> FiniteMap (FAST_STRING, FAST_STRING) elt
 774                  , FiniteMap RdrName elt -> [(RdrName,elt)] -> FiniteMap RdrName elt
 775     IF_NCG(COMMA   FiniteMap Reg elt -> [(Reg COMMA elt)] -> FiniteMap Reg elt)
 776     #-}
 777 {-# SPECIALIZE addListToFM_C
 778                 :: (elt -> elt -> elt) -> FiniteMap TyCon elt -> [(TyCon,elt)] -> FiniteMap TyCon elt
 779                  , (elt -> elt -> elt) -> FiniteMap FAST_STRING elt -> [(FAST_STRING,elt)] -> FiniteMap FAST_STRING elt
 780     IF_NCG(COMMA   (elt -> elt -> elt) -> FiniteMap Reg elt -> [(Reg COMMA elt)] -> FiniteMap Reg elt)
 781     #-}
 782 {-# SPECIALIZE addToFM
 783                 :: FiniteMap CLabel elt -> CLabel -> elt  -> FiniteMap CLabel elt
 784                  , FiniteMap FAST_STRING elt -> FAST_STRING -> elt  -> FiniteMap FAST_STRING elt
 785                  , FiniteMap (FAST_STRING, FAST_STRING) elt -> (FAST_STRING, FAST_STRING) -> elt  -> FiniteMap (FAST_STRING, FAST_STRING) elt
 786                  , FiniteMap RdrName elt -> RdrName -> elt  -> FiniteMap RdrName elt
 787     IF_NCG(COMMA   FiniteMap Reg elt -> Reg -> elt  -> FiniteMap Reg elt)
 788     #-}
 789 {-# SPECIALIZE addToFM_C
 790                 :: (elt -> elt -> elt) -> FiniteMap (RdrName, RdrName) elt -> (RdrName, RdrName) -> elt -> FiniteMap (RdrName, RdrName) elt
 791                  , (elt -> elt -> elt) -> FiniteMap FAST_STRING elt -> FAST_STRING -> elt -> FiniteMap FAST_STRING elt
 792     IF_NCG(COMMA   (elt -> elt -> elt) -> FiniteMap Reg elt -> Reg -> elt -> FiniteMap Reg elt)
 793     #-}
 794 {-# SPECIALIZE bagToFM
 795                 :: Bag (FAST_STRING,elt) -> FiniteMap FAST_STRING elt
 796     #-}
 797 {-# SPECIALIZE delListFromFM
 798                 :: FiniteMap RdrName elt -> [RdrName]   -> FiniteMap RdrName elt
 799                  , FiniteMap FAST_STRING elt -> [FAST_STRING]   -> FiniteMap FAST_STRING elt
 800     IF_NCG(COMMA   FiniteMap Reg elt -> [Reg]   -> FiniteMap Reg elt)
 801     #-}
 802 {-# SPECIALIZE listToFM
 803                 :: [([Char],elt)] -> FiniteMap [Char] elt
 804                  , [(FAST_STRING,elt)] -> FiniteMap FAST_STRING elt
 805                  , [((FAST_STRING,FAST_STRING),elt)] -> FiniteMap (FAST_STRING, FAST_STRING) elt
 806     IF_NCG(COMMA   [(Reg COMMA elt)] -> FiniteMap Reg elt)
 807     #-}
 808 {-# SPECIALIZE lookupFM
 809                 :: FiniteMap CLabel elt -> CLabel -> Maybe elt
 810                  , FiniteMap [Char] elt -> [Char] -> Maybe elt
 811                  , FiniteMap FAST_STRING elt -> FAST_STRING -> Maybe elt
 812                  , FiniteMap (FAST_STRING,FAST_STRING) elt -> (FAST_STRING,FAST_STRING) -> Maybe elt
 813                  , FiniteMap RdrName elt -> RdrName -> Maybe elt
 814                  , FiniteMap (RdrName,RdrName) elt -> (RdrName,RdrName) -> Maybe elt
 815     IF_NCG(COMMA   FiniteMap Reg elt -> Reg -> Maybe elt)
 816     #-}
 817 {-# SPECIALIZE lookupWithDefaultFM
 818                 :: FiniteMap FAST_STRING elt -> elt -> FAST_STRING -> elt
 819     IF_NCG(COMMA   FiniteMap Reg elt -> elt -> Reg -> elt)
 820     #-}
 821 {-# SPECIALIZE plusFM
 822                 :: FiniteMap RdrName elt -> FiniteMap RdrName elt -> FiniteMap RdrName elt
 823                  , FiniteMap FAST_STRING elt -> FiniteMap FAST_STRING elt -> FiniteMap FAST_STRING elt
 824     IF_NCG(COMMA   FiniteMap Reg elt -> FiniteMap Reg elt -> FiniteMap Reg elt)
 825     #-}
 826 {-# SPECIALIZE plusFM_C
 827                 :: (elt -> elt -> elt) -> FiniteMap FAST_STRING elt -> FiniteMap FAST_STRING elt -> FiniteMap FAST_STRING elt
 828     IF_NCG(COMMA   (elt -> elt -> elt) -> FiniteMap Reg elt -> FiniteMap Reg elt -> FiniteMap Reg elt)
 829     #-}
 830
 831 #endif {- compiling for GHC -}
 832 \end{code}