mirror of
https://github.com/c-cube/moonpool.git
synced 2025-12-17 16:16:48 -05:00
8 lines
No EOL
19 KiB
HTML
8 lines
No EOL
19 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>K2 (ocaml.Stdlib.Ephemeron.K2)</title><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../index.html">ocaml</a> » <a href="../../index.html">Stdlib</a> » <a href="../index.html">Ephemeron</a> » K2</nav><header class="odoc-preamble"><h1>Module <code><span>Ephemeron.K2</span></code></h1><p>Ephemerons with two keys.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>('k1, 'k2, 'd) t</span></span></code></div><div class="spec-doc"><p>an ephemeron with two keys</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span>unit <span class="arrow">-></span></span> <span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-create"><code>Ephemeron.K1.create</code></a></p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> old_ephemeron_api This function won't be available in 5.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_key1"><a href="#val-get_key1" class="anchor"></a><code><span><span class="keyword">val</span> get_key1 : <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'k1</span> option</span></span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-get_key"><code>Ephemeron.K1.get_key</code></a></p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> old_ephemeron_api This function won't be available in 5.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_key1_copy"><a href="#val-get_key1_copy" class="anchor"></a><code><span><span class="keyword">val</span> get_key1_copy : <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'k1</span> option</span></span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-get_key_copy"><code>Ephemeron.K1.get_key_copy</code></a></p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> old_ephemeron_api This function won't be available in 5.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_key1"><a href="#val-set_key1" class="anchor"></a><code><span><span class="keyword">val</span> set_key1 : <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'k1</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-set_key"><code>Ephemeron.K1.set_key</code></a></p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> old_ephemeron_api This function won't be available in 5.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-unset_key1"><a href="#val-unset_key1" class="anchor"></a><code><span><span class="keyword">val</span> unset_key1 : <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-unset_key"><code>Ephemeron.K1.unset_key</code></a></p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> old_ephemeron_api This function won't be available in 5.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-check_key1"><a href="#val-check_key1" class="anchor"></a><code><span><span class="keyword">val</span> check_key1 : <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-check_key"><code>Ephemeron.K1.check_key</code></a></p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> old_ephemeron_api This function won't be available in 5.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_key2"><a href="#val-get_key2" class="anchor"></a><code><span><span class="keyword">val</span> get_key2 : <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'k2</span> option</span></span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-get_key"><code>Ephemeron.K1.get_key</code></a></p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> old_ephemeron_api This function won't be available in 5.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_key2_copy"><a href="#val-get_key2_copy" class="anchor"></a><code><span><span class="keyword">val</span> get_key2_copy : <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'k2</span> option</span></span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-get_key_copy"><code>Ephemeron.K1.get_key_copy</code></a></p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> old_ephemeron_api This function won't be available in 5.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_key2"><a href="#val-set_key2" class="anchor"></a><code><span><span class="keyword">val</span> set_key2 : <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'k2</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-set_key"><code>Ephemeron.K1.set_key</code></a></p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> old_ephemeron_api This function won't be available in 5.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-unset_key2"><a href="#val-unset_key2" class="anchor"></a><code><span><span class="keyword">val</span> unset_key2 : <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-unset_key"><code>Ephemeron.K1.unset_key</code></a></p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> old_ephemeron_api This function won't be available in 5.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-check_key2"><a href="#val-check_key2" class="anchor"></a><code><span><span class="keyword">val</span> check_key2 : <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-check_key"><code>Ephemeron.K1.check_key</code></a></p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> old_ephemeron_api This function won't be available in 5.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-blit_key1"><a href="#val-blit_key1" class="anchor"></a><code><span><span class="keyword">val</span> blit_key1 : <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">_</span>, <span class="type-var">_</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">_</span>, <span class="type-var">_</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-blit_key"><code>Ephemeron.K1.blit_key</code></a></p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> old_ephemeron_api This function won't be available in 5.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-blit_key2"><a href="#val-blit_key2" class="anchor"></a><code><span><span class="keyword">val</span> blit_key2 : <span><span><span>(<span class="type-var">_</span>, <span class="type-var">'k2</span>, <span class="type-var">_</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">_</span>, <span class="type-var">'k2</span>, <span class="type-var">_</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-blit_key"><code>Ephemeron.K1.blit_key</code></a></p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> old_ephemeron_api This function won't be available in 5.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-blit_key12"><a href="#val-blit_key12" class="anchor"></a><code><span><span class="keyword">val</span> blit_key12 : <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">_</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">_</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-blit_key"><code>Ephemeron.K1.blit_key</code></a></p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> old_ephemeron_api This function won't be available in 5.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_data"><a href="#val-get_data" class="anchor"></a><code><span><span class="keyword">val</span> get_data : <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'d</span> option</span></span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-get_data"><code>Ephemeron.K1.get_data</code></a></p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> old_ephemeron_api This function won't be available in 5.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_data_copy"><a href="#val-get_data_copy" class="anchor"></a><code><span><span class="keyword">val</span> get_data_copy : <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'d</span> option</span></span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-get_data_copy"><code>Ephemeron.K1.get_data_copy</code></a></p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> old_ephemeron_api This function won't be available in 5.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_data"><a href="#val-set_data" class="anchor"></a><code><span><span class="keyword">val</span> set_data : <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'d</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-set_data"><code>Ephemeron.K1.set_data</code></a></p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> old_ephemeron_api This function won't be available in 5.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-unset_data"><a href="#val-unset_data" class="anchor"></a><code><span><span class="keyword">val</span> unset_data : <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-unset_data"><code>Ephemeron.K1.unset_data</code></a></p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> old_ephemeron_api This function won't be available in 5.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-check_data"><a href="#val-check_data" class="anchor"></a><code><span><span class="keyword">val</span> check_data : <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-check_data"><code>Ephemeron.K1.check_data</code></a></p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> old_ephemeron_api This function won't be available in 5.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-blit_data"><a href="#val-blit_data" class="anchor"></a><code><span><span class="keyword">val</span> blit_data : <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-blit_data"><code>Ephemeron.K1.blit_data</code></a></p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> old_ephemeron_api This function won't be available in 5.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make : <span><span class="type-var">'k1</span> <span class="arrow">-></span></span> <span><span class="type-var">'k2</span> <span class="arrow">-></span></span> <span><span class="type-var">'d</span> <span class="arrow">-></span></span> <span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-make"><code>Ephemeron.K1.make</code></a></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-query"><a href="#val-query" class="anchor"></a><code><span><span class="keyword">val</span> query : <span><span><span>(<span class="type-var">'k1</span>, <span class="type-var">'k2</span>, <span class="type-var">'d</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'k1</span> <span class="arrow">-></span></span> <span><span class="type-var">'k2</span> <span class="arrow">-></span></span> <span><span class="type-var">'d</span> option</span></span></code></div><div class="spec-doc"><p>Same as <a href="../K1/index.html#val-query"><code>Ephemeron.K1.query</code></a></p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span>
|
||
(<a href="Make/argument-1-H1/index.html">H1</a> : <a href="../../Hashtbl/module-type-HashedType/index.html">Hashtbl.HashedType</a>)
|
||
(<a href="Make/argument-2-H2/index.html">H2</a> : <a href="../../Hashtbl/module-type-HashedType/index.html">Hashtbl.HashedType</a>) :
|
||
<a href="../module-type-S/index.html">S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../module-type-S/index.html#type-key">key</a> = <a href="Make/argument-1-H1/index.html#type-t">H1.t</a> * <a href="Make/argument-2-H2/index.html#type-t">H2.t</a></span></span></code></div><div class="spec-doc"><p>Functor building an implementation of a weak hash table</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-MakeSeeded"><a href="#module-MakeSeeded" class="anchor"></a><code><span><span class="keyword">module</span> <a href="MakeSeeded/index.html">MakeSeeded</a></span><span>
|
||
(<a href="MakeSeeded/argument-1-H1/index.html">H1</a> : <a href="../../Hashtbl/module-type-SeededHashedType/index.html">Hashtbl.SeededHashedType</a>)
|
||
(<a href="MakeSeeded/argument-2-H2/index.html">H2</a> : <a href="../../Hashtbl/module-type-SeededHashedType/index.html">Hashtbl.SeededHashedType</a>) :
|
||
<a href="../module-type-SeededS/index.html">SeededS</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../module-type-SeededS/index.html#type-key">key</a> = <a href="MakeSeeded/argument-1-H1/index.html#type-t">H1.t</a> * <a href="MakeSeeded/argument-2-H2/index.html#type-t">H2.t</a></span></span></code></div><div class="spec-doc"><p>Functor building an implementation of a weak hash table. The seed is similar to the one of <a href="../../Hashtbl/MakeSeeded/index.html"><code>Hashtbl.MakeSeeded</code></a>.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Bucket"><a href="#module-Bucket" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Bucket/index.html">Bucket</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html> |