Тип модуля Map.S

Тип ключей карты.

Тип карт от типа key к типу 'a.

Пустая карта.

Проверить, является ли карта пустой.

mem x m возвращает true, если m содержит привязку для x, и false в противном случае.

add key data m возвращает карту, содержащую те же привязки, что и m, плюс привязку key к data. Если key уже было привязано в m к значению, физически равному data, возвращается m, неизменённой (результат функции тогда физически равен m). В противном случае, предыдущая привязка key в m исчезает.

update key f m возвращает карту, содержащую те же привязки, что и m, за исключением привязки key. В зависимости от значения y, где y равно f (find_opt key m), привязка key добавляется, удаляется или обновляется. Если y равно None, привязка удаляется, если она существует; в противном случае, если y равно Some z, то key связывается со значением z в результирующей карте. Если key уже было привязано в m к значению, физически равному z, возвращается m, неизменённой (результат функции тогда физически равен m).

singleton x y возвращает карту из одного элемента, которая содержит привязку y для x.

remove x m возвращает карту, содержащую те же привязки, что и m, за исключением x , которое не привязано в возвращаемой карте. Если x не было в m, возвращается m, неизменённой (результат функции тогда физически равен m).

merge f m1 m2 вычисляет карту, ключи которой являются подмножеством ключей m1 и m2. Наличие каждой такой привязки и соответствующее значение определяются функцией f. В терминах операции find_opt мы имеем find_opt x (merge f m1 m2) = f x (find_opt x m1) (find_opt x m2) для любого ключа x, при условии f x None None = None.

union f m1 m2 вычисляет карту, ключи которой являются подмножеством ключей m1 и m2 . Когда одна и та же привязка определена в обоих аргументах, функция f используется для их объединения. Это частный случай merge: union f m1 m2 эквивалентно merge f' m1 m2, где

• f' _key None None = None
• f' _key (Some v) None = Some v
• f' _key None (Some v) = Some v
• f' key (Some v1) (Some v2) = f key v1 v2

Полный порядок между картами. Первый аргумент — это полный порядок, используемый для сравнения данных, связанных с равными ключами в двух картах.

equal cmp m1 m2 проверяет, равны ли карты m1 и m2, то есть, содержат ли они равные ключи и связывают их с равными данными. cmp — это предикат равенства, используемый для сравнения данных, связанных с ключами.

iter f m применяет f ко всем привязанностям в карте m. f получает ключ в качестве первого аргумента и связанное значение во втором. Привязки передаются f в возрастающем порядке по отношению к упорядочению над типом ключей.

fold f m init вычисляет (f kN dN ... (f k1 d1 init)...), где k1 ... kN — это ключи всех привязанностей в m (в возрастающем порядке), а d1 ... dN — это связанные данные.

for_all f m проверяет, удовлетворяют ли все привязки карты предикату f.

exists f m проверяет, удовлетворяет ли хотя бы одна привязка карты предикату f.

filter f m возвращает карту со всеми привязками в m , которые удовлетворяют предикату p. Если каждая привязка в m удовлетворяет f, возвращается m, неизменённой (результат функции тогда физически равен m).

filter_map f m применяет функцию f к каждой привязке в m, и строит карту из результатов. Для каждой привязки (k, v) в входной карте:

• если f k v равно None, то k не находится в результате,
• если f k v равно Some v', то привязка (k, v') находится в выходной карте.

Например, следующая функция для карт, значениями которых являются списки

        filter_map
          (fun _k li -> match li with [] -> None | _::tl -> Some tl)
          m
        

отбрасывает все привязки m , значение которых является пустым списком, и извлекает первый элемент каждого значения, которое не пусто.

partition f m возвращает пару карт (m1, m2), где m1 содержит все привязки m , удовлетворяющие предикату f, а m2 — это карта со всеми привязками m , которые не удовлетворяют f.

Возвращает количество привязок в карте.

Возвращает список всех привязок заданной карты. Возвращаемый список отсортирован по возрастанию ключей относительно порядка Ord.compare, где Ord — аргумент, переданный в Map.Make.

Возвращает привязку с наименьшим ключом в заданной карте (относительно порядка Ord.compare ), или вызывает Not_found , если карта пустая.

Аналогично Map.S.min_binding, но возвращает привязку с наибольшим ключом в заданной карте.

Аналогично Map.S.min_binding_opt, но возвращает привязку с наибольшим ключом в заданной карте.

Возвращает одну привязку заданной карты или вызывает Not_found , если карта пустая. Выбор привязки не определён, но равные привязки будут выбраны для равных карт.

Возвращает одну привязку заданной карты или None , если карта пустая. Выбор привязки не определён, но равные привязки будут выбраны для равных карт.

split x m возвращает тройку (l, data, r), где l — это карта со всеми связываниями m, ключ которых строго меньше x; r — это карта со всеми связываниями m, ключ которых строго больше x; data — это None если m не содержит связывания для x, или Some v если m связывает v с x.

find x m возвращает текущее значение x в m, или вызывает Not_found если связывание для x не существует.

find_opt x m возвращает Some v если текущее значение x в m равно v, или None если связывание для x не существует.

find_first f m, где f — монотонно возрастающая функция, возвращает связывание m с наименьшим ключом k таким, что f k, или вызывает Not_found если такого ключа не существует.

Например, find_first (fun k -> Ord.compare k x >= 0) m вернет первое связывание k, v m где Ord.compare k x >= 0 (интуитивно: k >= x), или вызовет Not_found если x больше любого элемента m.

find_first_opt f m, где f — монотонно возрастающая функция, возвращает опцию, содержащую связывание m с наименьшим ключом k таким, что f k, или None если такого ключа не существует.

find_last f m, где f — монотонно убывающая функция, возвращает связывание m с наибольшим ключом k таким, что f k, или вызывает Not_found если такого ключа не существует.

find_last_opt f m, где f — монотонно убывающая функция, возвращает опцию, содержащую связывание m с наибольшим ключом k таким, что f k, или None если такого ключа не существует.

map f m возвращает карту с тем же доменом, что и m, где связанное значение a всех связываний m было заменено результатом применения f к a. Связывания передаются f в порядке возрастания по отношению к упорядочению над типом ключей.

То же, что и Map.S.map, но функция получает в качестве аргументов как ключ, так и связанное значение для каждого связывания карты.

Итерироваться по всей карте в порядке возрастания ключей

Итерироваться по всей карте в порядке убывания ключей

to_seq_from k m итерируется по подмножеству связываний m, в порядке возрастания ключей, от ключа k или выше.

Добавить заданные связывания в карту в порядке.

Построить карту из заданных связываний