Safe Haskell | None |
---|---|

Language | Haskell2010 |

## Synopsis

- newtype Map k v = Map (Map UnliftedArray Array k v)
- empty :: Map k v
- singleton :: PrimUnlifted k => k -> v -> Map k v
- lookup :: (PrimUnlifted k, Ord k) => k -> Map k v -> Maybe v
- size :: Map k v -> Int
- map :: PrimUnlifted k => (v -> w) -> Map k v -> Map k w
- mapMaybe :: PrimUnlifted k => (v -> Maybe w) -> Map k v -> Map k w
- mapMaybeWithKey :: PrimUnlifted k => (k -> v -> Maybe w) -> Map k v -> Map k w
- union :: (Ord k, PrimUnlifted k) => Map k v -> Map k v -> Map k v
- foldlWithKey' :: PrimUnlifted k => (b -> k -> v -> b) -> b -> Map k v -> b
- foldrWithKey' :: PrimUnlifted k => (k -> v -> b -> b) -> b -> Map k v -> b
- foldMapWithKey' :: (Monoid b, PrimUnlifted k) => (k -> v -> b) -> Map k v -> b
- foldlWithKeyM' :: (Monad m, PrimUnlifted k) => (b -> k -> v -> m b) -> b -> Map k v -> m b
- foldrWithKeyM' :: (Monad m, PrimUnlifted k) => (k -> v -> b -> m b) -> b -> Map k v -> m b
- foldlMapWithKeyM' :: (Monad m, Monoid b, PrimUnlifted k) => (k -> v -> m b) -> Map k v -> m b
- foldrMapWithKeyM' :: (Monad m, Monoid b, PrimUnlifted k) => (k -> v -> m b) -> Map k v -> m b
- traverse :: (Applicative f, PrimUnlifted k) => (v -> f b) -> Map k v -> f (Map k b)
- traverseWithKey :: (Applicative f, PrimUnlifted k) => (k -> v -> f b) -> Map k v -> f (Map k b)
- traverseWithKey_ :: (Applicative f, PrimUnlifted k) => (k -> v -> f b) -> Map k v -> f ()
- fromList :: (PrimUnlifted k, Ord k) => [(k, v)] -> Map k v
- fromListAppend :: (PrimUnlifted k, Ord k, Semigroup v) => [(k, v)] -> Map k v
- fromListN :: (PrimUnlifted k, Ord k) => Int -> [(k, v)] -> Map k v
- fromListAppendN :: (PrimUnlifted k, Ord k, Semigroup v) => Int -> [(k, v)] -> Map k v
- fromSet :: PrimUnlifted k => (k -> v) -> Set k -> Map k v
- unsafeFreezeZip :: (Ord k, PrimUnlifted k) => MutableUnliftedArray s k -> MutableArray s v -> ST s (Map k v)

# Documentation

A map from keys `k`

to values `v`

. The key type must have a
`PrimUnlifted`

instance and the value type must have a `Prim`

instance.

The data constructor for this type should not be exported. I am working on this.

Map (Map UnliftedArray Array k v) |

## Instances

(PrimUnlifted k, Ord k) => IsList (Map k v) Source # | |

(PrimUnlifted k, Eq k, Eq v) => Eq (Map k v) Source # | |

(PrimUnlifted k, Ord k, Ord v) => Ord (Map k v) Source # | |

(PrimUnlifted k, Show k, Show v) => Show (Map k v) Source # | |

(PrimUnlifted k, Ord k, Semigroup v) => Semigroup (Map k v) Source # | |

(PrimUnlifted k, Ord k, Semigroup v) => Monoid (Map k v) Source # | |

type Item (Map k v) Source # | |

Defined in Data.Map.Unlifted.Lifted |

singleton :: PrimUnlifted k => k -> v -> Map k v Source #

*O(1)* Create a map with a single element.

lookup :: (PrimUnlifted k, Ord k) => k -> Map k v -> Maybe v Source #

*O(log n)* Lookup the value at a key in the map.

map :: PrimUnlifted k => (v -> w) -> Map k v -> Map k w Source #

*O(n)* Map over the values in the map.

mapMaybe :: PrimUnlifted k => (v -> Maybe w) -> Map k v -> Map k w Source #

*O(n)* Drop elements for which the predicate returns `Nothing`

.

mapMaybeWithKey :: PrimUnlifted k => (k -> v -> Maybe w) -> Map k v -> Map k w Source #

*O(n)* Drop elements for which the predicate returns `Nothing`

.
The predicate is given access to the key.

union :: (Ord k, PrimUnlifted k) => Map k v -> Map k v -> Map k v Source #

*O(n+m)* The expression (

) takes the left-biased union
of `union`

t1 t2`t1`

and `t2`

. It prefers `t1`

when duplicate keys are encountered.

# Folds

:: PrimUnlifted k | |

=> (b -> k -> v -> b) | reduction |

-> b | initial accumulator |

-> Map k v | map |

-> b |

*O(n)* Left fold over the keys and values with a strict accumulator.

:: PrimUnlifted k | |

=> (k -> v -> b -> b) | reduction |

-> b | initial accumulator |

-> Map k v | map |

-> b |

*O(n)* Right fold over the keys and values with a strict accumulator.

:: (Monoid b, PrimUnlifted k) | |

=> (k -> v -> b) | reduction |

-> Map k v | map |

-> b |

*O(n)* Fold over the keys and values of the map with a strict monoidal
accumulator. This function does not have left and right variants since
the associativity required by a monoid instance means that both variants
would always produce the same result.

# Monadic Folds

:: (Monad m, PrimUnlifted k) | |

=> (b -> k -> v -> m b) | reduction |

-> b | initial accumulator |

-> Map k v | map |

-> m b |

*O(n)* Left monadic fold over the keys and values of the map. This fold
is strict in the accumulator.

:: (Monad m, PrimUnlifted k) | |

=> (k -> v -> b -> m b) | reduction |

-> b | initial accumulator |

-> Map k v | map |

-> m b |

*O(n)* Right monadic fold over the keys and values of the map. This fold
is strict in the accumulator.

:: (Monad m, Monoid b, PrimUnlifted k) | |

=> (k -> v -> m b) | reduction |

-> Map k v | map |

-> m b |

*O(n)* Monadic left fold over the keys and values of the map with a strict
monoidal accumulator. The monoidal accumulator is appended to the left
after each reduction.

:: (Monad m, Monoid b, PrimUnlifted k) | |

=> (k -> v -> m b) | reduction |

-> Map k v | map |

-> m b |

*O(n)* Monadic right fold over the keys and values of the map with a strict
monoidal accumulator. The monoidal accumulator is appended to the right
after each reduction.

# Traversals

traverse :: (Applicative f, PrimUnlifted k) => (v -> f b) -> Map k v -> f (Map k b) Source #

*O(n)* traversal over the values in the map.

traverseWithKey :: (Applicative f, PrimUnlifted k) => (k -> v -> f b) -> Map k v -> f (Map k b) Source #

*O(n)* traversal over the values in the map, using the keys.

traverseWithKey_ :: (Applicative f, PrimUnlifted k) => (k -> v -> f b) -> Map k v -> f () Source #

*O(n)* like `traverseWithKey`

, but discards the results.

# List Conversion

fromList :: (PrimUnlifted k, Ord k) => [(k, v)] -> Map k v Source #

*O(n*log n)* Create a map from a list of key-value pairs.
If the list contains more than one value for the same key,
the last value is retained. If the keys in the argument are
in nondescending order, this algorithm runs in *O(n)* time instead.

fromListAppend :: (PrimUnlifted k, Ord k, Semigroup v) => [(k, v)] -> Map k v Source #

:: (PrimUnlifted k, Ord k) | |

=> Int | expected size of resulting |

-> [(k, v)] | key-value pairs |

-> Map k v |

*O(n*log n)* This function has the same behavior as `fromList`

regardless of whether or not the expected size is accurate. Additionally,
negative sizes are handled correctly. The expected size is used as the
size of the initially allocated buffer when building the `Map`

. If the
keys in the argument are in nondescending order, this algorithm runs
in *O(n)* time.

fromSet :: PrimUnlifted k => (k -> v) -> Set k -> Map k v Source #

*O(n)* Build a map from a set. This function is uses the underlying
array that backs the set as the array for the keys. It constructs the
values by applying the given function to each key.

# Array Conversion

unsafeFreezeZip :: (Ord k, PrimUnlifted k) => MutableUnliftedArray s k -> MutableArray s v -> ST s (Map k v) Source #

*O(n*log n)* Zip an array of keys with an array of values. If they are
not the same length, the longer one will be truncated to match the shorter
one. This function sorts and deduplicates the array of keys, preserving the
last value associated with each key. The argument arrays may not be
reused after being passed to this function.

This is by far the fastest way to create a map, since the functions backing it
are aggressively specialized. It internally uses a hybrid of mergesort and
insertion sort provided by the `primitive-sort`

package. It generates much
less garbage than any of the `fromList`

variants.