ghc/compiler/utils/UniqFM.lhs

   1 %
   2 % (c) The AQUA Project, Glasgow University, 1994-1996
   3 %
   4 \section[UniqFM]{Specialised finite maps, for things with @Uniques@}
   5
   6 Based on @FiniteMaps@ (as you would expect).
   7
   8 Basically, the things need to be in class @Uniquable@, and we use the
   9 @uniqueOf@ method to grab their @Uniques@.
  10
  11 (A similar thing to @UniqSet@, as opposed to @Set@.)
  12
  13 \begin{code}
  14 module UniqFM (
  15         UniqFM,   -- abstract type
  16
  17         emptyUFM,
  18         unitUFM,
  19         unitDirectlyUFM,
  20         listToUFM,
  21         listToUFM_Directly,
  22         addToUFM,addToUFM_C,
  23         addListToUFM,addListToUFM_C,
  24         addToUFM_Directly,
  25         addListToUFM_Directly,
  26         delFromUFM,
  27         delFromUFM_Directly,
  28         delListFromUFM,
  29         plusUFM,
  30         plusUFM_C,
  31         minusUFM,
  32         intersectUFM,
  33         intersectUFM_C,
  34         foldUFM,
  35         mapUFM,
  36         filterUFM,
  37         sizeUFM,
  38         isNullUFM,
  39         lookupUFM, lookupUFM_Directly,
  40         lookupWithDefaultUFM, lookupWithDefaultUFM_Directly,
  41         eltsUFM, keysUFM,
  42         ufmToList,
  43         FastString
  44     ) where
  45
  46 #include "HsVersions.h"
  47
  48 import {-# SOURCE #-} Name      ( Name )
  49
  50 import Unique           ( Uniquable(..), Unique, u2i, mkUniqueGrimily )
  51 import Util
  52 import Outputable       ( Outputable(..) )
  53 import SrcLoc           ( SrcLoc )
  54 import GlaExts          -- Lots of Int# operations
  55
  56 #if ! OMIT_NATIVE_CODEGEN
  57 #define IF_NCG(a) a
  58 #else
  59 #define IF_NCG(a) {--}
  60 #endif
  61 \end{code}
  62
  63 %************************************************************************
  64 %*                                                                      *
  65 \subsection{The @UniqFM@ type, and signatures for the functions}
  66 %*                                                                      *
  67 %************************************************************************
  68
  69 We use @FiniteMaps@, with a (@uniqueOf@-able) @Unique@ as ``key''.
  70
  71 \begin{code}
  72 emptyUFM        :: UniqFM elt
  73 isNullUFM       :: UniqFM elt -> Bool
  74 unitUFM         :: Uniquable key => key -> elt -> UniqFM elt
  75 unitDirectlyUFM -- got the Unique already
  76                 :: Unique -> elt -> UniqFM elt
  77 listToUFM       :: Uniquable key => [(key,elt)] -> UniqFM elt
  78 listToUFM_Directly
  79                 :: [(Unique, elt)] -> UniqFM elt
  80
  81 addToUFM        :: Uniquable key => UniqFM elt -> key -> elt  -> UniqFM elt
  82 addListToUFM    :: Uniquable key => UniqFM elt -> [(key,elt)] -> UniqFM elt
  83 addToUFM_Directly
  84                 :: UniqFM elt -> Unique -> elt -> UniqFM elt
  85
  86 addToUFM_C      :: Uniquable key => (elt -> elt -> elt)
  87                            -> UniqFM elt -> key -> elt -> UniqFM elt
  88 addListToUFM_C  :: Uniquable key => (elt -> elt -> elt)
  89                            -> UniqFM elt -> [(key,elt)]
  90                            -> UniqFM elt
  91
  92 delFromUFM      :: Uniquable key => UniqFM elt -> key    -> UniqFM elt
  93 delListFromUFM  :: Uniquable key => UniqFM elt -> [key] -> UniqFM elt
  94 delFromUFM_Directly :: UniqFM elt -> Unique -> UniqFM elt
  95
  96 plusUFM         :: UniqFM elt -> UniqFM elt -> UniqFM elt
  97
  98 plusUFM_C       :: (elt -> elt -> elt)
  99                 -> UniqFM elt -> UniqFM elt -> UniqFM elt
 100
 101 minusUFM        :: UniqFM elt -> UniqFM elt -> UniqFM elt
 102
 103 intersectUFM    :: UniqFM elt -> UniqFM elt -> UniqFM elt
 104 intersectUFM_C  :: (elt -> elt -> elt)
 105                 -> UniqFM elt -> UniqFM elt -> UniqFM elt
 106 foldUFM         :: (elt -> a -> a) -> a -> UniqFM elt -> a
 107 mapUFM          :: (elt1 -> elt2) -> UniqFM elt1 -> UniqFM elt2
 108 filterUFM       :: (elt -> Bool) -> UniqFM elt -> UniqFM elt
 109
 110 sizeUFM         :: UniqFM elt -> Int
 111
 112 lookupUFM       :: Uniquable key => UniqFM elt -> key -> Maybe elt
 113 lookupUFM_Directly  -- when you've got the Unique already
 114                 :: UniqFM elt -> Unique -> Maybe elt
 115 lookupWithDefaultUFM
 116                 :: Uniquable key => UniqFM elt -> elt -> key -> elt
 117 lookupWithDefaultUFM_Directly
 118                 :: UniqFM elt -> elt -> Unique -> elt
 119
 120 keysUFM         :: UniqFM elt -> [Int]          -- Get the keys
 121 eltsUFM         :: UniqFM elt -> [elt]
 122 ufmToList       :: UniqFM elt -> [(Unique, elt)]
 123 \end{code}
 124
 125 %************************************************************************
 126 %*                                                                      *
 127 \subsection{The @IdFinMap@ and @TyVarFinMap@ specialisations for Ids/TyVars}
 128 %*                                                                      *
 129 %************************************************************************
 130
 131 \begin{code}
 132 #ifdef __GLASGOW_HASKELL__
 133 -- I don't think HBC was too happy about this (WDP 94/10)
 134
 135 {-# SPECIALIZE
 136     addListToUFM :: UniqFM elt -> [(Name,   elt)] -> UniqFM elt
 137   #-}
 138 {-# SPECIALIZE
 139     addListToUFM_C :: (elt -> elt -> elt) -> UniqFM elt -> [(Name,  elt)] -> UniqFM elt
 140   #-}
 141 {-# SPECIALIZE
 142     addToUFM    :: UniqFM elt -> Unique -> elt  -> UniqFM elt
 143   #-}
 144 {-# SPECIALIZE
 145     listToUFM   :: [(Unique, elt)]     -> UniqFM elt
 146   #-}
 147 {-# SPECIALIZE
 148     lookupUFM   :: UniqFM elt -> Name   -> Maybe elt
 149                  , UniqFM elt -> Unique -> Maybe elt
 150   #-}
 151
 152 #endif {- __GLASGOW_HASKELL__ -}
 153 \end{code}
 154
 155 %************************************************************************
 156 %*                                                                      *
 157 \subsection{Andy Gill's underlying @UniqFM@ machinery}
 158 %*                                                                      *
 159 %************************************************************************
 160
 161 ``Uniq Finite maps'' are the heart and soul of the compiler's
 162 lookup-tables/environments.  Important stuff!  It works well with
 163 Dense and Sparse ranges.
 164 Both @Uq@ Finite maps and @Hash@ Finite Maps
 165 are built ontop of Int Finite Maps.
 166
 167 This code is explained in the paper:
 168 \begin{display}
 169         A Gill, S Peyton Jones, B O'Sullivan, W Partain and Aqua Friends
 170         "A Cheap balancing act that grows on a tree"
 171         Glasgow FP Workshop, Sep 1994, pp??-??
 172 \end{display}
 173
 174 %************************************************************************
 175 %*                                                                      *
 176 \subsubsection{The @UniqFM@ type, and signatures for the functions}
 177 %*                                                                      *
 178 %************************************************************************
 179
 180 @UniqFM a@ is a mapping from Unique to a.
 181
 182 First, the DataType itself; which is either a Node, a Leaf, or an Empty.
 183
 184 \begin{code}
 185 data UniqFM ele
 186   = EmptyUFM
 187   | LeafUFM FAST_INT ele
 188   | NodeUFM FAST_INT        -- the switching
 189             FAST_INT        -- the delta
 190             (UniqFM ele)
 191             (UniqFM ele)
 192
 193 -- for debugging only :-)
 194 {-
 195 instance Text (UniqFM a) where
 196         showsPrec _ (NodeUFM a b t1 t2) =
 197                   showString "NodeUFM " . shows (IBOX(a))
 198                 . showString " " . shows (IBOX(b))
 199                 . showString " (" . shows t1
 200                 . showString ") (" . shows t2
 201                 . showString ")"
 202         showsPrec _ (LeafUFM x a) = showString "LeafUFM " . shows (IBOX(x))
 203         showsPrec _ (EmptyUFM) = id
 204 -}
 205 \end{code}
 206
 207 %************************************************************************
 208 %*                                                                      *
 209 \subsubsection{The @UniqFM@ functions}
 210 %*                                                                      *
 211 %************************************************************************
 212
 213 First the ways of building a UniqFM.
 214
 215 \begin{code}
 216 emptyUFM                     = EmptyUFM
 217 unitUFM      key elt = mkLeafUFM (u2i (uniqueOf key)) elt
 218 unitDirectlyUFM key elt = mkLeafUFM (u2i key) elt
 219
 220 listToUFM key_elt_pairs
 221   = addListToUFM_C use_snd EmptyUFM key_elt_pairs
 222
 223 listToUFM_Directly uniq_elt_pairs
 224   = addListToUFM_directly_C use_snd EmptyUFM uniq_elt_pairs
 225 \end{code}
 226
 227 Now ways of adding things to UniqFMs.
 228
 229 There is an alternative version of @addListToUFM_C@, that uses @plusUFM@,
 230 but the semantics of this operation demands a linear insertion;
 231 perhaps the version without the combinator function
 232 could be optimised using it.
 233
 234 \begin{code}
 235 addToUFM fm key elt = addToUFM_C use_snd fm key elt
 236
 237 addToUFM_Directly fm u elt = insert_ele use_snd fm (u2i u) elt
 238
 239 addToUFM_C combiner fm key elt
 240   = insert_ele combiner fm (u2i (uniqueOf key)) elt
 241
 242 addListToUFM fm key_elt_pairs = addListToUFM_C use_snd fm key_elt_pairs
 243 addListToUFM_Directly fm uniq_elt_pairs = addListToUFM_directly_C use_snd fm uniq_elt_pairs
 244
 245 addListToUFM_C combiner fm key_elt_pairs
 246  = foldl (\ fm (k, e) -> insert_ele combiner fm (u2i (uniqueOf k)) e)
 247          fm key_elt_pairs
 248
 249 addListToUFM_directly_C combiner fm uniq_elt_pairs
 250  = foldl (\ fm (k, e) -> insert_ele combiner fm (u2i k) e)
 251          fm uniq_elt_pairs
 252 \end{code}
 253
 254 Now ways of removing things from UniqFM.
 255
 256 \begin{code}
 257 delListFromUFM fm lst = foldl delFromUFM fm lst
 258
 259 delFromUFM          fm key = delete fm (u2i (uniqueOf key))
 260 delFromUFM_Directly fm u   = delete fm (u2i u)
 261
 262 delete EmptyUFM _   = EmptyUFM
 263 delete fm       key = del_ele fm
 264   where
 265     del_ele :: UniqFM a -> UniqFM a
 266
 267     del_ele lf@(LeafUFM j _)
 268       | j _EQ_ key      = EmptyUFM
 269       | otherwise       = lf    -- no delete!
 270
 271     del_ele nd@(NodeUFM j p t1 t2)
 272       | j _GT_ key
 273       = mkSLNodeUFM (NodeUFMData j p) (del_ele t1) t2
 274       | otherwise
 275       = mkLSNodeUFM (NodeUFMData j p) t1 (del_ele t2)
 276
 277     del_ele _ = panic "Found EmptyUFM FM when rec-deleting"
 278 \end{code}
 279
 280 Now ways of adding two UniqFM's together.
 281
 282 \begin{code}
 283 plusUFM tr1 tr2 = plusUFM_C use_snd tr1 tr2
 284
 285 plusUFM_C f EmptyUFM tr = tr
 286 plusUFM_C f tr EmptyUFM = tr
 287 plusUFM_C f fm1 fm2     = mix_trees fm1 fm2
 288     where
 289         mix_trees (LeafUFM i a) t2 = insert_ele (flip f) t2 i a
 290         mix_trees t1 (LeafUFM i a) = insert_ele f        t1 i a
 291
 292         mix_trees left_t@(NodeUFM j p t1 t2) right_t@(NodeUFM j' p' t1' t2')
 293           = mix_branches
 294                 (ask_about_common_ancestor
 295                         (NodeUFMData j p)
 296                         (NodeUFMData j' p'))
 297           where
 298                 -- Given a disjoint j,j' (p >^ p' && p' >^ p):
 299                 --
 300                 --        j             j'                      (C j j')
 301                 --       / \    +      / \      ==>             /       \
 302                 --     t1   t2      t1'   t2'                  j         j'
 303                 --                                            / \       / \
 304                 --                                           t1  t2   t1'  t2'
 305                 -- Fast, Ehh !
 306                 --
 307           mix_branches (NewRoot nd False)
 308                 = mkLLNodeUFM nd left_t right_t
 309           mix_branches (NewRoot nd True)
 310                 = mkLLNodeUFM nd right_t left_t
 311
 312                 -- Now, if j == j':
 313                 --
 314                 --        j             j'                       j
 315                 --       / \    +      / \      ==>             / \
 316                 --     t1   t2      t1'   t2'           t1 + t1'   t2 + t2'
 317                 --
 318           mix_branches (SameRoot)
 319                 = mkSSNodeUFM (NodeUFMData j p)
 320                         (mix_trees t1 t1')
 321                         (mix_trees t2 t2')
 322                 -- Now the 4 different other ways; all like this:
 323                 --
 324                 -- Given j >^ j' (and, say,  j > j')
 325                 --
 326                 --        j             j'                       j
 327                 --       / \    +      / \      ==>             / \
 328                 --     t1   t2      t1'   t2'                 t1   t2 + j'
 329                 --                                                     / \
 330                 --                                                   t1'  t2'
 331           mix_branches (LeftRoot Leftt) -- | trace "LL" True
 332             = mkSLNodeUFM
 333                 (NodeUFMData j p)
 334                 (mix_trees t1 right_t)
 335                 t2
 336
 337           mix_branches (LeftRoot Rightt) -- | trace "LR" True
 338             = mkLSNodeUFM
 339                 (NodeUFMData j p)
 340                 t1
 341                 (mix_trees t2 right_t)
 342
 343           mix_branches (RightRoot Leftt) -- | trace "RL" True
 344             = mkSLNodeUFM
 345                 (NodeUFMData j' p')
 346                 (mix_trees left_t t1')
 347                 t2'
 348
 349           mix_branches (RightRoot Rightt) -- | trace "RR" True
 350             = mkLSNodeUFM
 351                 (NodeUFMData j' p')
 352                 t1'
 353                 (mix_trees left_t t2')
 354
 355         mix_trees _ _ = panic "EmptyUFM found when inserting into plusInt"
 356 \end{code}
 357
 358 And ways of subtracting them. First the base cases,
 359 then the full D&C approach.
 360
 361 \begin{code}
 362 minusUFM EmptyUFM _  = EmptyUFM
 363 minusUFM t1 EmptyUFM = t1
 364 minusUFM fm1 fm2     = minus_trees fm1 fm2
 365     where
 366         --
 367         -- Notice the asymetry of subtraction
 368         --
 369         minus_trees lf@(LeafUFM i a) t2 =
 370                 case lookUp t2 i of
 371                   Nothing -> lf
 372                   Just b -> EmptyUFM
 373
 374         minus_trees t1 (LeafUFM i _) = delete t1 i
 375
 376         minus_trees left_t@(NodeUFM j p t1 t2) right_t@(NodeUFM j' p' t1' t2')
 377           = minus_branches
 378                 (ask_about_common_ancestor
 379                         (NodeUFMData j p)
 380                         (NodeUFMData j' p'))
 381           where
 382                 -- Given a disjoint j,j' (p >^ p' && p' >^ p):
 383                 --
 384                 --        j             j'                 j
 385                 --       / \    +      / \      ==>       / \
 386                 --     t1   t2      t1'   t2'            t1  t2
 387                 --
 388                 --
 389                 -- Fast, Ehh !
 390                 --
 391           minus_branches (NewRoot nd _) = left_t
 392
 393                 -- Now, if j == j':
 394                 --
 395                 --        j             j'                       j
 396                 --       / \    +      / \      ==>             / \
 397                 --     t1   t2      t1'   t2'           t1 + t1'   t2 + t2'
 398                 --
 399           minus_branches (SameRoot)
 400                 = mkSSNodeUFM (NodeUFMData j p)
 401                         (minus_trees t1 t1')
 402                         (minus_trees t2 t2')
 403                 -- Now the 4 different other ways; all like this:
 404                 -- again, with asymatry
 405
 406                 --
 407                 -- The left is above the right
 408                 --
 409           minus_branches (LeftRoot Leftt)
 410             = mkSLNodeUFM
 411                 (NodeUFMData j p)
 412                 (minus_trees t1 right_t)
 413                 t2
 414           minus_branches (LeftRoot Rightt)
 415             = mkLSNodeUFM
 416                 (NodeUFMData j p)
 417                 t1
 418                 (minus_trees t2 right_t)
 419
 420                 --
 421                 -- The right is above the left
 422                 --
 423           minus_branches (RightRoot Leftt)
 424             = minus_trees left_t t1'
 425           minus_branches (RightRoot Rightt)
 426             = minus_trees left_t t2'
 427
 428         minus_trees _ _ = panic "EmptyUFM found when insering into plusInt"
 429 \end{code}
 430
 431 And taking the intersection of two UniqFM's.
 432
 433 \begin{code}
 434 intersectUFM t1 t2 = intersectUFM_C use_snd t1 t2
 435
 436 intersectUFM_C f EmptyUFM _ = EmptyUFM
 437 intersectUFM_C f _ EmptyUFM = EmptyUFM
 438 intersectUFM_C f fm1 fm2    = intersect_trees fm1 fm2
 439     where
 440         intersect_trees (LeafUFM i a) t2 =
 441                 case lookUp t2 i of
 442                   Nothing -> EmptyUFM
 443                   Just b -> mkLeafUFM i (f a b)
 444
 445         intersect_trees t1 (LeafUFM i a) =
 446                 case lookUp t1 i of
 447                   Nothing -> EmptyUFM
 448                   Just b -> mkLeafUFM i (f b a)
 449
 450         intersect_trees left_t@(NodeUFM j p t1 t2) right_t@(NodeUFM j' p' t1' t2')
 451           = intersect_branches
 452                 (ask_about_common_ancestor
 453                         (NodeUFMData j p)
 454                         (NodeUFMData j' p'))
 455           where
 456                 -- Given a disjoint j,j' (p >^ p' && p' >^ p):
 457                 --
 458                 --        j             j'
 459                 --       / \    +      / \      ==>             EmptyUFM
 460                 --     t1   t2      t1'   t2'
 461                 --
 462                 -- Fast, Ehh !
 463                 --
 464           intersect_branches (NewRoot nd _) = EmptyUFM
 465
 466                 -- Now, if j == j':
 467                 --
 468                 --        j             j'                       j
 469                 --       / \    +      / \      ==>             / \
 470                 --     t1   t2      t1'   t2'           t1 x t1'   t2 x t2'
 471                 --
 472           intersect_branches (SameRoot)
 473                 = mkSSNodeUFM (NodeUFMData j p)
 474                         (intersect_trees t1 t1')
 475                         (intersect_trees t2 t2')
 476                 -- Now the 4 different other ways; all like this:
 477                 --
 478                 -- Given j >^ j' (and, say,  j > j')
 479                 --
 480                 --        j             j'                     t2 + j'
 481                 --       / \    +      / \      ==>                / \
 482                 --     t1   t2      t1'   t2'                    t1'  t2'
 483                 --
 484                 -- This does cut down the search space quite a bit.
 485
 486           intersect_branches (LeftRoot Leftt)
 487             = intersect_trees t1 right_t
 488           intersect_branches (LeftRoot Rightt)
 489             = intersect_trees t2 right_t
 490           intersect_branches (RightRoot Leftt)
 491             = intersect_trees left_t t1'
 492           intersect_branches (RightRoot Rightt)
 493             = intersect_trees left_t t2'
 494
 495         intersect_trees x y = panic ("EmptyUFM found when intersecting trees")
 496 \end{code}
 497
 498 Now the usual set of `collection' operators, like map, fold, etc.
 499
 500 \begin{code}
 501 foldUFM f a (NodeUFM _ _ t1 t2) = foldUFM f (foldUFM f a t2) t1
 502 foldUFM f a (LeafUFM _ obj)     = f obj a
 503 foldUFM f a EmptyUFM            = a
 504 \end{code}
 505
 506 \begin{code}
 507 mapUFM fn EmptyUFM    = EmptyUFM
 508 mapUFM fn fm          = map_tree fn fm
 509
 510 filterUFM fn EmptyUFM = EmptyUFM
 511 filterUFM fn fm       = filter_tree fn fm
 512 \end{code}
 513
 514 Note, this takes a long time, O(n), but
 515 because we dont want to do this very often, we put up with this.
 516 O'rable, but how often do we look at the size of
 517 a finite map?
 518
 519 \begin{code}
 520 sizeUFM EmptyUFM            = 0
 521 sizeUFM (NodeUFM _ _ t1 t2) = sizeUFM t1 + sizeUFM t2
 522 sizeUFM (LeafUFM _ _)       = 1
 523
 524 isNullUFM EmptyUFM = True
 525 isNullUFM _        = False
 526 \end{code}
 527
 528 looking up in a hurry is the {\em whole point} of this binary tree lark.
 529 Lookup up a binary tree is easy (and fast).
 530
 531 \begin{code}
 532 lookupUFM          fm key = lookUp fm (u2i (uniqueOf key))
 533 lookupUFM_Directly fm key = lookUp fm (u2i key)
 534
 535 lookupWithDefaultUFM fm deflt key
 536   = case lookUp fm (u2i (uniqueOf key)) of
 537       Nothing  -> deflt
 538       Just elt -> elt
 539
 540 lookupWithDefaultUFM_Directly fm deflt key
 541   = case lookUp fm (u2i key) of
 542       Nothing  -> deflt
 543       Just elt -> elt
 544
 545 lookUp EmptyUFM _   = Nothing
 546 lookUp fm i         = lookup_tree fm
 547   where
 548         lookup_tree :: UniqFM a -> Maybe a
 549
 550         lookup_tree (LeafUFM j b)
 551           | j _EQ_ i    = Just b
 552           | otherwise   = Nothing
 553         lookup_tree (NodeUFM j p t1 t2)
 554           | j _GT_ i    = lookup_tree t1
 555           | otherwise   = lookup_tree t2
 556
 557         lookup_tree EmptyUFM = panic "lookup Failed"
 558 \end{code}
 559
 560 folds are *wonderful* things.
 561
 562 \begin{code}
 563 eltsUFM fm = foldUFM (:) [] fm
 564
 565 ufmToList fm = fold_tree (\ iu elt rest -> (mkUniqueGrimily iu, elt) : rest) [] fm
 566
 567 keysUFM fm = fold_tree (\ iu elt rest -> IBOX(iu) : rest) [] fm
 568
 569 fold_tree f a (NodeUFM _ _ t1 t2) = fold_tree f (fold_tree f a t2) t1
 570 fold_tree f a (LeafUFM iu obj)    = f iu obj a
 571 fold_tree f a EmptyUFM            = a
 572 \end{code}
 573
 574 %************************************************************************
 575 %*                                                                      *
 576 \subsubsection{The @UniqFM@ type, and its functions}
 577 %*                                                                      *
 578 %************************************************************************
 579
 580 You should always use these to build the tree.
 581 There are 4 versions of mkNodeUFM, depending on
 582 the strictness of the two sub-tree arguments.
 583 The strictness is used *both* to prune out
 584 empty trees, *and* to improve performance,
 585 stoping needless thunks lying around.
 586 The rule of thumb (from experence with these trees)
 587 is make thunks strict, but data structures lazy.
 588 If in doubt, use mkSSNodeUFM, which has the `strongest'
 589 functionality, but may do a few needless evaluations.
 590
 591 \begin{code}
 592 mkLeafUFM :: FAST_INT -> a -> UniqFM a
 593 mkLeafUFM i a     = LeafUFM i a
 594
 595 -- The *ONLY* ways of building a NodeUFM.
 596
 597 mkSSNodeUFM (NodeUFMData j p) EmptyUFM t2 = t2
 598 mkSSNodeUFM (NodeUFMData j p) t1 EmptyUFM = t1
 599 mkSSNodeUFM (NodeUFMData j p) t1 t2
 600   = ASSERT(correctNodeUFM (IBOX(j)) (IBOX(p)) t1 t2)
 601     NodeUFM j p t1 t2
 602
 603 mkSLNodeUFM (NodeUFMData j p) EmptyUFM t2 = t2
 604 mkSLNodeUFM (NodeUFMData j p) t1 t2
 605   = ASSERT(correctNodeUFM (IBOX(j)) (IBOX(p)) t1 t2)
 606     NodeUFM j p t1 t2
 607
 608 mkLSNodeUFM (NodeUFMData j p) t1 EmptyUFM = t1
 609 mkLSNodeUFM (NodeUFMData j p) t1 t2
 610   = ASSERT(correctNodeUFM (IBOX(j)) (IBOX(p)) t1 t2)
 611     NodeUFM j p t1 t2
 612
 613 mkLLNodeUFM (NodeUFMData j p) t1 t2
 614   = ASSERT(correctNodeUFM (IBOX(j)) (IBOX(p)) t1 t2)
 615     NodeUFM j p t1 t2
 616
 617 correctNodeUFM
 618         :: Int
 619         -> Int
 620         -> UniqFM a
 621         -> UniqFM a
 622         -> Bool
 623
 624 correctNodeUFM j p t1 t2
 625   = correct (j-p) (j-1) p t1 && correct j ((j-1)+p) p t2
 626   where
 627     correct low high _ (LeafUFM i _)
 628       = low <= IBOX(i) && IBOX(i) <= high
 629     correct low high above_p (NodeUFM j p _ _)
 630       = low <= IBOX(j) && IBOX(j) <= high && above_p > IBOX(p)
 631     correct _ _ _ EmptyUFM = panic "EmptyUFM stored inside a tree"
 632 \end{code}
 633
 634 Note: doing SAT on this by hand seems to make it worse. Todo: Investigate,
 635 and if necessary do $\lambda$ lifting on our functions that are bound.
 636
 637 \begin{code}
 638 insert_ele
 639         :: (a -> a -> a)
 640         -> UniqFM a
 641         -> FAST_INT
 642         -> a
 643         -> UniqFM a
 644
 645 insert_ele f EmptyUFM i new = mkLeafUFM i new
 646
 647 insert_ele f (LeafUFM j old) i new
 648   | j _GT_ i =
 649           mkLLNodeUFM (getCommonNodeUFMData
 650                           (indexToRoot i)
 651                           (indexToRoot j))
 652                  (mkLeafUFM i new)
 653                  (mkLeafUFM j old)
 654   | j _EQ_ i  = mkLeafUFM j (f old new)
 655   | otherwise =
 656           mkLLNodeUFM (getCommonNodeUFMData
 657                           (indexToRoot i)
 658                           (indexToRoot j))
 659                  (mkLeafUFM j old)
 660                  (mkLeafUFM i new)
 661
 662 insert_ele f n@(NodeUFM j p t1 t2) i a
 663   | i _LT_ j
 664     = if (i _GE_ (j _SUB_ p))
 665       then mkSLNodeUFM (NodeUFMData j p) (insert_ele f t1 i a) t2
 666       else mkLLNodeUFM (getCommonNodeUFMData
 667                           (indexToRoot i)
 668                           ((NodeUFMData j p)))
 669                   (mkLeafUFM i a)
 670                   n
 671   | otherwise
 672     = if (i _LE_ ((j _SUB_ ILIT(1)) _ADD_ p))
 673       then mkLSNodeUFM (NodeUFMData j p) t1 (insert_ele f t2 i a)
 674       else mkLLNodeUFM (getCommonNodeUFMData
 675                           (indexToRoot i)
 676                           ((NodeUFMData j p)))
 677                   n
 678                   (mkLeafUFM i a)
 679 \end{code}
 680
 681
 682
 683 \begin{code}
 684 map_tree f (NodeUFM j p t1 t2)
 685   = mkSSNodeUFM (NodeUFMData j p) (map_tree f t1) (map_tree f t2)
 686 map_tree f (LeafUFM i obj)
 687   = mkLeafUFM i (f obj)
 688
 689 map_tree f _ = panic "map_tree failed"
 690 \end{code}
 691
 692 \begin{code}
 693 filter_tree f nd@(NodeUFM j p t1 t2)
 694   = mkSSNodeUFM (NodeUFMData j p) (filter_tree f t1) (filter_tree f t2)
 695
 696 filter_tree f lf@(LeafUFM i obj)
 697   | f obj = lf
 698   | otherwise = EmptyUFM
 699 filter_tree f _ = panic "filter_tree failed"
 700 \end{code}
 701
 702 %************************************************************************
 703 %*                                                                      *
 704 \subsubsection{The @UniqFM@ type, and signatures for the functions}
 705 %*                                                                      *
 706 %************************************************************************
 707
 708 Now some Utilities;
 709
 710 This is the information that is held inside a NodeUFM, packaged up for
 711 consumer use.
 712
 713 \begin{code}
 714 data NodeUFMData
 715   = NodeUFMData FAST_INT
 716                 FAST_INT
 717 \end{code}
 718
 719 This is the information used when computing new NodeUFMs.
 720
 721 \begin{code}
 722 data Side = Leftt | Rightt -- NB: avoid 1.3 names "Left" and "Right"
 723 data CommonRoot
 724   = LeftRoot  Side      -- which side is the right down ?
 725   | RightRoot Side      -- which side is the left down ?
 726   | SameRoot            -- they are the same !
 727   | NewRoot NodeUFMData -- here's the new, common, root
 728             Bool        -- do you need to swap left and right ?
 729 \end{code}
 730
 731 This specifies the relationship between NodeUFMData and CalcNodeUFMData.
 732
 733 \begin{code}
 734 indexToRoot :: FAST_INT -> NodeUFMData
 735
 736 indexToRoot i
 737   = let
 738         l = (ILIT(1) :: FAST_INT)
 739     in
 740     NodeUFMData (((i `shiftR_` l) `shiftL_` l) _ADD_ ILIT(1)) l
 741
 742 getCommonNodeUFMData :: NodeUFMData -> NodeUFMData -> NodeUFMData
 743
 744 getCommonNodeUFMData (NodeUFMData i p) (NodeUFMData i2 p2)
 745   | p _EQ_ p2   = getCommonNodeUFMData_ p j j2
 746   | p _LT_ p2   = getCommonNodeUFMData_ p2 (j _QUOT_ (p2 _QUOT_ p)) j2
 747   | otherwise   = getCommonNodeUFMData_ p j (j2 _QUOT_ (p _QUOT_ p2))
 748   where
 749     l  = (ILIT(1) :: FAST_INT)
 750     j  = i  _QUOT_ (p  `shiftL_` l)
 751     j2 = i2 _QUOT_ (p2 `shiftL_` l)
 752
 753     getCommonNodeUFMData_ :: FAST_INT -> FAST_INT -> FAST_INT -> NodeUFMData
 754
 755     getCommonNodeUFMData_ p j j_
 756       | j _EQ_ j_
 757       = NodeUFMData (((j `shiftL_` l) _ADD_ l) _MUL_ p) p
 758       | otherwise
 759       = getCommonNodeUFMData_ (p `shiftL_`  l) (j `shiftR_` l) (j_ `shiftR_` l)
 760
 761 ask_about_common_ancestor :: NodeUFMData -> NodeUFMData -> CommonRoot
 762
 763 ask_about_common_ancestor x@(NodeUFMData j p) y@(NodeUFMData j2 p2)
 764   | j _EQ_ j2 = SameRoot
 765   | otherwise
 766   = case getCommonNodeUFMData x y of
 767       nd@(NodeUFMData j3 p3)
 768         | j3 _EQ_ j  -> LeftRoot (decideSide (j _GT_ j2))
 769         | j3 _EQ_ j2 -> RightRoot (decideSide (j _LT_ j2))
 770         | otherwise   -> NewRoot nd (j _GT_ j2)
 771     where
 772         decideSide :: Bool -> Side
 773         decideSide True  = Leftt
 774         decideSide False = Rightt
 775 \end{code}
 776
 777 This might be better in Util.lhs ?
 778
 779
 780 Now the bit twiddling functions.
 781 \begin{code}
 782 shiftL_ :: FAST_INT -> FAST_INT -> FAST_INT
 783 shiftR_ :: FAST_INT -> FAST_INT -> FAST_INT
 784
 785 #if __GLASGOW_HASKELL__
 786 {-# INLINE shiftL_ #-}
 787 {-# INLINE shiftR_ #-}
 788 shiftL_ n p = word2Int#((int2Word# n) `shiftL#` p)
 789 shiftR_ n p = word2Int#((int2Word# n) `shiftr` p)
 790   where
 791     shiftr x y = shiftRA# x y
 792
 793 #else {- not GHC -}
 794 shiftL_ n p = n * (2 ^ p)
 795 shiftR_ n p = n `quot` (2 ^ p)
 796
 797 #endif {- not GHC -}
 798 \end{code}
 799
 800 \begin{code}
 801 use_snd :: a -> b -> b
 802 use_snd a b = b
 803 \end{code}