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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="Start" href="index.html">
<link rel="next" href="Ephemeron.K2.html">
<link rel="Up" href="Ephemeron.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of extensions" rel=Appendix href="index_extensions.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Arg" rel="Chapter" href="Arg.html">
<link title="Array" rel="Chapter" href="Array.html">
<link title="ArrayLabels" rel="Chapter" href="ArrayLabels.html">
<link title="Bigarray" rel="Chapter" href="Bigarray.html">
<link title="Bool" rel="Chapter" href="Bool.html">
<link title="Buffer" rel="Chapter" href="Buffer.html">
<link title="Bytes" rel="Chapter" href="Bytes.html">
<link title="BytesLabels" rel="Chapter" href="BytesLabels.html">
<link title="Callback" rel="Chapter" href="Callback.html">
<link title="CamlinternalFormat" rel="Chapter" href="CamlinternalFormat.html">
<link title="CamlinternalFormatBasics" rel="Chapter" href="CamlinternalFormatBasics.html">
<link title="CamlinternalLazy" rel="Chapter" href="CamlinternalLazy.html">
<link title="CamlinternalMod" rel="Chapter" href="CamlinternalMod.html">
<link title="CamlinternalOO" rel="Chapter" href="CamlinternalOO.html">
<link title="Char" rel="Chapter" href="Char.html">
<link title="Complex" rel="Chapter" href="Complex.html">
<link title="Condition" rel="Chapter" href="Condition.html">
<link title="Digest" rel="Chapter" href="Digest.html">
<link title="Dynlink" rel="Chapter" href="Dynlink.html">
<link title="Ephemeron" rel="Chapter" href="Ephemeron.html">
<link title="Event" rel="Chapter" href="Event.html">
<link title="Filename" rel="Chapter" href="Filename.html">
<link title="Float" rel="Chapter" href="Float.html">
<link title="Format" rel="Chapter" href="Format.html">
<link title="Fun" rel="Chapter" href="Fun.html">
<link title="Gc" rel="Chapter" href="Gc.html">
<link title="Genlex" rel="Chapter" href="Genlex.html">
<link title="Hashtbl" rel="Chapter" href="Hashtbl.html">
<link title="Int" rel="Chapter" href="Int.html">
<link title="Int32" rel="Chapter" href="Int32.html">
<link title="Int64" rel="Chapter" href="Int64.html">
<link title="Lazy" rel="Chapter" href="Lazy.html">
<link title="Lexing" rel="Chapter" href="Lexing.html">
<link title="List" rel="Chapter" href="List.html">
<link title="ListLabels" rel="Chapter" href="ListLabels.html">
<link title="Map" rel="Chapter" href="Map.html">
<link title="Marshal" rel="Chapter" href="Marshal.html">
<link title="MoreLabels" rel="Chapter" href="MoreLabels.html">
<link title="Mutex" rel="Chapter" href="Mutex.html">
<link title="Nativeint" rel="Chapter" href="Nativeint.html">
<link title="Obj" rel="Chapter" href="Obj.html">
<link title="Ocaml_operators" rel="Chapter" href="Ocaml_operators.html">
<link title="Oo" rel="Chapter" href="Oo.html">
<link title="Option" rel="Chapter" href="Option.html">
<link title="Parsing" rel="Chapter" href="Parsing.html">
<link title="Printexc" rel="Chapter" href="Printexc.html">
<link title="Printf" rel="Chapter" href="Printf.html">
<link title="Queue" rel="Chapter" href="Queue.html">
<link title="Random" rel="Chapter" href="Random.html">
<link title="Result" rel="Chapter" href="Result.html">
<link title="Scanf" rel="Chapter" href="Scanf.html">
<link title="Seq" rel="Chapter" href="Seq.html">
<link title="Set" rel="Chapter" href="Set.html">
<link title="Spacetime" rel="Chapter" href="Spacetime.html">
<link title="Stack" rel="Chapter" href="Stack.html">
<link title="StdLabels" rel="Chapter" href="StdLabels.html">
<link title="Stdlib" rel="Chapter" href="Stdlib.html">
<link title="Str" rel="Chapter" href="Str.html">
<link title="Stream" rel="Chapter" href="Stream.html">
<link title="String" rel="Chapter" href="String.html">
<link title="StringLabels" rel="Chapter" href="StringLabels.html">
<link title="Sys" rel="Chapter" href="Sys.html">
<link title="Thread" rel="Chapter" href="Thread.html">
<link title="ThreadUnix" rel="Chapter" href="ThreadUnix.html">
<link title="Uchar" rel="Chapter" href="Uchar.html">
<link title="Unit" rel="Chapter" href="Unit.html">
<link title="Unix" rel="Chapter" href="Unix.html">
<link title="UnixLabels" rel="Chapter" href="UnixLabels.html">
<link title="Weak" rel="Chapter" href="Weak.html"><title>Ephemeron.K1</title>
</head>
<body>
<div class="navbar"> <a class="up" href="Ephemeron.html" title="Ephemeron">Up</a>
<a class="post" href="Ephemeron.K2.html" title="Ephemeron.K2">Next</a>
</div>
<h1>Module <a href="type_Ephemeron.K1.html">Ephemeron.K1</a></h1>
<pre><span id="MODULEK1"><span class="keyword">module</span> K1</span>: <code class="code"><span class="keyword">sig</span></code> <a href="Ephemeron.K1.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><hr width="100%">
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type">('k, 'd)</code> t</span> </pre>
<div class="info ">
<div class="info-desc">
<p>an ephemeron with one key</p>
</div>
</div>
<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">unit -> ('k, 'd) <a href="Ephemeron.K1.html#TYPEt">t</a></code></pre><div class="info ">
<div class="info-desc">
<p><code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.create ()</code> creates an ephemeron with one key. The
data and the key are empty</p>
</div>
</div>
<pre><span id="VALget_key"><span class="keyword">val</span> get_key</span> : <code class="type">('k, 'd) <a href="Ephemeron.K1.html#TYPEt">t</a> -> 'k option</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.get_key eph</code> returns <code class="code"><span class="constructor">None</span></code> if the key of <code class="code">eph</code> is
empty, <code class="code"><span class="constructor">Some</span> x</code> (where <code class="code">x</code> is the key) if it is full.</p>
</div>
</div>
<pre><span id="VALget_key_copy"><span class="keyword">val</span> get_key_copy</span> : <code class="type">('k, 'd) <a href="Ephemeron.K1.html#TYPEt">t</a> -> 'k option</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.get_key_copy eph</code> returns <code class="code"><span class="constructor">None</span></code> if the key of <code class="code">eph</code> is
empty, <code class="code"><span class="constructor">Some</span> x</code> (where <code class="code">x</code> is a (shallow) copy of the key) if
it is full. This function has the same GC friendliness as <a href="Weak.html#VALget_copy"><code class="code"><span class="constructor">Weak</span>.get_copy</code></a></p>
<p>If the element is a custom block it is not copied.</p>
</div>
</div>
<pre><span id="VALset_key"><span class="keyword">val</span> set_key</span> : <code class="type">('k, 'd) <a href="Ephemeron.K1.html#TYPEt">t</a> -> 'k -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.set_key eph el</code> sets the key of <code class="code">eph</code> to be a
(full) key to <code class="code">el</code></p>
</div>
</div>
<pre><span id="VALunset_key"><span class="keyword">val</span> unset_key</span> : <code class="type">('k, 'd) <a href="Ephemeron.K1.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.unset_key eph el</code> sets the key of <code class="code">eph</code> to be an
empty key. Since there is only one key, the ephemeron starts
behaving like a reference on the data.</p>
</div>
</div>
<pre><span id="VALcheck_key"><span class="keyword">val</span> check_key</span> : <code class="type">('k, 'd) <a href="Ephemeron.K1.html#TYPEt">t</a> -> bool</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.check_key eph</code> returns <code class="code"><span class="keyword">true</span></code> if the key of the <code class="code">eph</code>
is full, <code class="code"><span class="keyword">false</span></code> if it is empty. Note that even if
<code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.check_key eph</code> returns <code class="code"><span class="keyword">true</span></code>, a subsequent
<a href="Ephemeron.K1.html#VALget_key"><code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.get_key</code></a><code class="code">eph</code> can return <code class="code"><span class="constructor">None</span></code>.</p>
</div>
</div>
<pre><span id="VALblit_key"><span class="keyword">val</span> blit_key</span> : <code class="type">('k, 'a) <a href="Ephemeron.K1.html#TYPEt">t</a> -> ('k, 'b) <a href="Ephemeron.K1.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.blit_key eph1 eph2</code> sets the key of <code class="code">eph2</code> with
the key of <code class="code">eph1</code>. Contrary to using <a href="Ephemeron.K1.html#VALget_key"><code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.get_key</code></a>
followed by <a href="Ephemeron.K1.html#VALset_key"><code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.set_key</code></a> or <a href="Ephemeron.K1.html#VALunset_key"><code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.unset_key</code></a>
this function does not prevent the incremental GC from erasing
the value in its current cycle.</p>
</div>
</div>
<pre><span id="VALget_data"><span class="keyword">val</span> get_data</span> : <code class="type">('k, 'd) <a href="Ephemeron.K1.html#TYPEt">t</a> -> 'd option</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.get_data eph</code> returns <code class="code"><span class="constructor">None</span></code> if the data of <code class="code">eph</code> is
empty, <code class="code"><span class="constructor">Some</span> x</code> (where <code class="code">x</code> is the data) if it is full.</p>
</div>
</div>
<pre><span id="VALget_data_copy"><span class="keyword">val</span> get_data_copy</span> : <code class="type">('k, 'd) <a href="Ephemeron.K1.html#TYPEt">t</a> -> 'd option</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.get_data_copy eph</code> returns <code class="code"><span class="constructor">None</span></code> if the data of <code class="code">eph</code> is
empty, <code class="code"><span class="constructor">Some</span> x</code> (where <code class="code">x</code> is a (shallow) copy of the data) if
it is full. This function has the same GC friendliness as <a href="Weak.html#VALget_copy"><code class="code"><span class="constructor">Weak</span>.get_copy</code></a></p>
<p>If the element is a custom block it is not copied.</p>
</div>
</div>
<pre><span id="VALset_data"><span class="keyword">val</span> set_data</span> : <code class="type">('k, 'd) <a href="Ephemeron.K1.html#TYPEt">t</a> -> 'd -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.set_data eph el</code> sets the data of <code class="code">eph</code> to be a
(full) data to <code class="code">el</code></p>
</div>
</div>
<pre><span id="VALunset_data"><span class="keyword">val</span> unset_data</span> : <code class="type">('k, 'd) <a href="Ephemeron.K1.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.unset_data eph el</code> sets the key of <code class="code">eph</code> to be an
empty key. The ephemeron starts behaving like a weak pointer.</p>
</div>
</div>
<pre><span id="VALcheck_data"><span class="keyword">val</span> check_data</span> : <code class="type">('k, 'd) <a href="Ephemeron.K1.html#TYPEt">t</a> -> bool</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.check_data eph</code> returns <code class="code"><span class="keyword">true</span></code> if the data of the <code class="code">eph</code>
is full, <code class="code"><span class="keyword">false</span></code> if it is empty. Note that even if
<code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.check_data eph</code> returns <code class="code"><span class="keyword">true</span></code>, a subsequent
<a href="Ephemeron.K1.html#VALget_data"><code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.get_data</code></a><code class="code">eph</code> can return <code class="code"><span class="constructor">None</span></code>.</p>
</div>
</div>
<pre><span id="VALblit_data"><span class="keyword">val</span> blit_data</span> : <code class="type">('a, 'd) <a href="Ephemeron.K1.html#TYPEt">t</a> -> ('b, 'd) <a href="Ephemeron.K1.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.blit_data eph1 eph2</code> sets the data of <code class="code">eph2</code> with
the data of <code class="code">eph1</code>. Contrary to using <a href="Ephemeron.K1.html#VALget_data"><code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.get_data</code></a>
followed by <a href="Ephemeron.K1.html#VALset_data"><code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.set_data</code></a> or <a href="Ephemeron.K1.html#VALunset_data"><code class="code"><span class="constructor">Ephemeron</span>.<span class="constructor">K1</span>.unset_data</code></a>
this function does not prevent the incremental GC from erasing
the value in its current cycle.</p>
</div>
</div>
<pre><span id="MODULEMake"><span class="keyword">module</span> <a href="Ephemeron.K1.Make.html">Make</a></span>: <div class="sig_block"><code class="code"><span class="keyword">functor</span> (</code><code class="code"><span class="constructor">H</span></code><code class="code"> : </code><code class="type"><a href="Hashtbl.HashedType.html">Hashtbl.HashedType</a></code><code class="code">) <span class="keywordsign">-></span> </code><code class="type"><a href="Ephemeron.S.html">Ephemeron.S</a></code><code class="type"> with type key = H.t</code></div></pre><div class="info">
<p>Functor building an implementation of a weak hash table</p>
</div>
<pre><span id="MODULEMakeSeeded"><span class="keyword">module</span> <a href="Ephemeron.K1.MakeSeeded.html">MakeSeeded</a></span>: <div class="sig_block"><code class="code"><span class="keyword">functor</span> (</code><code class="code"><span class="constructor">H</span></code><code class="code"> : </code><code class="type"><a href="Hashtbl.SeededHashedType.html">Hashtbl.SeededHashedType</a></code><code class="code">) <span class="keywordsign">-></span> </code><code class="type"><a href="Ephemeron.SeededS.html">Ephemeron.SeededS</a></code><code class="type"> with type key = H.t</code></div></pre><div class="info">
<p>Functor building an implementation of a weak hash table.</p>
</div>
</body></html>
|
