MutableMap

Same as Belt.Map, but mutable.

t

type t('k, 'v, 'id);

id

type id('key, 'id) = Belt_Id.comparable('key, 'id);

make

let make: (~id: id('k, 'id)) => t('k, 'a, 'id);

clear

let clear: t('a, 'b, 'c) => unit;

isEmpty

let isEmpty: t('a, 'b, 'c) => bool;

has

let has: (t('k, 'a, 'b), 'k) => bool;

cmpU

let cmpU: (t('k, 'a, 'id), t('k, 'a, 'id), [@bs] (('a, 'a) => int)) => int;

cmp

let cmp: (t('k, 'a, 'id), t('k, 'a, 'id), ('a, 'a) => int) => int;

cmp(m1, m2, cmp) First compare by size, if size is the same, compare by key, value pair.

eqU

let eqU: (t('k, 'a, 'id), t('k, 'a, 'id), [@bs] (('a, 'a) => bool)) => bool;

eq

let eq: (t('k, 'a, 'id), t('k, 'a, 'id), ('a, 'a) => bool) => bool;

eq(m1, m2, eqf) tests whether the maps m1 and m2 are equal, that is, contain equal keys and associate them with equal data. eqf is the equality predicate used to compare the data associated with the keys.

forEachU

let forEachU: (t('k, 'a, 'id), [@bs] (('k, 'a) => unit)) => unit;

forEach

let forEach: (t('k, 'a, 'id), ('k, 'a) => unit) => unit;

forEach(m, f) applies f to all bindings in map m. f receives the 'k as first argument, and the associated value as second argument. The bindings are passed to f in increasing order with respect to the ordering over the type of the keys.

reduceU

let reduceU: (t('k, 'a, 'id), 'b, [@bs] (('b, 'k, 'a) => 'b)) => 'b;

reduce

let reduce: (t('k, 'a, 'id), 'b, ('b, 'k, 'a) => 'b) => 'b;

reduce(m, a, f), computes(f(kN, dN) ... (f(k1, d1, a))...), wherek1 ... kNare the keys of all bindings inm(in increasing order), andd1 ... dN` are the associated data.

everyU

let everyU: (t('k, 'a, 'id), [@bs] (('k, 'a) => bool)) => bool;

every

let every: (t('k, 'a, 'id), ('k, 'a) => bool) => bool;

every(m, p) checks if all the bindings of the map satisfy the predicate p.

someU

let someU: (t('k, 'a, 'id), [@bs] (('k, 'a) => bool)) => bool;

some

let some: (t('k, 'a, 'id), ('k, 'a) => bool) => bool;

some(m, p) checks if at least one binding of the map satisfy the predicate p.

size

let size: t('k, 'a, 'id) => int;

toList

let toList: t('k, 'a, 'id) => list(('k, 'a));

In increasing order.

toArray

let toArray: t('k, 'a, 'id) => array(('k, 'a));

fromArray

let fromArray: (array(('k, 'a)), ~id: id('k, 'id)) => t('k, 'a, 'id);

keysToArray

let keysToArray: t('k, 'a, 'b) => array('k);

valuesToArray

let valuesToArray: t('b, 'a, 'c) => array('a);

minKey

let minKey: t('k, 'a, 'b) => option('k);

minKeyUndefined

let minKeyUndefined: t('k, 'a, 'b) => Js.undefined('k);

maxKey

let maxKey: t('k, 'a, 'b) => option('k);

maxKeyUndefined

let maxKeyUndefined: t('k, 'a, 'b) => Js.undefined('k);

minimum

let minimum: t('k, 'a, 'b) => option(('k, 'a));

minUndefined

let minUndefined: t('k, 'a, 'b) => Js.undefined(('k, 'a));

maximum

let maximum: t('k, 'a, 'b) => option(('k, 'a));

maxUndefined

let maxUndefined: t('k, 'a, 'b) => Js.undefined(('k, 'a));

get

let get: (t('k, 'a, 'id), 'k) => option('a);

getUndefined

let getUndefined: (t('k, 'a, 'id), 'k) => Js.undefined('a);

getWithDefault

let getWithDefault: (t('k, 'a, 'id), 'k, 'a) => 'a;

getExn

let getExn: (t('k, 'a, 'id), 'k) => 'a;

checkInvariantInternal

let checkInvariantInternal: t('a, 'b, 'c) => unit;

Raise when invariant is not held.

remove

let remove: (t('k, 'a, 'id), 'k) => unit;

remove(m, x) do the in-place modification.

removeMany

let removeMany: (t('k, 'a, 'id), array('k)) => unit;

set

let set: (t('k, 'a, 'id), 'k, 'a) => unit;

set(m, x, y) do the in-place modification

updateU

let updateU: (t('k, 'a, 'id), 'k, [@bs] (option('a) => option('a))) => unit;

update

let update: (t('k, 'a, 'id), 'k, option('a) => option('a)) => unit;

mergeMany

let mergeMany: (t('k, 'a, 'id), array(('k, 'a))) => unit;

mapU

let mapU: (t('k, 'a, 'id), [@bs] ('a => 'b)) => t('k, 'b, 'id);

map

let map: (t('k, 'a, 'id), 'a => 'b) => t('k, 'b, 'id);

map(m, f) returns a map with same domain as m, where the associated value a of all bindings of m has been replaced by the result of the application of f to a. The bindings are passed to f in increasing order with respect to the ordering over the type of the keys.

mapWithKeyU

let mapWithKeyU: (t('k, 'a, 'id), [@bs] (('k, 'a) => 'b)) => t('k, 'b, 'id);

mapWithKey

let mapWithKey: (t('k, 'a, 'id), ('k, 'a) => 'b) => t('k, 'b, 'id);