mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-07 03:35:30 -05:00
3 lines
No EOL
14 KiB
HTML
3 lines
No EOL
14 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (containers.CCHashSet.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">CCHashSet.Make</span></h1></header><h3 class="heading">Parameters</h3><div><div class="spec argument" id="argument-1-E"><a href="#argument-1-E" class="anchor"></a><div class="def argument"><code><a href="argument-1-E/index.html">E</a> : <a href="../index.html#module-type-ELEMENT">ELEMENT</a></code></div><div class="doc"></div></div></div><h3 class="heading">Signature</h3><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"></div></div><div class="spec type" id="type-elt"><a href="#type-elt" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>elt</code><code><span class="keyword"> = </span><a href="argument-1-E/index.html#type-t">E.t</a></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-create"><a href="#val-create" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>create : int <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">create n</code> makes a new set with the given capacity <code class="code">n</code>.</p></div></div><div class="spec val" id="val-singleton"><a href="#val-singleton" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>singleton : <a href="index.html#type-elt">elt</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">singleton x</code> is the singleton <code class="code">{x}</code>.</p></div></div><div class="spec val" id="val-clear"><a href="#val-clear" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>clear : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">clear s</code> removes all elements from <code class="code">s</code>.</p></div></div><div class="spec val" id="val-copy"><a href="#val-copy" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>copy : <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>Fresh copy.</p></div></div><div class="spec val" id="val-copy_into"><a href="#val-copy_into" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>copy_into : into:<a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">copy_into ~into s</code> copies all elements of <code class="code">s</code> into <code class="code">into</code>.</p></div></div><div class="spec val" id="val-insert"><a href="#val-insert" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>insert : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-elt">elt</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">insert s x</code> adds <code class="code">x</code> into <code class="code">s</code>.</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-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-elt">elt</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Remove the element, if it were in there.</p></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><code class="code">cardinal s</code> returns the number of elements in <code class="code">s</code>.</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 : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-elt">elt</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><p><code class="code">mem s x</code> returns <code class="code">true</code> iff <code class="code">x</code> is in <code class="code">s</code>.</p></div></div><div class="spec val" id="val-find_exn"><a href="#val-find_exn" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>find_exn : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-elt">elt</a> <span class="keyword">‑></span> <a href="index.html#type-elt">elt</a></code></div><div class="doc"><p><code class="code">find_exn s x</code> returns <code class="code">y</code> if <code class="code">x</code> and <code class="code">y</code> are equal, and <code class="code">mem s y</code>.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Not_found</span>: if <code class="code">x</code> not in <code class="code">s</code>.</li></ul></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 : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-elt">elt</a> <span class="keyword">‑></span> <a href="index.html#type-elt">elt</a> option</code></div><div class="doc"><p>Safe version of <a href="index.html#val-find_exn">find_exn</a>.</p></div></div><div class="spec val" id="val-inter"><a href="#val-inter" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>inter : <a href="index.html#type-t">t</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><code class="code">inter a b</code> returns <code class="code">a ∩ b</code>.</p></div></div><div class="spec val" id="val-inter_mut"><a href="#val-inter_mut" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>inter_mut : into:<a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">inter_mut ~into a</code> changes <code class="code">into</code> into <code class="code">a ∩ into</code>.</p></div></div><div class="spec val" id="val-union"><a href="#val-union" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>union : <a href="index.html#type-t">t</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><code class="code">union a b</code> returns <code class="code">a ∪ b</code>.</p></div></div><div class="spec val" id="val-union_mut"><a href="#val-union_mut" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>union_mut : into:<a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">union_mut ~into a</code> changes <code class="code">into</code> into <code class="code">a ∪ into</code>.</p></div></div><div class="spec val" id="val-diff"><a href="#val-diff" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>diff : <a href="index.html#type-t">t</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><code class="code">diff a b</code> returns <code class="code">a - b</code>.</p></div></div><div class="spec val" id="val-subset"><a href="#val-subset" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>subset : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><p><code class="code">subset a b</code> returns <code class="code">true</code> if all elements of <code class="code">a</code> are in <code class="code">b</code>.</p></div></div><div class="spec val" id="val-equal"><a href="#val-equal" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>equal : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><p><code class="code">equal a b</code> is extensional equality (<code class="code">a</code> and <code class="code">b</code> have the same elements).</p></div></div><div class="spec val" id="val-for_all"><a href="#val-for_all" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>for_all : (<a href="index.html#type-elt">elt</a> <span class="keyword">‑></span> bool) <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"></div></div><div class="spec val" id="val-exists"><a href="#val-exists" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>exists : (<a href="index.html#type-elt">elt</a> <span class="keyword">‑></span> bool) <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"></div></div><div class="spec val" id="val-iter"><a href="#val-iter" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>iter : (<a href="index.html#type-elt">elt</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 values.</p></div></div><div class="spec val" id="val-fold"><a href="#val-fold" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>fold : (<span class="type-var">'a</span> <span class="keyword">‑></span> <a href="index.html#type-elt">elt</a> <span class="keyword">‑></span> <span class="type-var">'a</span>) <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> <span class="type-var">'a</span></code></div><div class="doc"><p>Fold on values.</p></div></div><div class="spec val" id="val-elements"><a href="#val-elements" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>elements : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-elt">elt</a> list</code></div><div class="doc"><p>List of elements.</p></div></div><div class="spec val" id="val-of_list"><a href="#val-of_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_list : <a href="index.html#type-elt">elt</a> list <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-to_seq"><a href="#val-to_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_seq : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-elt">elt</a> <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"></div></div><div class="spec val" id="val-of_seq"><a href="#val-of_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_seq : <a href="index.html#type-elt">elt</a> <a href="../index.html#type-sequence">sequence</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-add_seq"><a href="#val-add_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>add_seq : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-elt">elt</a> <a href="../index.html#type-sequence">sequence</a> <span class="keyword">‑></span> unit</code></div><div class="doc"></div></div><div class="spec val" id="val-pp"><a href="#val-pp" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pp : ?⁠sep:string <span class="keyword">‑></span> <a href="index.html#type-elt">elt</a> <a href="../index.html#type-printer">printer</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <a href="../index.html#type-printer">printer</a></code></div><div class="doc"><p><code class="code">pp pp_elt</code> returns a set printer, given a printer for
|
||
individual elements.</p></div></div></body></html> |