Idris2Doc : Data.SortedMap

Data.SortedMap

Definitions

record SortedMap : Type -> Type -> Type
Totality: total
Visibility: export
Constructor: 
M : SortedDMap k (const v) -> SortedMap k v

Projection: 
.unM : SortedMap k v -> SortedDMap k (const v)

Hints:
Cast (SortedDMap k (const v)) (SortedMap k v)
Cast (SortedMap k v) (SortedDMap k (const v))
(Eq k, Eq v) => Eq (SortedMap k v)
Foldable (SortedMap k)
Functor (SortedMap k)
(Ord k, Semigroup v) => Monoid (SortedMap k v)
Semigroup v => Semigroup (SortedMap k v)
(Show k, Show v) => Show (SortedMap k v)
Traversable (SortedMap k)
Ord k => Zippable (SortedMap k)
empty : Ord k => SortedMap k v
Visibility: export
lookup : k -> SortedMap k v -> Maybe v
Visibility: export
lookup' : SortedMap k v -> k -> Maybe v
Visibility: public export
insert : k -> v -> SortedMap k v -> SortedMap k v
Visibility: export
insertWith : (v -> v -> v) -> k -> v -> SortedMap k v -> SortedMap k v
  Inserts a key value pair into a map and merges duplicated values
with the given function.

Visibility: export
insert' : SortedMap k v -> (k, v) -> SortedMap k v
Visibility: public export
singleton : Ord k => k -> v -> SortedMap k v
Visibility: export
insertFrom : Foldable f => f (k, v) -> SortedMap k v -> SortedMap k v
Visibility: export
insertFrom' : Foldable f => SortedMap k v -> f (k, v) -> SortedMap k v
Visibility: public export
insertFromWith : Foldable f => (v -> v -> v) -> f (k, v) -> SortedMap k v -> SortedMap k v
  Inserts any foldable of a key value pair into a map and merges duplicated
values with the given function.

Visibility: export
delete : k -> SortedMap k v -> SortedMap k v
Visibility: export
delete' : SortedMap k v -> k -> SortedMap k v
Visibility: public export
update : (Maybe v -> Maybe v) -> k -> SortedMap k v -> SortedMap k v
  Updates or deletes a value based on the decision function

The decision function takes information about the presence of the value,
and the value itself, if it is present.
It returns a new value or the fact that there should be no value as the result.

The current implementation performs up to two traversals of the original map

Visibility: export
update' : SortedMap k v -> (Maybe v -> Maybe v) -> k -> SortedMap k v
Visibility: public export
updateExisting : (v -> v) -> k -> SortedMap k v -> SortedMap k v
  Updates existing value, if it is present, and does nothing otherwise

The current implementation performs up to two traversals of the original map

Visibility: export
updateExisting' : SortedMap k v -> (v -> v) -> k -> SortedMap k v
Visibility: public export
fromList : Ord k => List (k, v) -> SortedMap k v
Visibility: export
fromListWith : Ord k => (v -> v -> v) -> List (k, v) -> SortedMap k v
  Converts a list of key-value pairs into a map and merges duplicated
values with the given function.

Visibility: export
toList : SortedMap k v -> List (k, v)
Visibility: export
kvList : SortedMap k v -> List (k, v)
  Returns a list of key-value pairs stored in this map

Visibility: public export
keys : SortedMap k v -> List k
  Gets the keys of the map.

Visibility: export
values : SortedMap k v -> List v
  Gets the values of the map. Could contain duplicates.

Visibility: export
mergeWith : (v -> v -> v) -> SortedMap k v -> SortedMap k v -> SortedMap k v
  Merge two maps. When encountering duplicate keys, using a function to combine the values.
Uses the ordering of the first map given.

Visibility: export
merge : Semigroup v => SortedMap k v -> SortedMap k v -> SortedMap k v
  Merge two maps using the Semigroup (and by extension, Monoid) operation.
Uses mergeWith internally, so the ordering of the left map is kept.

Visibility: export
mergeLeft : SortedMap k v -> SortedMap k v -> SortedMap k v
  Left-biased merge, also keeps the ordering specified  by the left map.

Visibility: export
lookupBetween : key -> SortedMap key val -> (Maybe (key, val), Maybe (key, val))
  looks up a key in map, returning the left and right closest values, so that
k1 <= k < k2. If at the end of the beginning and/or end of the sorted map, returns
nothing appropriately

Visibility: export
leftMost : SortedMap key val -> Maybe (key, val)
  Returns the leftmost (least) key and value

Visibility: export
rightMost : SortedMap key val -> Maybe (key, val)
  Returns the rightmost (greatest) key and value

Visibility: export
pop : SortedMap k v -> Maybe ((k, v), SortedMap k v)
  Pops the leftmost key and corresponding value from the map

Visibility: export