simon/ocaml-containers
1
0
Fork 0
mirror of https://github.com/c-cube/ocaml-containers.git synced 2025-12-06 03:05:28 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
ocaml-containers/3.6/containers-data/CCGraph/Traverse/Event/index.html
Simon Cruanes 48f87001b0
doc for 3.6
2021-10-18 22:33:12 -04:00

2 lines
No EOL
8.2 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 2.0.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">containers-data</a> &#x00BB; <a href="../../index.html">CCGraph</a> &#x00BB; <a href="../index.html">Traverse</a> &#x00BB; Event</nav><header class="odoc-preamble"><h1>Module <code><span>Traverse.Event</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#more-detailed-interface">More detailed interface</a></li></ul></nav><div class="odoc-content"><h3 id="more-detailed-interface"><a href="#more-detailed-interface" class="anchor"></a>More detailed interface</h3><div class="odoc-spec"><div class="spec type" id="type-edge_kind" class="anchored"><a href="#type-edge_kind" class="anchor"></a><code><span><span class="keyword">type</span> edge_kind</span><span> = </span><span>[ </span></code><table><tr id="type-edge_kind.Forward" class="anchored"><td class="def constructor"><a href="#type-edge_kind.Forward" class="anchor"></a><code><span>| </span></code><code><span>`Forward</span></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><span>| </span></code><code><span>`Back</span></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><span>| </span></code><code><span>`Cross</span></code></td></tr></table><code><span> ]</span></code></div></div><div class="odoc-spec"><div class="spec type" id="type-t" class="anchored"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>('v, 'e) t</span></span><span> = </span><span>[ </span></code><table><tr id="type-t.Enter" class="anchored"><td class="def constructor"><a href="#type-t.Enter" class="anchor"></a><code><span>| </span></code><code><span>`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></span></code></td></tr><tr id="type-t.Exit" class="anchored"><td class="def constructor"><a href="#type-t.Exit" class="anchor"></a><code><span>| </span></code><code><span>`Exit <span class="keyword">of</span> <span class="type-var">'v</span></span></code></td></tr><tr id="type-t.Edge" class="anchored"><td class="def constructor"><a href="#type-t.Edge" class="anchor"></a><code><span>| </span></code><code><span>`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="#type-edge_kind">edge_kind</a></span></code></td></tr></table><code><span> ]</span></code></div><div class="spec-doc"><p>A traversal is a sequence of such events</p></div></div><div class="odoc-spec"><div class="spec value" id="val-get_vertex" class="anchored"><a href="#val-get_vertex" class="anchor"></a><code><span><span class="keyword">val</span> get_vertex : <span><span><span>(<span class="type-var">'v</span>, <span class="type-var">'e</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span class="type-var">'v</span> * <span>[ `Enter <span>| `Exit</span> ]</span>)</span> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-get_enter" class="anchored"><a href="#val-get_enter" class="anchor"></a><code><span><span class="keyword">val</span> get_enter : <span><span><span>(<span class="type-var">'v</span>, <span class="type-var">'e</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'v</span> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-get_exit" class="anchored"><a href="#val-get_exit" class="anchor"></a><code><span><span class="keyword">val</span> get_exit : <span><span><span>(<span class="type-var">'v</span>, <span class="type-var">'e</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'v</span> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-get_edge" class="anchored"><a href="#val-get_edge" class="anchor"></a><code><span><span class="keyword">val</span> get_edge : <span><span><span>(<span class="type-var">'v</span>, <span class="type-var">'e</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span class="type-var">'v</span> * <span class="type-var">'e</span> * <span class="type-var">'v</span>)</span> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-get_edge_kind" class="anchored"><a href="#val-get_edge_kind" class="anchor"></a><code><span><span class="keyword">val</span> get_edge_kind : <span><span><span>(<span class="type-var">'v</span>, <span class="type-var">'e</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span class="type-var">'v</span> * <span class="type-var">'e</span> * <span class="type-var">'v</span> * <a href="#type-edge_kind">edge_kind</a>)</span> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-dfs" class="anchored"><a href="#val-dfs" class="anchor"></a><code><span><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 class="arrow">&#45;&gt;</span></span> <span>eq:<span>(<span><span class="type-var">'v</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'v</span> <span class="arrow">&#45;&gt;</span></span> bool)</span> <span class="arrow">&#45;&gt;</span></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 class="arrow">&#45;&gt;</span></span> <span><span><span class="type-var">'v</span> <a href="../../index.html#type-iter">iter</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span><span>(<span class="type-var">'v</span>, <span class="type-var">'e</span>)</span> <a href="#type-t">t</a></span> <a href="../../index.html#type-iter_once">iter_once</a></span></span></code></div><div class="spec-doc"><p>Full version of DFS.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">eq</span> <p>equality predicate on vertices.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value" id="val-dfs_tag" class="anchored"><a href="#val-dfs_tag" class="anchor"></a><code><span><span class="keyword">val</span> dfs_tag : <span>eq:<span>(<span><span class="type-var">'v</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'v</span> <span class="arrow">&#45;&gt;</span></span> bool)</span> <span class="arrow">&#45;&gt;</span></span> <span>tags:<span><span class="type-var">'v</span> <a href="../../index.html#type-tag_set">tag_set</a></span> <span class="arrow">&#45;&gt;</span></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 class="arrow">&#45;&gt;</span></span> <span><span><span class="type-var">'v</span> <a href="../../index.html#type-iter">iter</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span><span>(<span class="type-var">'v</span>, <span class="type-var">'e</span>)</span> <a href="#type-t">t</a></span> <a href="../../index.html#type-iter_once">iter_once</a></span></span></code></div><div class="spec-doc"><p>Full version of DFS using integer tags.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">eq</span> <p>equality predicate on vertices.</p></li></ul></div></div></div></body></html>
Reference in a new issue View git blame Copy permalink