This file is indexed.

/usr/share/gtk-doc/html/libgimpmath/libgimpmath-GimpMath.html is in libgimp2.0-doc 2.6.12-1ubuntu1.

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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GimpMath</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GIMP Math Library Reference Manual">
<link rel="up" href="libgimpmath.html" title="Part I. GIMP Math Library">
<link rel="prev" href="libgimpmath.html" title="Part I. GIMP Math Library">
<link rel="next" href="libgimpmath-GimpMatrix.html" title="GimpMatrix">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgimpmath.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpmath.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Math Library Reference Manual</th>
<td><a accesskey="n" href="libgimpmath-GimpMatrix.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgimpmath-GimpMath.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libgimpmath-GimpMath.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgimpmath-GimpMath"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimpmath-GimpMath.top_of_page"></a>GimpMath</span></h2>
<p>GimpMath — Mathematical definitions and macros.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgimpmath-GimpMath.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define             <a class="link" href="libgimpmath-GimpMath.html#RINT:CAPS" title="RINT()">RINT</a>                                (x)
#define             <a class="link" href="libgimpmath-GimpMath.html#ROUND:CAPS" title="ROUND()">ROUND</a>                               (x)
#define             <a class="link" href="libgimpmath-GimpMath.html#SQR:CAPS" title="SQR()">SQR</a>                                 (x)
#define             <a class="link" href="libgimpmath-GimpMath.html#MAX255:CAPS" title="MAX255()">MAX255</a>                              (a)
#define             <a class="link" href="libgimpmath-GimpMath.html#CLAMP0255:CAPS" title="CLAMP0255()">CLAMP0255</a>                           (a)
#define             <a class="link" href="libgimpmath-GimpMath.html#gimp-deg-to-rad" title="gimp_deg_to_rad()">gimp_deg_to_rad</a>                     (angle)
#define             <a class="link" href="libgimpmath-GimpMath.html#gimp-rad-to-deg" title="gimp_rad_to_deg()">gimp_rad_to_deg</a>                     (angle)
</pre>
</div>
<div class="refsect1">
<a name="libgimpmath-GimpMath.description"></a><h2>Description</h2>
<p>
Mathematical definitions and macros. These macros should be used
rather than the ones from math.h for enhanced portability.
</p>
</div>
<div class="refsect1">
<a name="libgimpmath-GimpMath.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="RINT:CAPS"></a><h3>RINT()</h3>
<pre class="programlisting">#define RINT(x) rint(x)
</pre>
<p>
This macro rounds its argument <em class="parameter"><code>x</code></em> to an integer value in floating point
format.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>the value to be rounded.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ROUND:CAPS"></a><h3>ROUND()</h3>
<pre class="programlisting">#define ROUND(x) ((int) ((x) + 0.5))
</pre>
<p>
This macro rounds its argument <em class="parameter"><code>x</code></em> to the nearest integer.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>the value to be rounded.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="SQR:CAPS"></a><h3>SQR()</h3>
<pre class="programlisting">#define SQR(x) ((x) * (x))
</pre>
<p>
This macro squares its argument <em class="parameter"><code>x</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>the value to be squared.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="MAX255:CAPS"></a><h3>MAX255()</h3>
<pre class="programlisting">#define MAX255(a)  ((a) | (((a) &amp; 256) - (((a) &amp; 256) &gt;&gt; 8)))
</pre>
<p>
This macro limits it argument <em class="parameter"><code>a</code></em>, an (0-511) int, to 255.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td>
<td>the value to be limited.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="CLAMP0255:CAPS"></a><h3>CLAMP0255()</h3>
<pre class="programlisting">#define CLAMP0255(a)  CLAMP(a,0,255)
</pre>
<p>
This macro clamps its argument <em class="parameter"><code>a</code></em>, an int32-range int, between 0 and
255 inclusive.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td>
<td>the value to be clamped.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-deg-to-rad"></a><h3>gimp_deg_to_rad()</h3>
<pre class="programlisting">#define gimp_deg_to_rad(angle) ((angle) * (2.0 * G_PI) / 360.0)
</pre>
<p>
This macro converts its argument <em class="parameter"><code>angle</code></em> from degree to radian.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>angle</code></em> :</span></p></td>
<td>the angle to be converted.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-rad-to-deg"></a><h3>gimp_rad_to_deg()</h3>
<pre class="programlisting">#define gimp_rad_to_deg(angle) ((angle) * 360.0 / (2.0 * G_PI))
</pre>
<p>
This macro converts its argument <em class="parameter"><code>angle</code></em> from radian to degree.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>angle</code></em> :</span></p></td>
<td>the angle to be converted.</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>