/usr/share/doc/mlpost/html/Mlpost.Tree.html is in libmlpost-ocaml-doc 0.8.1-6build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Mlpost.Helpers.html">
<link rel="next" href="Mlpost.Tree_adv.html">
<link rel="Up" href="Mlpost.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of class attributes" rel=Appendix href="index_attributes.html">
<link title="Index of class methods" rel=Appendix href="index_methods.html">
<link title="Index of classes" rel=Appendix href="index_classes.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Mlpost" rel="Chapter" href="Mlpost.html">
<link title="Mlpost_dot" rel="Chapter" href="Mlpost_dot.html">
<link title="Mlpost_lablgtk" rel="Chapter" href="Mlpost_lablgtk.html"><title>Mlpost.Tree</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Mlpost.Helpers.html" title="Mlpost.Helpers">Previous</a>
<a class="up" href="Mlpost.html" title="Mlpost">Up</a>
<a class="post" href="Mlpost.Tree_adv.html" title="Mlpost.Tree_adv">Next</a>
</div>
<h1>Module <a href="type_Mlpost.Tree.html">Mlpost.Tree</a></h1>
<pre><span class="keyword">module</span> Tree: <code class="code">sig</code> <a href="Mlpost.Tree.html">..</a> <code class="code">end</code></pre><div class="info module top">
Create and draw trees<br>
</div>
<hr width="100%">
<br>
This module provides high-level means for creating and drawing Trees<br>
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
<div class="info ">
The type of trees<br>
</div>
<pre><code><span id="TYPEarrow_style"><span class="keyword">type</span> <code class="type"></code>arrow_style</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTarrow_style.Directed"><span class="constructor">Directed</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
edges are directed and an
arrow is drawn at the end of an edge<br>
</div>
</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTarrow_style.Undirected"><span class="constructor">Undirected</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
edges are undirected and no arrow is drawn<br>
</div>
</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info ">
The style of arrows between nodes<br>
</div>
<pre><code><span id="TYPEedge_style"><span class="keyword">type</span> <code class="type"></code>edge_style</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTedge_style.Straight"><span class="constructor">Straight</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
edges are straight lines between nodes<br>
</div>
</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTedge_style.Curve"><span class="constructor">Curve</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
edges are curved lines between nodes<br>
</div>
</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTedge_style.Square"><span class="constructor">Square</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
edges are straight lines and
branch out from the sides of nodes<br>
</div>
</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTedge_style.HalfSquare"><span class="constructor">HalfSquare</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
edges are straight lines and
branch out from below nodes<br>
</div>
</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info ">
There are several styles available for edges<br>
</div>
<pre><span id="VALleaf"><span class="keyword">val</span> leaf</span> : <code class="type"><a href="Mlpost.Box.html#TYPEt">Box.t</a> -> <a href="Mlpost.Tree.html#TYPEt">t</a></code></pre><div class="info ">
<h2 id="2_Creation">Creation</h2>
<p>
<code class="code">leaf b</code> creates a leaf with Box <code class="code">b</code>.<br>
</div>
<pre><span id="VALnode"><span class="keyword">val</span> node</span> : <code class="type">?ls:<a href="Mlpost.Num.html#TYPEt">Num.t</a> -><br> ?cs:<a href="Mlpost.Num.html#TYPEt">Num.t</a> -><br> ?arrow_style:<a href="Mlpost.Tree.html#TYPEarrow_style">arrow_style</a> -><br> ?edge_style:<a href="Mlpost.Tree.html#TYPEedge_style">edge_style</a> -><br> ?stroke:<a href="Mlpost.Color.html#TYPEt">Color.t</a> -><br> ?brush:<a href="Mlpost.Brush.html#TYPEt">Brush.t</a> -><br> ?pen:Pen.t -><br> ?sep:<a href="Mlpost.Num.html#TYPEt">Num.t</a> -> <a href="Mlpost.Box.html#TYPEt">Box.t</a> -> <a href="Mlpost.Tree.html#TYPEt">t</a> list -> <a href="Mlpost.Tree.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">node label children</code> creates a node with label <code class="code">label</code> and a list
of children <code class="code">children</code>.
Default arrow_style is <code class="code">Directed</code>.
Default edge_style is <code class="code">Straight</code>.<ul>
<li><code class="code">ls</code> (level sep): vertical distance between levels.
The default value is 1.0. A negative value draws the tree upward.</li>
<li><code class="code">cs</code> (children sep): horizontal distance between siblings.
The default value is 0.2.
Optional arguments are the same as in <code class="code">leaf</code>.</li>
</ul>
<br>
</div>
<pre><span id="VALnodel"><span class="keyword">val</span> nodel</span> : <code class="type">?ls:<a href="Mlpost.Num.html#TYPEt">Num.t</a> -><br> ?cs:<a href="Mlpost.Num.html#TYPEt">Num.t</a> -><br> ?arrow_style:<a href="Mlpost.Tree.html#TYPEarrow_style">arrow_style</a> -><br> ?edge_style:<a href="Mlpost.Tree.html#TYPEedge_style">edge_style</a> -><br> ?stroke:<a href="Mlpost.Color.html#TYPEt">Color.t</a> -><br> ?brush:<a href="Mlpost.Brush.html#TYPEt">Brush.t</a> -><br> ?pen:Pen.t -><br> ?sep:<a href="Mlpost.Num.html#TYPEt">Num.t</a> -><br> <a href="Mlpost.Box.html#TYPEt">Box.t</a> -><br> (<a href="Mlpost.Tree.html#TYPEt">t</a> * (<a href="Mlpost.Command.html#TYPEposition">Command.position</a> * <a href="Mlpost.Picture.html#TYPEt">Picture.t</a>)) list -><br> <a href="Mlpost.Tree.html#TYPEt">t</a></code></pre><div class="info ">
Similar to <code class="code">node</code> but with labels on edges.
Labels are taken into account only when <code class="code">edge_style</code> is <code class="code">Straight</code>.<br>
</div>
<pre><span id="VALbin"><span class="keyword">val</span> bin</span> : <code class="type">?ls:<a href="Mlpost.Num.html#TYPEt">Num.t</a> -><br> ?cs:<a href="Mlpost.Num.html#TYPEt">Num.t</a> -><br> ?arrow_style:<a href="Mlpost.Tree.html#TYPEarrow_style">arrow_style</a> -><br> ?edge_style:<a href="Mlpost.Tree.html#TYPEedge_style">edge_style</a> -><br> ?stroke:<a href="Mlpost.Color.html#TYPEt">Color.t</a> -><br> ?brush:<a href="Mlpost.Brush.html#TYPEt">Brush.t</a> -><br> ?pen:Pen.t -><br> ?sep:<a href="Mlpost.Num.html#TYPEt">Num.t</a> -><br> <a href="Mlpost.Box.html#TYPEt">Box.t</a> -> <a href="Mlpost.Tree.html#TYPEt">t</a> -> <a href="Mlpost.Tree.html#TYPEt">t</a> -> <a href="Mlpost.Tree.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">bin label l r</code> creates a binary node with label <code class="code">label</code> and
children <code class="code">l</code> and <code class="code">r</code>.
Optional arguments are the same as in <code class="code">leaf</code>.<br>
</div>
<pre><span id="VALto_box"><span class="keyword">val</span> to_box</span> : <code class="type"><a href="Mlpost.Tree.html#TYPEt">t</a> -> <a href="Mlpost.Box.html#TYPEt">Box.t</a></code></pre>
<pre><span id="VALdraw"><span class="keyword">val</span> draw</span> : <code class="type">?debug:bool -> <a href="Mlpost.Tree.html#TYPEt">t</a> -> <a href="Mlpost.Command.html#TYPEt">Command.t</a></code></pre>
<pre><span class="keyword">module</span> <a href="Mlpost.Tree.Simple.html">Simple</a>: <code class="code">sig</code> <a href="Mlpost.Tree.Simple.html">..</a> <code class="code">end</code></pre></body></html>
|