mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
2 lines
No EOL
7.7 KiB
HTML
2 lines
No EOL
7.7 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Map (containers-data.CCGraph.Map)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.2"/><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">CCGraph</a> » Map</nav><h1>Module <code>CCGraph.Map</code></h1></header><h3 class="heading">Parameters</h3><ul><li><code>O : Stdlib.Map.OrderedType</code></li></ul><h3 class="heading">Signature</h3><dl><dt class="spec type" id="type-vertex"><a href="#type-vertex" class="anchor"></a><code><span class="keyword">type</span> vertex</code><code> = <a href="index.html#argument-1-O">O</a>.t</code></dt><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> <span>'a t</span></code></dt></dl><dl><dt class="spec value" id="val-as_graph"><a href="#val-as_graph" class="anchor"></a><code><span class="keyword">val</span> as_graph : <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span><span>(<a href="index.html#type-vertex">vertex</a>, <span class="type-var">'a</span>)</span> <a href="../index.html#type-graph">graph</a></span></code></dt><dd><p>Graph view of the map.</p></dd></dl><dl><dt class="spec value" id="val-empty"><a href="#val-empty" class="anchor"></a><code><span class="keyword">val</span> empty : <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span></code></dt><dt class="spec value" id="val-add_edge"><a href="#val-add_edge" class="anchor"></a><code><span class="keyword">val</span> add_edge : <a href="index.html#type-vertex">vertex</a> <span>-></span> <span class="type-var">'a</span> <span>-></span> <a href="index.html#type-vertex">vertex</a> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span></code></dt><dt class="spec value" id="val-remove_edge"><a href="#val-remove_edge" class="anchor"></a><code><span class="keyword">val</span> remove_edge : <a href="index.html#type-vertex">vertex</a> <span>-></span> <a href="index.html#type-vertex">vertex</a> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span></code></dt><dt class="spec value" id="val-add"><a href="#val-add" class="anchor"></a><code><span class="keyword">val</span> add : <a href="index.html#type-vertex">vertex</a> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Add a vertex, possibly with no outgoing edge.</p></dd></dl><dl><dt class="spec value" id="val-remove"><a href="#val-remove" class="anchor"></a><code><span class="keyword">val</span> remove : <a href="index.html#type-vertex">vertex</a> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Remove the vertex and all its outgoing edges. Edges that point to the vertex are <b>NOT</b> removed, they must be manually removed with <a href="index.html#val-remove_edge"><code>remove_edge</code></a>.</p></dd></dl><dl><dt class="spec value" id="val-union"><a href="#val-union" class="anchor"></a><code><span class="keyword">val</span> union : <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span></code></dt><dt class="spec value" id="val-vertices"><a href="#val-vertices" class="anchor"></a><code><span class="keyword">val</span> vertices : <span><span class="type-var">_</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span><a href="index.html#type-vertex">vertex</a> <a href="../index.html#type-iter">iter</a></span></code></dt><dt class="spec value" id="val-vertices_l"><a href="#val-vertices_l" class="anchor"></a><code><span class="keyword">val</span> vertices_l : <span><span class="type-var">_</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span><a href="index.html#type-vertex">vertex</a> list</span></code></dt><dt class="spec value" id="val-of_list"><a href="#val-of_list" class="anchor"></a><code><span class="keyword">val</span> of_list : <span><span>(<a href="index.html#type-vertex">vertex</a> * <span class="type-var">'a</span> * <a href="index.html#type-vertex">vertex</a>)</span> list</span> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span></code></dt><dt class="spec value" id="val-add_list"><a href="#val-add_list" class="anchor"></a><code><span class="keyword">val</span> add_list : <span><span>(<a href="index.html#type-vertex">vertex</a> * <span class="type-var">'a</span> * <a href="index.html#type-vertex">vertex</a>)</span> list</span> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span></code></dt><dt class="spec value" id="val-to_list"><a href="#val-to_list" class="anchor"></a><code><span class="keyword">val</span> to_list : <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span><span>(<a href="index.html#type-vertex">vertex</a> * <span class="type-var">'a</span> * <a href="index.html#type-vertex">vertex</a>)</span> list</span></code></dt><dt class="spec value" id="val-of_iter"><a href="#val-of_iter" class="anchor"></a><code><span class="keyword">val</span> of_iter : <span><span>(<a href="index.html#type-vertex">vertex</a> * <span class="type-var">'a</span> * <a href="index.html#type-vertex">vertex</a>)</span> <a href="../index.html#type-iter">iter</a></span> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span></code></dt><dd><dl><dt>since</dt><dd>2.8</dd></dl></dd></dl><dl><dt class="spec value" id="val-add_iter"><a href="#val-add_iter" class="anchor"></a><code><span class="keyword">val</span> add_iter : <span><span>(<a href="index.html#type-vertex">vertex</a> * <span class="type-var">'a</span> * <a href="index.html#type-vertex">vertex</a>)</span> <a href="../index.html#type-iter">iter</a></span> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span></code></dt><dd><dl><dt>since</dt><dd>2.8</dd></dl></dd></dl><dl><dt class="spec value" id="val-to_iter"><a href="#val-to_iter" class="anchor"></a><code><span class="keyword">val</span> to_iter : <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span><span>(<a href="index.html#type-vertex">vertex</a> * <span class="type-var">'a</span> * <a href="index.html#type-vertex">vertex</a>)</span> <a href="../index.html#type-iter">iter</a></span></code></dt><dd><dl><dt>since</dt><dd>2.8</dd></dl></dd></dl></div></body></html> |