Source file map_intf.ml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
(** This module defines interfaces used in {{!Map}[Map]}. See those docs for a description
of the design.
This module defines module types
[{Creators,Accessors}{1,2,3,_generic,_with_comparator}]. It uses check functors to
ensure that each module type is an instance of the corresponding [_generic] one.
We must treat [Creators] and [Accessors] separately, because we sometimes need to
choose different instantiations of their [options]. In particular, [Map] itself
matches [Creators3_with_comparator] but [Accessors3] (without comparator).
*)
open! Import
module Binable = Binable0
module Map = Base.Map
module Or_duplicate = Map.Or_duplicate
module With_comparator = Map.With_comparator
module With_first_class_module = Map.With_first_class_module
module Without_comparator = Map.Without_comparator
module Tree = Map.Using_comparator.Tree
module type Key_plain = sig
type t [@@deriving compare, sexp_of]
end
module type Key = sig
type t [@@deriving compare, sexp]
end
module type Key_binable = sig
type t [@@deriving bin_io, compare, sexp]
end
module type Key_hashable = sig
type t [@@deriving compare, hash, sexp]
end
module type Key_binable_hashable = sig
type t [@@deriving bin_io, compare, hash, sexp]
end
module Key_bin_io = struct
module type S = sig
type t [@@deriving bin_io]
type comparator_witness
val comparator : (t, comparator_witness) Comparator.t
end
type ('t, 'c) t = (module S with type t = 't and type comparator_witness = 'c)
end
module type Accessors_generic = sig
include Map.Accessors_generic
val key_set
: ('k, 'cmp, ('k, _, 'cmp) t -> ('k key, 'cmp cmp) Base.Set.t) access_options
val validate
: name:('k key -> string)
-> 'v Validate.check
-> ('k, 'v, _) t Validate.check
val validatei
: name:('k key -> string)
-> ('k key * 'v) Validate.check
-> ('k, 'v, _) t Validate.check
val quickcheck_observer
: 'k key Quickcheck.Observer.t
-> 'v Quickcheck.Observer.t
-> ('k, 'v, 'cmp) t Quickcheck.Observer.t
val quickcheck_shrinker
: ( 'k
, 'cmp
, 'k key Quickcheck.Shrinker.t
-> 'v Quickcheck.Shrinker.t
-> ('k, 'v, 'cmp) t Quickcheck.Shrinker.t )
access_options
end
module type Creators_generic = sig
include Map.Creators_generic
val of_hashtbl_exn
: ('k, 'cmp, ('k key, 'v) Hashtbl.t -> ('k, 'v, 'cmp) t) create_options
(** Never requires a comparator because it can get one from the input [Set.t]. *)
val of_key_set
: ('k key, 'cmp cmp) Base.Set.t
-> f:(('k key -> 'v)[@local])
-> ('k, 'v, 'cmp) t
val quickcheck_generator
: ( 'k
, 'cmp
, 'k key Quickcheck.Generator.t
-> 'v Quickcheck.Generator.t
-> ('k, 'v, 'cmp) t Quickcheck.Generator.t )
create_options
end
module type Creators_and_accessors_generic = sig
type ('a, 'b, 'c) t
type ('a, 'b, 'c) tree
type 'a key
type 'a cmp
type ('a, 'b, 'c) create_options
type ('a, 'b, 'c) access_options
include
Creators_generic
with type ('a, 'b, 'c) t := ('a, 'b, 'c) t
with type ('a, 'b, 'c) tree := ('a, 'b, 'c) tree
with type 'a key := 'a key
with type 'a cmp := 'a cmp
with type ('a, 'b, 'c) create_options := ('a, 'b, 'c) create_options
with type ('a, 'b, 'c) access_options := ('a, 'b, 'c) access_options
include
Accessors_generic
with type ('a, 'b, 'c) t := ('a, 'b, 'c) t
with type ('a, 'b, 'c) tree := ('a, 'b, 'c) tree
with type 'a key := 'a key
with type 'a cmp := 'a cmp
with type ('a, 'b, 'c) access_options := ('a, 'b, 'c) access_options
end
module Make_S_plain_tree (Key : Comparator.S) = struct
module type S = sig
type 'a t = (Key.t, 'a, Key.comparator_witness) Tree.t [@@deriving sexp_of]
include
Creators_and_accessors_generic
with type ('a, 'b, 'c) t := 'b t
with type ('a, 'b, 'c) tree := 'b t
with type 'a key := Key.t
with type 'a cmp := Key.comparator_witness
with type ('a, 'b, 'c) create_options := ('a, 'b, 'c) Without_comparator.t
with type ('a, 'b, 'c) access_options := ('a, 'b, 'c) Without_comparator.t
module Provide_of_sexp
(K : sig
type t [@@deriving of_sexp]
end
with type t := Key.t) : sig
type _ t [@@deriving of_sexp]
end
with type 'a t := 'a t
end
end
module type S_plain = sig
module Key : sig
type t [@@deriving sexp_of]
include Comparator.S with type t := t
end
type +'a t = (Key.t, 'a, Key.comparator_witness) Map.t
[@@deriving compare, equal, sexp_of]
include
Creators_generic
with type ('a, 'b, 'c) t := 'b t
with type ('a, 'b, 'c) tree := (Key.t, 'b, Key.comparator_witness) Tree.t
with type 'k key := Key.t
with type 'c cmp := Key.comparator_witness
with type ('a, 'b, 'c) create_options := ('a, 'b, 'c) Without_comparator.t
with type ('a, 'b, 'c) access_options := ('a, 'b, 'c) Without_comparator.t
val map : 'a t -> f:(('a -> 'b)[@local]) -> 'b t
module Provide_of_sexp
(Key : sig
type t [@@deriving of_sexp]
end
with type t := Key.t) : sig
type _ t [@@deriving of_sexp]
end
with type 'a t := 'a t
module Provide_bin_io
(Key : sig
type t [@@deriving bin_io]
end
with type t := Key.t) : Binable.S1 with type 'a t := 'a t
module Provide_hash (Key : Hasher.S with type t := Key.t) : sig
type 'a t [@@deriving hash]
end
with type 'a t := 'a t
val quickcheck_observer
: Key.t Quickcheck.Observer.t
-> 'v Quickcheck.Observer.t
-> 'v t Quickcheck.Observer.t
val quickcheck_shrinker
: ( 'k
, 'cmp
, Key.t Quickcheck.Shrinker.t
-> 'v Quickcheck.Shrinker.t
-> 'v t Quickcheck.Shrinker.t )
Without_comparator.t
end
module type S = sig
module Key : sig
type t [@@deriving sexp]
include Comparator.S with type t := t
end
include S_plain with module Key := Key
include Sexpable.S1 with type 'a t := 'a t
end
module type S_binable = sig
module Key : sig
type t [@@deriving bin_io, sexp]
include Comparator.S with type t := t
end
include S with module Key := Key
include Binable.S1 with type 'a t := 'a t
end
module type For_deriving = sig
include Base.Map.For_deriving
module M = Base.Map.M
(** The following [*bin*] functions support bin-io on base-style maps,
e.g.:
{[ type t = int Map.M(String).t [@@deriving bin_io] ]} *)
val bin_shape_m__t : ('a, 'c) Key_bin_io.t -> Bin_prot.Shape.t -> Bin_prot.Shape.t
val bin_size_m__t
: ('a, 'c) Key_bin_io.t
-> 'b Bin_prot.Size.sizer
-> ('a, 'b, 'c) t Bin_prot.Size.sizer
val bin_write_m__t
: ('a, 'c) Key_bin_io.t
-> 'b Bin_prot.Write.writer
-> ('a, 'b, 'c) t Bin_prot.Write.writer
val bin_read_m__t
: ('a, 'c) Key_bin_io.t
-> 'b Bin_prot.Read.reader
-> ('a, 'b, 'c) t Bin_prot.Read.reader
val __bin_read_m__t__
: ('a, 'c) Key_bin_io.t
-> 'b Bin_prot.Read.reader
-> (int -> ('a, 'b, 'c) t) Bin_prot.Read.reader
(** The following [quickcheck*] functions support deriving quickcheck on base-style maps,
e.g.:
{[ type t = int Map.M(String).t [@@deriving quickcheck] ]} *)
module type Quickcheck_generator_m = sig
include Comparator.S
val quickcheck_generator : t Quickcheck.Generator.t
end
module type Quickcheck_observer_m = sig
include Comparator.S
val quickcheck_observer : t Quickcheck.Observer.t
end
module type Quickcheck_shrinker_m = sig
include Comparator.S
val quickcheck_shrinker : t Quickcheck.Shrinker.t
end
val quickcheck_generator_m__t
: (module Quickcheck_generator_m with type t = 'k and type comparator_witness = 'cmp)
-> 'v Quickcheck.Generator.t
-> ('k, 'v, 'cmp) t Quickcheck.Generator.t
val quickcheck_observer_m__t
: (module Quickcheck_observer_m with type t = 'k and type comparator_witness = 'cmp)
-> 'v Quickcheck.Observer.t
-> ('k, 'v, 'cmp) t Quickcheck.Observer.t
val quickcheck_shrinker_m__t
: (module Quickcheck_shrinker_m with type t = 'k and type comparator_witness = 'cmp)
-> 'v Quickcheck.Shrinker.t
-> ('k, 'v, 'cmp) t Quickcheck.Shrinker.t
end
module type For_deriving_stable = sig
type ('a, 'b, 'c) t
module type Stable_witness_m = sig
include Comparator.S
val stable_witness : t Stable_witness.t
end
val stable_witness_m__t
: (module Stable_witness_m with type t = 'k and type comparator_witness = 'cmp)
-> 'v Stable_witness.t
-> ('k, 'v, 'cmp) t Stable_witness.t
end