ocaml-containers/dev/containers/Containers_scc/index.html
2023-02-15 17:36:59 +00:00

8 lines
No EOL
4.3 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

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>Containers_scc (containers.Containers_scc)</title><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.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</a> &#x00BB; Containers_scc</nav><header class="odoc-preamble"><h1>Module <code><span>Containers_scc</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-iter"><a href="#type-iter" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a iter</span></span><span> = <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> unit)</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-ARG"><a href="#module-type-ARG" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-ARG/index.html">ARG</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span> (<a href="Make/argument-1-A/index.html">A</a> : <a href="module-type-ARG/index.html">ARG</a>) : <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span><span class="keyword">module</span> <a href="module-type-S/A/index.html">A</a> = <a href="Make/argument-1-A/index.html">A</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-scc"><a href="#val-scc" class="anchor"></a><code><span><span class="keyword">val</span> scc :
<span>tbl:<span>(<span class="keyword">module</span> <a href="../../ocaml/Stdlib/Hashtbl/module-type-S/index.html">Stdlib.Hashtbl.S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="../../ocaml/Stdlib/Hashtbl/module-type-S/index.html#type-key">key</a> = <span class="type-var">'node</span>)</span> <span class="arrow">&#45;&gt;</span></span>
<span>graph:<span class="type-var">'graph</span> <span class="arrow">&#45;&gt;</span></span>
<span>children:<span>(<span><span class="type-var">'graph</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'node</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'node</span> <a href="#type-iter">iter</a></span>)</span> <span class="arrow">&#45;&gt;</span></span>
<span>nodes:<span><span class="type-var">'node</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<span><span><span class="type-var">'node</span> list</span> list</span></span></code></div><div class="spec-doc"><p>Compute the strongly connected components of the given <code>graph</code>, reachable from <code>nodes</code>.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">graph</span> <p>the graph state</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">children</span> <p>maps a node to its direct descendants (children)</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">nodes</span> <p>initial nodes.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">tbl</span> <p>a hashtable implementation that takes nodes as keys</p></li></ul></div></div></div></body></html>