[project @ 2005-01-13 10:37:35 by simonmar]
[haskell-directory.git] / Data / FiniteMap.hs
index ee18419..f8d0826 100644 (file)
@@ -8,6 +8,8 @@
 -- Stability   :  provisional
 -- Portability :  portable
 --
+-- NOTE: Data.FiniteMap is DEPRECATED, please use "Data.Map" instead.
+--
 -- A finite map implementation, derived from the paper:
 --        /Efficient sets: a balancing act/, S. Adams,
 --        Journal of functional programming 3(4) Oct 1993, pp553-562
@@ -38,7 +40,9 @@
 #define OUTPUTABLE_key {--}
 #endif
 
-module Data.FiniteMap (
+module Data.FiniteMap
+  {-# DEPRECATED "Please use Data.Map instead." #-} 
+  (
        -- * The @FiniteMap@ type
        FiniteMap,              -- abstract type
 
@@ -84,6 +88,8 @@ module Data.FiniteMap (
 #endif
     ) where
 
+import Prelude -- necessary to get dependencies right
+
 import Data.Maybe ( isJust )
 #ifdef __GLASGOW_HASKELL__
 import GHC.Base
@@ -187,7 +193,7 @@ minusFM             :: (Ord key OUTPUTABLE_key) => FiniteMap key elt1 -> FiniteMap key elt2
 -- key.
 intersectFM    :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> FiniteMap key elt -> FiniteMap key elt
 
--- | Returns the interesction of two mappings, using the specified
+-- | Returns the intersection of two mappings, using the specified
 -- combination function to combine values.
 intersectFM_C  :: (Ord key OUTPUTABLE_key) => (elt1 -> elt2 -> elt3)
                           -> FiniteMap key elt1 -> FiniteMap key elt2 -> FiniteMap key elt3