Data/Set.hs

   1 -----------------------------------------------------------------------------
   2 -- |
   3 -- Module      :  Data.Set
   4 -- Copyright   :  (c) Daan Leijen 2002
   5 -- License     :  BSD-style
   6 -- Maintainer  :  libraries@haskell.org
   7 -- Stability   :  provisional
   8 -- Portability :  portable
   9 --
  10 -- An efficient implementation of sets.
  11 --
  12 -- Since many function names (but not the type name) clash with
  13 -- "Prelude" names, this module is usually imported @qualified@, e.g.
  14 --
  15 -- >  import Data.Set (Set)
  16 -- >  import qualified Data.Set as Set
  17 --
  18 -- The implementation of 'Set' is based on /size balanced/ binary trees (or
  19 -- trees of /bounded balance/) as described by:
  20 --
  21 --    * Stephen Adams, \"/Efficient sets: a balancing act/\",
  22 --      Journal of Functional Programming 3(4):553-562, October 1993,
  23 --      <http://www.swiss.ai.mit.edu/~adams/BB>.
  24 --
  25 --    * J. Nievergelt and E.M. Reingold,
  26 --      \"/Binary search trees of bounded balance/\",
  27 --      SIAM journal of computing 2(1), March 1973.
  28 --
  29 -- Note that the implementation is /left-biased/ -- the elements of a
  30 -- first argument are always preferred to the second, for example in
  31 -- 'union' or 'insert'.  Of course, left-biasing can only be observed
  32 -- when equality is an equivalence relation instead of structural
  33 -- equality.
  34 -----------------------------------------------------------------------------
  35
  36 module Data.Set  (
  37             -- * Set type
  38               Set          -- instance Eq,Ord,Show,Read,Data,Typeable
  39
  40             -- * Operators
  41             , (\\)
  42
  43             -- * Query
  44             , null
  45             , size
  46             , member
  47             , notMember
  48             , isSubsetOf
  49             , isProperSubsetOf
  50
  51             -- * Construction
  52             , empty
  53             , singleton
  54             , insert
  55             , delete
  56
  57             -- * Combine
  58             , union, unions
  59             , difference
  60             , intersection
  61
  62             -- * Filter
  63             , filter
  64             , partition
  65             , split
  66             , splitMember
  67
  68             -- * Map
  69             , map
  70             , mapMonotonic
  71
  72             -- * Fold
  73             , fold
  74
  75             -- * Min\/Max
  76             , findMin
  77             , findMax
  78             , deleteMin
  79             , deleteMax
  80             , deleteFindMin
  81             , deleteFindMax
  82             , maxView
  83             , minView
  84
  85             -- * Conversion
  86
  87             -- ** List
  88             , elems
  89             , toList
  90             , fromList
  91
  92             -- ** Ordered list
  93             , toAscList
  94             , fromAscList
  95             , fromDistinctAscList
  96
  97             -- * Debugging
  98             , showTree
  99             , showTreeWith
 100             , valid
 101             ) where
 102
 103 import Prelude hiding (filter,foldr,null,map)
 104 import qualified Data.List as List
 105 import Data.Monoid (Monoid(..))
 106 import Data.Typeable
 107 import Data.Foldable (Foldable(foldMap))
 108
 109 {-
 110 -- just for testing
 111 import QuickCheck
 112 import List (nub,sort)
 113 import qualified List
 114 -}
 115
 116 #if __GLASGOW_HASKELL__
 117 import Text.Read
 118 import Data.Generics.Basics
 119 import Data.Generics.Instances
 120 #endif
 121
 122 {--------------------------------------------------------------------
 123   Operators
 124 --------------------------------------------------------------------}
 125 infixl 9 \\ --
 126
 127 -- | /O(n+m)/. See 'difference'.
 128 (\\) :: Ord a => Set a -> Set a -> Set a
 129 m1 \\ m2 = difference m1 m2
 130
 131 {--------------------------------------------------------------------
 132   Sets are size balanced trees
 133 --------------------------------------------------------------------}
 134 -- | A set of values @a@.
 135 data Set a    = Tip
 136               | Bin {-# UNPACK #-} !Size a !(Set a) !(Set a)
 137
 138 type Size     = Int
 139
 140 instance Ord a => Monoid (Set a) where
 141     mempty  = empty
 142     mappend = union
 143     mconcat = unions
 144
 145 instance Foldable Set where
 146     foldMap f Tip = mempty
 147     foldMap f (Bin _s k l r) = foldMap f l `mappend` f k `mappend` foldMap f r
 148
 149 #if __GLASGOW_HASKELL__
 150
 151 {--------------------------------------------------------------------
 152   A Data instance
 153 --------------------------------------------------------------------}
 154
 155 -- This instance preserves data abstraction at the cost of inefficiency.
 156 -- We omit reflection services for the sake of data abstraction.
 157
 158 instance (Data a, Ord a) => Data (Set a) where
 159   gfoldl f z set = z fromList `f` (toList set)
 160   toConstr _     = error "toConstr"
 161   gunfold _ _    = error "gunfold"
 162   dataTypeOf _   = mkNorepType "Data.Set.Set"
 163   dataCast1 f    = gcast1 f
 164
 165 #endif
 166
 167 {--------------------------------------------------------------------
 168   Query
 169 --------------------------------------------------------------------}
 170 -- | /O(1)/. Is this the empty set?
 171 null :: Set a -> Bool
 172 null t
 173   = case t of
 174       Tip           -> True
 175       Bin sz x l r  -> False
 176
 177 -- | /O(1)/. The number of elements in the set.
 178 size :: Set a -> Int
 179 size t
 180   = case t of
 181       Tip           -> 0
 182       Bin sz x l r  -> sz
 183
 184 -- | /O(log n)/. Is the element in the set?
 185 member :: Ord a => a -> Set a -> Bool
 186 member x t
 187   = case t of
 188       Tip -> False
 189       Bin sz y l r
 190           -> case compare x y of
 191                LT -> member x l
 192                GT -> member x r
 193                EQ -> True
 194
 195 -- | /O(log n)/. Is the element not in the set?
 196 notMember :: Ord a => a -> Set a -> Bool
 197 notMember x t = not $ member x t
 198
 199 {--------------------------------------------------------------------
 200   Construction
 201 --------------------------------------------------------------------}
 202 -- | /O(1)/. The empty set.
 203 empty  :: Set a
 204 empty
 205   = Tip
 206
 207 -- | /O(1)/. Create a singleton set.
 208 singleton :: a -> Set a
 209 singleton x
 210   = Bin 1 x Tip Tip
 211
 212 {--------------------------------------------------------------------
 213   Insertion, Deletion
 214 --------------------------------------------------------------------}
 215 -- | /O(log n)/. Insert an element in a set.
 216 -- If the set already contains an element equal to the given value,
 217 -- it is replaced with the new value.
 218 insert :: Ord a => a -> Set a -> Set a
 219 insert x t
 220   = case t of
 221       Tip -> singleton x
 222       Bin sz y l r
 223           -> case compare x y of
 224                LT -> balance y (insert x l) r
 225                GT -> balance y l (insert x r)
 226                EQ -> Bin sz x l r
 227
 228
 229 -- | /O(log n)/. Delete an element from a set.
 230 delete :: Ord a => a -> Set a -> Set a
 231 delete x t
 232   = case t of
 233       Tip -> Tip
 234       Bin sz y l r
 235           -> case compare x y of
 236                LT -> balance y (delete x l) r
 237                GT -> balance y l (delete x r)
 238                EQ -> glue l r
 239
 240 {--------------------------------------------------------------------
 241   Subset
 242 --------------------------------------------------------------------}
 243 -- | /O(n+m)/. Is this a proper subset? (ie. a subset but not equal).
 244 isProperSubsetOf :: Ord a => Set a -> Set a -> Bool
 245 isProperSubsetOf s1 s2
 246     = (size s1 < size s2) && (isSubsetOf s1 s2)
 247
 248
 249 -- | /O(n+m)/. Is this a subset?
 250 -- @(s1 `isSubsetOf` s2)@ tells whether @s1@ is a subset of @s2@.
 251 isSubsetOf :: Ord a => Set a -> Set a -> Bool
 252 isSubsetOf t1 t2
 253   = (size t1 <= size t2) && (isSubsetOfX t1 t2)
 254
 255 isSubsetOfX Tip t = True
 256 isSubsetOfX t Tip = False
 257 isSubsetOfX (Bin _ x l r) t
 258   = found && isSubsetOfX l lt && isSubsetOfX r gt
 259   where
 260     (lt,found,gt) = splitMember x t
 261
 262
 263 {--------------------------------------------------------------------
 264   Minimal, Maximal
 265 --------------------------------------------------------------------}
 266 -- | /O(log n)/. The minimal element of a set.
 267 findMin :: Set a -> a
 268 findMin (Bin _ x Tip r) = x
 269 findMin (Bin _ x l r)   = findMin l
 270 findMin Tip             = error "Set.findMin: empty set has no minimal element"
 271
 272 -- | /O(log n)/. The maximal element of a set.
 273 findMax :: Set a -> a
 274 findMax (Bin _ x l Tip)  = x
 275 findMax (Bin _ x l r)    = findMax r
 276 findMax Tip              = error "Set.findMax: empty set has no maximal element"
 277
 278 -- | /O(log n)/. Delete the minimal element.
 279 deleteMin :: Set a -> Set a
 280 deleteMin (Bin _ x Tip r) = r
 281 deleteMin (Bin _ x l r)   = balance x (deleteMin l) r
 282 deleteMin Tip             = Tip
 283
 284 -- | /O(log n)/. Delete the maximal element.
 285 deleteMax :: Set a -> Set a
 286 deleteMax (Bin _ x l Tip) = l
 287 deleteMax (Bin _ x l r)   = balance x l (deleteMax r)
 288 deleteMax Tip             = Tip
 289
 290
 291 {--------------------------------------------------------------------
 292   Union.
 293 --------------------------------------------------------------------}
 294 -- | The union of a list of sets: (@'unions' == 'foldl' 'union' 'empty'@).
 295 unions :: Ord a => [Set a] -> Set a
 296 unions ts
 297   = foldlStrict union empty ts
 298
 299
 300 -- | /O(n+m)/. The union of two sets, preferring the first set when
 301 -- equal elements are encountered.
 302 -- The implementation uses the efficient /hedge-union/ algorithm.
 303 -- Hedge-union is more efficient on (bigset `union` smallset).
 304 union :: Ord a => Set a -> Set a -> Set a
 305 union Tip t2  = t2
 306 union t1 Tip  = t1
 307 union t1 t2 = hedgeUnion (const LT) (const GT) t1 t2
 308
 309 hedgeUnion cmplo cmphi t1 Tip
 310   = t1
 311 hedgeUnion cmplo cmphi Tip (Bin _ x l r)
 312   = join x (filterGt cmplo l) (filterLt cmphi r)
 313 hedgeUnion cmplo cmphi (Bin _ x l r) t2
 314   = join x (hedgeUnion cmplo cmpx l (trim cmplo cmpx t2))
 315            (hedgeUnion cmpx cmphi r (trim cmpx cmphi t2))
 316   where
 317     cmpx y  = compare x y
 318
 319 {--------------------------------------------------------------------
 320   Difference
 321 --------------------------------------------------------------------}
 322 -- | /O(n+m)/. Difference of two sets.
 323 -- The implementation uses an efficient /hedge/ algorithm comparable with /hedge-union/.
 324 difference :: Ord a => Set a -> Set a -> Set a
 325 difference Tip t2  = Tip
 326 difference t1 Tip  = t1
 327 difference t1 t2   = hedgeDiff (const LT) (const GT) t1 t2
 328
 329 hedgeDiff cmplo cmphi Tip t
 330   = Tip
 331 hedgeDiff cmplo cmphi (Bin _ x l r) Tip
 332   = join x (filterGt cmplo l) (filterLt cmphi r)
 333 hedgeDiff cmplo cmphi t (Bin _ x l r)
 334   = merge (hedgeDiff cmplo cmpx (trim cmplo cmpx t) l)
 335           (hedgeDiff cmpx cmphi (trim cmpx cmphi t) r)
 336   where
 337     cmpx y = compare x y
 338
 339 {--------------------------------------------------------------------
 340   Intersection
 341 --------------------------------------------------------------------}
 342 -- | /O(n+m)/. The intersection of two sets.
 343 -- Elements of the result come from the first set.
 344 intersection :: Ord a => Set a -> Set a -> Set a
 345 intersection Tip t = Tip
 346 intersection t Tip = Tip
 347 intersection t1@(Bin s1 x1 l1 r1) t2@(Bin s2 x2 l2 r2) =
 348    if s1 >= s2 then
 349       let (lt,found,gt) = splitLookup x2 t1
 350           tl            = intersection lt l2
 351           tr            = intersection gt r2
 352       in case found of
 353       Just x -> join x tl tr
 354       Nothing -> merge tl tr
 355    else let (lt,found,gt) = splitMember x1 t2
 356             tl            = intersection l1 lt
 357             tr            = intersection r1 gt
 358         in if found then join x1 tl tr
 359            else merge tl tr
 360
 361 {--------------------------------------------------------------------
 362   Filter and partition
 363 --------------------------------------------------------------------}
 364 -- | /O(n)/. Filter all elements that satisfy the predicate.
 365 filter :: Ord a => (a -> Bool) -> Set a -> Set a
 366 filter p Tip = Tip
 367 filter p (Bin _ x l r)
 368   | p x       = join x (filter p l) (filter p r)
 369   | otherwise = merge (filter p l) (filter p r)
 370
 371 -- | /O(n)/. Partition the set into two sets, one with all elements that satisfy
 372 -- the predicate and one with all elements that don't satisfy the predicate.
 373 -- See also 'split'.
 374 partition :: Ord a => (a -> Bool) -> Set a -> (Set a,Set a)
 375 partition p Tip = (Tip,Tip)
 376 partition p (Bin _ x l r)
 377   | p x       = (join x l1 r1,merge l2 r2)
 378   | otherwise = (merge l1 r1,join x l2 r2)
 379   where
 380     (l1,l2) = partition p l
 381     (r1,r2) = partition p r
 382
 383 {----------------------------------------------------------------------
 384   Map
 385 ----------------------------------------------------------------------}
 386
 387 -- | /O(n*log n)/.
 388 -- @'map' f s@ is the set obtained by applying @f@ to each element of @s@.
 389 --
 390 -- It's worth noting that the size of the result may be smaller if,
 391 -- for some @(x,y)@, @x \/= y && f x == f y@
 392
 393 map :: (Ord a, Ord b) => (a->b) -> Set a -> Set b
 394 map f = fromList . List.map f . toList
 395
 396 -- | /O(n)/. The
 397 --
 398 -- @'mapMonotonic' f s == 'map' f s@, but works only when @f@ is monotonic.
 399 -- /The precondition is not checked./
 400 -- Semi-formally, we have:
 401 --
 402 -- > and [x < y ==> f x < f y | x <- ls, y <- ls]
 403 -- >                     ==> mapMonotonic f s == map f s
 404 -- >     where ls = toList s
 405
 406 mapMonotonic :: (a->b) -> Set a -> Set b
 407 mapMonotonic f Tip = Tip
 408 mapMonotonic f (Bin sz x l r) =
 409     Bin sz (f x) (mapMonotonic f l) (mapMonotonic f r)
 410
 411
 412 {--------------------------------------------------------------------
 413   Fold
 414 --------------------------------------------------------------------}
 415 -- | /O(n)/. Fold over the elements of a set in an unspecified order.
 416 fold :: (a -> b -> b) -> b -> Set a -> b
 417 fold f z s
 418   = foldr f z s
 419
 420 -- | /O(n)/. Post-order fold.
 421 foldr :: (a -> b -> b) -> b -> Set a -> b
 422 foldr f z Tip           = z
 423 foldr f z (Bin _ x l r) = foldr f (f x (foldr f z r)) l
 424
 425 {--------------------------------------------------------------------
 426   List variations
 427 --------------------------------------------------------------------}
 428 -- | /O(n)/. The elements of a set.
 429 elems :: Set a -> [a]
 430 elems s
 431   = toList s
 432
 433 {--------------------------------------------------------------------
 434   Lists
 435 --------------------------------------------------------------------}
 436 -- | /O(n)/. Convert the set to a list of elements.
 437 toList :: Set a -> [a]
 438 toList s
 439   = toAscList s
 440
 441 -- | /O(n)/. Convert the set to an ascending list of elements.
 442 toAscList :: Set a -> [a]
 443 toAscList t
 444   = foldr (:) [] t
 445
 446
 447 -- | /O(n*log n)/. Create a set from a list of elements.
 448 fromList :: Ord a => [a] -> Set a
 449 fromList xs
 450   = foldlStrict ins empty xs
 451   where
 452     ins t x = insert x t
 453
 454 {--------------------------------------------------------------------
 455   Building trees from ascending/descending lists can be done in linear time.
 456
 457   Note that if [xs] is ascending that:
 458     fromAscList xs == fromList xs
 459 --------------------------------------------------------------------}
 460 -- | /O(n)/. Build a set from an ascending list in linear time.
 461 -- /The precondition (input list is ascending) is not checked./
 462 fromAscList :: Eq a => [a] -> Set a
 463 fromAscList xs
 464   = fromDistinctAscList (combineEq xs)
 465   where
 466   -- [combineEq xs] combines equal elements with [const] in an ordered list [xs]
 467   combineEq xs
 468     = case xs of
 469         []     -> []
 470         [x]    -> [x]
 471         (x:xx) -> combineEq' x xx
 472
 473   combineEq' z [] = [z]
 474   combineEq' z (x:xs)
 475     | z==x      = combineEq' z xs
 476     | otherwise = z:combineEq' x xs
 477
 478
 479 -- | /O(n)/. Build a set from an ascending list of distinct elements in linear time.
 480 -- /The precondition (input list is strictly ascending) is not checked./
 481 fromDistinctAscList :: [a] -> Set a
 482 fromDistinctAscList xs
 483   = build const (length xs) xs
 484   where
 485     -- 1) use continutations so that we use heap space instead of stack space.
 486     -- 2) special case for n==5 to build bushier trees.
 487     build c 0 xs   = c Tip xs
 488     build c 5 xs   = case xs of
 489                        (x1:x2:x3:x4:x5:xx)
 490                             -> c (bin x4 (bin x2 (singleton x1) (singleton x3)) (singleton x5)) xx
 491     build c n xs   = seq nr $ build (buildR nr c) nl xs
 492                    where
 493                      nl = n `div` 2
 494                      nr = n - nl - 1
 495
 496     buildR n c l (x:ys) = build (buildB l x c) n ys
 497     buildB l x c r zs   = c (bin x l r) zs
 498
 499 {--------------------------------------------------------------------
 500   Eq converts the set to a list. In a lazy setting, this
 501   actually seems one of the faster methods to compare two trees
 502   and it is certainly the simplest :-)
 503 --------------------------------------------------------------------}
 504 instance Eq a => Eq (Set a) where
 505   t1 == t2  = (size t1 == size t2) && (toAscList t1 == toAscList t2)
 506
 507 {--------------------------------------------------------------------
 508   Ord
 509 --------------------------------------------------------------------}
 510
 511 instance Ord a => Ord (Set a) where
 512     compare s1 s2 = compare (toAscList s1) (toAscList s2)
 513
 514 {--------------------------------------------------------------------
 515   Show
 516 --------------------------------------------------------------------}
 517 instance Show a => Show (Set a) where
 518   showsPrec p xs = showParen (p > 10) $
 519     showString "fromList " . shows (toList xs)
 520
 521 showSet :: (Show a) => [a] -> ShowS
 522 showSet []
 523   = showString "{}"
 524 showSet (x:xs)
 525   = showChar '{' . shows x . showTail xs
 526   where
 527     showTail []     = showChar '}'
 528     showTail (x:xs) = showChar ',' . shows x . showTail xs
 529
 530 {--------------------------------------------------------------------
 531   Read
 532 --------------------------------------------------------------------}
 533 instance (Read a, Ord a) => Read (Set a) where
 534 #ifdef __GLASGOW_HASKELL__
 535   readPrec = parens $ prec 10 $ do
 536     Ident "fromList" <- lexP
 537     xs <- readPrec
 538     return (fromList xs)
 539
 540   readListPrec = readListPrecDefault
 541 #else
 542   readsPrec p = readParen (p > 10) $ \ r -> do
 543     ("fromList",s) <- lex r
 544     (xs,t) <- reads s
 545     return (fromList xs,t)
 546 #endif
 547
 548 {--------------------------------------------------------------------
 549   Typeable/Data
 550 --------------------------------------------------------------------}
 551
 552 #include "Typeable.h"
 553 INSTANCE_TYPEABLE1(Set,setTc,"Set")
 554
 555 {--------------------------------------------------------------------
 556   Utility functions that return sub-ranges of the original
 557   tree. Some functions take a comparison function as argument to
 558   allow comparisons against infinite values. A function [cmplo x]
 559   should be read as [compare lo x].
 560
 561   [trim cmplo cmphi t]  A tree that is either empty or where [cmplo x == LT]
 562                         and [cmphi x == GT] for the value [x] of the root.
 563   [filterGt cmp t]      A tree where for all values [k]. [cmp k == LT]
 564   [filterLt cmp t]      A tree where for all values [k]. [cmp k == GT]
 565
 566   [split k t]           Returns two trees [l] and [r] where all values
 567                         in [l] are <[k] and all keys in [r] are >[k].
 568   [splitMember k t]     Just like [split] but also returns whether [k]
 569                         was found in the tree.
 570 --------------------------------------------------------------------}
 571
 572 {--------------------------------------------------------------------
 573   [trim lo hi t] trims away all subtrees that surely contain no
 574   values between the range [lo] to [hi]. The returned tree is either
 575   empty or the key of the root is between @lo@ and @hi@.
 576 --------------------------------------------------------------------}
 577 trim :: (a -> Ordering) -> (a -> Ordering) -> Set a -> Set a
 578 trim cmplo cmphi Tip = Tip
 579 trim cmplo cmphi t@(Bin sx x l r)
 580   = case cmplo x of
 581       LT -> case cmphi x of
 582               GT -> t
 583               le -> trim cmplo cmphi l
 584       ge -> trim cmplo cmphi r
 585
 586 trimMemberLo :: Ord a => a -> (a -> Ordering) -> Set a -> (Bool, Set a)
 587 trimMemberLo lo cmphi Tip = (False,Tip)
 588 trimMemberLo lo cmphi t@(Bin sx x l r)
 589   = case compare lo x of
 590       LT -> case cmphi x of
 591               GT -> (member lo t, t)
 592               le -> trimMemberLo lo cmphi l
 593       GT -> trimMemberLo lo cmphi r
 594       EQ -> (True,trim (compare lo) cmphi r)
 595
 596
 597 {--------------------------------------------------------------------
 598   [filterGt x t] filter all values >[x] from tree [t]
 599   [filterLt x t] filter all values <[x] from tree [t]
 600 --------------------------------------------------------------------}
 601 filterGt :: (a -> Ordering) -> Set a -> Set a
 602 filterGt cmp Tip = Tip
 603 filterGt cmp (Bin sx x l r)
 604   = case cmp x of
 605       LT -> join x (filterGt cmp l) r
 606       GT -> filterGt cmp r
 607       EQ -> r
 608
 609 filterLt :: (a -> Ordering) -> Set a -> Set a
 610 filterLt cmp Tip = Tip
 611 filterLt cmp (Bin sx x l r)
 612   = case cmp x of
 613       LT -> filterLt cmp l
 614       GT -> join x l (filterLt cmp r)
 615       EQ -> l
 616
 617
 618 {--------------------------------------------------------------------
 619   Split
 620 --------------------------------------------------------------------}
 621 -- | /O(log n)/. The expression (@'split' x set@) is a pair @(set1,set2)@
 622 -- where all elements in @set1@ are lower than @x@ and all elements in
 623 -- @set2@ larger than @x@. @x@ is not found in neither @set1@ nor @set2@.
 624 split :: Ord a => a -> Set a -> (Set a,Set a)
 625 split x Tip = (Tip,Tip)
 626 split x (Bin sy y l r)
 627   = case compare x y of
 628       LT -> let (lt,gt) = split x l in (lt,join y gt r)
 629       GT -> let (lt,gt) = split x r in (join y l lt,gt)
 630       EQ -> (l,r)
 631
 632 -- | /O(log n)/. Performs a 'split' but also returns whether the pivot
 633 -- element was found in the original set.
 634 splitMember :: Ord a => a -> Set a -> (Set a,Bool,Set a)
 635 splitMember x t = let (l,m,r) = splitLookup x t in
 636      (l,maybe False (const True) m,r)
 637
 638 -- | /O(log n)/. Performs a 'split' but also returns the pivot
 639 -- element that was found in the original set.
 640 splitLookup :: Ord a => a -> Set a -> (Set a,Maybe a,Set a)
 641 splitLookup x Tip = (Tip,Nothing,Tip)
 642 splitLookup x (Bin sy y l r)
 643    = case compare x y of
 644        LT -> let (lt,found,gt) = splitLookup x l in (lt,found,join y gt r)
 645        GT -> let (lt,found,gt) = splitLookup x r in (join y l lt,found,gt)
 646        EQ -> (l,Just y,r)
 647
 648 {--------------------------------------------------------------------
 649   Utility functions that maintain the balance properties of the tree.
 650   All constructors assume that all values in [l] < [x] and all values
 651   in [r] > [x], and that [l] and [r] are valid trees.
 652
 653   In order of sophistication:
 654     [Bin sz x l r]    The type constructor.
 655     [bin x l r]       Maintains the correct size, assumes that both [l]
 656                       and [r] are balanced with respect to each other.
 657     [balance x l r]   Restores the balance and size.
 658                       Assumes that the original tree was balanced and
 659                       that [l] or [r] has changed by at most one element.
 660     [join x l r]      Restores balance and size.
 661
 662   Furthermore, we can construct a new tree from two trees. Both operations
 663   assume that all values in [l] < all values in [r] and that [l] and [r]
 664   are valid:
 665     [glue l r]        Glues [l] and [r] together. Assumes that [l] and
 666                       [r] are already balanced with respect to each other.
 667     [merge l r]       Merges two trees and restores balance.
 668
 669   Note: in contrast to Adam's paper, we use (<=) comparisons instead
 670   of (<) comparisons in [join], [merge] and [balance].
 671   Quickcheck (on [difference]) showed that this was necessary in order
 672   to maintain the invariants. It is quite unsatisfactory that I haven't
 673   been able to find out why this is actually the case! Fortunately, it
 674   doesn't hurt to be a bit more conservative.
 675 --------------------------------------------------------------------}
 676
 677 {--------------------------------------------------------------------
 678   Join
 679 --------------------------------------------------------------------}
 680 join :: a -> Set a -> Set a -> Set a
 681 join x Tip r  = insertMin x r
 682 join x l Tip  = insertMax x l
 683 join x l@(Bin sizeL y ly ry) r@(Bin sizeR z lz rz)
 684   | delta*sizeL <= sizeR  = balance z (join x l lz) rz
 685   | delta*sizeR <= sizeL  = balance y ly (join x ry r)
 686   | otherwise             = bin x l r
 687
 688
 689 -- insertMin and insertMax don't perform potentially expensive comparisons.
 690 insertMax,insertMin :: a -> Set a -> Set a
 691 insertMax x t
 692   = case t of
 693       Tip -> singleton x
 694       Bin sz y l r
 695           -> balance y l (insertMax x r)
 696
 697 insertMin x t
 698   = case t of
 699       Tip -> singleton x
 700       Bin sz y l r
 701           -> balance y (insertMin x l) r
 702
 703 {--------------------------------------------------------------------
 704   [merge l r]: merges two trees.
 705 --------------------------------------------------------------------}
 706 merge :: Set a -> Set a -> Set a
 707 merge Tip r   = r
 708 merge l Tip   = l
 709 merge l@(Bin sizeL x lx rx) r@(Bin sizeR y ly ry)
 710   | delta*sizeL <= sizeR = balance y (merge l ly) ry
 711   | delta*sizeR <= sizeL = balance x lx (merge rx r)
 712   | otherwise            = glue l r
 713
 714 {--------------------------------------------------------------------
 715   [glue l r]: glues two trees together.
 716   Assumes that [l] and [r] are already balanced with respect to each other.
 717 --------------------------------------------------------------------}
 718 glue :: Set a -> Set a -> Set a
 719 glue Tip r = r
 720 glue l Tip = l
 721 glue l r
 722   | size l > size r = let (m,l') = deleteFindMax l in balance m l' r
 723   | otherwise       = let (m,r') = deleteFindMin r in balance m l r'
 724
 725
 726 -- | /O(log n)/. Delete and find the minimal element.
 727 --
 728 -- > deleteFindMin set = (findMin set, deleteMin set)
 729
 730 deleteFindMin :: Set a -> (a,Set a)
 731 deleteFindMin t
 732   = case t of
 733       Bin _ x Tip r -> (x,r)
 734       Bin _ x l r   -> let (xm,l') = deleteFindMin l in (xm,balance x l' r)
 735       Tip           -> (error "Set.deleteFindMin: can not return the minimal element of an empty set", Tip)
 736
 737 -- | /O(log n)/. Delete and find the maximal element.
 738 --
 739 -- > deleteFindMax set = (findMax set, deleteMax set)
 740 deleteFindMax :: Set a -> (a,Set a)
 741 deleteFindMax t
 742   = case t of
 743       Bin _ x l Tip -> (x,l)
 744       Bin _ x l r   -> let (xm,r') = deleteFindMax r in (xm,balance x l r')
 745       Tip           -> (error "Set.deleteFindMax: can not return the maximal element of an empty set", Tip)
 746
 747 -- | /O(log n)/. Retrieves the minimal key of the set, and the set stripped from that element
 748 -- @fail@s (in the monad) when passed an empty set.
 749 minView :: Monad m => Set a -> m (Set a, a)
 750 minView Tip = fail "Set.minView: empty set"
 751 minView x = return (swap $ deleteFindMin x)
 752
 753 -- | /O(log n)/. Retrieves the maximal key of the set, and the set stripped from that element
 754 -- @fail@s (in the monad) when passed an empty set.
 755 maxView :: Monad m => Set a -> m (Set a, a)
 756 maxView Tip = fail "Set.maxView: empty set"
 757 maxView x = return (swap $ deleteFindMax x)
 758
 759 swap (a,b) = (b,a)
 760
 761
 762
 763 {--------------------------------------------------------------------
 764   [balance x l r] balances two trees with value x.
 765   The sizes of the trees should balance after decreasing the
 766   size of one of them. (a rotation).
 767
 768   [delta] is the maximal relative difference between the sizes of
 769           two trees, it corresponds with the [w] in Adams' paper,
 770           or equivalently, [1/delta] corresponds with the $\alpha$
 771           in Nievergelt's paper. Adams shows that [delta] should
 772           be larger than 3.745 in order to garantee that the
 773           rotations can always restore balance.
 774
 775   [ratio] is the ratio between an outer and inner sibling of the
 776           heavier subtree in an unbalanced setting. It determines
 777           whether a double or single rotation should be performed
 778           to restore balance. It is correspondes with the inverse
 779           of $\alpha$ in Adam's article.
 780
 781   Note that:
 782   - [delta] should be larger than 4.646 with a [ratio] of 2.
 783   - [delta] should be larger than 3.745 with a [ratio] of 1.534.
 784
 785   - A lower [delta] leads to a more 'perfectly' balanced tree.
 786   - A higher [delta] performs less rebalancing.
 787
 788   - Balancing is automatic for random data and a balancing
 789     scheme is only necessary to avoid pathological worst cases.
 790     Almost any choice will do in practice
 791
 792   - Allthough it seems that a rather large [delta] may perform better
 793     than smaller one, measurements have shown that the smallest [delta]
 794     of 4 is actually the fastest on a wide range of operations. It
 795     especially improves performance on worst-case scenarios like
 796     a sequence of ordered insertions.
 797
 798   Note: in contrast to Adams' paper, we use a ratio of (at least) 2
 799   to decide whether a single or double rotation is needed. Allthough
 800   he actually proves that this ratio is needed to maintain the
 801   invariants, his implementation uses a (invalid) ratio of 1.
 802   He is aware of the problem though since he has put a comment in his
 803   original source code that he doesn't care about generating a
 804   slightly inbalanced tree since it doesn't seem to matter in practice.
 805   However (since we use quickcheck :-) we will stick to strictly balanced
 806   trees.
 807 --------------------------------------------------------------------}
 808 delta,ratio :: Int
 809 delta = 4
 810 ratio = 2
 811
 812 balance :: a -> Set a -> Set a -> Set a
 813 balance x l r
 814   | sizeL + sizeR <= 1    = Bin sizeX x l r
 815   | sizeR >= delta*sizeL  = rotateL x l r
 816   | sizeL >= delta*sizeR  = rotateR x l r
 817   | otherwise             = Bin sizeX x l r
 818   where
 819     sizeL = size l
 820     sizeR = size r
 821     sizeX = sizeL + sizeR + 1
 822
 823 -- rotate
 824 rotateL x l r@(Bin _ _ ly ry)
 825   | size ly < ratio*size ry = singleL x l r
 826   | otherwise               = doubleL x l r
 827
 828 rotateR x l@(Bin _ _ ly ry) r
 829   | size ry < ratio*size ly = singleR x l r
 830   | otherwise               = doubleR x l r
 831
 832 -- basic rotations
 833 singleL x1 t1 (Bin _ x2 t2 t3)  = bin x2 (bin x1 t1 t2) t3
 834 singleR x1 (Bin _ x2 t1 t2) t3  = bin x2 t1 (bin x1 t2 t3)
 835
 836 doubleL x1 t1 (Bin _ x2 (Bin _ x3 t2 t3) t4) = bin x3 (bin x1 t1 t2) (bin x2 t3 t4)
 837 doubleR x1 (Bin _ x2 t1 (Bin _ x3 t2 t3)) t4 = bin x3 (bin x2 t1 t2) (bin x1 t3 t4)
 838
 839
 840 {--------------------------------------------------------------------
 841   The bin constructor maintains the size of the tree
 842 --------------------------------------------------------------------}
 843 bin :: a -> Set a -> Set a -> Set a
 844 bin x l r
 845   = Bin (size l + size r + 1) x l r
 846
 847
 848 {--------------------------------------------------------------------
 849   Utilities
 850 --------------------------------------------------------------------}
 851 foldlStrict f z xs
 852   = case xs of
 853       []     -> z
 854       (x:xx) -> let z' = f z x in seq z' (foldlStrict f z' xx)
 855
 856
 857 {--------------------------------------------------------------------
 858   Debugging
 859 --------------------------------------------------------------------}
 860 -- | /O(n)/. Show the tree that implements the set. The tree is shown
 861 -- in a compressed, hanging format.
 862 showTree :: Show a => Set a -> String
 863 showTree s
 864   = showTreeWith True False s
 865
 866
 867 {- | /O(n)/. The expression (@showTreeWith hang wide map@) shows
 868  the tree that implements the set. If @hang@ is
 869  @True@, a /hanging/ tree is shown otherwise a rotated tree is shown. If
 870  @wide@ is 'True', an extra wide version is shown.
 871
 872 > Set> putStrLn $ showTreeWith True False $ fromDistinctAscList [1..5]
 873 > 4
 874 > +--2
 875 > |  +--1
 876 > |  +--3
 877 > +--5
 878 >
 879 > Set> putStrLn $ showTreeWith True True $ fromDistinctAscList [1..5]
 880 > 4
 881 > |
 882 > +--2
 883 > |  |
 884 > |  +--1
 885 > |  |
 886 > |  +--3
 887 > |
 888 > +--5
 889 >
 890 > Set> putStrLn $ showTreeWith False True $ fromDistinctAscList [1..5]
 891 > +--5
 892 > |
 893 > 4
 894 > |
 895 > |  +--3
 896 > |  |
 897 > +--2
 898 >    |
 899 >    +--1
 900
 901 -}
 902 showTreeWith :: Show a => Bool -> Bool -> Set a -> String
 903 showTreeWith hang wide t
 904   | hang      = (showsTreeHang wide [] t) ""
 905   | otherwise = (showsTree wide [] [] t) ""
 906
 907 showsTree :: Show a => Bool -> [String] -> [String] -> Set a -> ShowS
 908 showsTree wide lbars rbars t
 909   = case t of
 910       Tip -> showsBars lbars . showString "|\n"
 911       Bin sz x Tip Tip
 912           -> showsBars lbars . shows x . showString "\n"
 913       Bin sz x l r
 914           -> showsTree wide (withBar rbars) (withEmpty rbars) r .
 915              showWide wide rbars .
 916              showsBars lbars . shows x . showString "\n" .
 917              showWide wide lbars .
 918              showsTree wide (withEmpty lbars) (withBar lbars) l
 919
 920 showsTreeHang :: Show a => Bool -> [String] -> Set a -> ShowS
 921 showsTreeHang wide bars t
 922   = case t of
 923       Tip -> showsBars bars . showString "|\n"
 924       Bin sz x Tip Tip
 925           -> showsBars bars . shows x . showString "\n"
 926       Bin sz x l r
 927           -> showsBars bars . shows x . showString "\n" .
 928              showWide wide bars .
 929              showsTreeHang wide (withBar bars) l .
 930              showWide wide bars .
 931              showsTreeHang wide (withEmpty bars) r
 932
 933
 934 showWide wide bars
 935   | wide      = showString (concat (reverse bars)) . showString "|\n"
 936   | otherwise = id
 937
 938 showsBars :: [String] -> ShowS
 939 showsBars bars
 940   = case bars of
 941       [] -> id
 942       _  -> showString (concat (reverse (tail bars))) . showString node
 943
 944 node           = "+--"
 945 withBar bars   = "|  ":bars
 946 withEmpty bars = "   ":bars
 947
 948 {--------------------------------------------------------------------
 949   Assertions
 950 --------------------------------------------------------------------}
 951 -- | /O(n)/. Test if the internal set structure is valid.
 952 valid :: Ord a => Set a -> Bool
 953 valid t
 954   = balanced t && ordered t && validsize t
 955
 956 ordered t
 957   = bounded (const True) (const True) t
 958   where
 959     bounded lo hi t
 960       = case t of
 961           Tip           -> True
 962           Bin sz x l r  -> (lo x) && (hi x) && bounded lo (<x) l && bounded (>x) hi r
 963
 964 balanced :: Set a -> Bool
 965 balanced t
 966   = case t of
 967       Tip           -> True
 968       Bin sz x l r  -> (size l + size r <= 1 || (size l <= delta*size r && size r <= delta*size l)) &&
 969                        balanced l && balanced r
 970
 971
 972 validsize t
 973   = (realsize t == Just (size t))
 974   where
 975     realsize t
 976       = case t of
 977           Tip          -> Just 0
 978           Bin sz x l r -> case (realsize l,realsize r) of
 979                             (Just n,Just m)  | n+m+1 == sz  -> Just sz
 980                             other            -> Nothing
 981
 982 {-
 983 {--------------------------------------------------------------------
 984   Testing
 985 --------------------------------------------------------------------}
 986 testTree :: [Int] -> Set Int
 987 testTree xs   = fromList xs
 988 test1 = testTree [1..20]
 989 test2 = testTree [30,29..10]
 990 test3 = testTree [1,4,6,89,2323,53,43,234,5,79,12,9,24,9,8,423,8,42,4,8,9,3]
 991
 992 {--------------------------------------------------------------------
 993   QuickCheck
 994 --------------------------------------------------------------------}
 995 qcheck prop
 996   = check config prop
 997   where
 998     config = Config
 999       { configMaxTest = 500
1000       , configMaxFail = 5000
1001       , configSize    = \n -> (div n 2 + 3)
1002       , configEvery   = \n args -> let s = show n in s ++ [ '\b' | _ <- s ]
1003       }
1004
1005
1006 {--------------------------------------------------------------------
1007   Arbitrary, reasonably balanced trees
1008 --------------------------------------------------------------------}
1009 instance (Enum a) => Arbitrary (Set a) where
1010   arbitrary = sized (arbtree 0 maxkey)
1011             where maxkey  = 10000
1012
1013 arbtree :: (Enum a) => Int -> Int -> Int -> Gen (Set a)
1014 arbtree lo hi n
1015   | n <= 0        = return Tip
1016   | lo >= hi      = return Tip
1017   | otherwise     = do{ i  <- choose (lo,hi)
1018                       ; m  <- choose (1,30)
1019                       ; let (ml,mr)  | m==(1::Int)= (1,2)
1020                                      | m==2       = (2,1)
1021                                      | m==3       = (1,1)
1022                                      | otherwise  = (2,2)
1023                       ; l  <- arbtree lo (i-1) (n `div` ml)
1024                       ; r  <- arbtree (i+1) hi (n `div` mr)
1025                       ; return (bin (toEnum i) l r)
1026                       }
1027
1028
1029 {--------------------------------------------------------------------
1030   Valid tree's
1031 --------------------------------------------------------------------}
1032 forValid :: (Enum a,Show a,Testable b) => (Set a -> b) -> Property
1033 forValid f
1034   = forAll arbitrary $ \t ->
1035 --    classify (balanced t) "balanced" $
1036     classify (size t == 0) "empty" $
1037     classify (size t > 0  && size t <= 10) "small" $
1038     classify (size t > 10 && size t <= 64) "medium" $
1039     classify (size t > 64) "large" $
1040     balanced t ==> f t
1041
1042 forValidIntTree :: Testable a => (Set Int -> a) -> Property
1043 forValidIntTree f
1044   = forValid f
1045
1046 forValidUnitTree :: Testable a => (Set Int -> a) -> Property
1047 forValidUnitTree f
1048   = forValid f
1049
1050
1051 prop_Valid
1052   = forValidUnitTree $ \t -> valid t
1053
1054 {--------------------------------------------------------------------
1055   Single, Insert, Delete
1056 --------------------------------------------------------------------}
1057 prop_Single :: Int -> Bool
1058 prop_Single x
1059   = (insert x empty == singleton x)
1060
1061 prop_InsertValid :: Int -> Property
1062 prop_InsertValid k
1063   = forValidUnitTree $ \t -> valid (insert k t)
1064
1065 prop_InsertDelete :: Int -> Set Int -> Property
1066 prop_InsertDelete k t
1067   = not (member k t) ==> delete k (insert k t) == t
1068
1069 prop_DeleteValid :: Int -> Property
1070 prop_DeleteValid k
1071   = forValidUnitTree $ \t ->
1072     valid (delete k (insert k t))
1073
1074 {--------------------------------------------------------------------
1075   Balance
1076 --------------------------------------------------------------------}
1077 prop_Join :: Int -> Property
1078 prop_Join x
1079   = forValidUnitTree $ \t ->
1080     let (l,r) = split x t
1081     in valid (join x l r)
1082
1083 prop_Merge :: Int -> Property
1084 prop_Merge x
1085   = forValidUnitTree $ \t ->
1086     let (l,r) = split x t
1087     in valid (merge l r)
1088
1089
1090 {--------------------------------------------------------------------
1091   Union
1092 --------------------------------------------------------------------}
1093 prop_UnionValid :: Property
1094 prop_UnionValid
1095   = forValidUnitTree $ \t1 ->
1096     forValidUnitTree $ \t2 ->
1097     valid (union t1 t2)
1098
1099 prop_UnionInsert :: Int -> Set Int -> Bool
1100 prop_UnionInsert x t
1101   = union t (singleton x) == insert x t
1102
1103 prop_UnionAssoc :: Set Int -> Set Int -> Set Int -> Bool
1104 prop_UnionAssoc t1 t2 t3
1105   = union t1 (union t2 t3) == union (union t1 t2) t3
1106
1107 prop_UnionComm :: Set Int -> Set Int -> Bool
1108 prop_UnionComm t1 t2
1109   = (union t1 t2 == union t2 t1)
1110
1111
1112 prop_DiffValid
1113   = forValidUnitTree $ \t1 ->
1114     forValidUnitTree $ \t2 ->
1115     valid (difference t1 t2)
1116
1117 prop_Diff :: [Int] -> [Int] -> Bool
1118 prop_Diff xs ys
1119   =  toAscList (difference (fromList xs) (fromList ys))
1120     == List.sort ((List.\\) (nub xs)  (nub ys))
1121
1122 prop_IntValid
1123   = forValidUnitTree $ \t1 ->
1124     forValidUnitTree $ \t2 ->
1125     valid (intersection t1 t2)
1126
1127 prop_Int :: [Int] -> [Int] -> Bool
1128 prop_Int xs ys
1129   =  toAscList (intersection (fromList xs) (fromList ys))
1130     == List.sort (nub ((List.intersect) (xs)  (ys)))
1131
1132 {--------------------------------------------------------------------
1133   Lists
1134 --------------------------------------------------------------------}
1135 prop_Ordered
1136   = forAll (choose (5,100)) $ \n ->
1137     let xs = [0..n::Int]
1138     in fromAscList xs == fromList xs
1139
1140 prop_List :: [Int] -> Bool
1141 prop_List xs
1142   = (sort (nub xs) == toList (fromList xs))
1143 -}