data Map k a
A Map from keys k to values a.
This module is considered internal.
The Package Versioning Policy does not apply.
The contents of this module may change in any way whatsoever and without any warning between minor versions of this package.
Authors importing this module are expected to track development closely.
The type represents a finite map (sometimes called a dictionary)
from keys of type Map k vk to values of type v. A Map is strict in its keys
but lazy in its values.
The implementation of Map is based on size balanced binary trees (or
trees of bounded balance) as described by:
Stephen Adams, "Efficient sets—a balancing act", Journal of Functional Programming 3(4):553-562, October 1993, https://doi.org/10.1017/S0956796800000885, https://groups.csail.mit.edu/mac/users/adams/BB/index.html.
J. Nievergelt and E.M. Reingold, "Binary search trees of bounded balance", SIAM journal of computing 2(1), March 1973. https://doi.org/10.1137/0202005.
Yoichi Hirai and Kazuhiko Yamamoto, "Balancing weight-balanced trees", Journal of Functional Programming 21(3):287-307, 2011, https://doi.org/10.1017/S0956796811000104
Bounds for union, intersection, and difference are as given
by
Guy Blelloch, Daniel Ferizovic, and Yihan Sun, "Parallel Ordered Sets Using Join", https://arxiv.org/abs/1602.02120v4.
data Map k aA Map from keys k to values a.
Bin :: Size -> k -> a -> (Map k a) -> (Map k a) -> Map k aTip :: Map k atype Size = Int(!) :: Ord k => Map k a -> k -> aO(\log n). Find the value at a key.
Calls error when the element can not be found.
Note: This function is partial. Prefer !?.
fromList [(5,'a'), (3,'b')] ! 1 Error: element not in the map
fromList [(5,'a'), (3,'b')] ! 5 == 'a'(!?) :: Ord k => Map k a -> k -> Maybe aO(\log n). Find the value at a key.
Returns Nothing when the element can not be found.
fromList [(5, 'a'), (3, 'b')] !? 1 == NothingfromList [(5, 'a'), (3, 'b')] !? 5 == Just 'a'(\\) :: Ord k => Map k a -> Map k b -> Map k aSame as difference.
null :: Map k a -> BoolO(1). Is the map empty?
Data.Map.null (empty) == True
Data.Map.null (singleton 1 'a') == Falsesize :: Map k a -> IntO(1). The number of elements in the map.
size empty == 0
size (singleton 1 'a') == 1
size (fromList([(1,'a'), (2,'c'), (3,'b')])) == 3member :: Ord k => k -> Map k a -> BoolO(\log n). Is the key a member of the map? See also notMember.
member 5 (fromList [(5,'a'), (3,'b')]) == True
member 1 (fromList [(5,'a'), (3,'b')]) == FalsenotMember :: Ord k => k -> Map k a -> BoolO(\log n). Is the key not a member of the map? See also member.
notMember 5 (fromList [(5,'a'), (3,'b')]) == False
notMember 1 (fromList [(5,'a'), (3,'b')]) == Truelookup :: Ord k => k -> Map k a -> Maybe aO(\log n). Look up the value at a key in the map.
The function will return the corresponding value as (,
or Just value)Nothing if the key isn't in the map.
An example of using lookup:
import Prelude hiding (lookup)
import Data.Map
employeeDept = fromList([("John","Sales"), ("Bob","IT")])
deptCountry = fromList([("IT","USA"), ("Sales","France")])
countryCurrency = fromList([("USA", "Dollar"), ("France", "Euro")])
employeeCurrency :: String -> Maybe String
employeeCurrency name = do
dept <- lookup name employeeDept
country <- lookup dept deptCountry
lookup country countryCurrency
main = do
putStrLn $ "John's currency: " ++ (show (employeeCurrency "John"))
putStrLn $ "Pete's currency: " ++ (show (employeeCurrency "Pete"))The output of this program:
John's currency: Just "Euro"
Pete's currency: NothingfindWithDefault :: Ord k => a -> k -> Map k a -> aO(\log n). The expression ( returns
the value at key findWithDefault def k map)k or returns default value def
when the key is not in the map.
findWithDefault 'x' 1 (fromList [(5,'a'), (3,'b')]) == 'x'
findWithDefault 'x' 5 (fromList [(5,'a'), (3,'b')]) == 'a'lookupLT :: Ord k => k -> Map k v -> Maybe (k, v)O(\log n). Find largest key smaller than the given one and return the
corresponding (key, value) pair.
lookupLT 3 (fromList [(3,'a'), (5,'b')]) == Nothing
lookupLT 4 (fromList [(3,'a'), (5,'b')]) == Just (3, 'a')lookupGT :: Ord k => k -> Map k v -> Maybe (k, v)O(\log n). Find smallest key greater than the given one and return the
corresponding (key, value) pair.
lookupGT 4 (fromList [(3,'a'), (5,'b')]) == Just (5, 'b')
lookupGT 5 (fromList [(3,'a'), (5,'b')]) == NothinglookupLE :: Ord k => k -> Map k v -> Maybe (k, v)O(\log n). Find largest key smaller or equal to the given one and return
the corresponding (key, value) pair.
lookupLE 2 (fromList [(3,'a'), (5,'b')]) == Nothing
lookupLE 4 (fromList [(3,'a'), (5,'b')]) == Just (3, 'a')
lookupLE 5 (fromList [(3,'a'), (5,'b')]) == Just (5, 'b')lookupGE :: Ord k => k -> Map k v -> Maybe (k, v)O(\log n). Find smallest key greater or equal to the given one and return
the corresponding (key, value) pair.
lookupGE 3 (fromList [(3,'a'), (5,'b')]) == Just (3, 'a')
lookupGE 4 (fromList [(3,'a'), (5,'b')]) == Just (5, 'b')
lookupGE 6 (fromList [(3,'a'), (5,'b')]) == Nothingempty :: Map k aO(1). The empty map.
empty == fromList []
size empty == 0singleton :: k -> a -> Map k aO(1). A map with a single element.
singleton 1 'a' == fromList [(1, 'a')]
size (singleton 1 'a') == 1insert :: Ord k => k -> a -> Map k a -> Map k aO(\log n). Insert a new key and value in the map.
If the key is already present in the map, the associated value is
replaced with the supplied value. insert is equivalent to
.insertWith const
insert 5 'x' (fromList [(5,'a'), (3,'b')]) == fromList [(3, 'b'), (5, 'x')]
insert 7 'x' (fromList [(5,'a'), (3,'b')]) == fromList [(3, 'b'), (5, 'a'), (7, 'x')]
insert 5 'x' empty == singleton 5 'x'insertWith :: Ord k => (a -> a -> a) -> k -> a -> Map k a -> Map k aO(\log n). Insert with a function, combining new value and old value.
will insert the pair (key, value) into insertWith f key value mpmp if key does
not exist in the map. If the key does exist, the function will
insert the pair (key, f new_value old_value).
insertWith (++) 5 "xxx" (fromList [(5,"a"), (3,"b")]) == fromList [(3, "b"), (5, "xxxa")]
insertWith (++) 7 "xxx" (fromList [(5,"a"), (3,"b")]) == fromList [(3, "b"), (5, "a"), (7, "xxx")]
insertWith (++) 5 "xxx" empty == singleton 5 "xxx"Also see the performance note on fromListWith.
insertWithKey :: Ord k => (k -> a -> a -> a) -> k -> a -> Map k a -> Map k aO(\log n). Insert with a function, combining key, new value and old value.
will insert the pair (key, value) into insertWithKey f key value mpmp if key does
not exist in the map. If the key does exist, the function will
insert the pair (key,f key new_value old_value).
Note that the key passed to f is the same key passed to insertWithKey.
let f key new_value old_value = (show key) ++ ":" ++ new_value ++ "|" ++ old_value
insertWithKey f 5 "xxx" (fromList [(5,"a"), (3,"b")]) == fromList [(3, "b"), (5, "5:xxx|a")]
insertWithKey f 7 "xxx" (fromList [(5,"a"), (3,"b")]) == fromList [(3, "b"), (5, "a"), (7, "xxx")]
insertWithKey f 5 "xxx" empty == singleton 5 "xxx"Also see the performance note on fromListWith.
insertLookupWithKey :: Ord k => (k -> a -> a -> a) -> k -> a -> Map k a -> (Maybe a, Map k a)O(\log n). Combines insert operation with old value retrieval.
The expression ()
is a pair where the first element is equal to (insertLookupWithKey f k x map)
and the second element equal to (lookup k map).insertWithKey f k x map
let f key new_value old_value = (show key) ++ ":" ++ new_value ++ "|" ++ old_value
insertLookupWithKey f 5 "xxx" (fromList [(5,"a"), (3,"b")]) == (Just "a", fromList [(3, "b"), (5, "5:xxx|a")])
insertLookupWithKey f 7 "xxx" (fromList [(5,"a"), (3,"b")]) == (Nothing, fromList [(3, "b"), (5, "a"), (7, "xxx")])
insertLookupWithKey f 5 "xxx" empty == (Nothing, singleton 5 "xxx")This is how to define insertLookup using insertLookupWithKey:
let insertLookup kx x t = insertLookupWithKey (\_ a _ -> a) kx x t
insertLookup 5 "x" (fromList [(5,"a"), (3,"b")]) == (Just "a", fromList [(3, "b"), (5, "x")])
insertLookup 7 "x" (fromList [(5,"a"), (3,"b")]) == (Nothing, fromList [(3, "b"), (5, "a"), (7, "x")])Also see the performance note on fromListWith.
delete :: Ord k => k -> Map k a -> Map k aO(\log n). Delete a key and its value from the map. When the key is not
a member of the map, the original map is returned.
delete 5 (fromList [(5,"a"), (3,"b")]) == singleton 3 "b"
delete 7 (fromList [(5,"a"), (3,"b")]) == fromList [(3, "b"), (5, "a")]
delete 5 empty == emptypop :: Ord k => k -> Map k a -> Maybe (a, Map k a)O(\log n). Pop an entry from the map.
Returns Nothing if the key is not in the map. Otherwise returns Just the
value at the key and a map with the entry removed.
pop 1 (fromList [(0,"a"),(2,"b"),(4,"c")]) == Nothing
pop 2 (fromList [(0,"a"),(2,"b"),(4,"c")]) == Just ("b",fromList [(0,"a"),(4,"c")])
adjust :: Ord k => (a -> a) -> k -> Map k a -> Map k aO(\log n). Update a value at a specific key with the result of the provided function.
When the key is not
a member of the map, the original map is returned.
adjust ("new " ++) 5 (fromList [(5,"a"), (3,"b")]) == fromList [(3, "b"), (5, "new a")]
adjust ("new " ++) 7 (fromList [(5,"a"), (3,"b")]) == fromList [(3, "b"), (5, "a")]
adjust ("new " ++) 7 empty == emptyadjustWithKey :: Ord k => (k -> a -> a) -> k -> Map k a -> Map k aO(\log n). Adjust a value at a specific key. When the key is not
a member of the map, the original map is returned.
let f key x = (show key) ++ ":new " ++ x
adjustWithKey f 5 (fromList [(5,"a"), (3,"b")]) == fromList [(3, "b"), (5, "5:new a")]
adjustWithKey f 7 (fromList [(5,"a"), (3,"b")]) == fromList [(3, "b"), (5, "a")]
adjustWithKey f 7 empty == emptyupdate :: Ord k => (a -> Maybe a) -> k -> Map k a -> Map k aO(\log n). The expression () updates the value update f k mapx
at k (if it is in the map). If (f x) is Nothing, the element is
deleted. If it is (), the key Just yk is bound to the new value y.
let f x = if x == "a" then Just "new a" else Nothing
update f 5 (fromList [(5,"a"), (3,"b")]) == fromList [(3, "b"), (5, "new a")]
update f 7 (fromList [(5,"a"), (3,"b")]) == fromList [(3, "b"), (5, "a")]
update f 3 (fromList [(5,"a"), (3,"b")]) == singleton 5 "a"updateWithKey :: Ord k => (k -> a -> Maybe a) -> k -> Map k a -> Map k aO(\log n). The expression () updates the
value updateWithKey f k mapx at k (if it is in the map). If (f k x) is Nothing,
the element is deleted. If it is (), the key Just yk is bound
to the new value y.
let f k x = if x == "a" then Just ((show k) ++ ":new a") else Nothing
updateWithKey f 5 (fromList [(5,"a"), (3,"b")]) == fromList [(3, "b"), (5, "5:new a")]
updateWithKey f 7 (fromList [(5,"a"), (3,"b")]) == fromList [(3, "b"), (5, "a")]
updateWithKey f 3 (fromList [(5,"a"), (3,"b")]) == singleton 5 "a"upsert :: Ord k => (Maybe a -> a) -> k -> Map k a -> Map k aO(\log n). Update the value at a key or insert a value if the key is
not in the map.
let inc = maybe 1 (+1)
upsert inc \'a\' (fromList [(\'a\',1),(\'c\',2)]) == fromList [(\'a\',2),(\'c\',2)]
upsert inc \'b\' (fromList [(\'a\',1),(\'c\',2)]) == fromList [(\'a\',1),(\'b\',1),(\'c\',2)]
updateLookupWithKey :: Ord k => (k -> a -> Maybe a) -> k -> Map k a -> (Maybe a, Map k a)O(\log n). Look up and update. See also updateWithKey.
This function returns the changed value, if it is updated.
Returns the original key value if the map entry is deleted.
let f k x = if x == "a" then Just ((show k) ++ ":new a") else Nothing
updateLookupWithKey f 5 (fromList [(5,"a"), (3,"b")]) == (Just "5:new a", fromList [(3, "b"), (5, "5:new a")])
updateLookupWithKey f 7 (fromList [(5,"a"), (3,"b")]) == (Nothing, fromList [(3, "b"), (5, "a")])
updateLookupWithKey f 3 (fromList [(5,"a"), (3,"b")]) == (Just "b", singleton 5 "a")See also: pop
alter :: Ord k => (Maybe a -> Maybe a) -> k -> Map k a -> Map k aO(\log n). The expression () alters the value alter f k mapx at k, or absence thereof.
alter can be used to insert, delete, or update a value in a Map.
In short : .lookup k (alter f k m) = f (lookup k m)
let f _ = Nothing
alter f 7 (fromList [(5,"a"), (3,"b")]) == fromList [(3, "b"), (5, "a")]
alter f 5 (fromList [(5,"a"), (3,"b")]) == singleton 3 "b"
let f _ = Just "c"
alter f 7 (fromList [(5,"a"), (3,"b")]) == fromList [(3, "b"), (5, "a"), (7, "c")]
alter f 5 (fromList [(5,"a"), (3,"b")]) == fromList [(3, "b"), (5, "c")]Note that .adjust = alter . fmap
alterF :: (Functor f, Ord k) => (Maybe a -> f (Maybe a)) -> k -> Map k a -> f (Map k a)O(\log n). The expression () alters the value alterF f k mapx at
k, or absence thereof. alterF can be used to inspect, insert, delete,
or update a value in a Map. In short: @lookup k <$> alterF f k m = f
(lookup k m)@.
alterF is the most general operation for working with an individual
key that may or may not be in a given map. When used with trivial
functors like Identity and Const, it is often slightly slower than
more specialized combinators like lookup and insert. However, when
the functor is non-trivial and key comparison is not particularly cheap,
it is the fastest way.
Note on rewrite rules:
This module includes GHC rewrite rules to optimize alterF for
the Const and Identity functors. In general, these rules
improve performance. The sole exception is that when using
Identity, deleting a key that is already absent takes longer
than it would without the rules. If you expect this to occur
a very large fraction of the time, you might consider using a
private copy of the Identity type.
Note: alterF is a flipped version of the at combinator from
Control.Lens.At.
-- Lookup the value at the key, and also remove the existing value or set a new value.
lookupAndSet :: Ord k => k -> Maybe a -> Map k a -> (Maybe a, Map k a)
lookupAndSet k new = alterF (\\old -> (old, new)) k
-- Delete the value at the key. If it is absent the result is Nothing.
mustDelete :: Ord k => k -> Map k a -> Maybe (Map k a)
mustDelete = alterF (Nothing <$)
union :: Ord k => Map k a -> Map k a -> Map k aO\bigl(m \log\bigl(\frac{n}{m}+1\bigr)\bigr), \; 0 < m \leq n.
The expression () takes the left-biased union of union t1 t2t1 and t2.
It prefers t1 when duplicate keys are encountered,
i.e. ().union == unionWith const
union (fromList [(5, "a"), (3, "b")]) (fromList [(5, "A"), (7, "C")]) == fromList [(3, "b"), (5, "a"), (7, "C")]unionWith :: Ord k => (a -> a -> a) -> Map k a -> Map k a -> Map k aO\bigl(m \log\bigl(\frac{n}{m}+1\bigr)\bigr), \; 0 < m \leq n. Union with a combining function.
unionWith (++) (fromList [(5, "a"), (3, "b")]) (fromList [(5, "A"), (7, "C")]) == fromList [(3, "b"), (5, "aA"), (7, "C")]Also see the performance note on fromListWith.
unionWithKey :: Ord k => (k -> a -> a -> a) -> Map k a -> Map k a -> Map k aO\bigl(m \log\bigl(\frac{n}{m}+1\bigr)\bigr), \; 0 < m \leq n.
Union with a combining function.
let f key left_value right_value = (show key) ++ ":" ++ left_value ++ "|" ++ right_value
unionWithKey f (fromList [(5, "a"), (3, "b")]) (fromList [(5, "A"), (7, "C")]) == fromList [(3, "b"), (5, "5:a|A"), (7, "C")]Also see the performance note on fromListWith.
unions :: (Foldable f, Ord k) => f (Map k a) -> Map k aThe union of a list of maps:
().unions == foldl union empty
unions [(fromList [(5, "a"), (3, "b")]), (fromList [(5, "A"), (7, "C")]), (fromList [(5, "A3"), (3, "B3")])]
== fromList [(3, "b"), (5, "a"), (7, "C")]
unions [(fromList [(5, "A3"), (3, "B3")]), (fromList [(5, "A"), (7, "C")]), (fromList [(5, "a"), (3, "b")])]
== fromList [(3, "B3"), (5, "A3"), (7, "C")]unionsWith :: (Foldable f, Ord k) => (a -> a -> a) -> f (Map k a) -> Map k aThe union of a list of maps, with a combining operation:
().unionsWith f == foldl (unionWith f) empty
unionsWith (++) [(fromList [(5, "a"), (3, "b")]), (fromList [(5, "A"), (7, "C")]), (fromList [(5, "A3"), (3, "B3")])]
== fromList [(3, "bB3"), (5, "aAA3"), (7, "C")]difference :: Ord k => Map k a -> Map k b -> Map k aO\bigl(m \log\bigl(\frac{n}{m}+1\bigr)\bigr), \; 0 < m \leq n. Difference of two maps.
Return elements of the first map not existing in the second map.
difference (fromList [(5, "a"), (3, "b")]) (fromList [(5, "A"), (7, "C")]) == singleton 3 "b"differenceWith :: Ord k => (a -> b -> Maybe a) -> Map k a -> Map k b -> Map k aO(n+m). Difference with a combining function.
When two equal keys are
encountered, the combining function is applied to the values of these keys.
If it returns Nothing, the element is discarded (proper set difference). If
it returns (), the element is updated with a new value Just yy.
let f al ar = if al == "b" then Just (al ++ ":" ++ ar) else Nothing
differenceWith f (fromList [(5, "a"), (3, "b")]) (fromList [(5, "A"), (3, "B"), (7, "C")])
== singleton 3 "b:B"differenceWithKey :: Ord k => (k -> a -> b -> Maybe a) -> Map k a -> Map k b -> Map k aO(n+m). Difference with a combining function. When two equal keys are
encountered, the combining function is applied to the key and both values.
If it returns Nothing, the element is discarded (proper set difference). If
it returns (), the element is updated with a new value Just yy.
let f k al ar = if al == "b" then Just ((show k) ++ ":" ++ al ++ "|" ++ ar) else Nothing
differenceWithKey f (fromList [(5, "a"), (3, "b")]) (fromList [(5, "A"), (3, "B"), (10, "C")])
== singleton 3 "3:b|B"intersection :: Ord k => Map k a -> Map k b -> Map k aO\bigl(m \log\bigl(\frac{n}{m}+1\bigr)\bigr), \; 0 < m \leq n. Intersection of two maps.
Return data in the first map for the keys existing in both maps.
().intersection m1 m2 == intersectionWith const m1 m2
intersection (fromList [(5, "a"), (3, "b")]) (fromList [(5, "A"), (7, "C")]) == singleton 5 "a"intersectionWith :: Ord k => (a -> b -> c) -> Map k a -> Map k b -> Map k cO\bigl(m \log\bigl(\frac{n}{m}+1\bigr)\bigr), \; 0 < m \leq n. Intersection with a combining function.
intersectionWith (++) (fromList [(5, "a"), (3, "b")]) (fromList [(5, "A"), (7, "C")]) == singleton 5 "aA"intersectionWithKey :: Ord k => (k -> a -> b -> c) -> Map k a -> Map k b -> Map k cO\bigl(m \log\bigl(\frac{n}{m}+1\bigr)\bigr), \; 0 < m \leq n. Intersection with a combining function.
let f k al ar = (show k) ++ ":" ++ al ++ "|" ++ ar
intersectionWithKey f (fromList [(5, "a"), (3, "b")]) (fromList [(5, "A"), (7, "C")]) == singleton 5 "5:a|A"symmetricDifference :: Ord k => Map k a -> Map k a -> Map k aO\bigl(m \log\bigl(\frac{n}{m}+1\bigr)\bigr), \; 0 < m \leq n.
The symmetric difference of two maps.
The result contains entries whose keys appear in exactly one of the two maps.
symmetricDifference
(fromList [(0,\'q\'),(2,\'b\'),(4,\'w\'),(6,\'o\')])
(fromList [(0,\'e\'),(3,\'r\'),(6,\'t\'),(9,\'s\')])
==
fromList [(2,\'b\'),(3,\'r\'),(4,\'w\'),(9,\'s\')]
disjoint :: Ord k => Map k a -> Map k b -> BoolO\bigl(m \log\bigl(\frac{n}{m}+1\bigr)\bigr), \; 0 < m \leq n. Check whether the key sets of two
maps are disjoint (i.e., their intersection is empty).
disjoint (fromList [(2,'a')]) (fromList [(1,()), (3,())]) == True
disjoint (fromList [(2,'a')]) (fromList [(1,'a'), (2,'b')]) == False
disjoint (fromList []) (fromList []) == Truexs ``disjoint`` ys = null (xs ``intersection`` ys)
compose :: Ord b => Map b c -> Map a b -> Map a cGiven maps bc and ab, relate the keys of ab to the values of bc,
by using the values of ab as keys for lookups in bc.
Complexity: O (n \log m) , where m is the size of the first argument
compose (fromList [('a', "A"), ('b', "B")]) (fromList [(1,'a'),(2,'b'),(3,'z')]) = fromList [(1,"A"),(2,"B")]('compose' bc ab '!?') = (bc '!?') <=< (ab '!?')
Note: Prior to v0.6.4, Data.Map.Strict exposed a version of
compose that forced the values of the output Map. This version does not
force these values.
This function is asymptotically optimal. Given n :: Map a b, m :: Map b c,
the composition essentially maps each a in n to Maybe c, since the
composed lookup yields either one of the c in m or Nothing. The number
of possible such mappings is (|m| + 1) ^ {|n|}.
We now follow a similar reasoning to the one for
[sorting](https:/en.wikipedia.orgwiki/Comparison_sort#Number_of_comparisons_required_to_sort_a_list).
To distinguish between x possible values, we need
\lceil \log_2 x \rceil bits. Thus, we have a lower bound of
\log_2 \left((|m| + 1) ^{|n|} \right) = |n| \cdot \log_2 (|m| + 1) bits.
Map lookups are comparison-based, and each comparison gives us at most
one bit of information: in the worst case we'll always be left with at least
half of the remaining possible values, meaning we need at least as many
comparisons as we need bits.
type SimpleWhenMissing = WhenMissing IdentityA tactic for dealing with keys present in one map but not the other in
merge.
A tactic of type SimpleWhenMissing k x z is an abstract representation
of a function of type k -> x -> Maybe z .
type SimpleWhenMatched = WhenMatched IdentityA tactic for dealing with keys present in both maps in merge.
A tactic of type SimpleWhenMatched k x y z is an abstract representation
of a function of type k -> x -> y -> Maybe z .
runWhenMatched :: WhenMatched f k x y z -> k -> x -> y -> f (Maybe z)Along with zipWithMaybeAMatched, witnesses the isomorphism between
WhenMatched f k x y z and k -> x -> y -> f (Maybe z).
runWhenMissing :: WhenMissing f k x y -> k -> x -> f (Maybe y)Along with traverseMaybeMissing, witnesses the isomorphism between
WhenMissing f k x y and k -> x -> f (Maybe y).
merge :: Ord k => SimpleWhenMissing k a c -> SimpleWhenMissing k b c -> SimpleWhenMatched k a b c -> Map k a -> Map k b -> Map k cMerge two maps.
merge takes two SimpleWhenMissing tactics, a SimpleWhenMatched
tactic and two maps. It uses the tactics to merge the maps.
Its behavior is best understood via its fundamental tactics,
mapMaybeMissing and zipWithMaybeMatched.
Consider
merge (mapMaybeMissing g1) (mapMaybeMissing g2) (zipWithMaybeMatched f) m1 m2
g1 k x = if k == 2 then Just ("1" ++ x) else Nothing
g2 k x = if k == 3 then Just ("2" ++ x) else Nothing
f k x y = if k == 6 then Just ("3" ++ x ++ y) else Nothing
m1 = fromList [(2,"a"), (4,"b"), (6,"c"), (8,"d"), (10,"e"), (12,"f")]
m2 = fromList [(3,"g"), (6,"h"), (9,"i"), (12,"j")]
merge will pass the keys and values to g1, g2, or f as appropriate,
producing a Maybe for each element.
m1: [ (2, "a"), (4, "b"), (6, "c"), (8, "d"), (10, "e"), (12, "f")]
m2: [ (3, "g"), (6, "h"), (9, "i"), (12, "j")]
result: [ g1 2 "a", g2 3 "g", g1 4 "b", f 6 "c" "h", g1 8 "d", g2 9 "i", g1 10 "e", f 12 "f" "j"]
= [Just "1a", Just "2g", Nothing, Just "3ch", Nothing, Nothing, Nothing, Nothing]
The result map contains the Just values.
>>> merge (mapMaybeMissing g1) (mapMaybeMissing g2) (zipWithMaybeMatched f) m1 m2
fromList [(2,"1a"), (3,"2g"), (6,"3ch")]The other tactics below are optimizations or simplifications of
mapMaybeMissing for special cases. Most importantly,
dropMissing drops all the keys.
preserveMissing leaves all the entries alone.
When merge is given three arguments, it is inlined at the call
site. To prevent excessive inlining, you should typically use merge
to define your custom combining functions.
Examples:
unionWithKey f = merge preserveMissing preserveMissing (zipWithMatched f)intersectionWithKey f = merge dropMissing dropMissing (zipWithMatched f)differenceWith f = merge preserveMissing dropMissing (zipWithMatched f)symmetricDifference = merge preserveMissing preserveMissing (zipWithMaybeMatched $ \ _ _ _ -> Nothing)mapEachPiece f g h = merge (mapMissing f) (mapMissing g) (zipWithMatched h)What to do with keys in m1 but not m2
What to do with keys in m2 but not m1
What to do with keys in both m1 and m2
Map m1
Map m2
WhenMatched tacticsdropMatched :: Applicative f => WhenMatched f k x y zWhen a key is found in both maps, drop the key and values.
zipWithMaybeMatched :: Applicative f => (k -> x -> y -> Maybe z) -> WhenMatched f k x y zWhen a key is found in both maps, apply a function to the key and values and maybe use the result in the merged map.
zipWithMaybeMatched :: (k -> x -> y -> Maybe z)
-> SimpleWhenMatched k x y z
zipWithMatched :: Applicative f => (k -> x -> y -> z) -> WhenMatched f k x y zWhen a key is found in both maps, apply a function to the key and values and use the result in the merged map.
zipWithMatched :: (k -> x -> y -> z)
-> SimpleWhenMatched k x y z
WhenMissing tacticsmapMaybeMissing :: Applicative f => (k -> x -> Maybe y) -> WhenMissing f k x yMap over the entries whose keys are missing from the other map,
optionally removing some. This is the most powerful SimpleWhenMissing
tactic, but others are usually more efficient.
mapMaybeMissing :: (k -> x -> Maybe y) -> SimpleWhenMissing k x y
mapMaybeMissing f = traverseMaybeMissing (\k x -> pure (f k x))but mapMaybeMissing uses fewer unnecessary Applicative operations.
dropMissing :: Applicative f => WhenMissing f k x yDrop all the entries whose keys are missing from the other map.
dropMissing :: SimpleWhenMissing k x y
dropMissing = mapMaybeMissing (\_ _ -> Nothing)but dropMissing is much faster.
preserveMissing :: Applicative f => WhenMissing f k x xPreserve, unchanged, the entries whose keys are missing from the other map.
preserveMissing :: SimpleWhenMissing k x x
preserveMissing = Merge.Lazy.mapMaybeMissing (\_ x -> Just x)but preserveMissing is much faster.
preserveMissing' :: Applicative f => WhenMissing f k x xForce the entries whose keys are missing from the other map and otherwise preserve them unchanged.
preserveMissing' :: SimpleWhenMissing k x x
preserveMissing' = Merge.Lazy.mapMaybeMissing (\_ x -> Just $! x)but preserveMissing' is quite a bit faster.
mapMissing :: Applicative f => (k -> x -> y) -> WhenMissing f k x yMap over the entries whose keys are missing from the other map.
mapMissing :: (k -> x -> y) -> SimpleWhenMissing k x y
mapMissing f = mapMaybeMissing (\k x -> Just $ f k x)but mapMissing is somewhat faster.
filterMissing :: Applicative f => (k -> x -> Bool) -> WhenMissing f k x xFilter the entries whose keys are missing from the other map.
filterMissing :: (k -> x -> Bool) -> SimpleWhenMissing k x x
filterMissing f = Merge.Lazy.mapMaybeMissing $ \k x -> guard (f k x) *> Just xbut this should be a little faster.
data WhenMissing f k x yA tactic for dealing with keys present in one map but not the other in
merge or mergeA.
A tactic of type WhenMissing f k x z is an abstract representation
of a function of type k -> x -> f (Maybe z) .
WhenMissing :: Map k x -> f (Map k y) -> k -> x -> f (Maybe y) -> WhenMissing f k x ymissingSubtree :: WhenMissing f k x y -> Map k x -> f (Map k y)missingKey :: WhenMissing f k x y -> k -> x -> f (Maybe y)newtype WhenMatched f k x y zA tactic for dealing with keys present in both
maps in merge or mergeA.
A tactic of type WhenMatched f k x y z is an abstract representation
of a function of type k -> x -> y -> f (Maybe z) .
WhenMatched :: k -> x -> y -> f (Maybe z) -> WhenMatched f k x y zmatchedKey :: WhenMatched f k x y z -> k -> x -> y -> f (Maybe z)mergeA :: (Applicative f, Ord k) => WhenMissing f k a c -> WhenMissing f k b c -> WhenMatched f k a b c -> Map k a -> Map k b -> f (Map k c)An applicative version of merge.
mergeA takes two WhenMissing tactics, a WhenMatched
tactic and two maps. It uses the tactics to merge the maps.
Its behavior is best understood via its fundamental tactics,
traverseMaybeMissing and zipWithMaybeAMatched.
Behaves just like merge while allowing Applicative effects. Effects are
performed in increasing order of keys.
Consider
mergeA (traverseMaybeMissing g1)
(traverseMaybeMissing g2)
(zipWithMaybeAMatched f)
m1
m2
g1 k x = let z = if k == 2 then Just ("1" ++ x) else Nothing
in z <$ putStrLn ("g1 " ++ show (k, x))
g2 k x = let z = if k == 3 then Just ("2" ++ x) else Nothing
in z <$ putStrLn ("g2 " ++ show (k, x))
f k x y = let z = if k == 6 then Just ("3" ++ x ++ y) else Nothing
in z <$ putStrLn ("f " ++ show (k, x, y))
m1 = fromList [(2,"a"), (4,"b"), (6,"c"), (8,"d"), (10,"e"), (12,"f")]
m2 = fromList [(3,"g"), (6,"h"), (9,"i"), (12,"j")]
As with merge, the result map is [(2,"1a"), (3,"2g"), (6,"3ch")].
Additionally, g1, g2, and f perform IO effects, printing in
increasing order of key.
>>> mergeA (traverseMaybeMissing g1) (traverseMaybeMissing g2) (zipWithMaybeAMatched f) m1 m2
g1 (2,"a")
g2 (3,"g")
g1 (4,"b")
f (6,"c","h")
g1 (8,"d")
g2 (9,"i")
g1 (10,"e")
f (12,"f","j")
fromList [(2,"1a"),(3,"2g"),(6,"3ch")]The other tactics below are optimizations or simplifications of
traverseMaybeMissing for special cases. Most importantly,
dropMissing drops all the keys.
preserveMissing leaves all the entries alone.
mapMaybeMissing does not use the Applicative context.
When mergeA is given three arguments, it is inlined at the call
site. To prevent excessive inlining, you should generally only use
mergeA to define custom combining functions.
data Pair a = Pair !a !a deriving Functor
instance Applicative Pair where
pure x = Pair x x
liftA2 f (Pair x1 y1) (Pair x2 y2) = Pair (f x1 x2) (f y1 y2)
-- | Calculate the left-biased union and intersection of two maps.
unionIntersection :: Ord k => Map k a -> Map k a -> (Map k a, Map k a)
unionIntersection m1 m2 =
case mergeA preserveAndDropMissing preserveAndDropMissing preserveLeftMatched m1 m2 of
Pair mu mi -> (mu, mi)
where
-- use Pair to build the union and intersection together
preserveAndDropMissing = 'whenMissing' (\\_k x -> Pair (Just x) Nothing) (\\m -> Pair m empty)
preserveLeftMatched = 'zipWithMaybeAMatched' (\\_k x1 _x2 -> Pair (Just x1) (Just x1))
import Data.Functor.Const (Const(..))
import Data.Monoid (All(..))
-- | Whether the keys of the first map are a subset of the keys of the second map.
keysAreSubsetOf :: Ord k => Map k a -> Map k b -> Bool
keysAreSubsetOf m1 m2 =
getAll (getConst (mergeA isEmpty 'dropMissing' 'dropMatched' m1 m2))
where
isEmpty = 'whenMissing' (\\_k _x -> Const (All False)) (\\m -> Const (All (null m)))
What to do with keys in m1 but not m2
What to do with keys in m2 but not m1
What to do with keys in both m1 and m2
Map m1
Map m2
WhenMatched tacticsmerge work for
mergeA as well. Furthermore, the following
are available.zipWithMaybeAMatched :: (k -> x -> y -> f (Maybe z)) -> WhenMatched f k x y zWhen a key is found in both maps, apply a function to the key and values, perform the resulting action, and maybe use the result in the merged map.
This is the fundamental WhenMatched tactic.
zipWithAMatched :: Applicative f => (k -> x -> y -> f z) -> WhenMatched f k x y zWhen a key is found in both maps, apply a function to the key and values to produce an action and use its result in the merged map.
WhenMissing tacticsmerge work for
mergeA as well. Furthermore, the following
are available.traverseMaybeMissing :: Applicative f => (k -> x -> f (Maybe y)) -> WhenMissing f k x yTraverse over the entries whose keys are missing from the other map,
optionally producing values to put in the result.
This is the most powerful WhenMissing tactic, but others are usually
more efficient.
traverseMissing :: Applicative f => (k -> x -> f y) -> WhenMissing f k x yTraverse over the entries whose keys are missing from the other map.
filterAMissing :: Applicative f => (k -> x -> f Bool) -> WhenMissing f k x xFilter the entries whose keys are missing from the other map
using some Applicative action.
filterAMissing f = Merge.Lazy.traverseMaybeMissing $
\k x -> (\b -> guard b *> Just x) <$> f k xbut this should be a little faster.
whenMissing :: (k -> x -> f (Maybe y)) -> (Map k x -> f (Map k y)) -> WhenMissing f k x yCreate a WhenMissing from two functions.
whenMissing must be called with two functions f and g such that
g = . traverseMaybeWithKey fg may be a more efficient way of applying
f to all key-value pairs in a Map.
Warning: It is the caller's responsibility to ensure the above property.
preserveMissing :: Applicative f => WhenMissing f k x x
preserveMissing = whenMissing f g
where
f _k x = pure (Just x)
g m = pure m
-- Note that this satisfies g = traverseMaybeWithKey f
import Data.Functor.Const (Const(..))
import Data.Monoid (All(..))
-- For a usage of this, see examples on mergeA
isEmpty :: WhenMissing (Const All) k x y
isEmpty = whenMissing f g
where
f _k _x = Const (All False)
g m = Const (All (null m))
-- Note that this satisfies g = traverseMaybeWithKey f
mergeWithKey :: Ord k => (k -> a -> b -> Maybe c) -> (Map k a -> Map k c) -> (Map k b -> Map k c) -> Map k a -> Map k b -> Map k cO(n+m). An unsafe general combining function.
Warning: This function can produce corrupt maps and its results
may depend on the internal structures of its inputs. Users should
prefer merge or mergeA.
When mergeWithKey is given three arguments, it is inlined to the call
site. You should therefore use mergeWithKey only to define custom
combining functions. For example, you could define unionWithKey,
differenceWithKey and intersectionWithKey as
myUnionWithKey f m1 m2 = mergeWithKey (\k x1 x2 -> Just (f k x1 x2)) id id m1 m2
myDifferenceWithKey f m1 m2 = mergeWithKey f id (const empty) m1 m2
myIntersectionWithKey f m1 m2 = mergeWithKey (\k x1 x2 -> Just (f k x1 x2)) (const empty) (const empty) m1 m2When calling , a function combining two
mergeWithKey combine only1 only2Maps is created, such that
if a key is present in both maps, it is passed with both corresponding
values to the combine function. Depending on the result, the key is either
present in the result with specified value, or is left out;
a nonempty subtree present only in the first map is passed to only1 and
the output is added to the result;
a nonempty subtree present only in the second map is passed to only2 and
the output is added to the result.
The only1 and only2 methods must return a map with a subset (possibly empty) of the keys of the given map.
The values can be modified arbitrarily. Most common variants of only1 and
only2 are id and , but for example const empty,
map f, or filterWithKey f could be used for any mapMaybeWithKey ff.
map :: (a -> b) -> Map k a -> Map k bO(n). Map a function over all values in the map.
map (++ "x") (fromList [(5,"a"), (3,"b")]) == fromList [(3, "bx"), (5, "ax")]mapWithKey :: (k -> a -> b) -> Map k a -> Map k bO(n). Map a function over all values in the map.
let f key x = (show key) ++ ":" ++ x
mapWithKey f (fromList [(5,"a"), (3,"b")]) == fromList [(3, "3:b"), (5, "5:a")]traverseWithKey :: Applicative t => (k -> a -> t b) -> Map k a -> t (Map k b)O(n).
That is, behaves exactly like a regular traverseWithKey f m == fromList <$> traverse (\(k, v) -> (,) k <$> f k v) (toList m)traverse except that the traversing
function also has access to the key associated with a value.
traverseWithKey (\k v -> if odd k then Just (succ v) else Nothing) (fromList [(1, 'a'), (5, 'e')]) == Just (fromList [(1, 'b'), (5, 'f')])
traverseWithKey (\k v -> if odd k then Just (succ v) else Nothing) (fromList [(2, 'c')]) == NothingtraverseMaybeWithKey :: Applicative f => (k -> a -> f (Maybe b)) -> Map k a -> f (Map k b)O(n). Traverse keys/values and collect the Just results.
mapAccum :: (a -> b -> (a, c)) -> a -> Map k b -> (a, Map k c)O(n). The function mapAccum threads an accumulating
argument through the map in ascending order of keys.
let f a b = (a ++ b, b ++ "X")
mapAccum f "Everything: " (fromList [(5,"a"), (3,"b")]) == ("Everything: ba", fromList [(3, "bX"), (5, "aX")])mapAccumWithKey :: (a -> k -> b -> (a, c)) -> a -> Map k b -> (a, Map k c)O(n). The function mapAccumWithKey threads an accumulating
argument through the map in ascending order of keys.
let f a k b = (a ++ " " ++ (show k) ++ "-" ++ b, b ++ "X")
mapAccumWithKey f "Everything:" (fromList [(5,"a"), (3,"b")]) == ("Everything: 3-b 5-a", fromList [(3, "bX"), (5, "aX")])mapAccumRWithKey :: (a -> k -> b -> (a, c)) -> a -> Map k b -> (a, Map k c)O(n). The function mapAccumRWithKey threads an accumulating
argument through the map in descending order of keys.
mapKeys :: Ord k2 => (k1 -> k2) -> Map k1 a -> Map k2 aO(n \log n).
is the map obtained by applying mapKeys f sf to each key of s.
If `f` is monotonically non-decreasing, this function takes O(n) time.
The size of the result may be smaller if f maps two or more distinct
keys to the same new key. In this case the value at the greatest of the
original keys is retained.
mapKeys (+ 1) (fromList [(5,"a"), (3,"b")]) == fromList [(4, "b"), (6, "a")]
mapKeys (\ _ -> 1) (fromList [(1,"b"), (2,"a"), (3,"d"), (4,"c")]) == singleton 1 "c"
mapKeys (\ _ -> 3) (fromList [(1,"b"), (2,"a"), (3,"d"), (4,"c")]) == singleton 3 "c"mapKeysWith :: Ord k2 => (a -> a -> a) -> (k1 -> k2) -> Map k1 a -> Map k2 aO(n \log n).
is the map obtained by applying mapKeysWith c f sf to each key of s.
If `f` is monotonically non-decreasing, this function takes O(n) time.
The size of the result may be smaller if f maps two or more distinct
keys to the same new key. In this case the associated values will be
combined using c. The value at the greater of the two original keys
is used as the first argument to c.
mapKeysWith (++) (\ _ -> 1) (fromList [(1,"b"), (2,"a"), (3,"d"), (4,"c")]) == singleton 1 "cdab"
mapKeysWith (++) (\ _ -> 3) (fromList [(1,"b"), (2,"a"), (3,"d"), (4,"c")]) == singleton 3 "cdab"Also see the performance note on fromListWith.
mapKeysMonotonic :: (k1 -> k2) -> Map k1 a -> Map k2 aO(n).
, but works only when mapKeysMonotonic f s == mapKeys f sf
is strictly monotonic.
That is, for any values x and y, if x < y then f x < f y.
Semi-formally, we have:
and [x < y ==> f x < f y | x <- ls, y <- ls]
==> mapKeysMonotonic f s == mapKeys f s
where ls = keys sThis means that f maps distinct original keys to distinct resulting keys.
This function has better performance than mapKeys.
Warning: This function should be used only if f is monotonically
strictly increasing. This precondition is not checked. Use mapKeys if the
precondition may not hold.
mapKeysMonotonic (\ k -> k * 2) (fromList [(5,"a"), (3,"b")]) == fromList [(6, "b"), (10, "a")]
valid (mapKeysMonotonic (\ k -> k * 2) (fromList [(5,"a"), (3,"b")])) == True
valid (mapKeysMonotonic (\ _ -> 1) (fromList [(5,"a"), (3,"b")])) == FalsemapAssocsMonotonic :: (k1 -> a1 -> (k2, a2)) -> Map k1 a1 -> Map k2 a2O(n). Map over keys and values with a function f that is
monotonically strictly increasing in the keys. That is, for keys kx and
ky and values x and y, if kx < ky then
fst (f kx x) < fst (f ky y).
Warning: This function should be used only if f is monotonically
strictly increasing in the key. This precondition is not checked.
foldr :: (a -> b -> b) -> b -> Map k a -> bO(n). Fold the values in the map using the given right-associative
binary operator, such that .foldr f z == foldr f z . elems
For example,
elems map = foldr (:) [] maplet f a len = len + (length a)
foldr f 0 (fromList [(5,"a"), (3,"bbb")]) == 4foldl :: (a -> b -> a) -> a -> Map k b -> aO(n). Fold the values in the map using the given left-associative
binary operator, such that .foldl f z == foldl f z . elems
For example,
elems = reverse . foldl (flip (:)) []let f len a = len + (length a)
foldl f 0 (fromList [(5,"a"), (3,"bbb")]) == 4foldrWithKey :: (k -> a -> b -> b) -> b -> Map k a -> bO(n). Fold the keys and values in the map using the given right-associative
binary operator, such that
.foldrWithKey f z == foldr (uncurry f) z . toAscList
For example,
keys map = foldrWithKey (\k x ks -> k:ks) [] maplet f k a result = result ++ "(" ++ (show k) ++ ":" ++ a ++ ")"
foldrWithKey f "Map: " (fromList [(5,"a"), (3,"b")]) == "Map: (5:a)(3:b)"foldlWithKey :: (a -> k -> b -> a) -> a -> Map k b -> aO(n). Fold the keys and values in the map using the given left-associative
binary operator, such that
.foldlWithKey f z == foldl (\z' (kx, x) -> f z' kx x) z . toAscList
For example,
keys = reverse . foldlWithKey (\ks k x -> k:ks) []let f result k a = result ++ "(" ++ (show k) ++ ":" ++ a ++ ")"
foldlWithKey f "Map: " (fromList [(5,"a"), (3,"b")]) == "Map: (3:b)(5:a)"foldMapWithKey :: Monoid m => (k -> a -> m) -> Map k a -> mO(n). Fold the keys and values in the map using the given monoid, such that
foldMapWithKey f = fold . mapWithKey f
This can be an asymptotically faster than foldrWithKey or foldlWithKey for some monoids.
foldr' :: (a -> b -> b) -> b -> Map k a -> bO(n). A strict version of foldr. Each application of the operator is
evaluated before using the result in the next application. This
function is strict in the starting value.
foldl' :: (a -> b -> a) -> a -> Map k b -> aO(n). A strict version of foldl. Each application of the operator is
evaluated before using the result in the next application. This
function is strict in the starting value.
foldrWithKey' :: (k -> a -> b -> b) -> b -> Map k a -> bO(n). A strict version of foldrWithKey. Each application of the operator is
evaluated before using the result in the next application. This
function is strict in the starting value.
foldlWithKey' :: (a -> k -> b -> a) -> a -> Map k b -> aO(n). A strict version of foldlWithKey. Each application of the operator is
evaluated before using the result in the next application. This
function is strict in the starting value.
elems :: Map k a -> [a]O(n).
Return all elements of the map in the ascending order of their keys.
Subject to list fusion.
elems (fromList [(5,"a"), (3,"b")]) == ["b","a"]
elems empty == []keys :: Map k a -> [k]O(n). Return all keys of the map in ascending order. Subject to list
fusion.
keys (fromList [(5,"a"), (3,"b")]) == [3,5]
keys empty == []assocs :: Map k a -> [(k, a)]O(n). An alias for toAscList. Return all key/value pairs in the map
in ascending key order. Subject to list fusion.
assocs (fromList [(5,"a"), (3,"b")]) == [(3,"b"), (5,"a")]
assocs empty == []keysSet :: Map k a -> Set.Set kO(n). The set of all keys of the map.
keysSet (fromList [(5,"a"), (3,"b")]) == Data.Set.fromList [3,5]
keysSet empty == Data.Set.emptyargSet :: Map k a -> Set.Set (Arg k a)O(n). The set of all elements of the map contained in Args.
argSet (fromList [(5,"a"), (3,"b")]) == Data.Set.fromList [Arg 3 "b",Arg 5 "a"]
argSet empty == Data.Set.emptyfromSet :: (k -> a) -> Set k -> Map k aO(n). Build a map from a Set of keys and a function which for each
key computes its value.
fromSet (\k -> replicate k 'a') (Data.Set.fromList [3,5]) == fromList [(3,"aaa"), (5,"aaaaa")]fromSetA :: Applicative f => (k -> f a) -> Set k -> f (Map k a)O(n). Build a map from a Set of keys and a function which for each
key computes its value in an Applicative context.
The Applicative actions are sequenced in order of increasing key.
let f k = if k == 0 then Nothing else Just (6 `div` k)
fromSetA f (Data.Set.fromList [1,2,3,4]) == Just (fromList [(1,6),(2,3),(3,2),(4,1)])
fromSetA f (Data.Set.fromList [0,1,2]) == NothingfromSetMaybe :: (k -> Maybe a) -> Set k -> Map k aO(n). Build a map from a Set of keys and a function which for each
key optionally computes its value.
let f k = if even k then Just (replicate k 'a') else Nothing
fromSetMaybe f (Data.Set.fromList [1,2,3,4]) == fromList [(2,"aa"), (4,"aaaa")]fromSetMaybeA :: Applicative f => (k -> f (Maybe a)) -> Set k -> f (Map k a)O(n). Build a map from a Set of keys and a function which for each
key optionally computes its values in an Applicative context.
The Applicative actions are sequenced in order of increasing key.
fromArgSet :: Set.Set (Arg k a) -> Map k aO(n). Build a map from a set of elements contained inside Args.
fromArgSet (Data.Set.fromList [Arg 3 "aaa", Arg 5 "aaaaa"]) == fromList [(5,"aaaaa"), (3,"aaa")]
fromArgSet Data.Set.empty == emptytoList :: Map k a -> [(k, a)]O(n). Convert the map to a list of key/value pairs. Subject to list fusion.
toList (fromList [(5,"a"), (3,"b")]) == [(3,"b"), (5,"a")]
toList empty == []fromList :: Ord k => [(k, a)] -> Map k aO(n \log n). Build a map from a list of key/value pairs.
If the list contains more than one value for the same key, the last value
for the key is retained.
If the keys are in non-decreasing order, this function takes O(n) time.
fromList [] == empty
fromList [(5,"a"), (3,"b"), (5, "c")] == fromList [(5,"c"), (3,"b")]
fromList [(5,"c"), (3,"b"), (5, "a")] == fromList [(5,"a"), (3,"b")]fromListWith :: Ord k => (a -> a -> a) -> [(k, a)] -> Map k aO(n \log n). Build a map from a list of key/value pairs with a combining function.
If the keys are in non-decreasing order, this function takes O(n) time.
fromListWith (++) [(5,"a"), (5,"b"), (3,"x"), (5,"c")] == fromList [(3, "x"), (5, "cba")]
fromListWith (++) [] == emptyNote the reverse ordering of "cba" in the example.
The symmetric combining function f is applied in a left-fold over the list, as f new old.
See also: fromListUpsert
You should ensure that the given f is fast with this order of arguments.
Symmetric functions may be slow in one order, and fast in another. For the common case of collecting values of matching keys in a list, as above:
The complexity of (++) a b is O(a), so it is fast when given a short list as its first argument.
Thus:
fromListWith (++) (replicate 1000000 (3, "x")) -- O(n), fast
fromListWith (flip (++)) (replicate 1000000 (3, "x")) -- O(n²), extremely slowbecause they evaluate as, respectively:
fromList [(3, "x" ++ ("x" ++ "xxxxx..xxxxx"))] -- O(n)
fromList [(3, ("xxxxx..xxxxx" ++ "x") ++ "x")] -- O(n²)Thus, to get good performance with an operation like (++) while also preserving
the same order as in the input list, reverse the input:
fromListWith (++) (reverse [(5,"a"), (5,"b"), (5,"c")]) == fromList [(5, "abc")]and it is always fast to combine singleton-list values [v] with fromListWith (++), as in:
fromListWith (++) $ reverse $ map (\(k, v) -> (k, [v])) someListOfTuplesfromListWithKey :: Ord k => (k -> a -> a -> a) -> [(k, a)] -> Map k aO(n \log n). Build a map from a list of key/value pairs with a combining function.
If the keys are in non-decreasing order, this function takes O(n) time.
let f key new_value old_value = show key ++ ":" ++ new_value ++ "|" ++ old_value
fromListWithKey f [(5,"a"), (5,"b"), (3,"b"), (3,"a"), (5,"c")] == fromList [(3, "3:a|b"), (5, "5:c|5:b|a")]
fromListWithKey f [] == emptyAlso see the performance note on fromListWith.
See also: fromListUpsert
fromListUpsert :: Ord k => (a -> Maybe b -> b) -> [(k, a)] -> Map k bO(n \log n). Build a map from a list of key/value pairs with a
combining function.
If the keys are in non-decreasing order, this function takes O(n) time.
The result is equivalent to performing an upsert for every key/value in
the list.
fromListUpsert f = foldl' (\\m (k, x) -> 'upsert' (f x) k m) 'empty'
let f x = maybe [x] (x:)
fromListUpsert f [(5,'a'), (5,'b'), (3,'c'), (3,'d'), (5,'e')] == fromList [(3,"dc"), (5,"eba")]toAscList :: Map k a -> [(k, a)]O(n). Convert the map to a list of key/value pairs where the keys are
in ascending order. Subject to list fusion.
toAscList (fromList [(5,"a"), (3,"b")]) == [(3,"b"), (5,"a")]toDescList :: Map k a -> [(k, a)]O(n). Convert the map to a list of key/value pairs where the keys
are in descending order. Subject to list fusion.
toDescList (fromList [(5,"a"), (3,"b")]) == [(5,"a"), (3,"b")]fromAscList :: Eq k => [(k, a)] -> Map k aO(n). Build a map from an ascending list in linear time.
Warning: This function should be used only if the keys are in
non-decreasing order. This precondition is not checked. Use fromList if the
precondition may not hold.
fromAscList [(3,"b"), (5,"a")] == fromList [(3, "b"), (5, "a")]
fromAscList [(3,"b"), (5,"a"), (5,"b")] == fromList [(3, "b"), (5, "b")]
valid (fromAscList [(3,"b"), (5,"a"), (5,"b")]) == True
valid (fromAscList [(5,"a"), (3,"b"), (5,"b")]) == FalsefromAscListWith :: Eq k => (a -> a -> a) -> [(k, a)] -> Map k aO(n). Build a map from an ascending list in linear time with a combining function for equal keys.
Warning: This function should be used only if the keys are in
non-decreasing order. This precondition is not checked. Use fromListWith if
the precondition may not hold.
fromAscListWith (++) [(3,"b"), (5,"a"), (5,"b")] == fromList [(3, "b"), (5, "ba")]
valid (fromAscListWith (++) [(3,"b"), (5,"a"), (5,"b")]) == True
valid (fromAscListWith (++) [(5,"a"), (3,"b"), (5,"b")]) == FalseSee also: fromAscListUpsert
fromAscListWithKey :: Eq k => (k -> a -> a -> a) -> [(k, a)] -> Map k aO(n). Build a map from an ascending list in linear time with a
combining function for equal keys.
Warning: This function should be used only if the keys are in
non-decreasing order. This precondition is not checked. Use fromListWithKey
if the precondition may not hold.
let f k a1 a2 = (show k) ++ ":" ++ a1 ++ a2
fromAscListWithKey f [(3,"b"), (5,"a"), (5,"b"), (5,"c")] == fromList [(3, "b"), (5, "5:c5:ba")]
valid (fromAscListWithKey f [(3,"b"), (5,"a"), (5,"b"), (5,"c")]) == True
valid (fromAscListWithKey f [(5,"a"), (3,"b"), (5,"b"), (5,"c")]) == FalseAlso see the performance note on fromListWith.
See also: fromAscListUpsert
fromAscListUpsert :: Eq k => (a -> Maybe b -> b) -> [(k, a)] -> Map k bO(n). Build a map from an ascending list in linear time with a
combining function for equal keys.
Warning: This function should be used only if the keys are in
non-decreasing order. This precondition is not checked. Use fromListUpsert
if the precondition may not hold.
let f x = maybe [x] (x:)
fromAscListUpsert f [(3,'a'), (3,'b'), (5,'c'), (5,'d'), (5,'e')] == fromList [(3,"ba"), (5,"edc")]fromDistinctAscList :: [(k, a)] -> Map k aO(n). Build a map from an ascending list of distinct elements in linear time.
Warning: This function should be used only if the keys are in
strictly increasing order. This precondition is not checked. Use fromList
if the precondition may not hold.
fromDistinctAscList [(3,"b"), (5,"a")] == fromList [(3, "b"), (5, "a")]
valid (fromDistinctAscList [(3,"b"), (5,"a")]) == True
valid (fromDistinctAscList [(3,"b"), (5,"a"), (5,"b")]) == FalsefromDescList :: Eq k => [(k, a)] -> Map k aO(n). Build a map from a descending list in linear time.
Warning: This function should be used only if the keys are in
non-increasing order. This precondition is not checked. Use fromList if the
precondition may not hold.
fromDescList [(5,"a"), (3,"b")] == fromList [(3, "b"), (5, "a")]
fromDescList [(5,"a"), (5,"b"), (3,"b")] == fromList [(3, "b"), (5, "b")]
valid (fromDescList [(5,"a"), (5,"b"), (3,"b")]) == True
valid (fromDescList [(5,"a"), (3,"b"), (5,"b")]) == FalsefromDescListWith :: Eq k => (a -> a -> a) -> [(k, a)] -> Map k aO(n). Build a map from a descending list in linear time with a combining function for equal keys.
Warning: This function should be used only if the keys are in
non-increasing order. This precondition is not checked. Use fromListWith if
the precondition may not hold.
fromDescListWith (++) [(5,"a"), (5,"b"), (3,"b")] == fromList [(3, "b"), (5, "ba")]
valid (fromDescListWith (++) [(5,"a"), (5,"b"), (3,"b")]) == True
valid (fromDescListWith (++) [(5,"a"), (3,"b"), (5,"b")]) == FalseAlso see the performance note on fromListWith.
See also: fromDescListUpsert
fromDescListWithKey :: Eq k => (k -> a -> a -> a) -> [(k, a)] -> Map k aO(n). Build a map from a descending list in linear time with a
combining function for equal keys.
Warning: This function should be used only if the keys are in
non-increasing order. This precondition is not checked. Use fromListWithKey
if the precondition may not hold.
let f k a1 a2 = (show k) ++ ":" ++ a1 ++ a2
fromDescListWithKey f [(5,"a"), (5,"b"), (5,"b"), (3,"b")] == fromList [(3, "b"), (5, "5:b5:ba")]
valid (fromDescListWithKey f [(5,"a"), (5,"b"), (5,"b"), (3,"b")]) == True
valid (fromDescListWithKey f [(5,"a"), (3,"b"), (5,"b"), (5,"b")]) == FalseAlso see the performance note on fromListWith.
See also: fromDescListUpsert
fromDescListUpsert :: Eq k => (a -> Maybe b -> b) -> [(k, a)] -> Map k bO(n). Build a map from a descending list in linear time with a
combining function for equal keys.
Warning: This function should be used only if the keys are in
non-increasing order. This precondition is not checked. Use fromListUpsert
if the precondition may not hold.
let f x = maybe [x] (x:)
fromDescListUpsert f [(5,'a'), (5,'b'), (5,'c'), (3,'d'), (3,'e')] == fromList [(3,"ed"), (5,"cba")]fromDistinctDescList :: [(k, a)] -> Map k aO(n). Build a map from a descending list of distinct elements in linear time.
Warning: This function should be used only if the keys are in
strictly decreasing order. This precondition is not checked. Use fromList
if the precondition may not hold.
fromDistinctDescList [(5,"a"), (3,"b")] == fromList [(3, "b"), (5, "a")]
valid (fromDistinctDescList [(5,"a"), (3,"b")]) == True
valid (fromDistinctDescList [(5,"a"), (5,"b"), (3,"b")]) == Falsefilter :: (a -> Bool) -> Map k a -> Map k aO(n). Keep all values that satisfy the predicate.
filter (> "a") (fromList [(5,"a"), (3,"b")]) == singleton 3 "b"
filter (> "x") (fromList [(5,"a"), (3,"b")]) == empty
filter (< "a") (fromList [(5,"a"), (3,"b")]) == emptyfilterKeys :: (k -> Bool) -> Map k a -> Map k aO(n). Keep all keys that satisfy the predicate.
filterKeys p = 'filterWithKey' (\\k _ -> p k)
filterKeys (> 4) (fromList [(5,"a"), (3,"b")]) == singleton 5 "a"filterWithKey :: (k -> a -> Bool) -> Map k a -> Map k aO(n). Keep all keys/values that satisfy the predicate.
filterWithKey (\k _ -> k > 4) (fromList [(5,"a"), (3,"b")]) == singleton 5 "a"takeWhileAntitone :: (k -> Bool) -> Map k a -> Map k aO(\log n). Take while a predicate on the keys holds.
The user is responsible for ensuring that for all keys j and k in the map,
j < k ==> p j >= p k. See note at spanAntitone.
takeWhileAntitone p = 'fromDistinctAscList' . 'Data.List.takeWhile' (p . fst) . 'toList'
takeWhileAntitone p = 'filterWithKey' (\k _ -> p k)
dropWhileAntitone :: (k -> Bool) -> Map k a -> Map k aO(\log n). Drop while a predicate on the keys holds.
The user is responsible for ensuring that for all keys j and k in the map,
j < k ==> p j >= p k. See note at spanAntitone.
dropWhileAntitone p = 'fromDistinctAscList' . 'Data.List.dropWhile' (p . fst) . 'toList'
dropWhileAntitone p = 'filterWithKey' (\\k _ -> not (p k))
spanAntitone :: (k -> Bool) -> Map k a -> (Map k a, Map k a)O(\log n). Divide a map at the point where a predicate on the keys stops holding.
The user is responsible for ensuring that for all keys j and k in the map,
j < k ==> p j >= p k.
spanAntitone p xs = ('takeWhileAntitone' p xs, 'dropWhileAntitone' p xs)
spanAntitone p xs = partitionWithKey (\\k _ -> p k) xs
Note: if p is not actually antitone, then spanAntitone will split the map
at some unspecified point where the predicate switches from holding to not
holding (where the predicate is seen to hold before the first key and to fail
after the last key).
restrictKeys :: Ord k => Map k a -> Set k -> Map k aO\bigl(m \log\bigl(\frac{n}{m}+1\bigr)\bigr), \; 0 < m \leq n. Restrict a Map to only those keys
found in a Set.
m \`restrictKeys\` s = 'filterWithKey' (\\k _ -> k ``Set.member`` s) m
m \`restrictKeys\` s = m ``intersection`` 'fromSet' (const ()) s
withoutKeys :: Ord k => Map k a -> Set k -> Map k aO\bigl(m \log\bigl(\frac{n}{m}+1\bigr)\bigr), \; 0 < m \leq n. Remove all keys in a Set from a Map.
m \`withoutKeys\` s = 'filterWithKey' (\\k _ -> k ``Set.notMember`` s) m
m \`withoutKeys\` s = m ``difference`` 'fromSet' (const ()) s
partition :: (a -> Bool) -> Map k a -> (Map k a, Map k a)O(n). Partition the map according to a predicate. The first
map contains all elements that satisfy the predicate, the second all
elements that fail the predicate. See also split.
partition (> "a") (fromList [(5,"a"), (3,"b")]) == (singleton 3 "b", singleton 5 "a")
partition (< "x") (fromList [(5,"a"), (3,"b")]) == (fromList [(3, "b"), (5, "a")], empty)
partition (> "x") (fromList [(5,"a"), (3,"b")]) == (empty, fromList [(3, "b"), (5, "a")])partitionWithKey :: (k -> a -> Bool) -> Map k a -> (Map k a, Map k a)O(n). Partition the map according to a predicate. The first
map contains all elements that satisfy the predicate, the second all
elements that fail the predicate. See also split.
partitionWithKey (\ k _ -> k > 3) (fromList [(5,"a"), (3,"b")]) == (singleton 5 "a", singleton 3 "b")
partitionWithKey (\ k _ -> k < 7) (fromList [(5,"a"), (3,"b")]) == (fromList [(3, "b"), (5, "a")], empty)
partitionWithKey (\ k _ -> k > 7) (fromList [(5,"a"), (3,"b")]) == (empty, fromList [(3, "b"), (5, "a")])mapMaybe :: (a -> Maybe b) -> Map k a -> Map k bO(n). Map values and collect the Just results.
let f x = if x == "a" then Just "new a" else Nothing
mapMaybe f (fromList [(5,"a"), (3,"b")]) == singleton 5 "new a"mapMaybeWithKey :: (k -> a -> Maybe b) -> Map k a -> Map k bO(n). Map keys/values and collect the Just results.
let f k _ = if k < 5 then Just ("key : " ++ (show k)) else Nothing
mapMaybeWithKey f (fromList [(5,"a"), (3,"b")]) == singleton 3 "key : 3"mapEither :: (a -> Either b c) -> Map k a -> (Map k b, Map k c)O(n). Map values and separate the Left and Right results.
let f a = if a < "c" then Left a else Right a
mapEither f (fromList [(5,"a"), (3,"b"), (1,"x"), (7,"z")])
== (fromList [(3,"b"), (5,"a")], fromList [(1,"x"), (7,"z")])
mapEither (\ a -> Right a) (fromList [(5,"a"), (3,"b"), (1,"x"), (7,"z")])
== (empty, fromList [(5,"a"), (3,"b"), (1,"x"), (7,"z")])mapEitherWithKey :: (k -> a -> Either b c) -> Map k a -> (Map k b, Map k c)O(n). Map keys/values and separate the Left and Right results.
let f k a = if k < 5 then Left (k * 2) else Right (a ++ a)
mapEitherWithKey f (fromList [(5,"a"), (3,"b"), (1,"x"), (7,"z")])
== (fromList [(1,2), (3,6)], fromList [(5,"aa"), (7,"zz")])
mapEitherWithKey (\_ a -> Right a) (fromList [(5,"a"), (3,"b"), (1,"x"), (7,"z")])
== (empty, fromList [(1,"x"), (3,"b"), (5,"a"), (7,"z")])split :: Ord k => k -> Map k a -> (Map k a, Map k a)O(\log n). The expression () is a pair split k map(map1,map2) where
the keys in map1 are smaller than k and the keys in map2 larger than k.
Any key equal to k is found in neither map1 nor map2.
split 2 (fromList [(5,"a"), (3,"b")]) == (empty, fromList [(3,"b"), (5,"a")])
split 3 (fromList [(5,"a"), (3,"b")]) == (empty, singleton 5 "a")
split 4 (fromList [(5,"a"), (3,"b")]) == (singleton 3 "b", singleton 5 "a")
split 5 (fromList [(5,"a"), (3,"b")]) == (singleton 3 "b", empty)
split 6 (fromList [(5,"a"), (3,"b")]) == (fromList [(3,"b"), (5,"a")], empty)splitLookup :: Ord k => k -> Map k a -> (Map k a, Maybe a, Map k a)O(\log n). The expression () splits a map just
like splitLookup k mapsplit but also returns .lookup k map
splitLookup 2 (fromList [(5,"a"), (3,"b")]) == (empty, Nothing, fromList [(3,"b"), (5,"a")])
splitLookup 3 (fromList [(5,"a"), (3,"b")]) == (empty, Just "b", singleton 5 "a")
splitLookup 4 (fromList [(5,"a"), (3,"b")]) == (singleton 3 "b", Nothing, singleton 5 "a")
splitLookup 5 (fromList [(5,"a"), (3,"b")]) == (singleton 3 "b", Just "a", empty)
splitLookup 6 (fromList [(5,"a"), (3,"b")]) == (fromList [(3,"b"), (5,"a")], Nothing, empty)splitRoot :: Map k b -> [Map k b]O(1). Decompose a map into pieces based on the structure of the underlying
tree. This function is useful for consuming a map in parallel.
No guarantee is made as to the sizes of the pieces; an internal, but deterministic process determines this. However, it is guaranteed that the pieces returned will be in ascending order (all elements in the first submap less than all elements in the second, and so on).
Examples:
splitRoot (fromList (zip [1..6] ['a'..])) ==
[fromList [(1,'a'),(2,'b'),(3,'c')],fromList [(4,'d')],fromList [(5,'e'),(6,'f')]]splitRoot empty == []Note that the current implementation does not return more than three submaps, but you should not depend on this behaviour because it can change in the future without notice.
isSubmapOf :: (Ord k, Eq a) => Map k a -> Map k a -> BoolO\bigl(m \log\bigl(\frac{n}{m}+1\bigr)\bigr), \; 0 < m \leq n.
This function is defined as ().isSubmapOf = isSubmapOfBy (==)
isSubmapOfBy :: Ord k => (a -> b -> Bool) -> Map k a -> Map k b -> BoolO\bigl(m \log\bigl(\frac{n}{m}+1\bigr)\bigr), \; 0 < m \leq n.
The expression () returns isSubmapOfBy f t1 t2True if
all keys in t1 are in tree t2, and when f returns True when
applied to their respective values. For example, the following
expressions are all True:
isSubmapOfBy (==) (fromList [('a',1)]) (fromList [('a',1),('b',2)])
isSubmapOfBy (<=) (fromList [('a',1)]) (fromList [('a',1),('b',2)])
isSubmapOfBy (==) (fromList [('a',1),('b',2)]) (fromList [('a',1),('b',2)])But the following are all False:
isSubmapOfBy (==) (fromList [('a',2)]) (fromList [('a',1),('b',2)])
isSubmapOfBy (<) (fromList [('a',1)]) (fromList [('a',1),('b',2)])
isSubmapOfBy (==) (fromList [('a',1),('b',2)]) (fromList [('a',1)])Note that isSubmapOfBy (_ _ -> True) m1 m2 tests whether all the keys
in m1 are also keys in m2.
isProperSubmapOf :: (Ord k, Eq a) => Map k a -> Map k a -> BoolO\bigl(m \log\bigl(\frac{n}{m}+1\bigr)\bigr), \; 0 < m \leq n. Is this a proper submap? (ie. a submap but not equal).
Defined as ().isProperSubmapOf = isProperSubmapOfBy (==)
isProperSubmapOfBy :: Ord k => (a -> b -> Bool) -> Map k a -> Map k b -> BoolO\bigl(m \log\bigl(\frac{n}{m}+1\bigr)\bigr), \; 0 < m \leq n. Is this a proper submap? (ie. a submap but not equal).
The expression () returns isProperSubmapOfBy f m1 m2True when
keys m1 and keys m2 are not equal,
all keys in m1 are in m2, and when f returns True when
applied to their respective values. For example, the following
expressions are all True:
isProperSubmapOfBy (==) (fromList [(1,1)]) (fromList [(1,1),(2,2)])
isProperSubmapOfBy (<=) (fromList [(1,1)]) (fromList [(1,1),(2,2)])But the following are all False:
isProperSubmapOfBy (==) (fromList [(1,1),(2,2)]) (fromList [(1,1),(2,2)])
isProperSubmapOfBy (==) (fromList [(1,1),(2,2)]) (fromList [(1,1)])
isProperSubmapOfBy (<) (fromList [(1,1)]) (fromList [(1,1),(2,2)])lookupIndex :: Ord k => k -> Map k a -> Maybe IntO(\log n). Look up the index of a key, which is its zero-based index in
the sequence sorted by keys. The index is a number from 0 up to, but not
including, the size of the map.
isJust (lookupIndex 2 (fromList [(5,"a"), (3,"b")])) == False
fromJust (lookupIndex 3 (fromList [(5,"a"), (3,"b")])) == 0
fromJust (lookupIndex 5 (fromList [(5,"a"), (3,"b")])) == 1
isJust (lookupIndex 6 (fromList [(5,"a"), (3,"b")])) == FalsefindIndex :: Ord k => k -> Map k a -> IntO(\log n). Return the index of a key, which is its zero-based index in
the sequence sorted by keys. The index is a number from 0 up to, but not
including, the size of the map. Calls error when the key is not
a member of the map.
Note: This function is partial. Prefer lookupIndex.
findIndex 2 (fromList [(5,"a"), (3,"b")]) Error: element is not in the map
findIndex 3 (fromList [(5,"a"), (3,"b")]) == 0
findIndex 5 (fromList [(5,"a"), (3,"b")]) == 1
findIndex 6 (fromList [(5,"a"), (3,"b")]) Error: element is not in the mapelemAt :: Int -> Map k a -> (k, a)O(\log n). Retrieve an element by its index, i.e. by its zero-based
index in the sequence sorted by keys. If the index is out of range (less
than zero, greater or equal to size of the map), error is called.
Note: This function is partial.
elemAt 0 (fromList [(5,"a"), (3,"b")]) == (3,"b")
elemAt 1 (fromList [(5,"a"), (3,"b")]) == (5, "a")
elemAt 2 (fromList [(5,"a"), (3,"b")]) Error: index out of rangeupdateAt :: (k -> a -> Maybe a) -> Int -> Map k a -> Map k aO(\log n). Update the element at index, i.e. by its zero-based index in
the sequence sorted by keys. If the index is out of range (less than zero,
greater or equal to size of the map), error is called.
Note: This function is partial.
updateAt (\ _ _ -> Just "x") 0 (fromList [(5,"a"), (3,"b")]) == fromList [(3, "x"), (5, "a")]
updateAt (\ _ _ -> Just "x") 1 (fromList [(5,"a"), (3,"b")]) == fromList [(3, "b"), (5, "x")]
updateAt (\ _ _ -> Just "x") 2 (fromList [(5,"a"), (3,"b")]) Error: index out of range
updateAt (\ _ _ -> Just "x") (-1) (fromList [(5,"a"), (3,"b")]) Error: index out of range
updateAt (\_ _ -> Nothing) 0 (fromList [(5,"a"), (3,"b")]) == singleton 5 "a"
updateAt (\_ _ -> Nothing) 1 (fromList [(5,"a"), (3,"b")]) == singleton 3 "b"
updateAt (\_ _ -> Nothing) 2 (fromList [(5,"a"), (3,"b")]) Error: index out of range
updateAt (\_ _ -> Nothing) (-1) (fromList [(5,"a"), (3,"b")]) Error: index out of rangedeleteAt :: Int -> Map k a -> Map k aO(\log n). Delete the element at index, i.e. by its zero-based index in
the sequence sorted by keys. If the index is out of range (less than zero,
greater or equal to size of the map), error is called.
Note: This function is partial.
deleteAt 0 (fromList [(5,"a"), (3,"b")]) == singleton 5 "a"
deleteAt 1 (fromList [(5,"a"), (3,"b")]) == singleton 3 "b"
deleteAt 2 (fromList [(5,"a"), (3,"b")]) Error: index out of range
deleteAt (-1) (fromList [(5,"a"), (3,"b")]) Error: index out of rangetake :: Int -> Map k a -> Map k aO(\log n). Take a given number of entries in key order, beginning
with the smallest keys.
take n = 'fromDistinctAscList' . 'Prelude.take' n . 'toAscList'
drop :: Int -> Map k a -> Map k aO(\log n). Drop a given number of entries in key order, beginning
with the smallest keys.
drop n = 'fromDistinctAscList' . 'Prelude.drop' n . 'toAscList'
splitAt :: Int -> Map k a -> (Map k a, Map k a)O(\log n). Split a map at a particular index.
splitAt !n !xs = ('take' n xs, 'drop' n xs)
lookupMin :: Map k a -> Maybe (k, a)O(\log n). The minimal key of the map. Returns Nothing if the map is empty.
lookupMin (fromList [(5,"a"), (3,"b")]) == Just (3,"b")
lookupMin empty = NothinglookupMax :: Map k a -> Maybe (k, a)O(\log n). The maximal key of the map. Returns Nothing if the map is empty.
lookupMax (fromList [(5,"a"), (3,"b")]) == Just (5,"a")
lookupMax empty = NothingfindMin :: Map k a -> (k, a)O(\log n). The minimal key of the map. Calls error if the map is empty.
Note: This function is partial. Prefer lookupMin.
findMin (fromList [(5,"a"), (3,"b")]) == (3,"b")
findMin empty Error: empty map has no minimal elementfindMax :: Map k a -> (k, a)O(\log n). The maximal key of the map. Calls error if the map is empty.
Note: This function is partial. Prefer lookupMax.
findMax (fromList [(5,"a"), (3,"b")]) == (5,"a")
findMax empty Error: empty map has no maximal elementdeleteMin :: Map k a -> Map k aO(\log n). Delete the minimal key. Returns an empty map if the map is empty.
deleteMin (fromList [(5,"a"), (3,"b"), (7,"c")]) == fromList [(5,"a"), (7,"c")]
deleteMin empty == emptydeleteMax :: Map k a -> Map k aO(\log n). Delete the maximal key. Returns an empty map if the map is empty.
deleteMax (fromList [(5,"a"), (3,"b"), (7,"c")]) == fromList [(3,"b"), (5,"a")]
deleteMax empty == emptydeleteFindMin :: Map k a -> ((k, a), Map k a)O(\log n). Delete and find the minimal element.
Calls error if the map is empty.
Note: This function is partial. Prefer minViewWithKey.
deleteFindMax :: Map k a -> ((k, a), Map k a)O(\log n). Delete and find the maximal element.
Calls error if the map is empty.
Note: This function is partial. Prefer maxViewWithKey.
updateMin :: (a -> Maybe a) -> Map k a -> Map k aO(\log n). Update the value at the minimal key.
updateMin (\ a -> Just ("X" ++ a)) (fromList [(5,"a"), (3,"b")]) == fromList [(3, "Xb"), (5, "a")]
updateMin (\ _ -> Nothing) (fromList [(5,"a"), (3,"b")]) == singleton 5 "a"updateMax :: (a -> Maybe a) -> Map k a -> Map k aO(\log n). Update the value at the maximal key.
updateMax (\ a -> Just ("X" ++ a)) (fromList [(5,"a"), (3,"b")]) == fromList [(3, "b"), (5, "Xa")]
updateMax (\ _ -> Nothing) (fromList [(5,"a"), (3,"b")]) == singleton 3 "b"updateMinWithKey :: (k -> a -> Maybe a) -> Map k a -> Map k aO(\log n). Update the value at the minimal key.
updateMinWithKey (\ k a -> Just ((show k) ++ ":" ++ a)) (fromList [(5,"a"), (3,"b")]) == fromList [(3,"3:b"), (5,"a")]
updateMinWithKey (\ _ _ -> Nothing) (fromList [(5,"a"), (3,"b")]) == singleton 5 "a"updateMaxWithKey :: (k -> a -> Maybe a) -> Map k a -> Map k aO(\log n). Update the value at the maximal key.
updateMaxWithKey (\ k a -> Just ((show k) ++ ":" ++ a)) (fromList [(5,"a"), (3,"b")]) == fromList [(3,"b"), (5,"5:a")]
updateMaxWithKey (\ _ _ -> Nothing) (fromList [(5,"a"), (3,"b")]) == singleton 3 "b"minView :: Map k a -> Maybe (a, Map k a)O(\log n). Retrieves the value associated with minimal key of the
map, and the map stripped of that element, or Nothing if passed an
empty map.
minView (fromList [(5,"a"), (3,"b")]) == Just ("b", singleton 5 "a")
minView empty == NothingmaxView :: Map k a -> Maybe (a, Map k a)O(\log n). Retrieves the value associated with maximal key of the
map, and the map stripped of that element, or Nothing if passed an
empty map.
maxView (fromList [(5,"a"), (3,"b")]) == Just ("a", singleton 3 "b")
maxView empty == NothingminViewWithKey :: Map k a -> Maybe ((k, a), Map k a)O(\log n). Retrieves the minimal (key,value) pair of the map, and
the map stripped of that element, or Nothing if passed an empty map.
minViewWithKey (fromList [(5,"a"), (3,"b")]) == Just ((3,"b"), singleton 5 "a")
minViewWithKey empty == NothingmaxViewWithKey :: Map k a -> Maybe ((k, a), Map k a)O(\log n). Retrieves the maximal (key,value) pair of the map, and
the map stripped of that element, or Nothing if passed an empty map.
maxViewWithKey (fromList [(5,"a"), (3,"b")]) == Just ((5,"a"), singleton 3 "b")
maxViewWithKey empty == Nothingdata AreWeStrictStrict :: AreWeStrictLazy :: AreWeStrictatKeyImpl :: (Functor f, Ord k) => AreWeStrict -> k -> (Maybe a -> f (Maybe a)) -> Map k a -> f (Map k a)bin :: k -> a -> Map k a -> Map k a -> Map k abalance :: k -> a -> Map k a -> Map k a -> Map k abalanceL :: k -> a -> Map k a -> Map k a -> Map k abalanceR :: k -> a -> Map k a -> Map k a -> Map k adelta :: IntinsertMax :: k -> a -> Map k a -> Map k alink :: k -> a -> Map k a -> Map k a -> Map k alink2 :: Map k a -> Map k a -> Map k aglue :: Map k a -> Map k a -> Map k aascLinkTop :: Stack k a -> Int -> Map k a -> k -> a -> Stack k aascLinkAll :: Stack k a -> Map k adescLinkTop :: k -> a -> Int -> Map k a -> Stack k a -> Stack k adescLinkAll :: Stack k a -> Map k anewtype Identity (a :: Type)Identity :: a -> Identity arunIdentity :: Identity a -> adata Stack k aPush :: k -> a -> (Map k a) -> (Stack k a) -> Stack k aNada :: Stack k afoldl'Stack :: (b -> k -> a -> Map k a -> b) -> b -> Stack k a -> bdata MapBuilder k aBAsc :: (Stack k a) -> MapBuilder k aBMap :: (Map k a) -> MapBuilder k aemptyB :: MapBuilder k ainsertB :: Ord k => k -> a -> MapBuilder k a -> MapBuilder k afinishB :: MapBuilder k a -> Map k amapWhenMissing :: Monad f => (a -> b) -> WhenMissing f k x a -> WhenMissing f k x bMap covariantly over a .WhenMissing f k x
mapWhenMatched :: Functor f => (a -> b) -> WhenMatched f k x y a -> WhenMatched f k x y bMap covariantly over a .WhenMatched f k x y
lmapWhenMissing :: (b -> a) -> WhenMissing f k a x -> WhenMissing f k b xMap contravariantly over a .WhenMissing f k _ x
contramapFirstWhenMatched :: (b -> a) -> WhenMatched f k a y z -> WhenMatched f k b y zMap contravariantly over a .WhenMatched f k _ y z
contramapSecondWhenMatched :: (b -> a) -> WhenMatched f k x a z -> WhenMatched f k x b zMap contravariantly over a .WhenMatched f k x _ z
mapGentlyWhenMissing :: Functor f => (a -> b) -> WhenMissing f k x a -> WhenMissing f k x bMap covariantly over a , using only a 'Functor f'
constraint.WhenMissing f k x
mapGentlyWhenMatched :: Functor f => (a -> b) -> WhenMatched f k x y a -> WhenMatched f k x y bMap covariantly over a , using only a 'Functor f'
constraint.WhenMatched f k x
instance (Lift k, Lift a) => Lift (Map k a)instance (Ord k) => Monoid (Map k v)mempty = empty
instance (Ord k) => Semigroup (Map k v)(<>) = union
instance (Data k, Data a, Ord k) => Data (Map k a)instance Monad f => Functor (WhenMissing f k x)instance Monad f => Category.Category (WhenMissing f k)instance Monad f => Applicative (WhenMissing f k x)Equivalent to ReaderT k (ReaderT x (MaybeT f)) .
instance Monad f => Monad (WhenMissing f k x)Equivalent to ReaderT k (ReaderT x (MaybeT f)) .
instance Functor f => Functor (WhenMatched f k x y)instance Monad f => Category.Category (WhenMatched f k x)instance Monad f => Applicative (WhenMatched f k x y)Equivalent to ReaderT k (ReaderT x (ReaderT y (MaybeT f)))
instance Monad f => Monad (WhenMatched f k x y)Equivalent to ReaderT k (ReaderT x (ReaderT y (MaybeT f)))
instance (Ord k) => GHCExts.IsList (Map k v)instance (Eq k, Eq a) => Eq (Map k a)instance Eq k => Eq1 (Map k)instance Eq2 Mapinstance (Ord k, Ord v) => Ord (Map k v)instance Ord k => Ord1 (Map k)instance Ord2 Mapinstance Show2 Mapinstance Show k => Show1 (Map k)instance (Ord k, Read k) => Read1 (Map k)instance Functor (Map k)instance Traversable (Map k)Traverses in order of increasing key.
instance Foldable.Foldable (Map k)Folds in order of increasing key.
instance Bifoldable Mapinstance (NFData k, NFData a) => NFData (Map k a)instance NFData k => NFData1 (Map k)instance NFData2 Mapinstance (Ord k, Read k, Read e) => Read (Map k e)instance (Show k, Show a) => Show (Map k a)Community contribution. The service has not verified this documentation. The generator reported 15 diagnostics.
Target: Linux on x86-64. Some inferred types and resolved links are not available.
Generator: aihc-haddock-aa6debbd-web-3
Metadata snapshot: 634f718c0d8cd970c4e2c511d2345d8fd36c6dc32b06343c2b4e914ffccbce7f
Open the dependency plan · Download the documentation model