<!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 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="Arg_helper" rel="Chapter" href="Arg_helper.html"> <link title="Array" rel="Chapter" href="Array.html"> <link title="ArrayLabels" rel="Chapter" href="ArrayLabels.html"> <link title="Ast_helper" rel="Chapter" href="Ast_helper.html"> <link title="Ast_invariants" rel="Chapter" href="Ast_invariants.html"> <link title="Ast_iterator" rel="Chapter" href="Ast_iterator.html"> <link title="Ast_mapper" rel="Chapter" href="Ast_mapper.html"> <link title="Asttypes" rel="Chapter" href="Asttypes.html"> <link title="Attr_helper" rel="Chapter" href="Attr_helper.html"> <link title="Bigarray" rel="Chapter" href="Bigarray.html"> <link title="Buffer" rel="Chapter" href="Buffer.html"> <link title="Build_path_prefix_map" rel="Chapter" href="Build_path_prefix_map.html"> <link title="Builtin_attributes" rel="Chapter" href="Builtin_attributes.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="Ccomp" rel="Chapter" href="Ccomp.html"> <link title="Char" rel="Chapter" href="Char.html"> <link title="Clflags" rel="Chapter" href="Clflags.html"> <link title="Complex" rel="Chapter" href="Complex.html"> <link title="Condition" rel="Chapter" href="Condition.html"> <link title="Config" rel="Chapter" href="Config.html"> <link title="Consistbl" rel="Chapter" href="Consistbl.html"> <link title="Depend" rel="Chapter" href="Depend.html"> <link title="Digest" rel="Chapter" href="Digest.html"> <link title="Docstrings" rel="Chapter" href="Docstrings.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="Gc" rel="Chapter" href="Gc.html"> <link title="Genlex" rel="Chapter" href="Genlex.html"> <link title="Graphics" rel="Chapter" href="Graphics.html"> <link title="GraphicsX11" rel="Chapter" href="GraphicsX11.html"> <link title="Hashtbl" rel="Chapter" href="Hashtbl.html"> <link title="Identifiable" rel="Chapter" href="Identifiable.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="Lexer" rel="Chapter" href="Lexer.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="Location" rel="Chapter" href="Location.html"> <link title="Longident" rel="Chapter" href="Longident.html"> <link title="Map" rel="Chapter" href="Map.html"> <link title="Marshal" rel="Chapter" href="Marshal.html"> <link title="Misc" rel="Chapter" href="Misc.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="Numbers" rel="Chapter" href="Numbers.html"> <link title="Obj" rel="Chapter" href="Obj.html"> <link title="Oo" rel="Chapter" href="Oo.html"> <link title="Parse" rel="Chapter" href="Parse.html"> <link title="Parser" rel="Chapter" href="Parser.html"> <link title="Parsetree" rel="Chapter" href="Parsetree.html"> <link title="Parsing" rel="Chapter" href="Parsing.html"> <link title="Pervasives" rel="Chapter" href="Pervasives.html"> <link title="Pparse" rel="Chapter" href="Pparse.html"> <link title="Pprintast" rel="Chapter" href="Pprintast.html"> <link title="Printast" rel="Chapter" href="Printast.html"> <link title="Printexc" rel="Chapter" href="Printexc.html"> <link title="Printf" rel="Chapter" href="Printf.html"> <link title="Profile" rel="Chapter" href="Profile.html"> <link title="Queue" rel="Chapter" href="Queue.html"> <link title="Random" rel="Chapter" href="Random.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="Simplif" rel="Chapter" href="Simplif.html"> <link title="Sort" rel="Chapter" href="Sort.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="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="Strongly_connected_components" rel="Chapter" href="Strongly_connected_components.html"> <link title="Syntaxerr" rel="Chapter" href="Syntaxerr.html"> <link title="Sys" rel="Chapter" href="Sys.html"> <link title="Targetint" rel="Chapter" href="Targetint.html"> <link title="Tbl" rel="Chapter" href="Tbl.html"> <link title="Terminfo" rel="Chapter" href="Terminfo.html"> <link title="Thread" rel="Chapter" href="Thread.html"> <link title="ThreadUnix" rel="Chapter" href="ThreadUnix.html"> <link title="Typemod" rel="Chapter" href="Typemod.html"> <link title="Uchar" rel="Chapter" href="Uchar.html"> <link title="Unix" rel="Chapter" href="Unix.html"> <link title="UnixLabels" rel="Chapter" href="UnixLabels.html"> <link title="Warnings" rel="Chapter" href="Warnings.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>