模組類型 MoreLabels.Map.S

module type S = sig .. end

函子 MoreLabels.Map.Make 的輸出簽名。

映射

type key

映射鍵的類型。

type !+'a t

從類型 key 到類型 'a 的映射類型。

val empty : 'a t

空的映射。

val add : key:key ->
       data:'a -> 'a t -> 'a t

add ~key ~data m 會返回一個包含與 m 相同綁定的映射，外加一個 key 到 data 的綁定。如果 key 在 m 中已經綁定到一個與 data 物理上相等的值，則 m 會保持不變地返回（該函數的結果與 m 在物理上相等）。否則，key 在 m 中的先前綁定會消失。

4.03 之前 未確保物理相等性。

val add_to_list : key:key ->
       data:'a -> 'a list t -> 'a list t

add_to_list ~key ~data m 是指 m，其中 key 映射到 l，使得如果 key 在 m 中已綁定，則 l 為 data :: Map.find key m，否則為 [v]。

自 5.1

val update : key:key ->
       f:('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

val singleton : key -> 'a -> 'a t

singleton x y 會返回一個單元素映射，其中包含 x 的 y 綁定。

自 3.12

val remove : key -> 'a t -> 'a t

remove x m 會返回一個包含與 m 相同綁定的映射，但 x 除外，它在返回的映射中未綁定。如果 x 不在 m 中，則 m 會保持不變地返回（該函數的結果與 m 在物理上相等）。

4.03 之前 未確保物理相等性。

val merge : f:(key -> 'a option -> 'b option -> 'c option) ->
       'a t -> 'b t -> 'c t

merge ~f m1 m2 會計算一個映射，其鍵是 m1 和 m2 的鍵的子集。每個此類綁定的存在及其對應值，會由函數 f 決定。就 find_opt 操作而言，對於任何鍵 x，我們有 find_opt x (merge f m1 m2) = f x (find_opt x m1) (find_opt x m2)，前提是 f x None None = None。

自 3.12

val union : f:(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 = 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

自 4.03

val cardinal : 'a t -> int

返回映射的綁定數量。

自 3.12

綁定

val bindings : 'a t -> (key * 'a) list

返回給定映射的所有綁定清單。返回的清單會根據鍵的升序排序，依據 Ord.compare 排序，其中 Ord 是給定給 MoreLabels.Map.Make 的參數。

自 3.12

val min_binding : 'a t -> key * 'a

返回給定映射中鍵最小的綁定（依據 Ord.compare 排序），如果映射為空，則引發 Not_found。

自 3.12

val min_binding_opt : 'a t -> (key * 'a) option

返回給定映射中鍵最小的綁定（依據 Ord.compare 排序），如果映射為空，則返回 None。

自 4.05

val max_binding : 'a t -> key * 'a

與 MoreLabels.Map.S.min_binding 相同，但會返回給定映射中鍵最大的綁定。

自 3.12

val max_binding_opt : 'a t -> (key * 'a) option

與 MoreLabels.Map.S.min_binding_opt 相同，但會返回給定映射中鍵最大的綁定。

自 4.05

val choose : 'a t -> key * 'a

返回給定映射的一個綁定，如果映射為空，則引發 Not_found。選取哪個綁定未指定，但相等映射會選取相等的綁定。

自 3.12

val choose_opt : 'a t -> (key * 'a) option

返回給定映射的一個綁定，如果映射為空，則返回 None。選取哪個綁定未指定，但相等映射會選取相等的綁定。

自 4.05

搜尋

val find : key -> 'a t -> 'a

find x m 會返回 x 在 m 中的當前值，如果不存在 x 的綁定，則引發 Not_found。

val find_opt : key -> 'a t -> 'a option

find_opt x m 如果 x 在 m 中的當前值為 v，則返回 Some v，如果不存在 x 的綁定，則返回 None。

自 4.05

val find_first : f:(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 會返回 m 的第一個綁定 k, v，其中 Ord.compare k x >= 0（直覺上：k >= x），如果 x 大於 m 的任何元素，則引發 Not_found。

自 4.05

val find_first_opt : f:(key -> bool) ->
       'a t -> (key * 'a) option

find_first_opt ~f m，其中 f 是單調遞增函數，會返回一個選項，其中包含 m 中鍵最低的綁定 k，使得 f k，如果不存在此類鍵，則返回 None。

自 4.05

val find_last : f:(key -> bool) ->
       'a t -> key * 'a

find_last ~f m，其中 f 是單調遞減函數，會返回 m 中鍵最高的綁定 k，使得 f k，如果不存在此類鍵，則引發 Not_found。

自 4.05

val find_last_opt : f:(key -> bool) ->
       'a t -> (key * 'a) option

find_last_opt ~f m，其中 f 是單調遞減函數，會返回一個選項，其中包含 m 中鍵最高的綁定 k，使得 f k，如果不存在此類鍵，則返回 None。

自 4.05

遍歷

val iter : f:(key:key -> data:'a -> unit) ->
       'a t -> unit

iter ~f m 會將 f 應用於映射 m 中的所有綁定。f 會接收鍵作為第一個參數，並將相關聯的值作為第二個參數。綁定會依照鍵類型的排序遞增順序傳遞給 f。

val fold : f:(key:key -> data:'a -> 'acc -> 'acc) ->
       'a t -> init:'acc -> 'acc

fold ~f m ~init 會計算 (f kN dN ... (f k1 d1 init)...)，其中 k1 ... kN 是 m 中所有綁定的鍵（依照遞增順序），而 d1 ... dN 是關聯的資料。

轉換

val map : f:('a -> 'b) -> 'a t -> 'b t

map ~f m 會返回一個與 m 具有相同定義域的映射，其中 m 的所有綁定的關聯值 a 已被 f 應用於 a 的結果取代。綁定會依照鍵類型的排序遞增順序傳遞給 f。

val mapi : f:(key -> 'a -> 'b) ->
       'a t -> 'b t

與 MoreLabels.Map.S.map 相同，但該函數會接收鍵和關聯值作為映射中每個綁定的參數。

val filter : f:(key -> 'a -> bool) ->
       'a t -> 'a t

filter ~f m 會返回映射中所有滿足謂詞 p 的綁定。如果 m 中的每個綁定都滿足 f，則 m 會保持不變地返回（該函數的結果與 m 在物理上相等）

4.03 之前 未確保物理相等性。
自 3.12

val filter_map : f:(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

val partition : f:(key -> 'a -> bool) ->
       'a t -> 'a t * 'a t

partition ~f m 會返回一對映射 (m1, m2)，其中 m1 包含 m 中滿足謂詞 f 的所有綁定，而 m2 則是 m 中不滿足 f 的所有綁定的映射。

自 3.12

val split : key ->
       'a t ->
       'a t * 'a option * 'a t

split x m 返回一個三元組 (l, data, r)，其中 l 是一個映射，包含 m 中所有鍵嚴格小於 x 的綁定；r 是一個映射，包含 m 中所有鍵嚴格大於 x 的綁定；如果 m 沒有關於 x 的綁定，則 data 為 None，如果 m 將 v 綁定到 x，則 data 為 Some v。

自 3.12

謂詞和比較

val is_empty : 'a t -> bool

測試映射是否為空。

val mem : key -> 'a t -> bool

mem x m 如果 m 包含關於 x 的綁定，則返回 true，否則返回 false。

val equal : cmp:('a -> 'a -> bool) ->
       'a t -> 'a t -> bool

equal ~cmp m1 m2 測試映射 m1 和 m2 是否相等，也就是說，是否包含相等的鍵，並將它們與相等的資料相關聯。cmp 是用於比較與鍵關聯的資料的相等性謂詞。

val compare : cmp:('a -> 'a -> int) ->
       'a t -> 'a t -> int

映射之間的總排序。第一個參數是一個總排序，用於比較兩個映射中與相等鍵相關聯的資料。

val for_all : f:(key -> 'a -> bool) -> 'a t -> bool

for_all ~f m 檢查映射的所有綁定是否都滿足謂詞 f。

自 3.12

val exists : f:(key -> 'a -> bool) -> 'a t -> bool

exists ~f m 檢查映射中是否至少有一個綁定滿足謂詞 f。

自 3.12

轉換

val to_list : 'a t -> (key * 'a) list

to_list m 等於 MoreLabels.Map.S.bindings m。

自 5.1

val of_list : (key * 'a) list -> 'a t

of_list bs 以列表順序將 bs 的綁定添加到空映射（如果一個鍵在 bs 中被綁定兩次，則最後一個綁定優先）。

自 5.1

val to_seq : 'a t -> (key * 'a) Seq.t

以鍵的升序遍歷整個映射。

自 4.07

val to_rev_seq : 'a t -> (key * 'a) Seq.t

以鍵的降序遍歷整個映射。

自 4.12

val to_seq_from : key ->
       'a t -> (key * 'a) Seq.t

to_seq_from k m 從鍵 k 或以上開始，以鍵的升序遍歷 m 的綁定子集。

自 4.07

val add_seq : (key * 'a) Seq.t ->
       'a t -> 'a t

依序將給定的綁定添加到映射中。

自 4.07

val of_seq : (key * 'a) Seq.t -> 'a t

從給定的綁定建立一個映射。

自 4.07