Функтор Map.Make
module Make: functor (Ord : OrderedType) -> S with type key = Ord.t
Функтор, создающий реализацию структуры карты (map) для заданного типа с полным упорядочением.
| Параметры: |
|
type key
Тип ключей карты.
type +'a t
Тип карт из типа key в тип 'a.
val empty : 'a t
Пустая карта.
val is_empty : 'a t -> bool
Проверка, является ли карта пустой.
val mem : key -> 'a t -> bool
mem x m возвращает true если m содержит привязку для x, и false в противном случае.
val add : key -> 'a -> 'a t -> 'a t
add key data m возвращает карту, содержащую те же привязки, что и m, плюс привязку key к data. Если key уже была связана в m со значением, физически равным data, то возвращается m без изменений (результат функции тогда физически равен m). В противном случае предыдущая привязка key в m исчезает.
- До 4.03 Физическое равенство не гарантировалось.
val update : key -> ('a option -> 'a option) -> 'a t -> 'a t
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).
- С 4.06.0
val singleton : key -> 'a -> 'a t
singleton x y возвращает карту из одного элемента, содержащую привязку y для x.
- С 3.12.0
val remove : key -> 'a t -> 'a t
remove x m возвращает карту, содержащую те же привязки, что и m, за исключением x, которое не связано в результирующей карте. Если x не было в m, то возвращается m без изменений (результат функции тогда физически равен m).
- До 4.03 Физическое равенство не гарантировалось.
val merge : (key -> 'a option -> 'b option -> 'c option) -> 'a t -> 'b t -> 'c t
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.
- С 3.12.0
val union : (key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
union f m1 m2 вычисляет карту, ключи которой являются подмножеством ключей m1 и m2. При совпадении привязки в обоих аргументах, функция f используется для их объединения. Это частный случай merge: union f m1 m2 эквивалентно merge f' m1 m2, где
f' _key None None = Nonef' _key (Some v) None = Some vf' _key None (Some v) = Some vf' key (Some v1) (Some v2) = f key v1 v2
- С 4.03.0
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
Полное упорядочение между картами. Первый аргумент — полное упорядочение, используемое для сравнения данных, связанных с одинаковыми ключами в двух картах.
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
equal cmp m1 m2 проверяет, равны ли карты m1 и m2, т.е. содержат ли они равные ключи и связывают ли их с равными данными. cmp — предикат равенства, используемый для сравнения данных, связанных с ключами.
val iter : (key -> 'a -> unit) -> 'a t -> unit
iter f m применяет f ко всем привязанным значениям в карте m. f получает ключ в качестве первого аргумента, а соответствующее значение — во втором. Привязки передаются в f в порядке возрастания по сравнению с упорядочением по типу ключей.
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
fold f m init вычисляет (f kN dN ... (f k1 d1 init)...), где k1 ... kN — это ключи всех привязок в m (в порядке возрастания), а d1 ... dN — это связанные данные.
val for_all : (key -> 'a -> bool) -> 'a t -> bool
for_all f m проверяет, удовлетворяют ли все привязки карты предикату f.
- С 3.12.0
val exists : (key -> 'a -> bool) -> 'a t -> bool
exists f m проверяет, удовлетворяет ли хотя бы одна привязка карты предикату f.
- С 3.12.0
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
filter f m возвращает карту со всеми привязками из m, которые удовлетворяют предикату p. Если все привязки в m удовлетворяют f, то возвращается m без изменений (результат функции тогда физически равен m).
- До 4.03 Физическое равенство не гарантировалось.
- С 3.12.0
val filter_map : (key -> 'a -> 'b option) -> 'a t -> 'b t
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 со значением пустой список и извлекает первый элемент каждого непустого значения.
- С 4.11.0
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
partition f m возвращает пару карт (m1, m2), где m1 содержит все привязки m которые удовлетворяют предикату f, и m2 — карта со всеми привязками m которые не удовлетворяют f.
- С 3.12.0
val cardinal : 'a t -> int
Возвращает количество привязок в карте.
- С 3.12.0
val bindings : 'a t -> (key * 'a) list
Возвращает список всех привязок данной карты. Возвращаемый список отсортирован в порядке возрастания ключей относительно упорядочения Ord.compare, где Ord — аргумент, переданный в Stdlib.Map.Make.
- С 3.12.0
val min_binding : 'a t -> key * 'a
Возвращает привязку с наименьшим ключом в заданной карте (относительно упорядочения Ord.compare или вызывает Not_found, если карта пуста.
- С 3.12.0
val min_binding_opt : 'a t -> (key * 'a) option
Возвращает привязку с наименьшим ключом в заданной карте (относительно упорядочения Ord.compare или None, если карта пуста.
- С 4.05
val max_binding : 'a t -> key * 'a
Аналогично Map.S.min_binding, но возвращает привязку с наибольшим ключом в заданной карте.
- С 3.12.0
val max_binding_opt : 'a t -> (key * 'a) option
Аналогично Map.S.min_binding_opt, но возвращает привязку с наибольшим ключом в заданной карте.
- С 4.05
val choose : 'a t -> key * 'a
Возвращает одну привязку из заданной карты или вызывает Not_found если карта пуста. Какой привязкой выбирается, не определено, но равные привязки будут выбираться для равных карт.
- С 3.12.0
val choose_opt : 'a t -> (key * 'a) option
Возвращает одну привязку из заданной карты или None если карта пуста. Какой привязкой выбирается, не определено, но равные привязки будут выбираться для равных карт.
- С 4.05
val split : key -> 'a t -> 'a t * 'a option * 'a t
split x m возвращает тройку (l, data, r), где l — это карта со всеми связываниями m, у которых ключ строго меньше x; r — это карта со всеми связываниями m, у которых ключ строго больше x; data — это None, если m не содержит связывания для x, или Some v, если m связывает v с x.
- Since 3.12.0
val find : key -> 'a t -> 'a
find x m возвращает текущее значение x в m, или поднимает Not_found, если связывание для x не существует.
val find_opt : key -> 'a t -> 'a option
find_opt x m возвращает Some v, если текущее значение x в m равно v, или None, если связывание для x не существует.
- Since 4.05
val find_first : (key -> bool) -> 'a t -> key * 'a
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.
- Since 4.05
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) option
find_first_opt f m, где f — монотонно возрастающая функция, возвращает опцию, содержащую связывание m с самым низким ключом k таким, что f k, или None, если такого ключа не существует.
- Since 4.05
val find_last : (key -> bool) -> 'a t -> key * 'a
find_last f m, где f — монотонно убывающая функция, возвращает связывание m с самым высоким ключом k таким, что f k, или поднимает Not_found, если такого ключа не существует.
- Since 4.05
val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) option
find_last_opt f m, где f — монотонно убывающая функция, возвращает опцию, содержащую связывание m с самым высоким ключом k таким, что f k, или None, если такого ключа не существует.
- Since 4.05
val map : ('a -> 'b) -> 'a t -> 'b t
map f m возвращает карту с тем же доменом, что и m, где связанное значение a всех связываний m было заменено результатом применения f к a. Связывания передаются f в возрастающем порядке относительно порядка над типом ключей.
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
Аналогично Map.S.map, но функция получает в качестве аргументов и ключ, и связанное значение для каждого связывания карты.
Карты и Последовательности
val to_seq : 'a t -> (key * 'a) Seq.t
Итерация по всей карте в порядке возрастания ключей
- Since 4.07
val to_rev_seq : 'a t -> (key * 'a) Seq.t
Итерация по всей карте в порядке убывания ключей
- Since 4.12
val to_seq_from : key -> 'a t -> (key * 'a) Seq.t
to_seq_from k m итерирует по подмножеству связываний m, в порядке возрастания ключей, начиная с ключа k или выше.
- Since 4.07
val add_seq : (key * 'a) Seq.t -> 'a t -> 'a t
Добавление заданных связываний в карту в порядке.
- Since 4.07
val of_seq : (key * 'a) Seq.t -> 'a t
Создание карты из заданных связываний
- Since 4.07
© 1995-2022 INRIA.
https://v2.ocaml.org/releases/4.14/htmlman/libref/Map.Make.html