<ocamldoc with-contents="true"><title>Stog library reference documentation : Stog_graph.S</title><contents><div class="ocamldoc-page">
<code class="code"><span class="keyword">sig</span><br/>
&#160;&#160;<span class="keyword">type</span>&#160;key<br/>
&#160;&#160;<span class="keyword">type</span>&#160;edge_data<br/>
&#160;&#160;<span class="keyword">type</span>&#160;t<br/>
&#160;&#160;<span class="keyword">val</span>&#160;create&#160;:&#160;unit&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t<br/>
&#160;&#160;<span class="keyword">val</span>&#160;marshal&#160;:&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t&#160;<span class="keywordsign">-&gt;</span>&#160;string<br/>
&#160;&#160;<span class="keyword">val</span>&#160;unmarshal&#160;:&#160;string&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t<br/>
&#160;&#160;<span class="keyword">val</span>&#160;succ&#160;:<br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;<span class="keywordsign">-&gt;</span>&#160;(<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;*&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.edge_data)&#160;list<br/>
&#160;&#160;<span class="keyword">val</span>&#160;pred&#160;:<br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;<span class="keywordsign">-&gt;</span>&#160;(<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;*&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.edge_data)&#160;list<br/>
&#160;&#160;<span class="keyword">val</span>&#160;add&#160;:<br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;*&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;*&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.edge_data&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t<br/>
&#160;&#160;<span class="keyword">val</span>&#160;rem&#160;:<br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;*&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;(<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.edge_data&#160;<span class="keywordsign">-&gt;</span>&#160;bool)&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t<br/>
&#160;&#160;<span class="keyword">val</span>&#160;rem_all&#160;:<br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;*&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t<br/>
&#160;&#160;<span class="keyword">val</span>&#160;isolate&#160;:&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t<br/>
&#160;&#160;<span class="keyword">val</span>&#160;remove_node&#160;:&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t<br/>
&#160;&#160;<span class="keyword">val</span>&#160;pred_roots&#160;:<br/>
&#160;&#160;&#160;&#160;?ignore_deps:<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.edge_data&#160;list&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;list<br/>
&#160;&#160;<span class="keyword">val</span>&#160;succ_roots&#160;:&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;list<br/>
&#160;&#160;<span class="keyword">val</span>&#160;recursive_succs&#160;:<br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;?pred:(<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.edge_data&#160;<span class="keywordsign">-&gt;</span>&#160;bool)&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;list<br/>
&#160;&#160;<span class="keyword">val</span>&#160;recursive_preds&#160;:<br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;?pred:(<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.edge_data&#160;<span class="keywordsign">-&gt;</span>&#160;bool)&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;list<br/>
&#160;&#160;<span class="keyword">val</span>&#160;reverse&#160;:&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t<br/>
&#160;&#160;<span class="keyword">val</span>&#160;fold_succ&#160;:<br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;(<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;&#160;(<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;*&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.edge_data)&#160;list&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="keywordsign">'</span>a&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="keywordsign">'</span>a)&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;<span class="keywordsign">'</span>a&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="keywordsign">'</span>a<br/>
&#160;&#160;<span class="keyword">val</span>&#160;fold_pred&#160;:<br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;(<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;&#160;(<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;*&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.edge_data)&#160;list&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="keywordsign">'</span>a&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="keywordsign">'</span>a)&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;<span class="keywordsign">'</span>a&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="keywordsign">'</span>a<br/>
&#160;&#160;<span class="keyword">val</span>&#160;iter_succ&#160;:<br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;(<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;&#160;(<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;*&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.edge_data)&#160;list&#160;<span class="keywordsign">-&gt;</span>&#160;unit)&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;unit<br/>
&#160;&#160;<span class="keyword">val</span>&#160;iter_pred&#160;:<br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;(<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;&#160;(<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;*&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.edge_data)&#160;list&#160;<span class="keywordsign">-&gt;</span>&#160;unit)&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;unit<br/>
&#160;&#160;<span class="keyword">val</span>&#160;dot_of_graph&#160;:<br/>
&#160;&#160;&#160;&#160;?f_edge:(<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.edge_data&#160;<span class="keywordsign">-&gt;</span>&#160;string&#160;*&#160;(string&#160;*&#160;string)&#160;list)&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;f_node:(<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;<span class="keywordsign">-&gt;</span>&#160;string&#160;*&#160;string&#160;*&#160;(string&#160;*&#160;string)&#160;list)&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t&#160;<span class="keywordsign">-&gt;</span>&#160;string<br/>
&#160;&#160;<span class="keyword">val</span>&#160;nodes_by_pred_order&#160;:&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t&#160;<span class="keywordsign">-&gt;</span>&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;list<br/>
&#160;&#160;<span class="keyword">val</span>&#160;shortest_path&#160;:<br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;(<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.t&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;*&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;&#160;(float&#160;*&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.edge_data)&#160;option)&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;*&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;<span class="keywordsign">-&gt;</span><br/>
&#160;&#160;&#160;&#160;(<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key&#160;*&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.edge_data&#160;*&#160;<span class="constructor">Stog_graph</span>.<span class="constructor">S</span>.key)&#160;list<br/>
<span class="keyword">end</span></code></div></contents></ocamldoc>