mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-05 19:00:31 -05:00
2 lines
No EOL
4.4 KiB
HTML
2 lines
No EOL
4.4 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (containers-data.CCMutHeap.Make)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers-data</a> » <a href="../index.html">CCMutHeap</a> » Make</nav><h1>Module <code>CCMutHeap.Make</code></h1></header><h3 class="heading">Parameters</h3><ul><li><code><a href="argument-1-X/index.html">X</a> : <a href="../index.html#module-type-RANKED">RANKED</a></code></li></ul><h3 class="heading">Signature</h3><dl><dt class="spec type" id="type-elt"><a href="#type-elt" class="anchor"></a><code><span class="keyword">type</span> elt</code><code> = <a href="argument-1-X/index.html#type-t">X.t</a></code></dt><dd><p>Type of elements</p></dd></dl><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt><dd><p>Heap of <a href="index.html#type-elt"><code>elt</code></a>, whose priority is increased or decreased incrementally (see <a href="index.html#val-decrease"><code>decrease</code></a> for instance)</p></dd></dl><dl><dt class="spec value" id="val-create"><a href="#val-create" class="anchor"></a><code><span class="keyword">val</span> create : unit <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p>Create a heap</p></dd></dl><dl><dt class="spec value" id="val-decrease"><a href="#val-decrease" class="anchor"></a><code><span class="keyword">val</span> decrease : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-elt">elt</a> <span>-></span> unit</code></dt><dd><p><code>decrease h x</code> decreases the value associated to <code>x</code> within <code>h</code></p></dd></dl><dl><dt class="spec value" id="val-increase"><a href="#val-increase" class="anchor"></a><code><span class="keyword">val</span> increase : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-elt">elt</a> <span>-></span> unit</code></dt><dd><p><code>increase h x</code> increases the value associated to <code>x</code> within <code>h</code></p></dd></dl><dl><dt class="spec value" id="val-in_heap"><a href="#val-in_heap" class="anchor"></a><code><span class="keyword">val</span> in_heap : <a href="index.html#type-elt">elt</a> <span>-></span> bool</code></dt><dt class="spec value" id="val-size"><a href="#val-size" class="anchor"></a><code><span class="keyword">val</span> size : <a href="index.html#type-t">t</a> <span>-></span> int</code></dt><dd><p>Number of integers within the heap</p></dd></dl><dl><dt class="spec value" id="val-is_empty"><a href="#val-is_empty" class="anchor"></a><code><span class="keyword">val</span> is_empty : <a href="index.html#type-t">t</a> <span>-></span> bool</code></dt><dt class="spec value" id="val-clear"><a href="#val-clear" class="anchor"></a><code><span class="keyword">val</span> clear : <a href="index.html#type-t">t</a> <span>-></span> unit</code></dt><dd><p>Clear the content of the heap</p></dd></dl><dl><dt class="spec value" id="val-insert"><a href="#val-insert" class="anchor"></a><code><span class="keyword">val</span> insert : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-elt">elt</a> <span>-></span> unit</code></dt><dd><p>Insert a new element into the heap</p></dd></dl><dl><dt class="spec value" id="val-remove_min"><a href="#val-remove_min" class="anchor"></a><code><span class="keyword">val</span> remove_min : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-elt">elt</a></code></dt><dd><p>Remove and return the integer that has the lowest value from the heap</p><dl><dt>raises Not_found</dt><dd><p>if the heap is empty</p></dd></dl></dd></dl><dl><dt class="spec value" id="val-filter"><a href="#val-filter" class="anchor"></a><code><span class="keyword">val</span> filter : <a href="index.html#type-t">t</a> <span>-></span> <span>(<a href="index.html#type-elt">elt</a> <span>-></span> bool)</span> <span>-></span> unit</code></dt><dd><p>Filter out values that don't satisfy the predicate</p></dd></dl></div></body></html> |