Data.Multimap

Generic multimap module.

Documentation

data Multimap k c v

Instances

Functor c => Functor (Multimap k c)

Defined in Data.Multimap.Internal

Methods

fmap :: (a -> b) -> Multimap k c a -> Multimap k c b

(<$) :: a -> Multimap k c b -> Multimap k c a

Collection c => Foldable (Multimap k c)

Defined in Data.Multimap.Internal

Methods

fold :: Monoid m => Multimap k c m -> m

foldMap :: Monoid m => (a -> m) -> Multimap k c a -> m

foldr :: (a -> b -> b) -> b -> Multimap k c a -> b

foldr' :: (a -> b -> b) -> b -> Multimap k c a -> b

foldl :: (b -> a -> b) -> b -> Multimap k c a -> b

foldl' :: (b -> a -> b) -> b -> Multimap k c a -> b

foldr1 :: (a -> a -> a) -> Multimap k c a -> a

foldl1 :: (a -> a -> a) -> Multimap k c a -> a

toList :: Multimap k c a -> [a]

null :: Multimap k c a -> Bool

length :: Multimap k c a -> Int

elem :: Eq a => a -> Multimap k c a -> Bool

maximum :: Ord a => Multimap k c a -> a

minimum :: Ord a => Multimap k c a -> a

sum :: Num a => Multimap k c a -> a

product :: Num a => Multimap k c a -> a

(Eq k, Eq (c v)) => Eq (Multimap k c v)

Defined in Data.Multimap.Internal

Methods

(==) :: Multimap k c v -> Multimap k c v -> Bool

(/=) :: Multimap k c v -> Multimap k c v -> Bool

(Ord k, Ord (c v)) => Ord (Multimap k c v)

Defined in Data.Multimap.Internal

Methods

compare :: Multimap k c v -> Multimap k c v -> Ordering

(<) :: Multimap k c v -> Multimap k c v -> Bool

(<=) :: Multimap k c v -> Multimap k c v -> Bool

(>) :: Multimap k c v -> Multimap k c v -> Bool

(>=) :: Multimap k c v -> Multimap k c v -> Bool

max :: Multimap k c v -> Multimap k c v -> Multimap k c v

min :: Multimap k c v -> Multimap k c v -> Multimap k c v

(Ord k, Read k, Read (c v)) => Read (Multimap k c v)

Defined in Data.Multimap.Internal

Methods

readsPrec :: Int -> ReadS (Multimap k c v)

readList :: ReadS [Multimap k c v]

readPrec :: ReadPrec (Multimap k c v)

readListPrec :: ReadPrec [Multimap k c v]

(Show k, Show (c v)) => Show (Multimap k c v)

Defined in Data.Multimap.Internal

Methods

showsPrec :: Int -> Multimap k c v -> ShowS

show :: Multimap k c v -> String

showList :: [Multimap k c v] -> ShowS

(Ord k, Semigroup (c v)) => Semigroup (Multimap k c v)

Defined in Data.Multimap.Internal

Methods

(<>) :: Multimap k c v -> Multimap k c v -> Multimap k c v

sconcat :: NonEmpty (Multimap k c v) -> Multimap k c v

stimes :: Integral b => b -> Multimap k c v -> Multimap k c v

(Ord k, Semigroup (c v)) => Monoid (Multimap k c v)

Defined in Data.Multimap.Internal

Methods

mempty :: Multimap k c v

mappend :: Multimap k c v -> Multimap k c v -> Multimap k c v

mconcat :: [Multimap k c v] -> Multimap k c v

class Foldable c => Collection c

Lower bound for multimap values.

An alternative could have been to use Applicative but that would have precluded common implementations (e.g. Set).

Minimal complete definition

empty, singleton

Instances

Collection []

Defined in Data.Multimap.Collection

Methods

empty :: [v]

singleton :: v -> [v]

null :: [v] -> Bool

size :: [v] -> Int

Collection Seq

Defined in Data.Multimap.Collection

Methods

empty :: Seq v

singleton :: v -> Seq v

null :: Seq v -> Bool

size :: Seq v -> Int

Collection Set

Defined in Data.Multimap.Collection

Methods

empty :: Set v

singleton :: v -> Set v

null :: Set v -> Bool

size :: Set v -> Int

Collection Multiset

Defined in Data.Multimap.Collection

Methods

empty :: Multiset v

singleton :: v -> Multiset v

null :: Multiset v -> Bool

size :: Multiset v -> Int

Tests

null :: Multimap k c v -> Bool

size :: Collection c => Multimap k c v -> Int

Construction

empty :: Multimap k c v

singleton :: (Collection c, Ord k) => k -> v -> Multimap k c v

fromMap :: Collection c => Map k (c v) -> Multimap k c v

fromList :: (Collection c, Semigroup (c v), Ord k) => [(k, v)] -> Multimap k c v

Build a multimap from a list.

This method uses insertWith and semigroup's <> operator. This might not be what you want, for example in the case of lists (where the order of the values will be inverted). For ordered collections, prefer fromCollectionsList.

fromCollectionsList :: (Collection c, Semigroup (c v), Ord k) => [(k, c v)] -> Multimap k c v

Build a multimap from a list of key-collection pairs.

Access

member :: (Collection c, Ord k) => k -> Multimap k c v -> Bool

notMember :: (Collection c, Ord k) => k -> Multimap k c v -> Bool

(!) :: (Collection c, Ord k) => Multimap k c v -> k -> c v

insert :: (Ord k, Collection c, Semigroup (c v)) => k -> v -> Multimap k c v -> Multimap k c v

insertAll :: (Ord k, Semigroup (c v)) => k -> c v -> Multimap k c v -> Multimap k c v

deleteAll :: Ord k => k -> Multimap k c v -> Multimap k c v

Modification

filter :: (Collection c, Semigroup (c v), Ord k) => (v -> Bool) -> Multimap k c v -> Multimap k c v

filterWithKey :: (Collection c, Semigroup (c v), Ord k) => (k -> v -> Bool) -> Multimap k c v -> Multimap k c v

union :: (Ord k, Semigroup (c v)) => Multimap k c v -> Multimap k c v -> Multimap k c v

Extraction

toMap :: Multimap k c v -> Map k (c v)

toMapWith :: (c v -> a) -> Multimap k c v -> Map k a

toList :: Collection c => Multimap k c v -> [(k, v)]

Other

keys :: Multimap k c v -> [k]

keysSet :: Multimap k c v -> Set k

keysMultiset :: (Ord k, Collection c) => Multimap k c v -> Multiset k

lift1 :: (Ord k, Collection c) => (c v -> c v) -> k -> Multimap k c v -> Multimap k c v

Lift an operation over a collection of values into a multimap operation.

Sample use to filter even values from a SetMultimap:

   let ms = fromList [('a', 1), ('a', 2)] :: SetMultimap Char Int
   lift1 (Set.filter even) 'a' ms == fromList [('a', 1)]

liftF1 :: (Ord k, Collection c, Functor f) => (c v -> f (c v)) -> k -> Multimap k c v -> f (Multimap k c v)

Applicative version of lift1