mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-07 11:45:31 -05:00
4 lines
No EOL
8.5 KiB
HTML
4 lines
No EOL
8.5 KiB
HTML
<!DOCTYPE html>
|
|
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (containers.CCMixmap.Make)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCMixmap.Make</span></h1></header><h3 class="heading">Parameters</h3><div><div class="spec argument" id="argument-1-X"><a href="#argument-1-X" class="anchor"></a><div class="def argument"><code><a href="argument-1-X/index.html">X</a> : <a href="../index.html#module-type-ORD">ORD</a></code></div><div class="doc"></div></div></div><h3 class="heading">Signature</h3><div class="spec type" id="type-key"><a href="#type-key" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>key</code><code><span class="keyword"> = </span><a href="argument-1-X/index.html#type-t">X.t</a></code><code></code></div><div class="doc"></div></div><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>t</code><code></code><code></code></div><div class="doc"><p>A map containing values of different types, indexed by <a href="index.html#type-key">key</a>.</p></div></div><div class="spec val" id="val-empty"><a href="#val-empty" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>empty : <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Empty map.</p></div></div><div class="spec val" id="val-get"><a href="#val-get" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get : inj:<span class="type-var">'a</span> <a href="../index.html#type-injection">injection</a> <span class="keyword">‑></span> <a href="index.html#type-key">key</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> option</code></div><div class="doc"><p>Get the value corresponding to this key, if it exists and
|
|
belongs to the same key.</p></div></div><div class="spec val" id="val-add"><a href="#val-add" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>add : inj:<span class="type-var">'a</span> <a href="../index.html#type-injection">injection</a> <span class="keyword">‑></span> <a href="index.html#type-key">key</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Bind the key to the value, using <code class="code">inj</code>.</p></div></div><div class="spec val" id="val-find"><a href="#val-find" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>find : inj:<span class="type-var">'a</span> <a href="../index.html#type-injection">injection</a> <span class="keyword">‑></span> <a href="index.html#type-key">key</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>Find the value for the given key, which must be of the right type.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Not_found</span>: if either the key is not found, or if its value
|
|
doesn't belong to the right type.</li></ul></div></div><div class="spec val" id="val-cardinal"><a href="#val-cardinal" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>cardinal : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"><p>Number of bindings.</p></div></div><div class="spec val" id="val-remove"><a href="#val-remove" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>remove : <a href="index.html#type-key">key</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Remove the binding for this key.</p></div></div><div class="spec val" id="val-mem"><a href="#val-mem" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>mem : inj:<span class="type-var">_</span> <a href="../index.html#type-injection">injection</a> <span class="keyword">‑></span> <a href="index.html#type-key">key</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><p>Is the given key in the map, with the right type?</p></div></div><div class="spec val" id="val-iter_keys"><a href="#val-iter_keys" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>iter_keys : f:(<a href="index.html#type-key">key</a> <span class="keyword">‑></span> unit) <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Iterate on the keys of this map.</p></div></div><div class="spec val" id="val-fold_keys"><a href="#val-fold_keys" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>fold_keys : f:(<span class="type-var">'a</span> <span class="keyword">‑></span> <a href="index.html#type-key">key</a> <span class="keyword">‑></span> <span class="type-var">'a</span>) <span class="keyword">‑></span> x:<span class="type-var">'a</span> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>Fold over the keys.</p></div></div><h3>Iterators</h3><div class="spec type" id="type-sequence"><a href="#type-sequence" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a sequence</code><code><span class="keyword"> = </span>(<span class="type-var">'a</span> <span class="keyword">‑></span> unit) <span class="keyword">‑></span> unit</code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-keys_seq"><a href="#val-keys_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>keys_seq : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-key">key</a> <a href="index.html#type-sequence">sequence</a></code></div><div class="doc"><p>All the keys.</p></div></div><div class="spec val" id="val-bindings_of"><a href="#val-bindings_of" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>bindings_of : inj:<span class="type-var">'a</span> <a href="../index.html#type-injection">injection</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<a href="index.html#type-key">key</a><span class="keyword"> * </span><span class="type-var">'a</span>) <a href="index.html#type-sequence">sequence</a></code></div><div class="doc"><p>All the bindings that come from the corresponding injection.</p></div></div><div class="spec type" id="type-value"><a href="#type-value" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>value</code><code></code><code><span class="keyword"> = </span></code><table class="variant"><tr id="type-value.Value" class="anchored"><td class="def constructor"><a href="#type-value.Value" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">Value</span><span class="keyword"> : </span>(<span class="type-var">'a</span> <a href="../index.html#type-injection">injection</a> <span class="keyword">‑></span> <span class="type-var">'a</span> option) <span class="keyword">‑></span> <a href="index.html#type-value">value</a></code></td></tr></table><code></code></div><div class="doc"></div></div><div class="spec val" id="val-bindings"><a href="#val-bindings" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>bindings : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<a href="index.html#type-key">key</a><span class="keyword"> * </span><a href="index.html#type-value">value</a>) <a href="index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Iterate on all bindings.</p></div></div></body></html> |