mirror of
https://github.com/c-cube/moonpool.git
synced 2025-12-06 03:05:30 -05:00
2 lines
5.6 KiB
HTML
2 lines
5.6 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (lwt.Lwt_pqueue.Make)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.0"/><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">Index</a> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_pqueue</a> » Make</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_pqueue.Make</span></code></h1><p>Generates priority queue types from ordered types.</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav></div><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-Ord"><a href="#argument-1-Ord" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-Ord/index.html">Ord</a></span><span> : <a href="../module-type-OrderedType/index.html">OrderedType</a></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec type anchored" id="type-elt"><a href="#type-elt" class="anchor"></a><code><span><span class="keyword">type</span> elt</span><span> = <a href="argument-1-Ord/index.html#type-t">Ord.t</a></span></code></div><div class="spec-doc"><p>Type of elements contained in the priority queue.</p></div></div><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>Type of priority queues.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-empty"><a href="#val-empty" class="anchor"></a><code><span><span class="keyword">val</span> empty : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>The empty priority queue. Contains no elements.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_empty"><a href="#val-is_empty" class="anchor"></a><code><span><span class="keyword">val</span> is_empty : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>is_empty q</code> evaluates to <code>true</code> iff <code>q</code> is empty.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add"><a href="#val-add" class="anchor"></a><code><span><span class="keyword">val</span> add : <span><a href="#type-elt">elt</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>add e q</code> evaluates to a new priority queue, which contains all the elements of <code>q</code>, and the additional element <code>e</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-union"><a href="#val-union" class="anchor"></a><code><span><span class="keyword">val</span> union : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>union q q'</code> evaluates to a new priority queue, which contains all the elements of both <code>q</code> and <code>q'</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-find_min"><a href="#val-find_min" class="anchor"></a><code><span><span class="keyword">val</span> find_min : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-elt">elt</a></span></code></div><div class="spec-doc"><p><code>find_min q</code> evaluates to the minimum element of <code>q</code> if it is not empty, and raises <code>Not_found</code> otherwise.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-lookup_min"><a href="#val-lookup_min" class="anchor"></a><code><span><span class="keyword">val</span> lookup_min : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-elt">elt</a> option</span></span></code></div><div class="spec-doc"><p><code>lookup_min q</code> evaluates to <code>Some e</code>, where <code>e</code> is the minimum element of <code>q</code>, if <code>q</code> is not empty, and evaluates to <code>None</code> otherwise.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove_min"><a href="#val-remove_min" class="anchor"></a><code><span><span class="keyword">val</span> remove_min : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>remove_min q</code> evaluates to a new priority queue, which contains all the elements of <code>q</code> except for its minimum element. Raises <code>Not_found</code> if <code>q</code> is empty.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-size"><a href="#val-size" class="anchor"></a><code><span><span class="keyword">val</span> size : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p><code>size q</code> evaluates to the number of elements in <code>q</code>.</p></div></div></div></body></html>
|