mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
2 lines
No EOL
7.4 KiB
HTML
2 lines
No EOL
7.4 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Dot (containers-data.CCKTree.Dot)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">containers-data</a> » <a href="../index.html">CCKTree</a> » Dot</nav><header class="odoc-preamble"><h1>Module <code><span>CCKTree.Dot</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-attribute"><a href="#type-attribute" class="anchor"></a><code><span><span class="keyword">type</span> attribute</span><span> = </span><span>[ </span></code><ol><li id="type-attribute.Color" class="def constructor anchored"><a href="#type-attribute.Color" class="anchor"></a><code><span>| </span></code><code><span>`Color <span class="keyword">of</span> string</span></code></li><li id="type-attribute.Shape" class="def constructor anchored"><a href="#type-attribute.Shape" class="anchor"></a><code><span>| </span></code><code><span>`Shape <span class="keyword">of</span> string</span></code></li><li id="type-attribute.Weight" class="def constructor anchored"><a href="#type-attribute.Weight" class="anchor"></a><code><span>| </span></code><code><span>`Weight <span class="keyword">of</span> int</span></code></li><li id="type-attribute.Style" class="def constructor anchored"><a href="#type-attribute.Style" class="anchor"></a><code><span>| </span></code><code><span>`Style <span class="keyword">of</span> string</span></code></li><li id="type-attribute.Label" class="def constructor anchored"><a href="#type-attribute.Label" class="anchor"></a><code><span>| </span></code><code><span>`Label <span class="keyword">of</span> string</span></code></li><li id="type-attribute.Id" class="def constructor anchored"><a href="#type-attribute.Id" class="anchor"></a><code><span>| </span></code><code><span>`Id <span class="keyword">of</span> string</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Unique ID in the graph. Allows sharing.</p><span class="comment-delim">*)</span></div></li><li id="type-attribute.Other" class="def constructor anchored"><a href="#type-attribute.Other" class="anchor"></a><code><span>| </span></code><code><span>`Other <span class="keyword">of</span> string * string</span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>Dot attributes for nodes</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-graph"><a href="#type-graph" class="anchor"></a><code><span><span class="keyword">type</span> graph</span><span> = string * <span><span><span><a href="#type-attribute">attribute</a> list</span> <a href="../index.html#type-t">t</a></span> list</span></span></code></div><div class="spec-doc"><p>A dot graph is a name, plus a list of trees labelled with attributes</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-mk_id"><a href="#val-mk_id" class="anchor"></a><code><span><span class="keyword">val</span> mk_id : <span><span><span>(<span class="type-var">'a</span>, <span class="xref-unresolved">Stdlib</span>.Buffer.t, unit, <a href="#type-attribute">attribute</a>)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Using a formatter string, build an ID.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-mk_label"><a href="#val-mk_label" class="anchor"></a><code><span><span class="keyword">val</span> mk_label : <span><span><span>(<span class="type-var">'a</span>, <span class="xref-unresolved">Stdlib</span>.Buffer.t, unit, <a href="#type-attribute">attribute</a>)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Using a formatter string, build a label.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make : <span>name:string <span class="arrow">-></span></span> <span><span><span><span><a href="#type-attribute">attribute</a> list</span> <a href="../index.html#type-t">t</a></span> list</span> <span class="arrow">-></span></span> <a href="#type-graph">graph</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-singleton"><a href="#val-singleton" class="anchor"></a><code><span><span class="keyword">val</span> singleton : <span>name:string <span class="arrow">-></span></span> <span><span><span><a href="#type-attribute">attribute</a> list</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <a href="#type-graph">graph</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_single"><a href="#val-pp_single" class="anchor"></a><code><span><span class="keyword">val</span> pp_single : <span>string <span class="arrow">-></span></span> <span><span><span><a href="#type-attribute">attribute</a> list</span> <a href="../index.html#type-t">t</a></span> <a href="../index.html#type-printer">printer</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><a href="#type-graph">graph</a> <a href="../index.html#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p>Printer to DOT with indentation, etc.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.6.1</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print_to_file"><a href="#val-print_to_file" class="anchor"></a><code><span><span class="keyword">val</span> print_to_file : <span>string <span class="arrow">-></span></span> <span><a href="#type-graph">graph</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>print_to_file filename g</code> prints <code>g</code> into a file whose name is <code>filename</code>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.6.1</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_file"><a href="#val-to_file" class="anchor"></a><code><span><span class="keyword">val</span> to_file : <span>?name:string <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span><span><span><span><a href="#type-attribute">attribute</a> list</span> <a href="../index.html#type-t">t</a></span> list</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><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><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">name</span> <p>name of the graph.</p></li></ul><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.6.1</li></ul></div></div></div></body></html> |