/usr/share/doc/haskell-edison-api-doc/html/Data-Edison-Assoc.html is in libghc-edison-api-doc 1.2.1-17.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Data.Edison.Assoc</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Data-Edison-Assoc.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Data-Edison-Assoc.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">EdisonAPI-1.2.1: A library of efficient, purely-functional data structures (API)</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>GHC, Hugs (MPTC and FD)</td></tr><tr><th>Stability</th><td>stable</td></tr><tr><th>Maintainer</th><td>robdockins AT fastmail DOT fm</td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">Data.Edison.Assoc</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Superclass aliases
</a></li><li><a href="#g:2">Non-observable associative collections
</a></li><li><a href="#g:3">Observable associative collections
</a></li><li><a href="#g:4">Specilizations of submap operations
</a></li><li><a href="#g:5">Specializations of sequence operations to lists
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>The <em>associative collection</em> abstraction includes finite maps, finite
relations, and priority queues where the priority is separate from the
element. Associative collections are defined in Edison as a set of eight
classes.
</p><p>Note that this
hierarchy mirrors the hierarchy for collections, but with the addition
of <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Functor">Functor</a></code> as a superclass of every associative collection. See
<a href="Data-Edison-Coll.html">Data.Edison.Coll</a> for a description of the class hierarchy.
</p><p>In almost all cases, associative collections make no guarantees about
behavior with respect to the actual keys stored and (in the case of
observable maps) which keys can be retrieved. We adopt the convention
that methods which create associative collections are <em>unambiguous</em>
with respect to the key storage behavior, but that methods which can
observe keys are <em>ambiguous</em> with respect to the actual keys returned.
</p><p>In all cases where an operation is ambiguous with respect to the key,
the operation is rendered <em>unambiguous</em> if the <code>Eq</code> instance on keys
corresponds to indistinguisability.
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:map">map</a> :: <a href="Data-Edison-Assoc.html#t:AssocX">AssocX</a> m k => (a -> b) -> m a -> m b</li><li class="src short"><span class="keyword">class</span> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> k, <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Functor">Functor</a> m) => <a href="#t:AssocX">AssocX</a> m k | m -> k <span class="keyword">where</span><ul class="subs"><li><a href="#v:empty">empty</a> :: m a</li><li><a href="#v:singleton">singleton</a> :: k -> a -> m a</li><li><a href="#v:fromSeq">fromSeq</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => seq (k, a) -> m a</li><li><a href="#v:insert">insert</a> :: k -> a -> m a -> m a</li><li><a href="#v:insertSeq">insertSeq</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => seq (k, a) -> m a -> m a</li><li><a href="#v:union">union</a> :: m a -> m a -> m a</li><li><a href="#v:unionSeq">unionSeq</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => seq (m a) -> m a</li><li><a href="#v:delete">delete</a> :: k -> m a -> m a</li><li><a href="#v:deleteAll">deleteAll</a> :: k -> m a -> m a</li><li><a href="#v:deleteSeq">deleteSeq</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => seq k -> m a -> m a</li><li><a href="#v:null">null</a> :: m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:size">size</a> :: m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a></li><li><a href="#v:member">member</a> :: k -> m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:count">count</a> :: k -> m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a></li><li><a href="#v:lookup">lookup</a> :: k -> m a -> a</li><li><a href="#v:lookupM">lookupM</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Monad">Monad</a> rm => k -> m a -> rm a</li><li><a href="#v:lookupAll">lookupAll</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => k -> m a -> seq a</li><li><a href="#v:lookupAndDelete">lookupAndDelete</a> :: k -> m a -> (a, m a)</li><li><a href="#v:lookupAndDeleteM">lookupAndDeleteM</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Monad">Monad</a> rm => k -> m a -> rm (a, m a)</li><li><a href="#v:lookupAndDeleteAll">lookupAndDeleteAll</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => k -> m a -> (seq a, m a)</li><li><a href="#v:lookupWithDefault">lookupWithDefault</a> :: a -> k -> m a -> a</li><li><a href="#v:adjust">adjust</a> :: (a -> a) -> k -> m a -> m a</li><li><a href="#v:adjustAll">adjustAll</a> :: (a -> a) -> k -> m a -> m a</li><li><a href="#v:adjustOrInsert">adjustOrInsert</a> :: (a -> a) -> a -> k -> m a -> m a</li><li><a href="#v:adjustAllOrInsert">adjustAllOrInsert</a> :: (a -> a) -> a -> k -> m a -> m a</li><li><a href="#v:adjustOrDelete">adjustOrDelete</a> :: (a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a) -> k -> m a -> m a</li><li><a href="#v:adjustOrDeleteAll">adjustOrDeleteAll</a> :: (a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a) -> k -> m a -> m a</li><li><a href="#v:fold">fold</a> :: (a -> b -> b) -> b -> m a -> b</li><li><a href="#v:fold-39-">fold'</a> :: (a -> b -> b) -> b -> m a -> b</li><li><a href="#v:fold1">fold1</a> :: (a -> a -> a) -> m a -> a</li><li><a href="#v:fold1-39-">fold1'</a> :: (a -> a -> a) -> m a -> a</li><li><a href="#v:filter">filter</a> :: (a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a>) -> m a -> m a</li><li><a href="#v:partition">partition</a> :: (a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a>) -> m a -> (m a, m a)</li><li><a href="#v:elements">elements</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => m a -> seq a</li><li><a href="#v:strict">strict</a> :: m a -> m a</li><li><a href="#v:strictWith">strictWith</a> :: (a -> b) -> m a -> m a</li><li><a href="#v:structuralInvariant">structuralInvariant</a> :: m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:instanceName">instanceName</a> :: m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li></ul></li><li class="src short"><span class="keyword">class</span> (<a href="Data-Edison-Assoc.html#t:AssocX">AssocX</a> m k, <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Ord.html#t:Ord">Ord</a> k) => <a href="#t:OrdAssocX">OrdAssocX</a> m k | m -> k <span class="keyword">where</span><ul class="subs"><li><a href="#v:minView">minView</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Monad">Monad</a> rm => m a -> rm (a, m a)</li><li><a href="#v:minElem">minElem</a> :: m a -> a</li><li><a href="#v:deleteMin">deleteMin</a> :: m a -> m a</li><li><a href="#v:unsafeInsertMin">unsafeInsertMin</a> :: k -> a -> m a -> m a</li><li><a href="#v:maxView">maxView</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Monad">Monad</a> rm => m a -> rm (a, m a)</li><li><a href="#v:maxElem">maxElem</a> :: m a -> a</li><li><a href="#v:deleteMax">deleteMax</a> :: m a -> m a</li><li><a href="#v:unsafeInsertMax">unsafeInsertMax</a> :: k -> a -> m a -> m a</li><li><a href="#v:foldr">foldr</a> :: (a -> b -> b) -> b -> m a -> b</li><li><a href="#v:foldr-39-">foldr'</a> :: (a -> b -> b) -> b -> m a -> b</li><li><a href="#v:foldl">foldl</a> :: (b -> a -> b) -> b -> m a -> b</li><li><a href="#v:foldl-39-">foldl'</a> :: (b -> a -> b) -> b -> m a -> b</li><li><a href="#v:foldr1">foldr1</a> :: (a -> a -> a) -> m a -> a</li><li><a href="#v:foldr1-39-">foldr1'</a> :: (a -> a -> a) -> m a -> a</li><li><a href="#v:foldl1">foldl1</a> :: (a -> a -> a) -> m a -> a</li><li><a href="#v:foldl1-39-">foldl1'</a> :: (a -> a -> a) -> m a -> a</li><li><a href="#v:unsafeFromOrdSeq">unsafeFromOrdSeq</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => seq (k, a) -> m a</li><li><a href="#v:unsafeAppend">unsafeAppend</a> :: m a -> m a -> m a</li><li><a href="#v:filterLT">filterLT</a> :: k -> m a -> m a</li><li><a href="#v:filterLE">filterLE</a> :: k -> m a -> m a</li><li><a href="#v:filterGT">filterGT</a> :: k -> m a -> m a</li><li><a href="#v:filterGE">filterGE</a> :: k -> m a -> m a</li><li><a href="#v:partitionLT_GE">partitionLT_GE</a> :: k -> m a -> (m a, m a)</li><li><a href="#v:partitionLE_GT">partitionLE_GT</a> :: k -> m a -> (m a, m a)</li><li><a href="#v:partitionLT_GT">partitionLT_GT</a> :: k -> m a -> (m a, m a)</li></ul></li><li class="src short"><span class="keyword">class</span> <a href="Data-Edison-Assoc.html#t:AssocX">AssocX</a> m k => <a href="#t:FiniteMapX">FiniteMapX</a> m k | m -> k <span class="keyword">where</span><ul class="subs"><li><a href="#v:fromSeqWith">fromSeqWith</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => (a -> a -> a) -> seq (k, a) -> m a</li><li><a href="#v:fromSeqWithKey">fromSeqWithKey</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => (k -> a -> a -> a) -> seq (k, a) -> m a</li><li><a href="#v:insertWith">insertWith</a> :: (a -> a -> a) -> k -> a -> m a -> m a</li><li><a href="#v:insertWithKey">insertWithKey</a> :: (k -> a -> a -> a) -> k -> a -> m a -> m a</li><li><a href="#v:insertSeqWith">insertSeqWith</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => (a -> a -> a) -> seq (k, a) -> m a -> m a</li><li><a href="#v:insertSeqWithKey">insertSeqWithKey</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => (k -> a -> a -> a) -> seq (k, a) -> m a -> m a</li><li><a href="#v:unionl">unionl</a> :: m a -> m a -> m a</li><li><a href="#v:unionr">unionr</a> :: m a -> m a -> m a</li><li><a href="#v:unionWith">unionWith</a> :: (a -> a -> a) -> m a -> m a -> m a</li><li><a href="#v:unionSeqWith">unionSeqWith</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => (a -> a -> a) -> seq (m a) -> m a</li><li><a href="#v:intersectionWith">intersectionWith</a> :: (a -> b -> c) -> m a -> m b -> m c</li><li><a href="#v:difference">difference</a> :: m a -> m b -> m a</li><li><a href="#v:properSubset">properSubset</a> :: m a -> m b -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:subset">subset</a> :: m a -> m b -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:submapBy">submapBy</a> :: (a -> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a>) -> m a -> m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:properSubmapBy">properSubmapBy</a> :: (a -> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a>) -> m a -> m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:sameMapBy">sameMapBy</a> :: (a -> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a>) -> m a -> m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li></ul></li><li class="src short"><span class="keyword">class</span> (<a href="Data-Edison-Assoc.html#t:OrdAssocX">OrdAssocX</a> m k, <a href="Data-Edison-Assoc.html#t:FiniteMapX">FiniteMapX</a> m k) => <a href="#t:OrdFiniteMapX">OrdFiniteMapX</a> m k | m -> k</li><li class="src short"><span class="keyword">class</span> <a href="Data-Edison-Assoc.html#t:AssocX">AssocX</a> m k => <a href="#t:Assoc">Assoc</a> m k | m -> k <span class="keyword">where</span><ul class="subs"><li><a href="#v:toSeq">toSeq</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => m a -> seq (k, a)</li><li><a href="#v:keys">keys</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => m a -> seq k</li><li><a href="#v:mapWithKey">mapWithKey</a> :: (k -> a -> b) -> m a -> m b</li><li><a href="#v:foldWithKey">foldWithKey</a> :: (k -> a -> b -> b) -> b -> m a -> b</li><li><a href="#v:foldWithKey-39-">foldWithKey'</a> :: (k -> a -> b -> b) -> b -> m a -> b</li><li><a href="#v:filterWithKey">filterWithKey</a> :: (k -> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a>) -> m a -> m a</li><li><a href="#v:partitionWithKey">partitionWithKey</a> :: (k -> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a>) -> m a -> (m a, m a)</li></ul></li><li class="src short"><span class="keyword">class</span> (<a href="Data-Edison-Assoc.html#t:Assoc">Assoc</a> m k, <a href="Data-Edison-Assoc.html#t:OrdAssocX">OrdAssocX</a> m k) => <a href="#t:OrdAssoc">OrdAssoc</a> m k | m -> k <span class="keyword">where</span><ul class="subs"><li><a href="#v:minViewWithKey">minViewWithKey</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Monad">Monad</a> rm => m a -> rm ((k, a), m a)</li><li><a href="#v:minElemWithKey">minElemWithKey</a> :: m a -> (k, a)</li><li><a href="#v:maxViewWithKey">maxViewWithKey</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Monad">Monad</a> rm => m a -> rm ((k, a), m a)</li><li><a href="#v:maxElemWithKey">maxElemWithKey</a> :: m a -> (k, a)</li><li><a href="#v:foldrWithKey">foldrWithKey</a> :: (k -> a -> b -> b) -> b -> m a -> b</li><li><a href="#v:foldrWithKey-39-">foldrWithKey'</a> :: (k -> a -> b -> b) -> b -> m a -> b</li><li><a href="#v:foldlWithKey">foldlWithKey</a> :: (b -> k -> a -> b) -> b -> m a -> b</li><li><a href="#v:foldlWithKey-39-">foldlWithKey'</a> :: (b -> k -> a -> b) -> b -> m a -> b</li><li><a href="#v:toOrdSeq">toOrdSeq</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => m a -> seq (k, a)</li></ul></li><li class="src short"><span class="keyword">class</span> (<a href="Data-Edison-Assoc.html#t:Assoc">Assoc</a> m k, <a href="Data-Edison-Assoc.html#t:FiniteMapX">FiniteMapX</a> m k) => <a href="#t:FiniteMap">FiniteMap</a> m k | m -> k <span class="keyword">where</span><ul class="subs"><li><a href="#v:unionWithKey">unionWithKey</a> :: (k -> a -> a -> a) -> m a -> m a -> m a</li><li><a href="#v:unionSeqWithKey">unionSeqWithKey</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => (k -> a -> a -> a) -> seq (m a) -> m a</li><li><a href="#v:intersectionWithKey">intersectionWithKey</a> :: (k -> a -> b -> c) -> m a -> m b -> m c</li></ul></li><li class="src short"><span class="keyword">class</span> (<a href="Data-Edison-Assoc.html#t:OrdAssoc">OrdAssoc</a> m k, <a href="Data-Edison-Assoc.html#t:FiniteMap">FiniteMap</a> m k) => <a href="#t:OrdFiniteMap">OrdFiniteMap</a> m k | m -> k</li><li class="src short"><a href="#v:submap">submap</a> :: (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> a, <a href="Data-Edison-Assoc.html#t:FiniteMapX">FiniteMapX</a> m k) => m a -> m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:properSubmap">properSubmap</a> :: (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> a, <a href="Data-Edison-Assoc.html#t:FiniteMapX">FiniteMapX</a> m k) => m a -> m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:sameMap">sameMap</a> :: (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> a, <a href="Data-Edison-Assoc.html#t:FiniteMapX">FiniteMapX</a> m k) => m a -> m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:fromList">fromList</a> :: <a href="Data-Edison-Assoc.html#t:AssocX">AssocX</a> m k => [(k, a)] -> m a</li><li class="src short"><a href="#v:insertList">insertList</a> :: <a href="Data-Edison-Assoc.html#t:AssocX">AssocX</a> m k => [(k, a)] -> m a -> m a</li><li class="src short"><a href="#v:unionList">unionList</a> :: <a href="Data-Edison-Assoc.html#t:AssocX">AssocX</a> m k => [m a] -> m a</li><li class="src short"><a href="#v:deleteList">deleteList</a> :: <a href="Data-Edison-Assoc.html#t:AssocX">AssocX</a> m k => [k] -> m a -> m a</li><li class="src short"><a href="#v:lookupList">lookupList</a> :: <a href="Data-Edison-Assoc.html#t:AssocX">AssocX</a> m k => k -> m a -> [a]</li><li class="src short"><a href="#v:elementsList">elementsList</a> :: <a href="Data-Edison-Assoc.html#t:AssocX">AssocX</a> m k => m a -> [a]</li><li class="src short"><a href="#v:unsafeFromOrdList">unsafeFromOrdList</a> :: <a href="Data-Edison-Assoc.html#t:OrdAssocX">OrdAssocX</a> m k => [(k, a)] -> m a</li><li class="src short"><a href="#v:fromListWith">fromListWith</a> :: <a href="Data-Edison-Assoc.html#t:FiniteMapX">FiniteMapX</a> m k => (a -> a -> a) -> [(k, a)] -> m a</li><li class="src short"><a href="#v:fromListWithKey">fromListWithKey</a> :: <a href="Data-Edison-Assoc.html#t:FiniteMapX">FiniteMapX</a> m k => (k -> a -> a -> a) -> [(k, a)] -> m a</li><li class="src short"><a href="#v:insertListWith">insertListWith</a> :: <a href="Data-Edison-Assoc.html#t:FiniteMapX">FiniteMapX</a> m k => (a -> a -> a) -> [(k, a)] -> m a -> m a</li><li class="src short"><a href="#v:insertListWithKey">insertListWithKey</a> :: <a href="Data-Edison-Assoc.html#t:FiniteMapX">FiniteMapX</a> m k => (k -> a -> a -> a) -> [(k, a)] -> m a -> m a</li><li class="src short"><a href="#v:unionListWith">unionListWith</a> :: <a href="Data-Edison-Assoc.html#t:FiniteMapX">FiniteMapX</a> m k => (a -> a -> a) -> [m a] -> m a</li><li class="src short"><a href="#v:toList">toList</a> :: <a href="Data-Edison-Assoc.html#t:Assoc">Assoc</a> m k => m a -> [(k, a)]</li><li class="src short"><a href="#v:keysList">keysList</a> :: <a href="Data-Edison-Assoc.html#t:Assoc">Assoc</a> m k => m a -> [k]</li><li class="src short"><a href="#v:toOrdList">toOrdList</a> :: <a href="Data-Edison-Assoc.html#t:OrdAssoc">OrdAssoc</a> m k => m a -> [(k, a)]</li><li class="src short"><a href="#v:unionListWithKey">unionListWithKey</a> :: <a href="Data-Edison-Assoc.html#t:FiniteMap">FiniteMap</a> m k => (k -> a -> a -> a) -> [m a] -> m a</li></ul></div><div id="interface"><h1 id="g:1">Superclass aliases
</h1><div class="top"><p class="src"><a name="v:map" class="def">map</a> :: <a href="Data-Edison-Assoc.html#t:AssocX">AssocX</a> m k => (a -> b) -> m a -> m b<a href="src/Data-Edison-Assoc.html#map" class="link">Source</a></p><div class="doc"><p>Apply a function to the elements of every binding in the associative
collection. Identical to <code>fmap</code> from <code>Functor</code>.
</p><p>This function is always <em>unambiguous</em>.
</p></div></div><h1 id="g:2">Non-observable associative collections
</h1><div class="top"><p class="src"><span class="keyword">class</span> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> k, <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Functor">Functor</a> m) => <a name="t:AssocX" class="def">AssocX</a> m k | m -> k <span class="keyword">where</span><a href="src/Data-Edison-Assoc.html#AssocX" class="link">Source</a></p><div class="doc"><p>The root class of the associative collection hierarchy.
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:empty" class="def">empty</a> :: m a<a href="src/Data-Edison-Assoc.html#empty" class="link">Source</a></p><div class="doc"><p>The empty associative collection.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:singleton" class="def">singleton</a> :: k -> a -> m a<a href="src/Data-Edison-Assoc.html#singleton" class="link">Source</a></p><div class="doc"><p>Create an associative collection with a single binding.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:fromSeq" class="def">fromSeq</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => seq (k, a) -> m a<a href="src/Data-Edison-Assoc.html#fromSeq" class="link">Source</a></p><div class="doc"><p>Create an associative collection from a list of bindings. Which element
and key are kept in the case of duplicate keys is unspecified.
</p><p>This function is <em>ambiguous</em> at finite map types if the sequence
contains more than one equivalent key. Otherwise it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:insert" class="def">insert</a> :: k -> a -> m a -> m a<a href="src/Data-Edison-Assoc.html#insert" class="link">Source</a></p><div class="doc"><p>Add a binding to an associative collection. For finite maps, <code><a href="Data-Edison-Assoc.html#v:insert">insert</a></code>
keeps the new element in the case of duplicate keys.
</p><p>This function is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:insertSeq" class="def">insertSeq</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => seq (k, a) -> m a -> m a<a href="src/Data-Edison-Assoc.html#insertSeq" class="link">Source</a></p><div class="doc"><p>Add a sequence of bindings to a collection. For finite maps, which key
and which element are kept in the case of duplicates is unspecified.
However, if a key appears in the sequence and in the map, (one of) the
elements in the list will be given preference.
</p><p>This function is <em>ambiguous</em> at finite map types if the sequence contains
more than one equivalent key. Otherwise it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:union" class="def">union</a> :: m a -> m a -> m a<a href="src/Data-Edison-Assoc.html#union" class="link">Source</a></p><div class="doc"><p>Merge two associative collections. For finite maps, which element
to keep in the case of duplicate keys is unspecified.
</p><p>This function is <em>ambiguous</em> at finite map types if the map keys are not
disjoint. Otherwise it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:unionSeq" class="def">unionSeq</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => seq (m a) -> m a<a href="src/Data-Edison-Assoc.html#unionSeq" class="link">Source</a></p><div class="doc"><p>Merge a sequence of associative collections. Which element
to keep in the case of duplicate keys is unspecified.
</p><p>This function is <em>ambiguous</em> at finite map types if the map keys are not
mutually disjoint. Otherwise it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:delete" class="def">delete</a> :: k -> m a -> m a<a href="src/Data-Edison-Assoc.html#delete" class="link">Source</a></p><div class="doc"><p>Delete one binding with the given key, or leave the associative collection
unchanged if it does not contain the key. For bag-like associative
collections, it is unspecified which binding will be removed.
</p><p>This function is <em>ambiguous</em> at finite relation types if the key appears more
than once in the relation. Otherwise it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:deleteAll" class="def">deleteAll</a> :: k -> m a -> m a<a href="src/Data-Edison-Assoc.html#deleteAll" class="link">Source</a></p><div class="doc"><p>Delete all bindings with the given key, or leave the associative collection
unchanged if it does not contain the key.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:deleteSeq" class="def">deleteSeq</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => seq k -> m a -> m a<a href="src/Data-Edison-Assoc.html#deleteSeq" class="link">Source</a></p><div class="doc"><p>Delete a single occurrence of each of the given keys from an associative
collection. For bag-like associative collections containing duplicate keys,
it is unspecified which bindings will be removed.
</p><p>This function is <em>ambiguous</em> at finite relation types if any key appears both
in the sequence and in the finite relation AND the number of occurrences in
the sequence is less than the number of occurrences in the finite relation.
Otherwise it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:null" class="def">null</a> :: m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Data-Edison-Assoc.html#null" class="link">Source</a></p><div class="doc"><p>Test whether the associative collection is empty.
</p><p><em>Axioms:</em>
</p><ul><li><pre>null m = (size m == 0)</pre></li></ul><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:size" class="def">size</a> :: m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a><a href="src/Data-Edison-Assoc.html#size" class="link">Source</a></p><div class="doc"><p>Return the number of bindings in the associative collection.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:member" class="def">member</a> :: k -> m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Data-Edison-Assoc.html#member" class="link">Source</a></p><div class="doc"><p>Test whether the given key is bound in the associative collection.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:count" class="def">count</a> :: k -> m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a><a href="src/Data-Edison-Assoc.html#count" class="link">Source</a></p><div class="doc"><p>Returns the number of bindings with the given key. For finite maps
this will always return 0 or 1.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:lookup" class="def">lookup</a> :: k -> m a -> a<a href="src/Data-Edison-Assoc.html#lookup" class="link">Source</a></p><div class="doc"><p>Find the element associated with the given key. Signals an error if
the given key is not bound. If more than one element is bound by the
given key, it is unspecified which is returned.
</p><p>This function is <em>ambiguous</em> at finite relation types if the key appears
more than once in the finite relation. Otherwise, it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:lookupM" class="def">lookupM</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Monad">Monad</a> rm => k -> m a -> rm a<a href="src/Data-Edison-Assoc.html#lookupM" class="link">Source</a></p><div class="doc"><p>Find the element associated with the given key. Calls <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#v:fail">fail</a></code> if the
given key is not bound. If more than one element is bound by the given
key, it is unspecified which is returned.
</p><p>This function is <em>ambiguous</em> at finite relation types if the key appears
more than once in the finite relation. Otherwise, it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:lookupAll" class="def">lookupAll</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => k -> m a -> seq a<a href="src/Data-Edison-Assoc.html#lookupAll" class="link">Source</a></p><div class="doc"><p>Return all elements bound by the given key in an unspecified order.
</p><p>This function is <em>ambiguous</em> at finite relation types if the key appears
more than once in the finite relation. Otherwise, it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:lookupAndDelete" class="def">lookupAndDelete</a> :: k -> m a -> (a, m a)<a href="src/Data-Edison-Assoc.html#lookupAndDelete" class="link">Source</a></p><div class="doc"><p>Find the element associated with the given key; return the element
and the collection with that element deleted. Signals an error if
the given key is not bound. If more than one element is bound by the
given key, it is unspecified which is deleted and returned.
</p><p>This function is <em>ambiguous</em> at finite relation types if the key appears
more than once in the finite relation. Otherwise, it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:lookupAndDeleteM" class="def">lookupAndDeleteM</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Monad">Monad</a> rm => k -> m a -> rm (a, m a)<a href="src/Data-Edison-Assoc.html#lookupAndDeleteM" class="link">Source</a></p><div class="doc"><p>Find the element associated with the given key; return the element
and the collection with that element deleted. Calls <code>fail</code> if
the given key is not bound. If more than one element is bound by the
given key, it is unspecified which is deleted and returned.
</p><p>This function is <em>ambiguous</em> at finite relation types if the key appears
more than once in the finite relation. Otherwise, it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:lookupAndDeleteAll" class="def">lookupAndDeleteAll</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => k -> m a -> (seq a, m a)<a href="src/Data-Edison-Assoc.html#lookupAndDeleteAll" class="link">Source</a></p><div class="doc"><p>Find all elements bound by the given key; return a sequence containing
all such bound elements in an unspecified order and the collection
with all such elements deleted.
</p><p>This function is <em>ambiguous</em> at finite relation types if the key appears
more than once in the finite relation. Otherwise, it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:lookupWithDefault" class="def">lookupWithDefault</a><a href="src/Data-Edison-Assoc.html#lookupWithDefault" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: a</td><td class="doc"><p>default element
</p></td></tr><tr><td class="src">-> k</td><td class="doc"><p>the key to look up
</p></td></tr><tr><td class="src">-> m a</td><td class="doc"><p>the associative collection
</p></td></tr><tr><td class="src">-> a</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Return the element associated with the given key. If no such element
is found, return the default.
</p><p>This function is <em>ambiguous</em> at finite relation types if the key appears
more than once in the finite relation. Otherwise, it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:adjust" class="def">adjust</a> :: (a -> a) -> k -> m a -> m a<a href="src/Data-Edison-Assoc.html#adjust" class="link">Source</a></p><div class="doc"><p>Change a single binding for the given key by applying a function to its
element. If the key binds more than one element, it is unspecified which
will be modified. If the key is not found in the collection, it is returned
unchanged.
</p><p>This function is <em>ambiguous</em> at finite relation types if the key appears
more than once in the finite relation. Otherwise, it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:adjustAll" class="def">adjustAll</a> :: (a -> a) -> k -> m a -> m a<a href="src/Data-Edison-Assoc.html#adjustAll" class="link">Source</a></p><div class="doc"><p>Change all bindings for the given key by applying a function to its
elements. If the key is not found in the collection, it is returned
unchanged.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:adjustOrInsert" class="def">adjustOrInsert</a> :: (a -> a) -> a -> k -> m a -> m a<a href="src/Data-Edison-Assoc.html#adjustOrInsert" class="link">Source</a></p><div class="doc"><p>Searches for a matching key in the collection. If the key is found,
the given function is called to adjust the value. If the key is not
found, a new binding is inserted with the given element. If the given
key is bound more than once in the collection, it is unspecified
which element is adjusted.
</p><p>This function is <em>ambiguous</em> at finite relation types if the key appears
more than once in the finite relation. Otherwise, it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:adjustAllOrInsert" class="def">adjustAllOrInsert</a> :: (a -> a) -> a -> k -> m a -> m a<a href="src/Data-Edison-Assoc.html#adjustAllOrInsert" class="link">Source</a></p><div class="doc"><p>Searches for all matching keys in the collection. If the key is found,
the given function is applied to all its elements to adjust their values.
If the key is not found, a new binding is inserted with the given element.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:adjustOrDelete" class="def">adjustOrDelete</a> :: (a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a) -> k -> m a -> m a<a href="src/Data-Edison-Assoc.html#adjustOrDelete" class="link">Source</a></p><div class="doc"><p>Change or delete a single binding for the given key by applying a function
to its element. If the function returns <code>Nothing</code>, then the binding
will be deleted. If the key binds more than one element, it is unspecified which
will be modified. If the key is not found in the collection, it is returned
unchanged.
</p><p>This function is <em>ambiguous</em> at finite relation types if the key appears
more than once in the finite relation. Otherwise, it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:adjustOrDeleteAll" class="def">adjustOrDeleteAll</a> :: (a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a) -> k -> m a -> m a<a href="src/Data-Edison-Assoc.html#adjustOrDeleteAll" class="link">Source</a></p><div class="doc"><p>Change or delete all bindings for the given key by applying a function to
its elements. For any element where the function returns <code>Nothing</code>, the
corresponding binding is deleted. If the key is not found in the collection,
it is returned unchanged.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:fold" class="def">fold</a> :: (a -> b -> b) -> b -> m a -> b<a href="src/Data-Edison-Assoc.html#fold" class="link">Source</a></p><div class="doc"><p>Combine all the elements in the associative collection, given a combining
function and an initial value. The elements are processed in an
unspecified order. <em>Note</em> that <code><a href="Data-Edison-Assoc.html#v:fold">fold</a></code> ignores the keys.
</p><p><code>fold f</code> is <em>unambiguous</em> iff <code>f</code> is fold-commutative.
</p></div><p class="src"><a name="v:fold-39-" class="def">fold'</a> :: (a -> b -> b) -> b -> m a -> b<a href="src/Data-Edison-Assoc.html#fold%27" class="link">Source</a></p><div class="doc"><p>A strict variant of <code><a href="Data-Edison-Assoc.html#v:fold">fold</a></code>.
</p><p><code>fold' f</code> is <em>unambiguous</em> iff <code>f</code> is fold-commutative.
</p></div><p class="src"><a name="v:fold1" class="def">fold1</a> :: (a -> a -> a) -> m a -> a<a href="src/Data-Edison-Assoc.html#fold1" class="link">Source</a></p><div class="doc"><p>Combine all the elements in a non-empty associative collection using the
given combining function. Signals an error if the associative collection
is empty. The elements are processed in an unspecified order. An
implementation may choose to process the elements linearly or in a
balanced fashion (like <code>reduce1</code> on sequences). <em>Note</em> that <code><a href="Data-Edison-Assoc.html#v:fold1">fold1</a></code>
ignores the keys.
</p><p><code>fold1 f</code> is <em>unambiguous</em> iff <code>f</code> is fold-commutative.
</p></div><p class="src"><a name="v:fold1-39-" class="def">fold1'</a> :: (a -> a -> a) -> m a -> a<a href="src/Data-Edison-Assoc.html#fold1%27" class="link">Source</a></p><div class="doc"><p>A strict variant of <code><a href="Data-Edison-Assoc.html#v:fold1">fold1</a></code>.
</p><p><code>fold1' f</code> is <em>unambiguous</em> iff <code>f</code> is fold-commutative.
</p></div><p class="src"><a name="v:filter" class="def">filter</a> :: (a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a>) -> m a -> m a<a href="src/Data-Edison-Assoc.html#filter" class="link">Source</a></p><div class="doc"><p>Extract all bindings whose elements satisfy the given predicate.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:partition" class="def">partition</a> :: (a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a>) -> m a -> (m a, m a)<a href="src/Data-Edison-Assoc.html#partition" class="link">Source</a></p><div class="doc"><p>Split an associative collection into those bindings which satisfy the
given predicate, and those which do not.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:elements" class="def">elements</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => m a -> seq a<a href="src/Data-Edison-Assoc.html#elements" class="link">Source</a></p><div class="doc"><p>Returns all the elements in an associative collection, in an unspecified
order.
</p><p>This function is <em>ambiguous</em> iff the associative collection contains
more than one element.
</p></div><p class="src"><a name="v:strict" class="def">strict</a> :: m a -> m a<a href="src/Data-Edison-Assoc.html#strict" class="link">Source</a></p><div class="doc"><p>Semanticly, this function is a partial identity function. If the
datastructure is infinite in size or contains exceptions or non-termination
in the structure itself, then <code>strict</code> will result in bottom. Operationally,
this function walks the datastructure forcing any closures. Elements contained
in the map are <em>not</em> forced.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:strictWith" class="def">strictWith</a> :: (a -> b) -> m a -> m a<a href="src/Data-Edison-Assoc.html#strictWith" class="link">Source</a></p><div class="doc"><p>Similar to <code><a href="Data-Edison-Assoc.html#v:strict">strict</a></code>, this function walks the datastructure forcing closures.
However, <code>strictWith</code> will additionally apply the given function to the
map elements, force the result using <code>seq</code>, and then ignore it.
This function can be used to perform various levels of forcing on the
sequence elements. In particular:
</p><pre> strictWith id xs
</pre><p>will force the spine of the datastructure and reduce each element to WHNF.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:structuralInvariant" class="def">structuralInvariant</a> :: m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Data-Edison-Assoc.html#structuralInvariant" class="link">Source</a></p><div class="doc"><p>A method to facilitate unit testing. Returns <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#v:True">True</a></code> if the structural
invariants of the implementation hold for the given associative
collection. If this function returns <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#v:False">False</a></code>, it represents a bug;
generally, either the implementation itself is flawed, or an unsafe
operation has been used while violating the preconditions.
</p></div><p class="src"><a name="v:instanceName" class="def">instanceName</a> :: m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a><a href="src/Data-Edison-Assoc.html#instanceName" class="link">Source</a></p><div class="doc"><p>Returns the name of the module implementing this associative collection.
</p></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> (<a href="Data-Edison-Assoc.html#t:AssocX">AssocX</a> m k, <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Ord.html#t:Ord">Ord</a> k) => <a name="t:OrdAssocX" class="def">OrdAssocX</a> m k | m -> k <span class="keyword">where</span><a href="src/Data-Edison-Assoc.html#OrdAssocX" class="link">Source</a></p><div class="doc"><p>An associative collection where the keys additionally have an ordering
relation.
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:minView" class="def">minView</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Monad">Monad</a> rm => m a -> rm (a, m a)<a href="src/Data-Edison-Assoc.html#minView" class="link">Source</a></p><div class="doc"><p>Remove the binding with the minimum key, and return its element together
with the remaining associative collection. Calls <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#v:fail">fail</a></code> if the
associative collection is empty. Which binding is removed if there
is more than one minimum is unspecified.
</p><p>This function is <em>ambiguous</em> at finite relation types if the finite relation
contains more than one minimum key. Otherwise it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:minElem" class="def">minElem</a> :: m a -> a<a href="src/Data-Edison-Assoc.html#minElem" class="link">Source</a></p><div class="doc"><p>Find the binding with the minimum key and return its element. Signals
an error if the associative collection is empty. Which element is chosen
if there is more than one minimum is unspecified.
</p><p>This function is <em>ambiguous</em> at finite relation types if the finite relation
contains more than one minimum key. Otherwise it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:deleteMin" class="def">deleteMin</a> :: m a -> m a<a href="src/Data-Edison-Assoc.html#deleteMin" class="link">Source</a></p><div class="doc"><p>Remove the binding with the minimum key and return the remaining
associative collection, or return empty if it is already empty.
</p><p>This function is <em>ambiguous</em> at finite relation types if the finite relation
contains more than one minimum key. Otherwise it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:unsafeInsertMin" class="def">unsafeInsertMin</a> :: k -> a -> m a -> m a<a href="src/Data-Edison-Assoc.html#unsafeInsertMin" class="link">Source</a></p><div class="doc"><p>Insert a binding into an associative collection with the precondition
that the given key is <code><=</code> any existing keys already in the collection.
For finite maps, this precondition is strengthened to <code><</code>.
</p><p>This function is <em>unambiguous</em> under the preconditions.
</p></div><p class="src"><a name="v:maxView" class="def">maxView</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Monad">Monad</a> rm => m a -> rm (a, m a)<a href="src/Data-Edison-Assoc.html#maxView" class="link">Source</a></p><div class="doc"><p>Remove the binding with the maximum key, and return its element together
with the remaining associative collection. Calls <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#v:fail">fail</a></code> if the
associative collection is empty. Which binding is removed if there
is more than one maximum is unspecified.
</p><p>This function is <em>ambiguous</em> at finite relation types if the finite relation
contains more than one minimum key. Otherwise it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:maxElem" class="def">maxElem</a> :: m a -> a<a href="src/Data-Edison-Assoc.html#maxElem" class="link">Source</a></p><div class="doc"><p>Find the binding with the maximum key and return its element. Signals
an error if the associative collection is empty. Which element is chosen
if there is more than one maximum is unspecified.
</p><p>This function is <em>ambiguous</em> at finite relation types if the finite relation
contains more than one minimum key. Otherwise it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:deleteMax" class="def">deleteMax</a> :: m a -> m a<a href="src/Data-Edison-Assoc.html#deleteMax" class="link">Source</a></p><div class="doc"><p>Remove the binding with the maximum key and return the remaining
associative collection, or return empty if it is already empty.
</p><p>This function is <em>ambiguous</em> at finite relation types if the finite relation
contains more than one minimum key. Otherwise it is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:unsafeInsertMax" class="def">unsafeInsertMax</a> :: k -> a -> m a -> m a<a href="src/Data-Edison-Assoc.html#unsafeInsertMax" class="link">Source</a></p><div class="doc"><p>Insert a binding into an associative collection with the precondition
that the given key is <code>>=</code> any existing keys already in the collection.
For finite maps, this precondition is strengthened to <code>></code>.
</p><p>This function is <em>unambiguous</em> under the precondition.
</p></div><p class="src"><a name="v:foldr" class="def">foldr</a> :: (a -> b -> b) -> b -> m a -> b<a href="src/Data-Edison-Assoc.html#foldr" class="link">Source</a></p><div class="doc"><p>Fold across the elements of an associative collection in non-decreasing
order by key with right associativity. For finite maps, the order
is increasing.
</p><p><code>foldr f</code> is <em>unambiguous</em> if <code>f</code> is fold-commutative, at finite
map types, or at finite relation types if the relation contains no
duplicate keys. Otherwise it is <em>ambiguous</em>.
</p></div><p class="src"><a name="v:foldr-39-" class="def">foldr'</a> :: (a -> b -> b) -> b -> m a -> b<a href="src/Data-Edison-Assoc.html#foldr%27" class="link">Source</a></p><div class="doc"><p>A strict variant of <code><a href="Data-Edison-Assoc.html#v:foldr">foldr</a></code>.
</p><p><code>foldr' f</code> is <em>unambiguous</em> if <code>f</code> is fold-commutative, at finite
map types, or at finite relation types if the relation contains no
duplicate keys. Otherwise it is <em>ambiguous</em>.
</p></div><p class="src"><a name="v:foldl" class="def">foldl</a> :: (b -> a -> b) -> b -> m a -> b<a href="src/Data-Edison-Assoc.html#foldl" class="link">Source</a></p><div class="doc"><p>Fold across the elements of an associative collection in non-decreasing
order by key with left associativity. For finite maps, the order
is increasing.
</p><p><code>foldl f</code> is <em>unambiguous</em> if <code>f</code> is fold-commutative, at finite
map types, or at finite relation types if the relation contains no
duplicate keys. Otherwise it is <em>ambiguous</em>.
</p></div><p class="src"><a name="v:foldl-39-" class="def">foldl'</a> :: (b -> a -> b) -> b -> m a -> b<a href="src/Data-Edison-Assoc.html#foldl%27" class="link">Source</a></p><div class="doc"><p>A strict variant of <code><a href="Data-Edison-Assoc.html#v:foldl">foldl</a></code>.
</p><p><code>foldl' f</code> is <em>unambiguous</em> if <code>f</code> is fold-commutative, at finite
map types, or at finite relation types if the relation contains no
duplicate keys. Otherwise it is <em>ambiguous</em>.
</p></div><p class="src"><a name="v:foldr1" class="def">foldr1</a> :: (a -> a -> a) -> m a -> a<a href="src/Data-Edison-Assoc.html#foldr1" class="link">Source</a></p><div class="doc"><p>Fold across the elements of an associative collection in non-decreasing
order by key with right associativity. Signals an error if the
associative collection is empty. For finite maps, the order is
increasing.
</p><p><code>foldr1 f</code> is <em>unambiguous</em> if <code>f</code> is fold-commutative, at finite
map types, or at finite relation types if the relation contains no
duplicate keys. Otherwise it is <em>ambiguous</em>.
</p></div><p class="src"><a name="v:foldr1-39-" class="def">foldr1'</a> :: (a -> a -> a) -> m a -> a<a href="src/Data-Edison-Assoc.html#foldr1%27" class="link">Source</a></p><div class="doc"><p>A strict variant of <code><a href="Data-Edison-Assoc.html#v:foldr1">foldr1</a></code>.
</p><p><code>foldr1' f</code> is <em>unambiguous</em> if <code>f</code> is fold-commutative, at finite
map types, or at finite relation types if the relation contains no
duplicate keys. Otherwise it is <em>ambiguous</em>.
</p></div><p class="src"><a name="v:foldl1" class="def">foldl1</a> :: (a -> a -> a) -> m a -> a<a href="src/Data-Edison-Assoc.html#foldl1" class="link">Source</a></p><div class="doc"><p>Fold across the elements of an associative collection in non-decreasing
order by key with left associativity. Signals an error if the
associative collection is empty. For finite maps, the order is
increasing.
</p><p><code>foldl1 f</code> is <em>unambiguous</em> if <code>f</code> is fold-commutative, at finite
map types, or at finite relation types if the relation contains no
duplicate keys. Otherwise it is <em>ambiguous</em>.
</p></div><p class="src"><a name="v:foldl1-39-" class="def">foldl1'</a> :: (a -> a -> a) -> m a -> a<a href="src/Data-Edison-Assoc.html#foldl1%27" class="link">Source</a></p><div class="doc"><p>A strict variant of <code><a href="Data-Edison-Assoc.html#v:foldl1">foldl1</a></code>.
</p><p><code>foldl1' f</code> is <em>unambiguous</em> if <code>f</code> is fold-commutative, at finite
map types, or at finite relation types if the relation contains no
duplicate keys. Otherwise it is <em>ambiguous</em>.
</p></div><p class="src"><a name="v:unsafeFromOrdSeq" class="def">unsafeFromOrdSeq</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => seq (k, a) -> m a<a href="src/Data-Edison-Assoc.html#unsafeFromOrdSeq" class="link">Source</a></p><div class="doc"><p>Convert a sequence of bindings into an associative collection with the
precondition that the sequence is sorted into non-decreasing order by
key. For finite maps, this precondition is strengthened to increasing
order.
</p><p>This function is <em>unambiguous</em> under the precondition.
</p></div><p class="src"><a name="v:unsafeAppend" class="def">unsafeAppend</a> :: m a -> m a -> m a<a href="src/Data-Edison-Assoc.html#unsafeAppend" class="link">Source</a></p><div class="doc"><p>Merge two associative collections with the precondition that every key
in the first associative collection is <code><=</code> every key in the second
associative collection. For finite maps, this precondition is
strengthened to <code><</code>.
</p><p>This function is <em>unambiguous</em> under the precondition.
</p></div><p class="src"><a name="v:filterLT" class="def">filterLT</a> :: k -> m a -> m a<a href="src/Data-Edison-Assoc.html#filterLT" class="link">Source</a></p><div class="doc"><p>Extract all bindings whose keys are <code><</code> the given key.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:filterLE" class="def">filterLE</a> :: k -> m a -> m a<a href="src/Data-Edison-Assoc.html#filterLE" class="link">Source</a></p><div class="doc"><p>Extract all bindings whose keys are <code><=</code> the given key.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:filterGT" class="def">filterGT</a> :: k -> m a -> m a<a href="src/Data-Edison-Assoc.html#filterGT" class="link">Source</a></p><div class="doc"><p>Extract all bindings whose keys are <code>></code> the given key.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:filterGE" class="def">filterGE</a> :: k -> m a -> m a<a href="src/Data-Edison-Assoc.html#filterGE" class="link">Source</a></p><div class="doc"><p>Extract all bindings whose keys are <code>>=</code> the given key.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:partitionLT_GE" class="def">partitionLT_GE</a> :: k -> m a -> (m a, m a)<a href="src/Data-Edison-Assoc.html#partitionLT_GE" class="link">Source</a></p><div class="doc"><p>Split an associative collection into two sub-collections, containing
those bindings whose keys are <code><</code> the given key and those which are <code>>=</code>.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:partitionLE_GT" class="def">partitionLE_GT</a> :: k -> m a -> (m a, m a)<a href="src/Data-Edison-Assoc.html#partitionLE_GT" class="link">Source</a></p><div class="doc"><p>Split an associative collection into two sub-collections, containing
those bindings whose keys are <code><=</code> the given key and those which are <code>></code>.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:partitionLT_GT" class="def">partitionLT_GT</a> :: k -> m a -> (m a, m a)<a href="src/Data-Edison-Assoc.html#partitionLT_GT" class="link">Source</a></p><div class="doc"><p>Split an associative collection into two sub-collections, containing
those bindings whose keys are <code><</code> the given key and those which are <code>></code>.
All bindings with keys equal to the given key are discarded.
</p><p>This function is always <em>unambiguous</em>.
</p></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a href="Data-Edison-Assoc.html#t:AssocX">AssocX</a> m k => <a name="t:FiniteMapX" class="def">FiniteMapX</a> m k | m -> k <span class="keyword">where</span><a href="src/Data-Edison-Assoc.html#FiniteMapX" class="link">Source</a></p><div class="doc"><p>An associative collection where the keys form a set; that is, each key
appears in the associative collection at most once.
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:fromSeqWith" class="def">fromSeqWith</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => (a -> a -> a) -> seq (k, a) -> m a<a href="src/Data-Edison-Assoc.html#fromSeqWith" class="link">Source</a></p><div class="doc"><p>Same as <code><a href="Data-Edison-Assoc.html#v:fromSeq">fromSeq</a></code>, but with a combining function to resolve duplicates.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:fromSeqWithKey" class="def">fromSeqWithKey</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => (k -> a -> a -> a) -> seq (k, a) -> m a<a href="src/Data-Edison-Assoc.html#fromSeqWithKey" class="link">Source</a></p><div class="doc"><p>Same as <code><a href="Data-Edison-Assoc.html#v:fromSeq">fromSeq</a></code>, but with a combining function to resolve duplicates;
the combining function takes the key in addition to the two elements.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:insertWith" class="def">insertWith</a> :: (a -> a -> a) -> k -> a -> m a -> m a<a href="src/Data-Edison-Assoc.html#insertWith" class="link">Source</a></p><div class="doc"><p>Same as <code><a href="Data-Edison-Assoc.html#v:insert">insert</a></code>, but with a combining function to resolve duplicates.
</p><p>This function is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:insertWithKey" class="def">insertWithKey</a> :: (k -> a -> a -> a) -> k -> a -> m a -> m a<a href="src/Data-Edison-Assoc.html#insertWithKey" class="link">Source</a></p><div class="doc"><p>Same as <code><a href="Data-Edison-Assoc.html#v:insert">insert</a></code>, but with a combining function to resolve duplicates;
the combining function takes the key in addition to the two elements.
The key passed to the combining function is always the same as the
given key.
</p><p>This function is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:insertSeqWith" class="def">insertSeqWith</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => (a -> a -> a) -> seq (k, a) -> m a -> m a<a href="src/Data-Edison-Assoc.html#insertSeqWith" class="link">Source</a></p><div class="doc"><p>Same as <code><a href="Data-Edison-Assoc.html#v:insertSeq">insertSeq</a></code>, but with a combining function to resolve duplicates.
</p><p>This function is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:insertSeqWithKey" class="def">insertSeqWithKey</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => (k -> a -> a -> a) -> seq (k, a) -> m a -> m a<a href="src/Data-Edison-Assoc.html#insertSeqWithKey" class="link">Source</a></p><div class="doc"><p>Same as <code><a href="Data-Edison-Assoc.html#v:insertSeq">insertSeq</a></code>, but with a combining function to resolve duplicates;
the combining function takes the key in addition to the two elements.
</p><p>This function is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:unionl" class="def">unionl</a> :: m a -> m a -> m a<a href="src/Data-Edison-Assoc.html#unionl" class="link">Source</a></p><div class="doc"><p>Left biased union.
</p><p><em>Axioms:</em>
</p><ul><li><pre>unionl = unionwith (\x y -> x)</pre></li></ul><p>This function is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:unionr" class="def">unionr</a> :: m a -> m a -> m a<a href="src/Data-Edison-Assoc.html#unionr" class="link">Source</a></p><div class="doc"><p>Right biased union.
</p><p><em>Axioms:</em>
</p><ul><li><pre>unionr = unionWith (\x y -> y)</pre></li></ul><p>This function is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:unionWith" class="def">unionWith</a> :: (a -> a -> a) -> m a -> m a -> m a<a href="src/Data-Edison-Assoc.html#unionWith" class="link">Source</a></p><div class="doc"><p>Same as <code><a href="Data-Edison-Assoc.html#v:union">union</a></code>, but with a combining function to resolve duplicates.
</p><p>This function is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:unionSeqWith" class="def">unionSeqWith</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => (a -> a -> a) -> seq (m a) -> m a<a href="src/Data-Edison-Assoc.html#unionSeqWith" class="link">Source</a></p><div class="doc"><p>Same as <code><a href="Data-Edison-Assoc.html#v:unionSeq">unionSeq</a></code>, but with a combining function to resolve duplicates.
</p><p>This function is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:intersectionWith" class="def">intersectionWith</a> :: (a -> b -> c) -> m a -> m b -> m c<a href="src/Data-Edison-Assoc.html#intersectionWith" class="link">Source</a></p><div class="doc"><p>Compute the intersection of two finite maps. The resulting finite map
will contain bindings where the keys are the set intersection of the
keys in the argument finite maps. The combining function computes
the value of the element given the bound elements from the argument
finite maps.
</p><p>This function is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:difference" class="def">difference</a> :: m a -> m b -> m a<a href="src/Data-Edison-Assoc.html#difference" class="link">Source</a></p><div class="doc"><p>Computes the difference of two finite maps; that is, all bindings
in the first finite map whose keys to not appear in the second.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:properSubset" class="def">properSubset</a> :: m a -> m b -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Data-Edison-Assoc.html#properSubset" class="link">Source</a></p><div class="doc"><p>Test whether the set of keys in the first finite map is a proper subset
of the set of keys of the second; that is, every key present in
the first finite map is also a member of the second finite map AND
there exists some key in the second finite map which is not present
in the first.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:subset" class="def">subset</a> :: m a -> m b -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Data-Edison-Assoc.html#subset" class="link">Source</a></p><div class="doc"><p>Test whether the set of keys in the first finite map is a subset of
the set of keys of the second; that is, if every key present in the first
finite map is also present in the second.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:submapBy" class="def">submapBy</a> :: (a -> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a>) -> m a -> m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Data-Edison-Assoc.html#submapBy" class="link">Source</a></p><div class="doc"><p>Test whether the first map is a submap of the second map given a comparison
function on elements; that is, if every key present in the first map is also
present in the second map and the comparison function returns true when applied
two the bound elements.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:properSubmapBy" class="def">properSubmapBy</a> :: (a -> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a>) -> m a -> m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Data-Edison-Assoc.html#properSubmapBy" class="link">Source</a></p><div class="doc"><p>Test whether the first map is a proper submap of the second map given a comparison
function on elements; that is, if every key present in the first map is also
present in the second map and the comparison function returns true when applied
two the bound elements AND there exiss some key in the second finite map which
is not present in the first.
</p><p>This function is always <em>unambiguous</em>.
</p></div><p class="src"><a name="v:sameMapBy" class="def">sameMapBy</a> :: (a -> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a>) -> m a -> m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Data-Edison-Assoc.html#sameMapBy" class="link">Source</a></p><div class="doc"><p>Test whether the first map is the "same" map as the second map given a comparison
function on elements; that is, if the first and second maps have the same set of keys
and the comparison function returns true when applied to corresponding elements.
</p><p>This function is always <em>unambiguous</em>.
</p></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> (<a href="Data-Edison-Assoc.html#t:OrdAssocX">OrdAssocX</a> m k, <a href="Data-Edison-Assoc.html#t:FiniteMapX">FiniteMapX</a> m k) => <a name="t:OrdFiniteMapX" class="def">OrdFiniteMapX</a> m k | m -> k<a href="src/Data-Edison-Assoc.html#OrdFiniteMapX" class="link">Source</a></p><div class="doc"><p>Finite maps where the keys additionally have an ordering relation.
This class introduces no new methods.
</p></div></div><h1 id="g:3">Observable associative collections
</h1><div class="top"><p class="src"><span class="keyword">class</span> <a href="Data-Edison-Assoc.html#t:AssocX">AssocX</a> m k => <a name="t:Assoc" class="def">Assoc</a> m k | m -> k <span class="keyword">where</span><a href="src/Data-Edison-Assoc.html#Assoc" class="link">Source</a></p><div class="doc"><p>Associative collections where the keys are observable.
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:toSeq" class="def">toSeq</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => m a -> seq (k, a)<a href="src/Data-Edison-Assoc.html#toSeq" class="link">Source</a></p><div class="doc"><p>Extract the bindings of an associative collection into a
sequence. The bindings are emitted in an unspecified order.
</p><p>This function is <em>ambiguous</em> with respect to the sequence order
iff the associative collection contains more than one binding.
Furthermore, it is <em>ambiguous</em> with respect to the actual key
returned, unless the <code>Eq</code> instance on keys corresponds to
indistinguisability.
</p></div><p class="src"><a name="v:keys" class="def">keys</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => m a -> seq k<a href="src/Data-Edison-Assoc.html#keys" class="link">Source</a></p><div class="doc"><p>Extract the keys of an associative collection into a sequence.
The keys are emitted in an unspecified order. For finite relations,
keys which appear multiple times in the relation will appear as many
times in the extracted sequence.
</p><p>This function is <em>ambiguous</em> with respect to the sequence order
iff the associative collection contains more than one binding.
Furthermore, it is <em>ambiguous</em> with respect to the actual key
returned, unless the <code>Eq</code> instance on keys corresponds to
indistinguisability.
</p></div><p class="src"><a name="v:mapWithKey" class="def">mapWithKey</a> :: (k -> a -> b) -> m a -> m b<a href="src/Data-Edison-Assoc.html#mapWithKey" class="link">Source</a></p><div class="doc"><p>Apply a function to every element in an associative collection. The
mapped function additionally takes the value of the key.
</p><p>This function is <em>ambiguous</em> with respect to the actual keys
observed, unless the <code>Eq</code> instance on keys corresponds to
indistinguisability.
</p></div><p class="src"><a name="v:foldWithKey" class="def">foldWithKey</a> :: (k -> a -> b -> b) -> b -> m a -> b<a href="src/Data-Edison-Assoc.html#foldWithKey" class="link">Source</a></p><div class="doc"><p>Combine all the elements in the associative collection, given a combining
function and an initial value. The elements are processed in an
unspecified order. The combining function additionally takes the
value of the key.
</p><p><code>foldWithKey f</code> is <em>unambiguous</em> iff <code>f</code> is fold-commutative and
the <code>Eq</code> instance on keys corresponds to indistinguisability.
</p></div><p class="src"><a name="v:foldWithKey-39-" class="def">foldWithKey'</a> :: (k -> a -> b -> b) -> b -> m a -> b<a href="src/Data-Edison-Assoc.html#foldWithKey%27" class="link">Source</a></p><div class="doc"><p>A strict variant of <code><a href="Data-Edison-Assoc.html#v:foldWithKey">foldWithKey</a></code>.
</p><p><code>foldWithKey' f</code> is <em>unambiguous</em> iff <code>f</code> is fold-commutative and
the <code>Eq</code> instance on keys corresponds to indistinguisability.
</p></div><p class="src"><a name="v:filterWithKey" class="def">filterWithKey</a> :: (k -> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a>) -> m a -> m a<a href="src/Data-Edison-Assoc.html#filterWithKey" class="link">Source</a></p><div class="doc"><p>Extract all bindings from an associative collection which satisfy the
given predicate.
</p><p>This function is <em>ambiguous</em> with respect to the actual keys
observed, unless the <code>Eq</code> instance on keys corresponds to
indistinguisability.
</p></div><p class="src"><a name="v:partitionWithKey" class="def">partitionWithKey</a> :: (k -> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a>) -> m a -> (m a, m a)<a href="src/Data-Edison-Assoc.html#partitionWithKey" class="link">Source</a></p><div class="doc"><p>Split an associative collection into two sub-collections containing those
bindings which satisfy the given predicate and those which do not.
</p><p>This function is <em>ambiguous</em> with respect to the actual keys
observed, unless the <code>Eq</code> instance on keys corresponds to
indistinguisability.
</p></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> (<a href="Data-Edison-Assoc.html#t:Assoc">Assoc</a> m k, <a href="Data-Edison-Assoc.html#t:OrdAssocX">OrdAssocX</a> m k) => <a name="t:OrdAssoc" class="def">OrdAssoc</a> m k | m -> k <span class="keyword">where</span><a href="src/Data-Edison-Assoc.html#OrdAssoc" class="link">Source</a></p><div class="doc"><p>An associative collection with observable keys where the keys additionally
have an ordering relation.
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:minViewWithKey" class="def">minViewWithKey</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Monad">Monad</a> rm => m a -> rm ((k, a), m a)<a href="src/Data-Edison-Assoc.html#minViewWithKey" class="link">Source</a></p><div class="doc"><p>Delete the binding with the minimum key from an associative
collection and return the key, the element and the remaining
associative collection. Calls <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#v:fail">fail</a></code> if the associative collection
is empty. Which binding is chosen if there are multiple minimum keys
is unspecified.
</p><p>This function is <em>ambiguous</em> at finite relation types if more than one
minimum key exists in the relation. Furthermore, it is <em>ambiguous</em>
with respect to the actual key observed unless the <code>Eq</code> instance on
keys corresponds to indistinguisability.
</p></div><p class="src"><a name="v:minElemWithKey" class="def">minElemWithKey</a> :: m a -> (k, a)<a href="src/Data-Edison-Assoc.html#minElemWithKey" class="link">Source</a></p><div class="doc"><p>Find the binding with the minimum key in an associative collection and
return the key and the element. Signals an error if the associative
collection is empty. Which binding is chosen if there are multiple
minimum keys is unspecified.
</p><p>This function is <em>ambiguous</em> at finite relation types if more than one
minimum key exists in the relation. Furthermore, it is <em>ambiguous</em>
with respect to the actual key observed unless the <code>Eq</code> instance on
keys corresponds to indistinguisability.
</p></div><p class="src"><a name="v:maxViewWithKey" class="def">maxViewWithKey</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Monad">Monad</a> rm => m a -> rm ((k, a), m a)<a href="src/Data-Edison-Assoc.html#maxViewWithKey" class="link">Source</a></p><div class="doc"><p>Delete the binding with the maximum key from an associative
collection and return the key, the element and the remaining
associative collection. Calls <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#v:fail">fail</a></code> if the associative collection
is empty. Which binding is chosen if there are multiple maximum keys
is unspecified.
</p><p>This function is <em>ambiguous</em> at finite relation types if more than one
maximum key exists in the relation. Furthermore, it is <em>ambiguous</em>
with respect to the actual key observed unless the <code>Eq</code> instance on
keys corresponds to indistinguisability.
</p></div><p class="src"><a name="v:maxElemWithKey" class="def">maxElemWithKey</a> :: m a -> (k, a)<a href="src/Data-Edison-Assoc.html#maxElemWithKey" class="link">Source</a></p><div class="doc"><p>Find the binding with the maximum key in an associative collection and
return the key and the element. Signals an error if the associative
collection is empty. Which binding is chosen if there are multiple
maximum keys is unspecified.
</p><p>This function is <em>ambiguous</em> at finite relation types if more than one
maximum key exists in the relation. Furthermore, it is <em>ambiguous</em>
with respect to the actual key observed unless the <code>Eq</code> instance on
keys corresponds to indistinguisability.
</p></div><p class="src"><a name="v:foldrWithKey" class="def">foldrWithKey</a> :: (k -> a -> b -> b) -> b -> m a -> b<a href="src/Data-Edison-Assoc.html#foldrWithKey" class="link">Source</a></p><div class="doc"><p>Fold over all bindings in an associative collection in non-decreasing
order by key with right associativity, given a combining function
and an initial value. For finite maps, the order is increasing.
</p><p><code>foldrWithKey f</code> is <em>ambiguous</em> at finite relation types if
the relation contains more than one equivalent key and
<code>f</code> is not fold-commutative OR if the <code>Eq</code> instance on keys
does not correspond to indistingusihability.
</p></div><p class="src"><a name="v:foldrWithKey-39-" class="def">foldrWithKey'</a> :: (k -> a -> b -> b) -> b -> m a -> b<a href="src/Data-Edison-Assoc.html#foldrWithKey%27" class="link">Source</a></p><div class="doc"><p>A strict variant of <code><a href="Data-Edison-Assoc.html#v:foldrWithKey">foldrWithKey</a></code>.
</p><p><code>foldrWithKey' f</code> is <em>ambiguous</em> at finite relation types if
the relation contains more than one equivalent key and
<code>f</code> is not fold-commutative OR if the <code>Eq</code> instance on keys
does not correspond to indistingusihability. Otherwise it
is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:foldlWithKey" class="def">foldlWithKey</a> :: (b -> k -> a -> b) -> b -> m a -> b<a href="src/Data-Edison-Assoc.html#foldlWithKey" class="link">Source</a></p><div class="doc"><p>Fold over all bindings in an associative collection in non-decreasing
order by key with left associativity, given a combining function
and an initial value. For finite maps, the order is increasing.
</p><p><code>foldlWithKey f</code> is <em>ambiguous</em> at finite relation types if
the relation contains more than one equivalent key and
<code>f</code> is not fold-commutative OR if the <code>Eq</code> instance on keys
does not correspond to indistingusihability. Otherwise it
is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:foldlWithKey-39-" class="def">foldlWithKey'</a> :: (b -> k -> a -> b) -> b -> m a -> b<a href="src/Data-Edison-Assoc.html#foldlWithKey%27" class="link">Source</a></p><div class="doc"><p>A strict variant of <code><a href="Data-Edison-Assoc.html#v:foldlWithKey">foldlWithKey</a></code>.
</p><p><code>foldlWithKey' f</code> is <em>ambiguous</em> at finite relation types if
the relation contains more than one equivalent key and
<code>f</code> is not fold-commutative OR if the <code>Eq</code> instance on keys
does not correspond to indistinguishability. Otherwise it
is <em>unambiguous</em>.
</p></div><p class="src"><a name="v:toOrdSeq" class="def">toOrdSeq</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => m a -> seq (k, a)<a href="src/Data-Edison-Assoc.html#toOrdSeq" class="link">Source</a></p><div class="doc"><p>Extract the bindings of an associative collection into a sequence, where
the bindings are in non-decreasing order by key. For finite maps, this
is increasing order.
</p><p>This function is <em>ambiguous</em> at finite relation types if the relation
contains more than one equivalent key, or if the <code>Eq</code> instance on
keys does not correspond to indistinguishability.
</p></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> (<a href="Data-Edison-Assoc.html#t:Assoc">Assoc</a> m k, <a href="Data-Edison-Assoc.html#t:FiniteMapX">FiniteMapX</a> m k) => <a name="t:FiniteMap" class="def">FiniteMap</a> m k | m -> k <span class="keyword">where</span><a href="src/Data-Edison-Assoc.html#FiniteMap" class="link">Source</a></p><div class="doc"><p>Finite maps with observable keys.
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:unionWithKey" class="def">unionWithKey</a> :: (k -> a -> a -> a) -> m a -> m a -> m a<a href="src/Data-Edison-Assoc.html#unionWithKey" class="link">Source</a></p><div class="doc"><p>Same as <code><a href="Data-Edison-Assoc.html#v:union">union</a></code>, but with a combining function to resolve duplicates.
The combining function additionally takes the key. Which key is kept
and passed into the combining function is unspecified.
</p><p>This function is <em>unambiguous</em> provided that the <code>Eq</code> instance on keys
corresponds to indistinguishability.
</p></div><p class="src"><a name="v:unionSeqWithKey" class="def">unionSeqWithKey</a> :: <a href="Data-Edison-Seq.html#t:Sequence">Sequence</a> seq => (k -> a -> a -> a) -> seq (m a) -> m a<a href="src/Data-Edison-Assoc.html#unionSeqWithKey" class="link">Source</a></p><div class="doc"><p>Same as <code><a href="Data-Edison-Assoc.html#v:unionSeq">unionSeq</a></code>, but with a combining function to resolve duplicates.
The combining function additionally takes the key. Which key is
kept and passed into the combining function is unspecified.
</p><p>This function is <em>unambiguous</em> provided that the <code>Eq</code> instance on keys
corresponds to indistinguishability.
</p></div><p class="src"><a name="v:intersectionWithKey" class="def">intersectionWithKey</a> :: (k -> a -> b -> c) -> m a -> m b -> m c<a href="src/Data-Edison-Assoc.html#intersectionWithKey" class="link">Source</a></p><div class="doc"><p>Same as <code><a href="Data-Edison-Assoc.html#v:intersectionWith">intersectionWith</a></code>, except that the combining function
additionally takes the key value for each binding. Which key is
kept and passed into the combining function is unspecified.
</p><p>This function is <em>unambiguous</em> provided the <code>Eq</code> instance on keys
corresponds to indistinguishability.
</p></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> (<a href="Data-Edison-Assoc.html#t:OrdAssoc">OrdAssoc</a> m k, <a href="Data-Edison-Assoc.html#t:FiniteMap">FiniteMap</a> m k) => <a name="t:OrdFiniteMap" class="def">OrdFiniteMap</a> m k | m -> k<a href="src/Data-Edison-Assoc.html#OrdFiniteMap" class="link">Source</a></p><div class="doc"><p>Finite maps with observable keys where the keys additionally
have an ordering relation. This class introduces no new methods.
</p></div></div><h1 id="g:4">Specilizations of submap operations
</h1><div class="top"><p class="src"><a name="v:submap" class="def">submap</a> :: (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> a, <a href="Data-Edison-Assoc.html#t:FiniteMapX">FiniteMapX</a> m k) => m a -> m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Data-Edison-Assoc.html#submap" class="link">Source</a></p><div class="doc"><p>Specialization of <code><a href="Data-Edison-Assoc.html#v:submapBy">submapBy</a></code> where the comparison function is
given by <code>(==)</code>.
</p></div></div><div class="top"><p class="src"><a name="v:properSubmap" class="def">properSubmap</a> :: (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> a, <a href="Data-Edison-Assoc.html#t:FiniteMapX">FiniteMapX</a> m k) => m a -> m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Data-Edison-Assoc.html#properSubmap" class="link">Source</a></p><div class="doc"><p>Specialization of <code><a href="Data-Edison-Assoc.html#v:properSubmapBy">properSubmapBy</a></code> where the comparison function
is given by <code>(==)</code>.
</p></div></div><div class="top"><p class="src"><a name="v:sameMap" class="def">sameMap</a> :: (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> a, <a href="Data-Edison-Assoc.html#t:FiniteMapX">FiniteMapX</a> m k) => m a -> m a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Data-Edison-Assoc.html#sameMap" class="link">Source</a></p><div class="doc"><p>Specialization of <code><a href="Data-Edison-Assoc.html#v:sameMapBy">sameMapBy</a></code> where the comparison function is
given by <code>(==)</code>.
</p></div></div><h1 id="g:5">Specializations of sequence operations to lists
</h1><div class="top"><p class="src"><a name="v:fromList" class="def">fromList</a> :: <a href="Data-Edison-Assoc.html#t:AssocX">AssocX</a> m k => [(k, a)] -> m a<a href="src/Data-Edison-Assoc.html#fromList" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:insertList" class="def">insertList</a> :: <a href="Data-Edison-Assoc.html#t:AssocX">AssocX</a> m k => [(k, a)] -> m a -> m a<a href="src/Data-Edison-Assoc.html#insertList" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:unionList" class="def">unionList</a> :: <a href="Data-Edison-Assoc.html#t:AssocX">AssocX</a> m k => [m a] -> m a<a href="src/Data-Edison-Assoc.html#unionList" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:deleteList" class="def">deleteList</a> :: <a href="Data-Edison-Assoc.html#t:AssocX">AssocX</a> m k => [k] -> m a -> m a<a href="src/Data-Edison-Assoc.html#deleteList" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:lookupList" class="def">lookupList</a> :: <a href="Data-Edison-Assoc.html#t:AssocX">AssocX</a> m k => k -> m a -> [a]<a href="src/Data-Edison-Assoc.html#lookupList" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:elementsList" class="def">elementsList</a> :: <a href="Data-Edison-Assoc.html#t:AssocX">AssocX</a> m k => m a -> [a]<a href="src/Data-Edison-Assoc.html#elementsList" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:unsafeFromOrdList" class="def">unsafeFromOrdList</a> :: <a href="Data-Edison-Assoc.html#t:OrdAssocX">OrdAssocX</a> m k => [(k, a)] -> m a<a href="src/Data-Edison-Assoc.html#unsafeFromOrdList" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:fromListWith" class="def">fromListWith</a> :: <a href="Data-Edison-Assoc.html#t:FiniteMapX">FiniteMapX</a> m k => (a -> a -> a) -> [(k, a)] -> m a<a href="src/Data-Edison-Assoc.html#fromListWith" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:fromListWithKey" class="def">fromListWithKey</a> :: <a href="Data-Edison-Assoc.html#t:FiniteMapX">FiniteMapX</a> m k => (k -> a -> a -> a) -> [(k, a)] -> m a<a href="src/Data-Edison-Assoc.html#fromListWithKey" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:insertListWith" class="def">insertListWith</a> :: <a href="Data-Edison-Assoc.html#t:FiniteMapX">FiniteMapX</a> m k => (a -> a -> a) -> [(k, a)] -> m a -> m a<a href="src/Data-Edison-Assoc.html#insertListWith" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:insertListWithKey" class="def">insertListWithKey</a> :: <a href="Data-Edison-Assoc.html#t:FiniteMapX">FiniteMapX</a> m k => (k -> a -> a -> a) -> [(k, a)] -> m a -> m a<a href="src/Data-Edison-Assoc.html#insertListWithKey" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:unionListWith" class="def">unionListWith</a> :: <a href="Data-Edison-Assoc.html#t:FiniteMapX">FiniteMapX</a> m k => (a -> a -> a) -> [m a] -> m a<a href="src/Data-Edison-Assoc.html#unionListWith" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:toList" class="def">toList</a> :: <a href="Data-Edison-Assoc.html#t:Assoc">Assoc</a> m k => m a -> [(k, a)]<a href="src/Data-Edison-Assoc.html#toList" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:keysList" class="def">keysList</a> :: <a href="Data-Edison-Assoc.html#t:Assoc">Assoc</a> m k => m a -> [k]<a href="src/Data-Edison-Assoc.html#keysList" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:toOrdList" class="def">toOrdList</a> :: <a href="Data-Edison-Assoc.html#t:OrdAssoc">OrdAssoc</a> m k => m a -> [(k, a)]<a href="src/Data-Edison-Assoc.html#toOrdList" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:unionListWithKey" class="def">unionListWithKey</a> :: <a href="Data-Edison-Assoc.html#t:FiniteMap">FiniteMap</a> m k => (k -> a -> a -> a) -> [m a] -> m a<a href="src/Data-Edison-Assoc.html#unionListWithKey" class="link">Source</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.10.0</p></div></body></html>
|