ocaml-containers/2.0/containers.data/CCGraph/Dot/index.html
2018-01-21 15:48:04 -06:00

2 lines
No EOL
6.1 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.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Dot (containers.data.CCGraph.Dot)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> &mdash; <span class="package">package <a href="../../index.html">containers.data</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCGraph.Dot</span></h1></header><div class="spec type" id="type-attribute"><a href="#type-attribute" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>attribute</code><span class="keyword"> = </span><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><span class="keyword">| </span></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><span class="keyword">| </span></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><span class="keyword">| </span></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><span class="keyword">| </span></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><span class="keyword">| </span></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><span class="keyword">| </span></code><code>`Other<span class="keyword"> of </span>string<span class="keyword"> * </span>string</code></td></tr></table><code> ]</code><code></code></div><div class="doc"><p>Dot attribute</p></div></div><div class="spec type" id="type-vertex_state"><a href="#type-vertex_state" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>vertex_state</code><code></code><code></code></div><div class="doc"><p>Hidden state associated to a vertex</p></div></div><div class="spec val" id="val-pp"><a href="#val-pp" class="anchor"></a><div class="def val"><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 class="keyword">&#8209;&gt;</span> eq:(<span class="type-var">'v</span> <span class="keyword">&#8209;&gt;</span> <span class="type-var">'v</span> <span class="keyword">&#8209;&gt;</span> bool) <span class="keyword">&#8209;&gt;</span> ?&#8288;attrs_v:(<span class="type-var">'v</span> <span class="keyword">&#8209;&gt;</span> <a href="index.html#type-attribute">attribute</a> list) <span class="keyword">&#8209;&gt;</span> ?&#8288;attrs_e:(<span class="type-var">'e</span> <span class="keyword">&#8209;&gt;</span> <a href="index.html#type-attribute">attribute</a> list) <span class="keyword">&#8209;&gt;</span> ?&#8288;name:string <span class="keyword">&#8209;&gt;</span> graph:(<span class="type-var">'v</span>, <span class="type-var">'e</span>) <a href="../index.html#type-t">t</a> <span class="keyword">&#8209;&gt;</span> Format.formatter <span class="keyword">&#8209;&gt;</span> <span class="type-var">'v</span> <span class="keyword">&#8209;&gt;</span> unit</code></div><div class="doc"><p>Print the graph, starting from given vertex, on the formatter.</p><ul class="at-tag"><li><span class="at-tag parameter">Parameter</span> <span class="module-path">attrs_v</span>: attributes for vertices.</li><li><span class="at-tag parameter">Parameter</span> <span class="module-path">attrs_e</span>: attributes for edges.</li><li><span class="at-tag parameter">Parameter</span> <span class="module-path">name</span>: name of the graph.</li></ul></div></div><div class="spec val" id="val-pp_seq"><a href="#val-pp_seq" class="anchor"></a><div class="def val"><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 class="keyword">&#8209;&gt;</span> eq:(<span class="type-var">'v</span> <span class="keyword">&#8209;&gt;</span> <span class="type-var">'v</span> <span class="keyword">&#8209;&gt;</span> bool) <span class="keyword">&#8209;&gt;</span> ?&#8288;attrs_v:(<span class="type-var">'v</span> <span class="keyword">&#8209;&gt;</span> <a href="index.html#type-attribute">attribute</a> list) <span class="keyword">&#8209;&gt;</span> ?&#8288;attrs_e:(<span class="type-var">'e</span> <span class="keyword">&#8209;&gt;</span> <a href="index.html#type-attribute">attribute</a> list) <span class="keyword">&#8209;&gt;</span> ?&#8288;name:string <span class="keyword">&#8209;&gt;</span> graph:(<span class="type-var">'v</span>, <span class="type-var">'e</span>) <a href="../index.html#type-t">t</a> <span class="keyword">&#8209;&gt;</span> Format.formatter <span class="keyword">&#8209;&gt;</span> <span class="type-var">'v</span> <a href="../index.html#type-sequence">sequence</a> <span class="keyword">&#8209;&gt;</span> unit</code></div><div class="doc"></div></div><div class="spec val" id="val-with_out"><a href="#val-with_out" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>with_out : string <span class="keyword">&#8209;&gt;</span> (Format.formatter <span class="keyword">&#8209;&gt;</span> <span class="type-var">'a</span>) <span class="keyword">&#8209;&gt;</span> <span class="type-var">'a</span></code></div><div class="doc"><p>Shortcut to open a file and write to it.</p></div></div></body></html>