1Ephemeron.K2.MakeSeeded(3)       OCaml library      Ephemeron.K2.MakeSeeded(3)
2
3
4

NAME

6       Ephemeron.K2.MakeSeeded  - Functor building an implementation of a weak
7       hash table.
8

Module

10       Module   Ephemeron.K2.MakeSeeded
11

Documentation

13       Module MakeSeeded
14        : functor (H1 : Hashtbl.SeededHashedType) (H2 :  Hashtbl.SeededHashed‐
15       Type) -> sig end
16
17
18       Functor  building  an implementation of a weak hash table.  The seed is
19       similar to the one of Hashtbl.MakeSeeded .
20
21
22       Parameters:
23
24       "H1"
25
26       Stdlib.Hashtbl.SeededHashedType
27
28
29
30       "H2"
31
32       Stdlib.Hashtbl.SeededHashedType
33
34
35
36
37
38
39
40       type key
41
42
43
44
45       type 'a t
46
47
48
49
50
51       val create : ?random:bool -> int -> 'a t
52
53
54
55
56       val clear : 'a t -> unit
57
58
59
60
61       val reset : 'a t -> unit
62
63
64
65
66       val copy : 'a t -> 'a t
67
68
69
70
71       val add : 'a t -> key -> 'a -> unit
72
73
74
75
76       val remove : 'a t -> key -> unit
77
78
79
80
81       val find : 'a t -> key -> 'a
82
83
84
85
86       val find_opt : 'a t -> key -> 'a option
87
88
89
90
91       val find_all : 'a t -> key -> 'a list
92
93
94
95
96       val replace : 'a t -> key -> 'a -> unit
97
98
99
100
101       val mem : 'a t -> key -> bool
102
103
104
105
106       val iter : (key -> 'a -> unit) -> 'a t -> unit
107
108
109
110
111       val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
112
113
114
115
116       val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
117
118
119
120
121       val length : 'a t -> int
122
123
124
125
126       val stats : 'a t -> Hashtbl.statistics
127
128
129
130
131       val to_seq : 'a t -> (key * 'a) Seq.t
132
133
134
135
136       val to_seq_keys : 'a t -> key Seq.t
137
138
139
140
141       val to_seq_values : 'a t -> 'a Seq.t
142
143
144
145
146       val add_seq : 'a t -> (key * 'a) Seq.t -> unit
147
148
149
150
151       val replace_seq : 'a t -> (key * 'a) Seq.t -> unit
152
153
154
155
156       val of_seq : (key * 'a) Seq.t -> 'a t
157
158
159
160
161       val clean : 'a t -> unit
162
163       remove all dead bindings. Done automatically during automatic resizing.
164
165
166
167       val stats_alive : 'a t -> Hashtbl.statistics
168
169       same as Hashtbl.SeededS.stats but only count the alive bindings
170
171
172
173
174
175OCamldoc                          2022-07-22        Ephemeron.K2.MakeSeeded(3)