ocaml-containers/2.8/containers/CCGraph/Dot/index.html
2019-12-14 17:27:18 -06:00

2 lines
No EOL
6.2 KiB
HTML
Raw Permalink 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>Dot (containers.CCGraph.Dot)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><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</a> &#x00BB; <a href="../index.html">CCGraph</a> &#x00BB; Dot</nav><h1>Module <code>CCGraph.Dot</code></h1></header><dl><dt class="spec type" id="type-attribute"><a href="#type-attribute" class="anchor"></a><code><span class="keyword">type</span> attribute</code> = <code>[ </code><table class="variant"><tr id="type-attribute.Color" class="anchored"><td class="def constructor"><a href="#type-attribute.Color" class="anchor"></a><code>| </code><code>`Color <span class="keyword">of</span> string</code></td></tr><tr id="type-attribute.Shape" class="anchored"><td class="def constructor"><a href="#type-attribute.Shape" class="anchor"></a><code>| </code><code>`Shape <span class="keyword">of</span> string</code></td></tr><tr id="type-attribute.Weight" class="anchored"><td class="def constructor"><a href="#type-attribute.Weight" class="anchor"></a><code>| </code><code>`Weight <span class="keyword">of</span> int</code></td></tr><tr id="type-attribute.Style" class="anchored"><td class="def constructor"><a href="#type-attribute.Style" class="anchor"></a><code>| </code><code>`Style <span class="keyword">of</span> string</code></td></tr><tr id="type-attribute.Label" class="anchored"><td class="def constructor"><a href="#type-attribute.Label" class="anchor"></a><code>| </code><code>`Label <span class="keyword">of</span> string</code></td></tr><tr id="type-attribute.Other" class="anchored"><td class="def constructor"><a href="#type-attribute.Other" class="anchor"></a><code>| </code><code>`Other <span class="keyword">of</span> string * string</code></td></tr></table><code> ]</code></dt><dd><p>Dot attribute</p></dd></dl><dl><dt class="spec type" id="type-vertex_state"><a href="#type-vertex_state" class="anchor"></a><code><span class="keyword">type</span> vertex_state</code></dt><dd><p>Hidden state associated to a vertex</p></dd></dl><dl><dt class="spec value" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span class="keyword">val</span> pp : tbl:(<span class="type-var">'v</span>, <a href="index.html#type-vertex_state">vertex_state</a>) <a href="../index.html#type-table">table</a> <span>&#45;&gt;</span> eq:(<span class="type-var">'v</span> <span>&#45;&gt;</span> <span class="type-var">'v</span> <span>&#45;&gt;</span> bool) <span>&#45;&gt;</span> ?&#8288;attrs_v:(<span class="type-var">'v</span> <span>&#45;&gt;</span> <a href="index.html#type-attribute">attribute</a> list) <span>&#45;&gt;</span> ?&#8288;attrs_e:(<span class="type-var">'e</span> <span>&#45;&gt;</span> <a href="index.html#type-attribute">attribute</a> list) <span>&#45;&gt;</span> ?&#8288;name:string <span>&#45;&gt;</span> graph:(<span class="type-var">'v</span>, <span class="type-var">'e</span>) <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> Stdlib.Format.formatter <span>&#45;&gt;</span> <span class="type-var">'v</span> <span>&#45;&gt;</span> unit</code></dt><dd><p>Print the graph, starting from given vertex, on the formatter.</p><dl><dt>parameter attrs_v</dt><dd><p>attributes for vertices.</p></dd></dl><dl><dt>parameter attrs_e</dt><dd><p>attributes for edges.</p></dd></dl><dl><dt>parameter name</dt><dd><p>name of the graph.</p></dd></dl></dd></dl><dl><dt class="spec value" id="val-pp_all"><a href="#val-pp_all" class="anchor"></a><code><span class="keyword">val</span> pp_all : tbl:(<span class="type-var">'v</span>, <a href="index.html#type-vertex_state">vertex_state</a>) <a href="../index.html#type-table">table</a> <span>&#45;&gt;</span> eq:(<span class="type-var">'v</span> <span>&#45;&gt;</span> <span class="type-var">'v</span> <span>&#45;&gt;</span> bool) <span>&#45;&gt;</span> ?&#8288;attrs_v:(<span class="type-var">'v</span> <span>&#45;&gt;</span> <a href="index.html#type-attribute">attribute</a> list) <span>&#45;&gt;</span> ?&#8288;attrs_e:(<span class="type-var">'e</span> <span>&#45;&gt;</span> <a href="index.html#type-attribute">attribute</a> list) <span>&#45;&gt;</span> ?&#8288;name:string <span>&#45;&gt;</span> graph:(<span class="type-var">'v</span>, <span class="type-var">'e</span>) <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> Stdlib.Format.formatter <span>&#45;&gt;</span> <span class="type-var">'v</span> <a href="../index.html#type-iter">iter</a> <span>&#45;&gt;</span> unit</code></dt><dd><p>Same as <a href="index.html#val-pp"><code>pp</code></a> but starting from several vertices, not just one.</p><dl><dt>since</dt><dd>2.8</dd></dl></dd></dl><dl><dt class="spec value" id="val-pp_seq"><a href="#val-pp_seq" class="anchor"></a><code><span class="keyword">val</span> pp_seq : tbl:(<span class="type-var">'v</span>, <a href="index.html#type-vertex_state">vertex_state</a>) <a href="../index.html#type-table">table</a> <span>&#45;&gt;</span> eq:(<span class="type-var">'v</span> <span>&#45;&gt;</span> <span class="type-var">'v</span> <span>&#45;&gt;</span> bool) <span>&#45;&gt;</span> ?&#8288;attrs_v:(<span class="type-var">'v</span> <span>&#45;&gt;</span> <a href="index.html#type-attribute">attribute</a> list) <span>&#45;&gt;</span> ?&#8288;attrs_e:(<span class="type-var">'e</span> <span>&#45;&gt;</span> <a href="index.html#type-attribute">attribute</a> list) <span>&#45;&gt;</span> ?&#8288;name:string <span>&#45;&gt;</span> graph:(<span class="type-var">'v</span>, <span class="type-var">'e</span>) <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> Stdlib.Format.formatter <span>&#45;&gt;</span> <span class="type-var">'v</span> <a href="../index.html#type-iter">iter</a> <span>&#45;&gt;</span> unit</code></dt><dt class="spec value" id="val-with_out"><a href="#val-with_out" class="anchor"></a><code><span class="keyword">val</span> with_out : string <span>&#45;&gt;</span> (Stdlib.Format.formatter <span>&#45;&gt;</span> <span class="type-var">'a</span>) <span>&#45;&gt;</span> <span class="type-var">'a</span></code></dt><dd><p>Shortcut to open a file and write to it.</p></dd></dl></div></body></html>