Data.MultiKeyedMap

Still very much experimental and missing lots of functions and testing.

Internally, a MKMap is two maps, a keyMap referencing an intermediate key (whose type can be chosen freely and which is incremented sequentially), and a valueMap going from intermediate key to final value.

A correct implementation guarantees that

1. the internal structure can’t be corrupted by operations declared safe
2. adding and removing keys does not make values inaccessible (thus leaking memory) and doesn’t insert unnecessary values

Documentation

data MKMap k v

A Map-like structure where multiple keys can point to the same value, with corresponding abstracted interface.

Internally, we use two maps connected by an intermediate key. The intermediate key (ik) can be anything implementing Ord (for Map), Bounded (to get the first value) and Enum (for succ).

Instances

Functor (MKMap k)

Defined in Data.MultiKeyedMap

Methods

fmap :: (a -> b) -> MKMap k a -> MKMap k b

(<$) :: a -> MKMap k b -> MKMap k a

Foldable (MKMap k)

Defined in Data.MultiKeyedMap

Methods

fold :: Monoid m => MKMap k m -> m

foldMap :: Monoid m => (a -> m) -> MKMap k a -> m

foldr :: (a -> b -> b) -> b -> MKMap k a -> b

foldr' :: (a -> b -> b) -> b -> MKMap k a -> b

foldl :: (b -> a -> b) -> b -> MKMap k a -> b

foldl' :: (b -> a -> b) -> b -> MKMap k a -> b

foldr1 :: (a -> a -> a) -> MKMap k a -> a

foldl1 :: (a -> a -> a) -> MKMap k a -> a

toList :: MKMap k a -> [a]

null :: MKMap k a -> Bool

length :: MKMap k a -> Int

elem :: Eq a => a -> MKMap k a -> Bool

maximum :: Ord a => MKMap k a -> a

minimum :: Ord a => MKMap k a -> a

sum :: Num a => MKMap k a -> a

product :: Num a => MKMap k a -> a

Traversable (MKMap k)

Defined in Data.MultiKeyedMap

Methods

traverse :: Applicative f => (a -> f b) -> MKMap k a -> f (MKMap k b)

sequenceA :: Applicative f => MKMap k (f a) -> f (MKMap k a)

mapM :: Monad m => (a -> m b) -> MKMap k a -> m (MKMap k b)

sequence :: Monad m => MKMap k (m a) -> m (MKMap k a)

(Eq k, Ord k, Eq v) => Eq (MKMap k v)

Defined in Data.MultiKeyedMap

Methods

(==) :: MKMap k v -> MKMap k v -> Bool

(/=) :: MKMap k v -> MKMap k v -> Bool

(Show k, Show v) => Show (MKMap k v)

Defined in Data.MultiKeyedMap

Methods

showsPrec :: Int -> MKMap k v -> ShowS

show :: MKMap k v -> String

showList :: [MKMap k v] -> ShowS

at :: (HasCallStack, Ord k) => MKMap k v -> k -> v

Find value at key. Partial. See !.

(!) :: (HasCallStack, Ord k) => MKMap k v -> k -> v infixl 9

Operator alias of at.

mkMKMap

Arguments

:: (Ord k, Ord ik, Enum ik, Bounded ik)

=> Proxy ik

type of intermediate key

-> MKMap k v

new map

Create a MKMap given a type for the internally used intermediate key.

fromList

Arguments

:: (Ord k, Ord ik, Enum ik, Bounded ik)

=> Proxy ik

type of intermediate key

-> [(NonEmpty k, v)]

list of (key, value)

-> MKMap k v

new map

Build a map from a list of key/value pairs.

toList :: MKMap k v -> [(NonEmpty k, v)]

Convert the map to a list of key/value pairs.

insert :: Ord k => k -> v -> MKMap k v -> MKMap k v

Equivalent to insert, if the key doesn’t exist a new singleton key is added.

flattenKeys :: Ord k => MKMap k v -> Map k v

“Unlink” keys that are pointing to the same value.

Returns a normal map.

keys :: Ord k => MKMap k v -> [k]

Return a list of all keys.

values :: MKMap k v -> [v]

Return a list of all values.