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