ocaml-containers/3.4/containers-data/CCGraph/Traverse/Event/index.html
2021-05-03 13:35:10 -04:00

2 lines
No EOL
6.8 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Event (containers-data.CCGraph.Traverse.Event)</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> &#x00BB; <a href="../../index.html">CCGraph</a> &#x00BB; <a href="../index.html">Traverse</a> &#x00BB; Event</nav><h1>Module <code>Traverse.Event</code></h1><h3 id="more-detailed-interface"><a href="#more-detailed-interface" class="anchor"></a>More detailed interface</h3></header><dl><dt class="spec type" id="type-edge_kind"><a href="#type-edge_kind" class="anchor"></a><code><span class="keyword">type</span> edge_kind</code> = <code>[ </code><table class="variant"><tr id="type-edge_kind.Forward" class="anchored"><td class="def constructor"><a href="#type-edge_kind.Forward" class="anchor"></a><code>| </code><code>`Forward</code></td></tr><tr id="type-edge_kind.Back" class="anchored"><td class="def constructor"><a href="#type-edge_kind.Back" class="anchor"></a><code>| </code><code>`Back</code></td></tr><tr id="type-edge_kind.Cross" class="anchored"><td class="def constructor"><a href="#type-edge_kind.Cross" class="anchor"></a><code>| </code><code>`Cross</code></td></tr></table><code> ]</code></dt><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> <span>('v, 'e) t</span></code> = <code>[ </code><table class="variant"><tr id="type-t.Enter" class="anchored"><td class="def constructor"><a href="#type-t.Enter" class="anchor"></a><code>| </code><code>`Enter <span class="keyword">of</span> <span class="type-var">'v</span> * int * <span><span>(<span class="type-var">'v</span>, <span class="type-var">'e</span>)</span> <a href="../index.html#type-path">path</a></span></code></td></tr><tr id="type-t.Exit" class="anchored"><td class="def constructor"><a href="#type-t.Exit" class="anchor"></a><code>| </code><code>`Exit <span class="keyword">of</span> <span class="type-var">'v</span></code></td></tr><tr id="type-t.Edge" class="anchored"><td class="def constructor"><a href="#type-t.Edge" class="anchor"></a><code>| </code><code>`Edge <span class="keyword">of</span> <span class="type-var">'v</span> * <span class="type-var">'e</span> * <span class="type-var">'v</span> * <a href="index.html#type-edge_kind">edge_kind</a></code></td></tr></table><code> ]</code></dt><dd><p>A traversal is a sequence of such events</p></dd></dl><dl><dt class="spec value" id="val-get_vertex"><a href="#val-get_vertex" class="anchor"></a><code><span class="keyword">val</span> get_vertex : <span><span>(<span class="type-var">'v</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'v</span> * <span>[ `Enter <span>| `Exit</span> ]</span>)</span> option</span></code></dt><dt class="spec value" id="val-get_enter"><a href="#val-get_enter" class="anchor"></a><code><span class="keyword">val</span> get_enter : <span><span>(<span class="type-var">'v</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'v</span> option</span></code></dt><dt class="spec value" id="val-get_exit"><a href="#val-get_exit" class="anchor"></a><code><span class="keyword">val</span> get_exit : <span><span>(<span class="type-var">'v</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'v</span> option</span></code></dt><dt class="spec value" id="val-get_edge"><a href="#val-get_edge" class="anchor"></a><code><span class="keyword">val</span> get_edge : <span><span>(<span class="type-var">'v</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'v</span> * <span class="type-var">'e</span> * <span class="type-var">'v</span>)</span> option</span></code></dt><dt class="spec value" id="val-get_edge_kind"><a href="#val-get_edge_kind" class="anchor"></a><code><span class="keyword">val</span> get_edge_kind : <span><span>(<span class="type-var">'v</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'v</span> * <span class="type-var">'e</span> * <span class="type-var">'v</span> * <a href="index.html#type-edge_kind">edge_kind</a>)</span> option</span></code></dt><dt class="spec value" id="val-dfs"><a href="#val-dfs" class="anchor"></a><code><span class="keyword">val</span> dfs : <span>tbl:<span><span class="type-var">'v</span> <a href="../../index.html#type-set">set</a></span></span> <span>&#45;&gt;</span> <span>eq:<span>(<span class="type-var">'v</span> <span>&#45;&gt;</span> <span class="type-var">'v</span> <span>&#45;&gt;</span> bool)</span></span> <span>&#45;&gt;</span> <span>graph:<span><span>(<span class="type-var">'v</span>, <span class="type-var">'e</span>)</span> <a href="../../index.html#type-graph">graph</a></span></span> <span>&#45;&gt;</span> <span><span class="type-var">'v</span> <a href="../../index.html#type-iter">iter</a></span> <span>&#45;&gt;</span> <span><span><span>(<span class="type-var">'v</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t">t</a></span> <a href="../../index.html#type-iter_once">iter_once</a></span></code></dt><dd><p>Full version of DFS.</p><dl><dt>parameter eq</dt><dd><p>equality predicate on vertices.</p></dd></dl></dd></dl><dl><dt class="spec value" id="val-dfs_tag"><a href="#val-dfs_tag" class="anchor"></a><code><span class="keyword">val</span> dfs_tag : <span>eq:<span>(<span class="type-var">'v</span> <span>&#45;&gt;</span> <span class="type-var">'v</span> <span>&#45;&gt;</span> bool)</span></span> <span>&#45;&gt;</span> <span>tags:<span><span class="type-var">'v</span> <a href="../../index.html#type-tag_set">tag_set</a></span></span> <span>&#45;&gt;</span> <span>graph:<span><span>(<span class="type-var">'v</span>, <span class="type-var">'e</span>)</span> <a href="../../index.html#type-graph">graph</a></span></span> <span>&#45;&gt;</span> <span><span class="type-var">'v</span> <a href="../../index.html#type-iter">iter</a></span> <span>&#45;&gt;</span> <span><span><span>(<span class="type-var">'v</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t">t</a></span> <a href="../../index.html#type-iter_once">iter_once</a></span></code></dt><dd><p>Full version of DFS using integer tags.</p><dl><dt>parameter eq</dt><dd><p>equality predicate on vertices.</p></dd></dl></dd></dl></div></body></html>