/
incr_map_intf.ml
1292 lines (1115 loc) · 46.2 KB
/
incr_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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
open! Core
module Instrumentation = struct
(** All [Incr_map] functions take an optional [instrumentation] parameter that has type
[Instrumentation.t]. A value of this type is a record containing a function which
is polymorphic over a universally-quantified type ['a]. This function is passed
a [unit -> 'a] function, which must be immediately executed, and the result of
which must be returned.
The function passed to the instrumentor will be doing the bulk of the work for the
[Incr_map] function in question (usually a [Map.fold_symmetric_diff]).
You may want to use the Instrumentation API to assist in performance profiling like
so:
{[
let profile name =
{ Incr_map.Instrumentation.f = fun f ->
let before = Time.now () in
let r = f () in
let after = Time.now () in
let delta = Time.sub after before in
printf "%s took %s" name (Time.Span.to_string_hum delta);
r
}
;;
Incr_map.map ~instrumentation:(profile "foo") ~f:map_foo
]} *)
type t = { f : 'a. (unit -> 'a) -> 'a } [@@unboxed]
end
(** [S_gen] is the type of the module returned by [Incr_map.Make]. It is a specialization
of the interface of [Incr_map], with:
- the ['w] state_witness type parameter removed
- the [Incremental.State.t] argument removed
The comments for components of [S_gen] are in [module type Incr_map] below. *)
module type S_gen = sig
module Incr : sig
type 'a t
module Cutoff : sig
type 'a t
end
end
module Instrumentation = Instrumentation
val of_set
: ?instrumentation:Instrumentation.t
-> ('k, 'cmp) Set.t Incr.t
-> ('k, unit, 'cmp) Map.t Incr.t
val filter_mapi
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v1 -> 'v1 -> bool)
-> ('k, 'v1, 'cmp) Map.t Incr.t
-> f:(key:'k -> data:'v1 -> 'v2 option)
-> ('k, 'v2, 'cmp) Map.t Incr.t
val mapi
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v1 -> 'v1 -> bool)
-> ('k, 'v1, 'cmp) Map.t Incr.t
-> f:(key:'k -> data:'v1 -> 'v2)
-> ('k, 'v2, 'cmp) Map.t Incr.t
val filter_map
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v1 -> 'v1 -> bool)
-> ('k, 'v1, 'cmp) Map.t Incr.t
-> f:('v1 -> 'v2 option)
-> ('k, 'v2, 'cmp) Map.t Incr.t
val map
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v1 -> 'v1 -> bool)
-> ('k, 'v1, 'cmp) Map.t Incr.t
-> f:('v1 -> 'v2)
-> ('k, 'v2, 'cmp) Map.t Incr.t
val filter_mapi'
: ?instrumentation:Instrumentation.t
-> ?cutoff:'v1 Incr.Cutoff.t
-> ?data_equal:('v1 -> 'v1 -> bool)
-> ('k, 'v1, 'cmp) Map.t Incr.t
-> f:(key:'k -> data:'v1 Incr.t -> 'v2 option Incr.t)
-> ('k, 'v2, 'cmp) Map.t Incr.t
val mapi'
: ?instrumentation:Instrumentation.t
-> ?cutoff:'v1 Incr.Cutoff.t
-> ?data_equal:('v1 -> 'v1 -> bool)
-> ('k, 'v1, 'cmp) Map.t Incr.t
-> f:(key:'k -> data:'v1 Incr.t -> 'v2 Incr.t)
-> ('k, 'v2, 'cmp) Map.t Incr.t
val filter_map'
: ?instrumentation:Instrumentation.t
-> ?cutoff:'v1 Incr.Cutoff.t
-> ?data_equal:('v1 -> 'v1 -> bool)
-> ('k, 'v1, 'cmp) Map.t Incr.t
-> f:('v1 Incr.t -> 'v2 option Incr.t)
-> ('k, 'v2, 'cmp) Map.t Incr.t
val map'
: ?instrumentation:Instrumentation.t
-> ?cutoff:'v1 Incr.Cutoff.t
-> ?data_equal:('v1 -> 'v1 -> bool)
-> ('k, 'v1, 'cmp) Map.t Incr.t
-> f:('v1 Incr.t -> 'v2 Incr.t)
-> ('k, 'v2, 'cmp) Map.t Incr.t
val partition_mapi
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v1 -> 'v1 -> bool)
-> ('k, 'v1, 'cmp) Map.t Incr.t
-> f:(key:'k -> data:'v1 -> ('v2, 'v3) Either.t)
-> (('k, 'v2, 'cmp) Map.t * ('k, 'v3, 'cmp) Map.t) Incr.t
val partition_mapi'
: ?instrumentation:Instrumentation.t
-> ?cutoff:'v1 Incr.Cutoff.t
-> ?data_equal:('v1 -> 'v1 -> bool)
-> ('k, 'v1, 'cmp) Map.t Incr.t
-> f:(key:'k -> data:'v1 Incr.t -> ('v2, 'v3) Either.t Incr.t)
-> (('k, 'v2, 'cmp) Map.t * ('k, 'v3, 'cmp) Map.t) Incr.t
val unordered_fold
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ?update:(key:'k -> old_data:'v -> new_data:'v -> 'acc -> 'acc)
-> ?specialized_initial:(init:'acc -> ('k, 'v, 'cmp) Map.t -> 'acc)
-> ?finalize:('acc -> 'acc)
-> ?revert_to_init_when_empty:bool
-> ('k, 'v, 'cmp) Map.t Incr.t
-> init:'acc
-> add:(key:'k -> data:'v -> 'acc -> 'acc)
-> remove:(key:'k -> data:'v -> 'acc -> 'acc)
-> 'acc Incr.t
val unordered_fold_with_extra
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ?extra_equal:('extra -> 'extra -> bool)
-> ?update:(key:'k -> old_data:'v -> new_data:'v -> 'acc -> 'extra -> 'acc)
-> ?specialized_initial:(init:'acc -> ('k, 'v, 'e) Map.t -> 'extra -> 'acc)
-> ?finalize:('acc -> 'acc)
-> ?revert_to_init_when_empty:bool
-> ('k, 'v, 'e) Map.t Incr.t
-> 'extra Incr.t
-> init:'acc
-> add:(key:'k -> data:'v -> 'acc -> 'extra -> 'acc)
-> remove:(key:'k -> data:'v -> 'acc -> 'extra -> 'acc)
-> extra_changed:
(old_extra:'extra
-> new_extra:'extra
-> input:('k, 'v, 'e) Map.t
-> 'acc
-> 'acc)
-> 'acc Incr.t
val cutoff
: ?instrumentation:Instrumentation.t
-> ('k, 'v, 'cmp) Map.t Incr.t
-> cutoff:'v Incremental.Cutoff.t
-> ('k, 'v, 'cmp) Map.t Incr.t
val mapi_count
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('k1, 'v, 'cmp1) Map.t Incr.t
-> comparator:('k2, 'cmp2) Comparator.Module.t
-> f:(key:'k1 -> data:'v -> 'k2)
-> ('k2, int, 'cmp2) Map.t Incr.t
val map_count
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('k1, 'v, 'cmp1) Map.t Incr.t
-> comparator:('k2, 'cmp2) Comparator.Module.t
-> f:('v -> 'k2)
-> ('k2, int, 'cmp2) Map.t Incr.t
val mapi_min
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('k, 'v, _) Map.t Incr.t
-> comparator:('r, _) Comparator.Module.t
-> f:(key:'k -> data:'v -> 'r)
-> 'r option Incr.t
val mapi_max
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('k, 'v, _) Map.t Incr.t
-> comparator:('r, _) Comparator.Module.t
-> f:(key:'k -> data:'v -> 'r)
-> 'r option Incr.t
val map_min
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('k, 'v, _) Map.t Incr.t
-> comparator:('r, _) Comparator.Module.t
-> f:('v -> 'r)
-> 'r option Incr.t
val map_max
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('k, 'v, _) Map.t Incr.t
-> comparator:('r, _) Comparator.Module.t
-> f:('v -> 'r)
-> 'r option Incr.t
val min_value
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('k, 'v, _) Map.t Incr.t
-> comparator:('v, _) Comparator.Module.t
-> 'v option Incr.t
val max_value
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('k, 'v, _) Map.t Incr.t
-> comparator:('v, _) Comparator.Module.t
-> 'v option Incr.t
val mapi_bounds
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('k, 'v, _) Map.t Incr.t
-> comparator:('r, _) Comparator.Module.t
-> f:(key:'k -> data:'v -> 'r)
-> ('r * 'r) option Incr.t
val map_bounds
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('k, 'v, _) Map.t Incr.t
-> comparator:('r, _) Comparator.Module.t
-> f:('v -> 'r)
-> ('r * 'r) option Incr.t
val value_bounds
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('k, 'v, _) Map.t Incr.t
-> comparator:('v, _) Comparator.Module.t
-> ('v * 'v) option Incr.t
val merge
: ?instrumentation:Instrumentation.t
-> ?data_equal_left:('v1 -> 'v1 -> bool)
-> ?data_equal_right:('v2 -> 'v2 -> bool)
-> ('k, 'v1, 'cmp) Map.t Incr.t
-> ('k, 'v2, 'cmp) Map.t Incr.t
-> f:(key:'k -> ('v1, 'v2) Map.Merge_element.t -> 'v3 option)
-> ('k, 'v3, 'cmp) Map.t Incr.t
val merge_both_some
: ?instrumentation:Instrumentation.t
-> ?data_equal_left:('v1 -> 'v1 -> bool)
-> ?data_equal_right:('v2 -> 'v2 -> bool)
-> ?out_equal:('v3 -> 'v3 -> bool)
-> ('k, 'v1, 'cmp) Map.t Incr.t
-> ('k, 'v2, 'cmp) Map.t Incr.t
-> f:(key:'k -> 'v1 -> 'v2 -> 'v3)
-> ('k, 'v3, 'cmp) Map.t Incr.t
val merge_disjoint
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('k, 'v, 'cmp) Map.t Incr.t
-> ('k, 'v, 'cmp) Map.t Incr.t
-> ('k, 'v, 'cmp) Map.t Incr.t
val unzip
: ?instrumentation:Instrumentation.t
-> ?left_result_equal:('v1 -> 'v1 -> bool)
-> ?right_result_equal:('v2 -> 'v2 -> bool)
-> ('k, 'v1 * 'v2, 'cmp) Map.t Incr.t
-> ('k, 'v1, 'cmp) Map.t Incr.t * ('k, 'v2, 'cmp) Map.t Incr.t
val unzip_mapi
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ?left_result_equal:('v1 -> 'v1 -> bool)
-> ?right_result_equal:('v2 -> 'v2 -> bool)
-> ('k, 'v, 'cmp) Map.t Incr.t
-> f:(key:'k -> data:'v -> 'v1 * 'v2)
-> ('k, 'v1, 'cmp) Map.t Incr.t * ('k, 'v2, 'cmp) Map.t Incr.t
val unzip_mapi'
: ?instrumentation:Instrumentation.t
-> ?cutoff:'v Incr.Cutoff.t
-> ?data_equal:('v -> 'v -> bool)
-> ('k, 'v, 'cmp) Map.t Incr.t
-> f:(key:'k -> data:'v Incr.t -> 'v1 Incr.t * 'v2 Incr.t)
-> ('k, 'v1, 'cmp) Map.t Incr.t * ('k, 'v2, 'cmp) Map.t Incr.t
val merge'
: ?instrumentation:Instrumentation.t
-> ?cutoff:('v1, 'v2) Map.Merge_element.t Incr.Cutoff.t
-> ?data_equal_left:('v1 -> 'v1 -> bool)
-> ?data_equal_right:('v2 -> 'v2 -> bool)
-> ('k, 'v1, 'cmp) Map.t Incr.t
-> ('k, 'v2, 'cmp) Map.t Incr.t
-> f:(key:'k -> ('v1, 'v2) Map.Merge_element.t Incr.t -> 'v3 option Incr.t)
-> ('k, 'v3, 'cmp) Map.t Incr.t
val flatten : ('k, 'v Incr.t, 'cmp) Map.t -> ('k, 'v, 'cmp) Map.t Incr.t
val join
: ?instrumentation:Instrumentation.t
-> ('k, 'v Incr.t, 'cmp) Map.t Incr.t
-> ('k, 'v, 'cmp) Map.t Incr.t
val separate
: ?instrumentation:Instrumentation.t
-> ('k, 'v, 'cmp) Map.t Incr.t
-> data_equal:('v -> 'v -> bool)
-> ('k, 'v Incr.t, 'cmp) Map.t Incr.t
val keys
: ?instrumentation:Instrumentation.t
-> ('k, 'v, 'c) Map.t Incr.t
-> ('k, 'c) Set.t Incr.t
val rank
: ?instrumentation:Instrumentation.t
-> ('k, 'v, 'cmp) Base.Map.t Incr.t
-> 'k Incr.t
-> int option Incr.t
val subrange
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('k, 'v, 'cmp) Map.t Incr.t
-> ('k Maybe_bound.As_lower_bound.t * 'k Maybe_bound.As_upper_bound.t) option Incr.t
-> ('k, 'v, 'cmp) Map.t Incr.t
val subrange_by_rank
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('k, 'v, 'cmp) Map.t Incr.t
-> (int Maybe_bound.As_lower_bound.t * int Maybe_bound.As_upper_bound.t) Incr.t
-> ('k, 'v, 'cmp) Map.t Incr.t
val rekey
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('k1, 'v, 'cmp1) Map.t Incr.t
-> comparator:('k2, 'cmp2) Comparator.Module.t
-> f:(key:'k1 -> data:'v -> 'k2)
-> ('k2, 'v, 'cmp2) Map.t Incr.t
val index_byi
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('inner_key, 'v, 'inner_cmp) Map.t Incr.t
-> comparator:('outer_key, 'outer_cmp) Comparator.Module.t
-> index:(key:'inner_key -> data:'v -> 'outer_key option)
-> ('outer_key, ('inner_key, 'v, 'inner_cmp) Map.t, 'outer_cmp) Map.t Incr.t
val index_by
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('inner_key, 'v, 'inner_cmp) Map.t Incr.t
-> comparator:('outer_key, 'outer_cmp) Comparator.Module.t
-> index:('v -> 'outer_key option)
-> ('outer_key, ('inner_key, 'v, 'inner_cmp) Map.t, 'outer_cmp) Map.t Incr.t
val unordered_fold_nested_maps
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ?revert_to_init_when_empty:bool
-> ?update:
(outer_key:'outer_key
-> inner_key:'inner_key
-> old_data:'v
-> new_data:'v
-> 'acc
-> 'acc)
-> ('outer_key, ('inner_key, 'v, 'inner_cmp) Map.t, 'outer_cmp) Map.t Incr.t
-> init:'acc
-> add:(outer_key:'outer_key -> inner_key:'inner_key -> data:'v -> 'acc -> 'acc)
-> remove:(outer_key:'outer_key -> inner_key:'inner_key -> data:'v -> 'acc -> 'acc)
-> 'acc Incr.t
val transpose
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('k2, 'k2_cmp) Comparator.Module.t
-> ('k1, ('k2, 'v, 'k2_cmp) Map.t, 'k1_cmp) Map.t Incr.t
-> ('k2, ('k1, 'v, 'k1_cmp) Map.t, 'k2_cmp) Map.t Incr.t
val collapse
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('outer_key, ('inner_key, 'v, 'inner_cmp) Map.t, 'outer_cmp) Map.t Incr.t
-> comparator:('inner_key, 'inner_cmp) Comparator.Module.t
-> ( 'outer_key * 'inner_key
, 'v
, ('outer_cmp, 'inner_cmp) Tuple2.comparator_witness )
Map.t
Incr.t
val collapse_by
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('outer_key, ('inner_key, 'v, 'inner_cmp) Map.t, 'outer_cmp) Map.t Incr.t
-> merge_keys:('outer_key -> 'inner_key -> 'combined_key)
-> comparator:('combined_key, 'combined_cmp) Comparator.Module.t
-> ('combined_key, 'v, 'combined_cmp) Map.t Incr.t
val expand
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('outer_key * 'inner_key, 'v, 'tuple_cmp) Map.t Incr.t
-> outer_comparator:('outer_key, 'outer_cmp) Comparator.Module.t
-> inner_comparator:('inner_key, 'inner_cmp) Comparator.Module.t
-> ('outer_key, ('inner_key, 'v, 'inner_cmp) Map.t, 'outer_cmp) Map.t Incr.t
val counti
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('k, 'v, _) Map.t Incr.t
-> f:(key:'k -> data:'v -> bool)
-> int Incr.t
val count
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> (_, 'v, _) Map.t Incr.t
-> f:('v -> bool)
-> int Incr.t
val for_alli
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('k, 'v, _) Map.t Incr.t
-> f:(key:'k -> data:'v -> bool)
-> bool Incr.t
val for_all
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> (_, 'v, _) Map.t Incr.t
-> f:('v -> bool)
-> bool Incr.t
val existsi
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('k, 'v, _) Map.t Incr.t
-> f:(key:'k -> data:'v -> bool)
-> bool Incr.t
val exists
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> (_, 'v, _) Map.t Incr.t
-> f:('v -> bool)
-> bool Incr.t
val sum
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> (_, 'v, _) Map.t Incr.t
-> (module Abstract_algebra.Commutative_group.Without_sexp with type t = 'u)
-> f:('v -> 'u)
-> 'u Incr.t
val observe_changes_exn
: ?data_equal:('v -> 'v -> bool)
-> ('k, 'v, 'cmp) Map.t Incr.t
-> f:(('k, 'v) Map.Symmetric_diff_element.t -> unit)
-> unit
module Lookup : sig
type ('k, 'v, 'cmp) t
val create
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ('k, 'v, 'cmp) Map.t Incr.t
-> comparator:('k, 'cmp) Comparator.t
-> ('k, 'v, 'cmp) t
val find : ('k, 'v, _) t -> 'k -> 'v option Incr.t
module M (K : sig
type t
type comparator_witness
end) : sig
type nonrec 'v t = (K.t, 'v, K.comparator_witness) t
end
module For_debug : sig
val sexp_of_t : ('k -> Sexp.t) -> ('v -> Sexp.t) -> ('k, 'v, 'cmp) t -> Sexp.t
end
end
module For_testing : sig
val find_key_range_linear
: from:int
-> to_:int
-> ('a, 'b, 'c) Base.Map.t
-> ('a * 'a option) option
end
end
module type Incr_map = sig
(** Functions for using maps efficiently within Incremental. The goal of the algorithms
here is to do work on the output of the computation proportional to the amount of
work done on the input. i.e., [k] modifications to the input map for some
computation will result in [k] modifications to the output map. The changes to the
input map are typically computed using [Map.symmetric_diff].
Unless stated otherwise, the non-incremental semantics of these functions (i.e..,
ignoring performance) is the same as the corresponding function in Core's [Map]
module. *)
module Instrumentation = Instrumentation
val of_set
: ?instrumentation:Instrumentation.t
-> (('k, 'cmp) Set.t, 'w) Incremental.t
-> (('k, unit, 'cmp) Map.t, 'w) Incremental.t
val filter_mapi
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v1 -> 'v1 -> bool)
-> (('k, 'v1, 'cmp) Map.t, 'w) Incremental.t
-> f:(key:'k -> data:'v1 -> 'v2 option)
-> (('k, 'v2, 'cmp) Map.t, 'w) Incremental.t
val mapi
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v1 -> 'v1 -> bool)
-> (('k, 'v1, 'cmp) Map.t, 'w) Incremental.t
-> f:(key:'k -> data:'v1 -> 'v2)
-> (('k, 'v2, 'cmp) Map.t, 'w) Incremental.t
val filter_map
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v1 -> 'v1 -> bool)
-> (('k, 'v1, 'cmp) Map.t, 'w) Incremental.t
-> f:('v1 -> 'v2 option)
-> (('k, 'v2, 'cmp) Map.t, 'w) Incremental.t
val map
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v1 -> 'v1 -> bool)
-> (('k, 'v1, 'cmp) Map.t, 'w) Incremental.t
-> f:('v1 -> 'v2)
-> (('k, 'v2, 'cmp) Map.t, 'w) Incremental.t
val filter_mapi'
: ?instrumentation:Instrumentation.t
-> ?cutoff:'v1 Incremental.Cutoff.t
-> ?data_equal:('v1 -> 'v1 -> bool)
-> (('k, 'v1, 'cmp) Map.t, 'w) Incremental.t
-> f:(key:'k -> data:('v1, 'w) Incremental.t -> ('v2 option, 'w) Incremental.t)
-> (('k, 'v2, 'cmp) Map.t, 'w) Incremental.t
val map'
: ?instrumentation:Instrumentation.t
-> ?cutoff:'v1 Incremental.Cutoff.t
-> ?data_equal:('v1 -> 'v1 -> bool)
-> (('k, 'v1, 'cmp) Map.t, 'w) Incremental.t
-> f:(('v1, 'w) Incremental.t -> ('v2, 'w) Incremental.t)
-> (('k, 'v2, 'cmp) Map.t, 'w) Incremental.t
val filter_map'
: ?instrumentation:Instrumentation.t
-> ?cutoff:'v1 Incremental.Cutoff.t
-> ?data_equal:('v1 -> 'v1 -> bool)
-> (('k, 'v1, 'cmp) Map.t, 'w) Incremental.t
-> f:(('v1, 'w) Incremental.t -> ('v2 option, 'w) Incremental.t)
-> (('k, 'v2, 'cmp) Map.t, 'w) Incremental.t
val mapi'
: ?instrumentation:Instrumentation.t
-> ?cutoff:'v1 Incremental.Cutoff.t
-> ?data_equal:('v1 -> 'v1 -> bool)
-> (('k, 'v1, 'cmp) Map.t, 'w) Incremental.t
-> f:(key:'k -> data:('v1, 'w) Incremental.t -> ('v2, 'w) Incremental.t)
-> (('k, 'v2, 'cmp) Map.t, 'w) Incremental.t
val partition_mapi
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v1 -> 'v1 -> bool)
-> (('k, 'v1, 'cmp) Map.t, 'w) Incremental.t
-> f:(key:'k -> data:'v1 -> ('v2, 'v3) Either.t)
-> (('k, 'v2, 'cmp) Map.t * ('k, 'v3, 'cmp) Map.t, 'w) Incremental.t
val partition_mapi'
: ?instrumentation:Instrumentation.t
-> ?cutoff:'v1 Incremental.Cutoff.t
-> ?data_equal:('v1 -> 'v1 -> bool)
-> (('k, 'v1, 'cmp) Map.t, 'w) Incremental.t
-> f:
(key:'k
-> data:('v1, 'w) Incremental.t
-> (('v2, 'v3) Either.t, 'w) Incremental.t)
-> (('k, 'v2, 'cmp) Map.t * ('k, 'v3, 'cmp) Map.t, 'w) Incremental.t
(** [unordered_fold i ~init ~add ~remove] constructs a more incremental version of:
{[
let%map m = i in
Map.fold m ~init ~f:add
]}
assuming that [remove] is the inverse of [add], and that the operations for
different keys can be performed in any order. Note that [data_equal] defaults
to [phys_equal], but a more precise equality can be provided instead.
When the data for a key updates, by default [remove] is called on the old data
and then [add] is called on the new data.
[update] provides an alternative single function to call each time a key's data
updates, and can be used to improve efficiency.
For the initial computation, by default [add] is called on all the elements in the
map. As this can be inefficient, [specialized_initial] can be provided to perform
the computation in a more effective way.
If [revert_to_init_when_empty] is true, then if the input map transitions from
being full to empty, then instead of calling [remove] on every kv-pair, it will
instead just set the output to whatever you've passed as [init].
The default value of [revert_to_init_when_empty] is [false], so this optimization
does not apply automatically.
[finalize] defaults to [Fn.id] is called immediately before the accumulator value
is stored and returned during stabilization. You can use it to e.g. process the
fold operations in a different order. *)
val unordered_fold
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ?update:(key:'k -> old_data:'v -> new_data:'v -> 'acc -> 'acc)
-> ?specialized_initial:(init:'acc -> ('k, 'v, 'cmp) Map.t -> 'acc)
-> ?finalize:('acc -> 'acc)
-> ?revert_to_init_when_empty:bool
-> (('k, 'v, 'cmp) Map.t, 'w) Incremental.t
-> init:'acc
-> add:(key:'k -> data:'v -> 'acc -> 'acc)
-> remove:(key:'k -> data:'v -> 'acc -> 'acc)
-> ('acc, 'w) Incremental.t
(** [unordered_fold_with_extra] is similar to [unordered_fold], but it also
depends on another arbitrary incremental value which can be factored into
the folding computation. *)
val unordered_fold_with_extra
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ?extra_equal:('extra -> 'extra -> bool)
-> ?update:(key:'k -> old_data:'v -> new_data:'v -> 'acc -> 'extra -> 'acc)
-> ?specialized_initial:(init:'acc -> ('k, 'v, 'e) Map.t -> 'extra -> 'acc)
-> ?finalize:('acc -> 'acc)
-> ?revert_to_init_when_empty:bool
-> (('k, 'v, 'e) Map.t, 'w) Incremental.t
-> ('extra, 'w) Incremental.t
-> init:'acc
-> add:(key:'k -> data:'v -> 'acc -> 'extra -> 'acc)
-> remove:(key:'k -> data:'v -> 'acc -> 'extra -> 'acc)
-> extra_changed:
(old_extra:'extra
-> new_extra:'extra
-> input:('k, 'v, 'e) Map.t
-> 'acc
-> 'acc)
-> ('acc, 'w) Incremental.t
(** [cutoff] applies a cutoff to values in the map as they pass through the
function. It has the same behavior as calling [Incr_map.map'] with an
[Incr.set_cutoff] inside, but with considerably better performance and
memory usage. *)
val cutoff
: ?instrumentation:Instrumentation.t
-> (('k, 'v, 'cmp) Map.t, 'w) Incremental.t
-> cutoff:'v Incremental.Cutoff.t
-> (('k, 'v, 'cmp) Map.t, 'w) Incremental.t
(** Given an input map and a function mapping a kv-pair to a new
value, [mapi_count] will compute a multi-set keyed on that
new value.
Any value that would otherwise have a count of "0" is instead
removed from the map.
It is assumed that [f] is quite fast as the function will be
called more often than strictly necessary, but it does this
in order to avoid allocating an extra map. If [f] is very slow
and you don't mind the extra allocations, use
[Incr_map.index_byi] composed with [Incr_map.map ~f:Map.length] *)
val mapi_count
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> (('k1, 'v, 'cmp1) Map.t, 'w) Incremental.t
-> comparator:('k2, 'cmp2) Comparator.Module.t
-> f:(key:'k1 -> data:'v -> 'k2)
-> (('k2, int, 'cmp2) Map.t, 'w) Incremental.t
(** The same as [mapi_count] but the [f] function only gets to see the
data instead of both the key and the data. *)
val map_count
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> (('k1, 'v, 'cmp1) Map.t, 'w) Incremental.t
-> comparator:('k2, 'cmp2) Comparator.Module.t
-> f:('v -> 'k2)
-> (('k2, int, 'cmp2) Map.t, 'w) Incremental.t
(** Computes the smallest [r] where [r] is computed for each kv-pair in the
input map. *)
val mapi_min
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> (('k, 'v, _) Map.t, 'w) Incremental.t
-> comparator:('r, _) Comparator.Module.t
-> f:(key:'k -> data:'v -> 'r)
-> ('r option, 'w) Incremental.t
(** Computes the largest [r] where [r] is computed for each kv-pair in the
input map. *)
val mapi_max
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> (('k, 'v, _) Map.t, 'w) Incremental.t
-> comparator:('r, _) Comparator.Module.t
-> f:(key:'k -> data:'v -> 'r)
-> ('r option, 'w) Incremental.t
(** Computes the smallest [r] where [r] is computed for each kv-pair in the
input map. *)
val map_min
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> (('k, 'v, _) Map.t, 'w) Incremental.t
-> comparator:('r, _) Comparator.Module.t
-> f:('v -> 'r)
-> ('r option, 'w) Incremental.t
(** Computes the largest [r] where [r] is computed for each kv-pair in the
input map. *)
val map_max
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> (('k, 'v, _) Map.t, 'w) Incremental.t
-> comparator:('r, _) Comparator.Module.t
-> f:('v -> 'r)
-> ('r option, 'w) Incremental.t
(** Computes the smallest data value from the input map. *)
val min_value
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> (('k, 'v, _) Map.t, 'w) Incremental.t
-> comparator:('v, _) Comparator.Module.t
-> ('v option, 'w) Incremental.t
(** Computes the largest data value from the input map. *)
val max_value
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> (('k, 'v, _) Map.t, 'w) Incremental.t
-> comparator:('v, _) Comparator.Module.t
-> ('v option, 'w) Incremental.t
(** Computes [min * max] where the value is computed for each kv-pair
in the input map *)
val mapi_bounds
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> (('k, 'v, _) Map.t, 'w) Incremental.t
-> comparator:('r, _) Comparator.Module.t
-> f:(key:'k -> data:'v -> 'r)
-> (('r * 'r) option, 'w) Incremental.t
(** Computes [min * max] where the value is computed for each kv-pair
in the input map *)
val map_bounds
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> (('k, 'v, _) Map.t, 'w) Incremental.t
-> comparator:('r, _) Comparator.Module.t
-> f:('v -> 'r)
-> (('r * 'r) option, 'w) Incremental.t
(** Computes the smallest and largest data value from the input map. *)
val value_bounds
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> (('k, 'v, _) Map.t, 'w) Incremental.t
-> comparator:('v, _) Comparator.Module.t
-> (('v * 'v) option, 'w) Incremental.t
(** Like [merge] in [Base.Map.merge]. Note that [f] is called at most once per key in
any given stabilization. *)
val merge
: ?instrumentation:Instrumentation.t
-> ?data_equal_left:('v1 -> 'v1 -> bool)
-> ?data_equal_right:('v2 -> 'v2 -> bool)
-> (('k, 'v1, 'cmp) Map.t, 'w) Incremental.t
-> (('k, 'v2, 'cmp) Map.t, 'w) Incremental.t
-> f:(key:'k -> ('v1, 'v2) Map.Merge_element.t -> 'v3 option)
-> (('k, 'v3, 'cmp) Map.t, 'w) Incremental.t
(** [merge_both_same] is like [merge], but optimized for the case where you only care
about the case where both maps contain a particular key. *)
val merge_both_some
: ?instrumentation:Instrumentation.t
-> ?data_equal_left:('v1 -> 'v1 -> bool)
-> ?data_equal_right:('v2 -> 'v2 -> bool)
-> ?out_equal:('v3 -> 'v3 -> bool)
-> (('k, 'v1, 'cmp) Map.t, 'w) Incremental.t
-> (('k, 'v2, 'cmp) Map.t, 'w) Incremental.t
-> f:(key:'k -> 'v1 -> 'v2 -> 'v3)
-> (('k, 'v3, 'cmp) Map.t, 'w) Incremental.t
(** [merge_disjoint] merges two maps that _must_ not share any keys on a given
stabilization. If this invariant is not upheld by the caller, incremental may
crash, or the output map may contain incorrect results. *)
val merge_disjoint
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> (('k, 'v, 'cmp) Map.t, 'w) Incremental.t
-> (('k, 'v, 'cmp) Map.t, 'w) Incremental.t
-> (('k, 'v, 'cmp) Map.t, 'w) Incremental.t
(** Like [merge], but operating using incremental nodes. This is a good use case for
[ppx_pattern_bind]. *)
val merge'
: ?instrumentation:Instrumentation.t
-> ?cutoff:('v1, 'v2) Map.Merge_element.t Incremental.Cutoff.t
-> ?data_equal_left:('v1 -> 'v1 -> bool)
-> ?data_equal_right:('v2 -> 'v2 -> bool)
-> (('k, 'v1, 'cmp) Map.t, 'w) Incremental.t
-> (('k, 'v2, 'cmp) Map.t, 'w) Incremental.t
-> f:
(key:'k
-> (('v1, 'v2) Map.Merge_element.t, 'w) Incremental.t
-> ('v3 option, 'w) Incremental.t)
-> (('k, 'v3, 'cmp) Map.t, 'w) Incremental.t
val unzip
: ?instrumentation:Instrumentation.t
-> ?left_result_equal:('a -> 'a -> bool)
-> ?right_result_equal:('b -> 'b -> bool)
-> (('k, 'a * 'b, 'cmp) Map.t, 'w) Incremental.t
-> (('k, 'a, 'cmp) Map.t, 'w) Incremental.t * (('k, 'b, 'cmp) Map.t, 'w) Incremental.t
(** [unzip_mapi] is similar to [List.unzip], but for incremental maps. Note that [f] may
be called multiple times on a single element. *)
val unzip_mapi
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> ?left_result_equal:('v1 -> 'v1 -> bool)
-> ?right_result_equal:('v2 -> 'v2 -> bool)
-> (('k, 'v, 'cmp) Map.t, 'w) Incremental.t
-> f:(key:'k -> data:'v -> 'v1 * 'v2)
-> (('k, 'v1, 'cmp) Map.t, 'w) Incremental.t
* (('k, 'v2, 'cmp) Map.t, 'w) Incremental.t
(** [unzip_mapi'] is like [unzip_mapi], but allows you to define the mapping from the
input map's elements to the output maps' elements incrementally.
The naive implementation (see below) produces worse Incremental graphs.
{[
let temp =
Incr_map.mapi' input ~f:(fun ~key ~data ->
f ~key ~data |> Tuple2.uncurry Incr.both)
in
let left = Incr_map.map temp ~f:Tuple2.get1 in
let right = Incr_map.map temp ~f:Tuple2.get2 in
left, right
]} *)
val unzip_mapi'
: ?instrumentation:Instrumentation.t
-> ?cutoff:'v Incremental.Cutoff.t
-> ?data_equal:('v -> 'v -> bool)
-> (('k, 'v, 'cmp) Map.t, 'w) Incremental.t
-> f:
(key:'k
-> data:('v, 'w) Incremental.t
-> ('v1, 'w) Incremental.t * ('v2, 'w) Incremental.t)
-> (('k, 'v1, 'cmp) Map.t, 'w) Incremental.t
* (('k, 'v2, 'cmp) Map.t, 'w) Incremental.t
(** This is the "easy" version of [join] *)
val flatten
: 'w Incremental.State.t
-> ('k, ('v, 'w) Incremental.t, 'cmp) Map.t
-> (('k, 'v, 'cmp) Map.t, 'w) Incremental.t
(** The non-incremental semantics of this function is the identity function. Its
purpose is to collapse the extra level of incrementality at the level of the data of
the map.*)
val join
: ?instrumentation:Instrumentation.t
-> (('k, ('v, 'w) Incremental.t, 'cmp) Map.t, 'w) Incremental.t
-> (('k, 'v, 'cmp) Map.t, 'w) Incremental.t
val separate
: ?instrumentation:Instrumentation.t
-> (('k, 'v, 'cmp) Map.t, 'w) Incremental.t
-> data_equal:('v -> 'v -> bool)
-> (('k, ('v, 'w) Incremental.t, 'cmp) Map.t, 'w) Incremental.t
val keys
: ?instrumentation:Instrumentation.t
-> (('k, 'v, 'c) Map.t, 'w) Incremental.t
-> (('k, 'c) Set.t, 'w) Incremental.t
(** Computes the [rank] of a key (given incrementally) inside of a map (also
incremental). The traditional [Map.rank] function is O(n), and this incremental
rank function has the following performance characteristics:
definitions:
n : the size of the map
r : the time to compute [Map.symmetric_diff] between the two maps
k : the change in rank of the key between two stabilizations
note that [r] and [k] are _much_ smaller than [n] for most practical purposes
- O(log n) when the key is not in the map.
This takes precedence over other every other scenario.
- O(n) on the initial stabilization
- O(n) when the key transitions from not being in the map to being in the map
- O(log n + r) when the map changes
- O(log n + k) when the key changes
- O(log n + r + k) when both key and map change *)
val rank
: ?instrumentation:Instrumentation.t
-> (('k, 'v, 'cmp) Base.Map.t, 'state_witness) Incremental.t
-> ('k, 'state_witness) Incremental.t
-> (int option, 'state_witness) Incremental.t
(** [subrange map (min, max)] constructs an incremental submap that includes all of the
keys and data from [map] between [min] and [max], and none of the keys outside the
range.
[subrange map None] is the empty map. [range] being [None] means no elements are
chosen.
Note that incremental changes have a runtime of O((k + m) log n) where k is the size
of the changes to the underlying map and m is the size of the changes to the
elements contained by the range. The complexity of the initial computation is the
same as the incremental computation, with some simplification. k = 0 because we have
not made any changes to the underlying map yet, and m equals the size of the range,
because the initial range is empty. *)
val subrange
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> (('k, 'v, 'cmp) Map.t, 'w) Incremental.t
-> ( ('k Maybe_bound.As_lower_bound.t * 'k Maybe_bound.As_upper_bound.t) option
, 'w )
Incremental.t
-> (('k, 'v, 'cmp) Map.t, 'w) Incremental.t
(** [subrange_by_rank map (s, e)] constructs an incremental submap that includes (e-s+1)
keys between s-th and e-th, inclusive.
If s is greater or equal to map length, the result is empty.
If e is greater or equal to map length, the result contains keys from s-th to the
last one.
Raises for invalid indices - s < 0 or e < s.
Runtime of the initial computation is O(min(e, n-s) + log(n)), i.e. linear,
but optimized for ranges close to beginning or end.
Runtime of the incremental computation is O(log(n) + k + (m+m') * log(n)) where:
- k is the size of the diff
- m is the total impact of map changes on the range, bounded by k (e.g. if we add
1001 keys and remove 1000 below s, then m = 1)
- m' = O( |new s - old s| + |new e - old e| ).
*)
val subrange_by_rank
: ?instrumentation:Instrumentation.t
-> ?data_equal:('v -> 'v -> bool)
-> (('k, 'v, 'cmp) Map.t, 'w) Incremental.t
-> ( int Maybe_bound.As_lower_bound.t * int Maybe_bound.As_upper_bound.t
, 'w )
Incremental.t
-> (('k, 'v, 'cmp) Map.t, 'w) Incremental.t
(** [rekey] transforms a map by modifying the type of the key. The user is
responsible for ensuring that [f] doesn't return the same output key for
multiple input keys.
This function assumes [f] is cheap to compute and accordingly may call