[project @ 2003-02-17 15:13:56 by simonpj]

[ghc-base.git] / Data / Set.hs

diff --git a/Data/Set.hs b/Data/Set.hs
index f4dad32..3e46e2c 100644 (file)
--- a/Data/Set.hs
+++ b/Data/Set.hs
@@ -2,24 +2,32 @@
 -- |
 -- Module      :  Data.Set
 -- Copyright   :  (c) The University of Glasgow 2001
--- License     :  BSD-style (see the file libraries/core/LICENSE)
+-- License     :  BSD-style (see the file libraries/base/LICENSE)
 -- 
 -- Maintainer  :  libraries@haskell.org
 -- Stability   :  provisional
 -- Portability :  portable
 --
--- This implementation of sets sits squarely upon Data.FiniteMap.
+-- An implementation of sets, based on the "Data.FiniteMap".
 --
 -----------------------------------------------------------------------------
 
 module Data.Set (
+       -- * The @Set@ type
        Set,            -- abstract, instance of: Eq
 
+       -- * Construction
        emptySet,       -- :: Set a
        mkSet,          -- :: Ord a => [a]  -> Set a
        setToList,      -- :: Set a -> [a] 
        unitSet,        -- :: a -> Set a
 
+       -- * Inspection
+       elementOf,      -- :: Ord a => a -> Set a -> Bool
+       isEmptySet,     -- :: Set a -> Bool
+       cardinality,    -- :: Set a -> Int
+
+       -- * Operations
        union,          -- :: Ord a => Set a -> Set a -> Set a
        unionManySets,  -- :: Ord a => [Set a] -> Set a
        minusSet,       -- :: Ord a => Set a -> Set a -> Set a
@@ -27,11 +35,6 @@ module Data.Set (
        intersect,      -- :: Ord a => Set a -> Set a -> Set a
        addToSet,       -- :: Ord a => Set a -> a -> Set a
        delFromSet,     -- :: Ord a => Set a -> a -> Set a
-
-       elementOf,      -- :: Ord a => a -> Set a -> Bool
-       isEmptySet,     -- :: Set a -> Bool
-       
-       cardinality     -- :: Set a -> Int
     ) where
 
 import Prelude