mirror of
https://github.com/c-cube/moonpool.git
synced 2025-12-18 00:26:43 -05:00
2 lines
No EOL
5 KiB
HTML
2 lines
No EOL
5 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>H (ocaml.Stdlib.Ephemeron.GenHashTable.MakeSeeded.H)</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> » <a href="../../index.html">GenHashTable</a> » <a href="../index.html">MakeSeeded</a> » H</nav><header class="odoc-preamble"><h1>Parameter <code><span>MakeSeeded.H</span></code></h1></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> t</span></code></div><div class="spec-doc"><p>keys</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-container"><a href="#type-container" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a container</span></span></code></div><div class="spec-doc"><p>contains keys and the associated data</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-hash"><a href="#val-hash" class="anchor"></a><code><span><span class="keyword">val</span> hash : <span>int <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>same as <a href="../../../../Hashtbl/module-type-SeededHashedType/index.html"><code>Hashtbl.SeededHashedType</code></a></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : <span><span><span class="type-var">'a</span> <a href="#type-container">container</a></span> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../../index.html#type-equal">equal</a></span></code></div><div class="spec-doc"><p>equality predicate used to compare a key with the one in a container. Can return <code>EDead</code> if the keys in the container are dead</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><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-container">container</a></span></span></code></div><div class="spec-doc"><p><code>create key data</code> creates a container from some initials keys and one data</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_key"><a href="#val-get_key" class="anchor"></a><code><span><span class="keyword">val</span> get_key : <span><span><span class="type-var">'a</span> <a href="#type-container">container</a></span> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> option</span></span></code></div><div class="spec-doc"><p><code>get_key cont</code> returns the keys if they are all alive</p></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 class="type-var">'a</span> <a href="#type-container">container</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> option</span></span></code></div><div class="spec-doc"><p><code>get_data cont</code> returns the data if it is alive</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_key_data"><a href="#val-set_key_data" class="anchor"></a><code><span><span class="keyword">val</span> set_key_data : <span><span><span class="type-var">'a</span> <a href="#type-container">container</a></span> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>set_key_data cont</code> modifies the key and data</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-check_key"><a href="#val-check_key" class="anchor"></a><code><span><span class="keyword">val</span> check_key : <span><span><span class="type-var">'a</span> <a href="#type-container">container</a></span> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>check_key cont</code> checks if all the keys contained in the data are alive</p></div></div></div></body></html> |