Data.Multimap.Collection

This module exposes the base class used to power multimap functionality. You should not need to be aware of it unless you are interested in adding a new specific multimap type.

Documentation

class Foldable c => Collection c where

A lower bound for multimap values. By creating an instance of this class, you can use multimap operations with a custom type. An alternative could have been to use Applicative but that would have precluded common implementations like Set.

Minimal complete definition

filter

Methods

singleton :: v -> c v

Creates a singleton collection.

default singleton :: Applicative c => v -> c v

filter :: (v -> Bool) -> c v -> c v

size :: c v -> Int

Returns the size of the collection. The default implementation folds over the entire structure and is O(n).

null :: c v -> Bool

Checks whether the collection is empty. The default implementation lazily folds over the structure.

Instances

Collection []

Defined in Data.Multimap.Collection

Methods

singleton :: v -> [v]

filter :: (v -> Bool) -> [v] -> [v]

size :: [v] -> Int

null :: [v] -> Bool

Collection Seq

Defined in Data.Multimap.Collection

Methods

singleton :: v -> Seq v

filter :: (v -> Bool) -> Seq v -> Seq v

size :: Seq v -> Int

null :: Seq v -> Bool

Collection Set

Defined in Data.Multimap.Collection

Methods

singleton :: v -> Set v

filter :: (v -> Bool) -> Set v -> Set v

size :: Set v -> Int

null :: Set v -> Bool