mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
6 lines
No EOL
7 KiB
HTML
6 lines
No EOL
7 KiB
HTML
<!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="generator" content="odoc 2.0.2"/><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">CCGraph</a> » Dot</nav><header class="odoc-preamble"><h1>Module <code><span>CCGraph.Dot</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type" id="type-attribute" class="anchored"><a href="#type-attribute" class="anchor"></a><code><span><span class="keyword">type</span> attribute</span><span> = </span><span>[ </span></code><table><tr id="type-attribute.Color" class="anchored"><td class="def constructor"><a href="#type-attribute.Color" class="anchor"></a><code><span>| </span></code><code><span>`Color <span class="keyword">of</span> string</span></code></td></tr><tr id="type-attribute.Shape" class="anchored"><td class="def constructor"><a href="#type-attribute.Shape" class="anchor"></a><code><span>| </span></code><code><span>`Shape <span class="keyword">of</span> string</span></code></td></tr><tr id="type-attribute.Weight" class="anchored"><td class="def constructor"><a href="#type-attribute.Weight" class="anchor"></a><code><span>| </span></code><code><span>`Weight <span class="keyword">of</span> int</span></code></td></tr><tr id="type-attribute.Style" class="anchored"><td class="def constructor"><a href="#type-attribute.Style" class="anchor"></a><code><span>| </span></code><code><span>`Style <span class="keyword">of</span> string</span></code></td></tr><tr id="type-attribute.Label" class="anchored"><td class="def constructor"><a href="#type-attribute.Label" class="anchor"></a><code><span>| </span></code><code><span>`Label <span class="keyword">of</span> string</span></code></td></tr><tr id="type-attribute.Other" class="anchored"><td class="def constructor"><a href="#type-attribute.Other" class="anchor"></a><code><span>| </span></code><code><span>`Other <span class="keyword">of</span> string * string</span></code></td></tr></table><code><span> ]</span></code></div><div class="spec-doc"><p>Dot attribute</p></div></div><div class="odoc-spec"><div class="spec type" id="type-vertex_state" class="anchored"><a href="#type-vertex_state" class="anchor"></a><code><span><span class="keyword">type</span> vertex_state</span></code></div><div class="spec-doc"><p>Hidden state associated to a vertex</p></div></div><div class="odoc-spec"><div class="spec value" id="val-pp" class="anchored"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span>tbl:<span><span>(<span class="type-var">'v</span>, <a href="#type-vertex_state">vertex_state</a>)</span> <a href="../index.html#type-table">table</a></span> <span class="arrow">-></span></span> <span>eq:<span>(<span><span class="type-var">'v</span> <span class="arrow">-></span></span> <span><span class="type-var">'v</span> <span class="arrow">-></span></span> bool)</span> <span class="arrow">-></span></span> <span>?attrs_v:<span>(<span><span class="type-var">'v</span> <span class="arrow">-></span></span> <span><a href="#type-attribute">attribute</a> list</span>)</span> <span class="arrow">-></span></span>
|
||
<span>?attrs_e:<span>(<span><span class="type-var">'e</span> <span class="arrow">-></span></span> <span><a href="#type-attribute">attribute</a> list</span>)</span> <span class="arrow">-></span></span> <span>?name:string <span class="arrow">-></span></span> <span>graph:<span><span>(<span class="type-var">'v</span>, <span class="type-var">'e</span>)</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">-></span></span>
|
||
<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">-></span></span> <span><span class="type-var">'v</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Print the graph, starting from given vertex, on the formatter.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">attrs_v</span> <p>attributes for vertices.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">attrs_e</span> <p>attributes for edges.</p></li></ul><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></div></div><div class="odoc-spec"><div class="spec value" id="val-pp_all" class="anchored"><a href="#val-pp_all" class="anchor"></a><code><span><span class="keyword">val</span> pp_all : <span>tbl:<span><span>(<span class="type-var">'v</span>, <a href="#type-vertex_state">vertex_state</a>)</span> <a href="../index.html#type-table">table</a></span> <span class="arrow">-></span></span> <span>eq:<span>(<span><span class="type-var">'v</span> <span class="arrow">-></span></span> <span><span class="type-var">'v</span> <span class="arrow">-></span></span> bool)</span> <span class="arrow">-></span></span> <span>?attrs_v:<span>(<span><span class="type-var">'v</span> <span class="arrow">-></span></span> <span><a href="#type-attribute">attribute</a> list</span>)</span> <span class="arrow">-></span></span>
|
||
<span>?attrs_e:<span>(<span><span class="type-var">'e</span> <span class="arrow">-></span></span> <span><a href="#type-attribute">attribute</a> list</span>)</span> <span class="arrow">-></span></span> <span>?name:string <span class="arrow">-></span></span> <span>graph:<span><span>(<span class="type-var">'v</span>, <span class="type-var">'e</span>)</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">-></span></span>
|
||
<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">-></span></span> <span><span><span class="type-var">'v</span> <a href="../index.html#type-iter">iter</a></span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Same as <a href="#val-pp"><code>pp</code></a> but starting from several vertices, not just one.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.8</li></ul></div></div><div class="odoc-spec"><div class="spec value" id="val-with_out" class="anchored"><a href="#val-with_out" class="anchor"></a><code><span><span class="keyword">val</span> with_out : <span>string <span class="arrow">-></span></span> <span><span>(<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">-></span></span> <span class="type-var">'a</span>)</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Shortcut to open a file and write to it.</p></div></div></div></body></html> |