mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
4 lines
No EOL
6.8 KiB
HTML
4 lines
No EOL
6.8 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Dot (containers.iter.CCKTree.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> — <span class="package">package <a href="../../index.html">containers.iter</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCKTree.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.Id" class="anchored"><td class="def constructor"><a href="#type-attribute.Id" class="anchor"></a><code><span class="keyword">| </span></code><code>`Id<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 attributes for nodes</p></div></div><div class="spec type" id="type-graph"><a href="#type-graph" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>graph</code><code><span class="keyword"> = </span>string<span class="keyword"> * </span><a href="index.html#type-attribute">attribute</a> list <a href="../index.html#type-t">t</a> list</code><code></code></div><div class="doc"><p>A dot graph is a name, plus a list of trees labelled with attributes</p></div></div><div class="spec val" id="val-mk_id"><a href="#val-mk_id" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>mk_id : (<span class="type-var">'a</span>, Buffer.t, unit, <a href="index.html#type-attribute">attribute</a>) Pervasives.format4 <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>Using a formatter string, build an ID.</p></div></div><div class="spec val" id="val-mk_label"><a href="#val-mk_label" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>mk_label : (<span class="type-var">'a</span>, Buffer.t, unit, <a href="index.html#type-attribute">attribute</a>) Pervasives.format4 <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>Using a formatter string, build a label.</p></div></div><div class="spec val" id="val-make"><a href="#val-make" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>make : name:string <span class="keyword">‑></span> <a href="index.html#type-attribute">attribute</a> list <a href="../index.html#type-t">t</a> list <span class="keyword">‑></span> <a href="index.html#type-graph">graph</a></code></div><div class="doc"></div></div><div class="spec val" id="val-singleton"><a href="#val-singleton" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>singleton : name:string <span class="keyword">‑></span> <a href="index.html#type-attribute">attribute</a> list <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-graph">graph</a></code></div><div class="doc"></div></div><div class="spec val" id="val-pp_single"><a href="#val-pp_single" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pp_single : string <span class="keyword">‑></span> <a href="index.html#type-attribute">attribute</a> list <a href="../index.html#type-t">t</a> <a href="../index.html#type-printer">printer</a></code></div><div class="doc"></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 : <a href="index.html#type-graph">graph</a> <a href="../index.html#type-printer">printer</a></code></div><div class="doc"><p>Printer to DOT with indentation, etc.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.6.1</li></ul></div></div><div class="spec val" id="val-print_to_file"><a href="#val-print_to_file" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>print_to_file : string <span class="keyword">‑></span> <a href="index.html#type-graph">graph</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">print_to_file filename g</code> prints <code class="code">g</code> into a file whose name
|
||
is <code class="code">filename</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.6.1</li></ul></div></div><div class="spec val" id="val-to_file"><a href="#val-to_file" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_file : ?⁠name:string <span class="keyword">‑></span> string <span class="keyword">‑></span> <a href="index.html#type-attribute">attribute</a> list <a href="../index.html#type-t">t</a> list <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">to_file filename trees</code> makes a graph out of the trees, opens the
|
||
file <code class="code">filename</code> and prints the graph into the file.</p><ul class="at-tag"><li><span class="at-tag parameter">Parameter</span> <span class="module-path">name</span>: name of the graph.</li><li><span class="at-tag since">Since</span>: 0.6.1</li></ul></div></div></body></html> |