diff --git a/src/Data/Map.purs b/src/Data/Map.purs index e764370b..6cdb33d7 100644 --- a/src/Data/Map.purs +++ b/src/Data/Map.purs @@ -1,43 +1,72 @@ -- | This module defines a type of maps as balanced 2-3 trees, based on -- | +-- | +-- | Quick reference: +-- | +-- | ```purescript +-- | > import Data.Map as Map +-- | > example = Map.fromFoldable [Tuple "key" "val"] +-- | > Map.lookup "key" example -- (Just "val") +-- | > Map.insert "key" "new value" example +-- | > Map.delete "key" example +-- | ``` module Data.Map ( Map - , showTree + -- creation , empty - , isEmpty , singleton - , checkValid - , insert - , lookup - , lookupLE - , lookupLT - , lookupGE - , lookupGT - , findMin - , findMax - , foldSubmap - , submap , fromFoldable , fromFoldableWith - , toUnfoldable - , toAscUnfoldable + + -- common ops + , lookup + , insert , delete - , pop + + -- queries , member - , alter - , update + , size + , isEmpty + + -- manipulation of keys and values , keys , values + , mapWithKey + + -- less common + , update + , alter + , pop + + -- setlike , union , unionWith , unions , isSubmap - , size - , mapWithKey + + -- filters + , filter , filterWithKey , filterKeys - , filter + + -- taking advantage of Ord + , lookupLE + , lookupLT + , lookupGE + , lookupGT + , findMin + , findMax + , submap + , foldSubmap + + -- Unfoldable + , toUnfoldable + , toAscUnfoldable + + -- utils + , showTree + , checkValid ) where import Prelude