/usr/share/doc/mlpost/html/Mlpost.Diag.html is in libmlpost-ocaml-doc 0.8.1-6.
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 | <!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.Tree_adv.html">
<link rel="next" href="Mlpost.Plot.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"><link title="Creation" rel="Section" href="#2_Creation">
<link title="Drawing" rel="Section" href="#2_Drawing">
<title>Mlpost.Diag</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Mlpost.Tree_adv.html" title="Mlpost.Tree_adv">Previous</a>
<a class="up" href="Mlpost.html" title="Mlpost">Up</a>
<a class="post" href="Mlpost.Plot.html" title="Mlpost.Plot">Next</a>
</div>
<h1>Module <a href="type_Mlpost.Diag.html">Mlpost.Diag</a></h1>
<pre><span class="keyword">module</span> Diag: <code class="code">sig</code> <a href="Mlpost.Diag.html">..</a> <code class="code">end</code></pre><div class="info module top">
Create simple diagrams by placing objects in a table. Deprecated.<br>
</div>
<hr width="100%">
<br>
Diagrams.<br>
<br>
This module permits to create diagrams in a very simple and yet quite
flexible fashion. It permits to specify content, form and color of nodes as
well as color, form and labels of arrows between nodes. Nodes have to be
placed by hand, though<br>
<br>
<h2 id="2_Creation">Creation</h2><br>
<pre><span id="TYPEnode"><span class="keyword">type</span> <code class="type"></code>node</span> </pre>
<div class="info ">
The abstract type of nodes<br>
</div>
<pre><span id="TYPEnode_style"><span class="keyword">type</span> <code class="type"></code>node_style</span> = <code class="type"><a href="Mlpost.Box.html#TYPEt">Box.t</a> -> <a href="Mlpost.Box.html#TYPEt">Box.t</a></code> </pre>
<div class="info ">
The type for node styles; It corresponds to the type of the box
creation functions in the <a href="Mlpost.Box.html"><code class="code">Box</code></a> module<br>
</div>
<pre><span id="VALnode"><span class="keyword">val</span> node</span> : <code class="type">?style:<a href="Mlpost.Diag.html#TYPEnode_style">node_style</a> -><br> ?fill:<a href="Mlpost.Color.html#TYPEt">Color.t</a> -><br> ?boxed:bool -> float -> float -> <a href="Mlpost.Box.html#TYPEt">Box.t</a> -> <a href="Mlpost.Diag.html#TYPEnode">node</a></code></pre><div class="info ">
Construct a node at a given position with a given content in Latex
format and a box style<br>
</div>
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
<div class="info ">
The abstract type of diagrams<br>
</div>
<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type"><a href="Mlpost.Diag.html#TYPEnode">node</a> list -> <a href="Mlpost.Diag.html#TYPEt">t</a></code></pre><div class="info ">
Create a diagram that consists of the given nodes<br>
</div>
<pre><code><span id="TYPEdir"><span class="keyword">type</span> <code class="type"></code>dir</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="TYPEELTdir.Up"><span class="constructor">Up</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdir.Down"><span class="constructor">Down</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdir.Left"><span class="constructor">Left</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdir.Right"><span class="constructor">Right</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdir.Angle"><span class="constructor">Angle</span></span> <span class="keyword">of</span> <code class="type">float</code></code></td>
</tr></table>
<pre><span id="VALarrow"><span class="keyword">val</span> arrow</span> : <code class="type"><a href="Mlpost.Diag.html#TYPEt">t</a> -><br> ?lab:string -><br> ?line_width:<a href="Mlpost.Num.html#TYPEt">Num.t</a> -><br> ?boxed:bool -><br> ?line_color:<a href="Mlpost.Color.html#TYPEt">Color.t</a> -><br> ?fill_color:<a href="Mlpost.Color.html#TYPEt">Color.t</a> -><br> ?pos:<a href="Mlpost.Command.html#TYPEposition">Command.position</a> -><br> ?head:bool -><br> ?dashed:Dash.t -><br> ?outd:<a href="Mlpost.Diag.html#TYPEdir">dir</a> -><br> ?ind:<a href="Mlpost.Diag.html#TYPEdir">dir</a> -> <a href="Mlpost.Diag.html#TYPEnode">node</a> -> <a href="Mlpost.Diag.html#TYPEnode">node</a> -> unit</code></pre><div class="info ">
<code class="code">arrow d n1 n2</code> adds an arrow between n1 and n2 in the diagram d, by
side effect.<br>
</div>
<div class="param_info"><code class="code">lab</code> : The label of the arrow, in Latex format</div>
<div class="param_info"><code class="code">line_width</code> : Draws a thick arrow of that width, if present
(experimental)</div>
<div class="param_info"><code class="code">pos</code> : The position of the label, relative to the arrow</div>
<div class="param_info"><code class="code">head</code> : If true, the arrow has a head. Otherwise, it's just a line.</div>
<div class="param_info"><code class="code">outd</code> : The outgoing direction of the arrow</div>
<div class="param_info"><code class="code">ind</code> : The ingoing direction of the arrow</div>
<br>
<h2 id="2_Drawing">Drawing</h2><br>
<pre><span id="VALdraw"><span class="keyword">val</span> draw</span> : <code class="type">?scale:(float -> <a href="Mlpost.Num.html#TYPEt">Num.t</a>) -><br> ?style:<a href="Mlpost.Diag.html#TYPEnode_style">node_style</a> -><br> ?boxed:bool -><br> ?fill:<a href="Mlpost.Color.html#TYPEt">Color.t</a> -><br> ?stroke:<a href="Mlpost.Color.html#TYPEt">Color.t</a> -><br> ?pen:Pen.t -> <a href="Mlpost.Diag.html#TYPEt">t</a> -> <a href="Mlpost.Command.html#TYPEt">Command.t</a></code></pre><div class="info ">
Draws the diagram.<br>
</div>
<div class="param_info"><code class="code">scale</code> : The distance between nodes; default is 40 bp</div>
<div class="param_info"><code class="code">style</code> : The style of nodes: circular or rectangular
(default is circular)</div>
<div class="param_info"><code class="code">boxed</code> : The border is drawn if set (default is true)</div>
<div class="param_info"><code class="code">fill</code> : The color to fill nodes</div>
<div class="param_info"><code class="code">stroke</code> : The color to draw arrows</div>
<div class="param_info"><code class="code">pen</code> : The pen used for arrows</div>
</body></html>
|