This file is indexed.

/usr/share/doc/mlpost/html/Mlpost.Num.html is in libmlpost-ocaml-doc 0.8.1-8build1.

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
<!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">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="Start" href="index.html">
<link rel="previous" href="Mlpost.Signature.html">
<link rel="next" href="Mlpost.Color.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="Conversion functions" rel="Section" href="#2_Conversionfunctions">
<link title="Useful operations on Nums" rel="Section" href="#2_UsefuloperationsonNums">
<link title="Useful constants and functions" rel="Section" href="#2_Usefulconstantsandfunctions">
<link title="Infix operators" rel="Subsection" href="#3_Infixoperators">
<title>Mlpost.Num</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Mlpost.Signature.html" title="Mlpost.Signature">Previous</a>
&nbsp;<a class="up" href="Mlpost.html" title="Mlpost">Up</a>
&nbsp;<a class="post" href="Mlpost.Color.html" title="Mlpost.Color">Next</a>
</div>
<h1>Module <a href="type_Mlpost.Num.html">Mlpost.Num</a></h1>

<pre><span class="keyword">module</span> Num: <code class="code">sig</code> <a href="Mlpost.Num.html">..</a> <code class="code">end</code></pre><div class="info module top">
Abstract numeric values<br>
</div>
<hr width="100%">
<br>
Numerics are a symbolic representation of numeric values.
    In many cases, but not always, an object of type <a href="Mlpost.Num.html#TYPEt"><code class="code">Num.t</code></a> is intended to be
    a length in some unit. In addition, values of type <a href="Mlpost.Num.html#TYPEt"><code class="code">Num.t</code></a> may actually be
    unknown to Mlpost. This is why there is no function that gives back a
    <code class="code">float</code>.<br>

<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> = <code class="type"><a href="Mlpost.Signature.html#TYPEnum">Signature.num</a></code> </pre>
<div class="info ">
The Mlpost numeric type is an abstract datatype<br>
</div>

<br>
<h2 id="2_Conversionfunctions">Conversion functions</h2><br>

<pre><span id="VALof_float"><span class="keyword">val</span> of_float</span> : <code class="type">float -> <a href="Mlpost.Num.html#TYPEt">t</a></code></pre><div class="info ">
Convert a float into a <a href="Mlpost.Num.html#TYPEt"><code class="code">Num.t</code></a><br>
</div>

<pre><span id="VALbp"><span class="keyword">val</span> bp</span> : <code class="type">float -> <a href="Mlpost.Num.html#TYPEt">t</a></code></pre><div class="info ">
The base unit in Mlpost is bp.<br>
</div>

<pre><span id="VALpt"><span class="keyword">val</span> pt</span> : <code class="type">float -> <a href="Mlpost.Num.html#TYPEt">t</a></code></pre><div class="info ">
pt are PostScript points. This is the same unit as the pt unit in TeX<br>
</div>

<pre><span id="VALcm"><span class="keyword">val</span> cm</span> : <code class="type">float -> <a href="Mlpost.Num.html#TYPEt">t</a></code></pre>
<pre><span id="VALmm"><span class="keyword">val</span> mm</span> : <code class="type">float -> <a href="Mlpost.Num.html#TYPEt">t</a></code></pre>
<pre><span id="VALinch"><span class="keyword">val</span> inch</span> : <code class="type">float -> <a href="Mlpost.Num.html#TYPEt">t</a></code></pre><br>
The following are units dependent of the font used<br>

<pre><span id="VALem"><span class="keyword">val</span> em</span> : <code class="type">float -> <a href="Mlpost.Num.html#TYPEt">t</a></code></pre><div class="info ">
the width of an "m"<br>
</div>

<pre><span id="VALex"><span class="keyword">val</span> ex</span> : <code class="type">float -> <a href="Mlpost.Num.html#TYPEt">t</a></code></pre><div class="info ">
the height of an "x"<br>
</div>
<br>
<h2 id="2_UsefuloperationsonNums">Useful operations on Nums</h2><br>

<pre><span id="VALaddn"><span class="keyword">val</span> addn</span> : <code class="type"><a href="Mlpost.Num.html#TYPEt">t</a> -> <a href="Mlpost.Num.html#TYPEt">t</a> -> <a href="Mlpost.Num.html#TYPEt">t</a></code></pre>
<pre><span id="VALsubn"><span class="keyword">val</span> subn</span> : <code class="type"><a href="Mlpost.Num.html#TYPEt">t</a> -> <a href="Mlpost.Num.html#TYPEt">t</a> -> <a href="Mlpost.Num.html#TYPEt">t</a></code></pre>
<pre><span id="VALmultn"><span class="keyword">val</span> multn</span> : <code class="type"><a href="Mlpost.Num.html#TYPEt">t</a> -> <a href="Mlpost.Num.html#TYPEt">t</a> -> <a href="Mlpost.Num.html#TYPEt">t</a></code></pre>
<pre><span id="VALmultf"><span class="keyword">val</span> multf</span> : <code class="type">float -> <a href="Mlpost.Num.html#TYPEt">t</a> -> <a href="Mlpost.Num.html#TYPEt">t</a></code></pre>
<pre><span id="VALdivf"><span class="keyword">val</span> divf</span> : <code class="type"><a href="Mlpost.Num.html#TYPEt">t</a> -> float -> <a href="Mlpost.Num.html#TYPEt">t</a></code></pre>
<pre><span id="VALneg"><span class="keyword">val</span> neg</span> : <code class="type"><a href="Mlpost.Num.html#TYPEt">t</a> -> <a href="Mlpost.Num.html#TYPEt">t</a></code></pre>
<pre><span id="VALdivn"><span class="keyword">val</span> divn</span> : <code class="type"><a href="Mlpost.Num.html#TYPEt">t</a> -> <a href="Mlpost.Num.html#TYPEt">t</a> -> <a href="Mlpost.Num.html#TYPEt">t</a></code></pre>
<pre><span id="VALmaxn"><span class="keyword">val</span> maxn</span> : <code class="type"><a href="Mlpost.Num.html#TYPEt">t</a> -> <a href="Mlpost.Num.html#TYPEt">t</a> -> <a href="Mlpost.Num.html#TYPEt">t</a></code></pre>
<pre><span id="VALminn"><span class="keyword">val</span> minn</span> : <code class="type"><a href="Mlpost.Num.html#TYPEt">t</a> -> <a href="Mlpost.Num.html#TYPEt">t</a> -> <a href="Mlpost.Num.html#TYPEt">t</a></code></pre>
<pre><span id="VALgmean"><span class="keyword">val</span> gmean</span> : <code class="type"><a href="Mlpost.Num.html#TYPEt">t</a> -> <a href="Mlpost.Num.html#TYPEt">t</a> -> <a href="Mlpost.Num.html#TYPEt">t</a></code></pre><div class="info ">
the geometric mean of two nums : sqrt(a * a + b * b)<br>
</div>

<pre><span id="VALif_null"><span class="keyword">val</span> if_null</span> : <code class="type"><a href="Mlpost.Num.html#TYPEt">t</a> -> <a href="Mlpost.Num.html#TYPEt">t</a> -> <a href="Mlpost.Num.html#TYPEt">t</a> -> <a href="Mlpost.Num.html#TYPEt">t</a></code></pre><div class="info ">
if_null n n1 n2 is equal to n1 if n is null, n2 othewise<br>
</div>
<br>
<h3 id="3_Infixoperators">Infix operators</h3><br>

<pre><span class="keyword">module</span> <a href="Mlpost.Num.Infix.html">Infix</a>: <code class="code">sig</code> <a href="Mlpost.Num.Infix.html">..</a> <code class="code">end</code></pre><br>
<h2 id="2_Usefulconstantsandfunctions">Useful constants and functions</h2><br>

<pre><span id="VALzero"><span class="keyword">val</span> zero</span> : <code class="type"><a href="Mlpost.Num.html#TYPEt">t</a></code></pre>
<pre><span id="VALone"><span class="keyword">val</span> one</span> : <code class="type"><a href="Mlpost.Num.html#TYPEt">t</a></code></pre>
<pre><span id="VALtwo"><span class="keyword">val</span> two</span> : <code class="type"><a href="Mlpost.Num.html#TYPEt">t</a></code></pre><div class="info ">
Shortcuts for <code class="code">bp 0.</code>, <code class="code">bp 1.</code> and <code class="code">bp 2.</code>.<br>
</div>

<pre><span id="VALpi"><span class="keyword">val</span> pi</span> : <code class="type">float</code></pre><div class="info ">
3 .14159<br>
</div>

<pre><span id="VALdeg2rad"><span class="keyword">val</span> deg2rad</span> : <code class="type">float -> float</code></pre><div class="info ">
Converts degrees into radians<br>
</div>

<pre><span id="TYPEscale"><span class="keyword">type</span> <code class="type"></code>scale</span> = <code class="type">float -> <a href="Mlpost.Num.html#TYPEt">t</a></code> </pre>


<pre><span class="keyword">module</span> <a href="Mlpost.Num.Scale.html">Scale</a>: <code class="code">sig</code> <a href="Mlpost.Num.Scale.html">..</a> <code class="code">end</code></pre></body></html>