/usr/share/gtk-doc/html/liboil/liboil-liboilclass-unstable.html is in liboil0.3-doc 0.3.17-2ubuntu3.
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 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>OilFunctionClass</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="index.html" title="Liboil Reference Manual">
<link rel="up" href="ch02.html" title="Liboil Unstable API">
<link rel="prev" href="liboil-liboildebug.html" title="Debug">
<link rel="next" href="liboil-liboilimpl-unstable.html" title="OilFunctionImpl">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Liboil Stable API">
<link rel="chapter" href="ch02.html" title="Liboil Unstable API">
</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="liboil-liboildebug.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.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">Liboil Reference Manual</th>
<td><a accesskey="n" href="liboil-liboilimpl-unstable.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#liboil-liboilclass-unstable.synopsis" class="shortcut">Top</a>
|
<a href="#liboil-liboilclass-unstable.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="OilFunctionClass">
<a name="liboil-liboilclass-unstable"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="liboil-liboilclass-unstable.top_of_page"></a>OilFunctionClass</span></h2>
<p>OilFunctionClass — Functions for manipulating function classes</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="liboil-liboilclass-unstable.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="liboil-liboilclass-unstable.html#OilFunctionClass" title="OilFunctionClass">OilFunctionClass</a>;
#define <a class="link" href="liboil-liboilclass-unstable.html#OIL-DECLARE-CLASS--CAPS" title="OIL_DECLARE_CLASS()">OIL_DECLARE_CLASS</a> (klass)
#define <a class="link" href="liboil-liboilclass-unstable.html#OIL-DEFINE-CLASS-FULL--CAPS" title="OIL_DEFINE_CLASS_FULL()">OIL_DEFINE_CLASS_FULL</a> (klass, string, test)
#define <a class="link" href="liboil-liboilclass-unstable.html#OIL-DEFINE-CLASS--CAPS" title="OIL_DEFINE_CLASS()">OIL_DEFINE_CLASS</a> (klass, string)
<a class="link" href="liboil-liboilclass-unstable.html#OilFunctionClass" title="OilFunctionClass">OilFunctionClass</a> * <a class="link" href="liboil-liboilclass-unstable.html#oil-class-get-by-index" title="oil_class_get_by_index ()">oil_class_get_by_index</a> (int i);
<a class="link" href="liboil-liboilclass-unstable.html#OilFunctionClass" title="OilFunctionClass">OilFunctionClass</a> * <a class="link" href="liboil-liboilclass-unstable.html#oil-class-get" title="oil_class_get ()">oil_class_get</a> (const char *class_name);
void <a class="link" href="liboil-liboilclass-unstable.html#oil-class-optimize" title="oil_class_optimize ()">oil_class_optimize</a> (<a class="link" href="liboil-liboilclass-unstable.html#OilFunctionClass" title="OilFunctionClass">OilFunctionClass</a> *klass);
int <a class="link" href="liboil-liboilclass-unstable.html#oil-class-get-n-classes" title="oil_class_get_n_classes ()">oil_class_get_n_classes</a> (void);
void <a class="link" href="liboil-liboilclass-unstable.html#oil-class-choose-by-name" title="oil_class_choose_by_name ()">oil_class_choose_by_name</a> (<a class="link" href="liboil-liboilclass-unstable.html#OilFunctionClass" title="OilFunctionClass">OilFunctionClass</a> *klass,
const char *name);
void <a class="link" href="liboil-liboilclass-unstable.html#oil-class-register-impl-by-name" title="oil_class_register_impl_by_name ()">oil_class_register_impl_by_name</a> (const char *klass_name,
<a class="link" href="liboil-liboilimpl-unstable.html#OilFunctionImpl" title="OilFunctionImpl">OilFunctionImpl</a> *impl);
void <a class="link" href="liboil-liboilclass-unstable.html#oil-class-register-impl" title="oil_class_register_impl ()">oil_class_register_impl</a> (<a class="link" href="liboil-liboilclass-unstable.html#OilFunctionClass" title="OilFunctionClass">OilFunctionClass</a> *klass,
<a class="link" href="liboil-liboilimpl-unstable.html#OilFunctionImpl" title="OilFunctionImpl">OilFunctionImpl</a> *impl);
void <a class="link" href="liboil-liboilclass-unstable.html#oil-class-register-impl-full" title="oil_class_register_impl_full ()">oil_class_register_impl_full</a> (<a class="link" href="liboil-liboilclass-unstable.html#OilFunctionClass" title="OilFunctionClass">OilFunctionClass</a> *klass,
void (funcvoid) (),
const char *name,
unsigned int flags);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="liboil-liboilclass-unstable.description"></a><h2>Description</h2>
<p>
</p>
<p>
Functions operate on arrays of data. The arrays can be either source
arrays (input only), destination arrays (output only), or in-place
arrays (both input and output).
</p>
<p>
</p>
<p>
</p>
<p>
The interpretation of a parameter can usually be determined from its
name. Parameters for arrays are of the form d1_1xn, where the first
character represents the direction (source, destination, or in-place),
the second represents the index for that particular direction, and
the characters after the underscore indicate the size of the array.
In this case, "1xn" represents an array that is 1 by N. Note that
the index and the size can both be omitted, giving a default of 1
for the index and 1xn for the size.
</p>
<p>
</p>
<p>
</p>
<p>
Parameters that represent strides are of the form "d1s". The
interpretation is similar to above, except that the s indicates
a stride parameter.
</p>
<p>
</p>
<p>
</p>
<p>
The exceptions to the above rule are "dest", "src", "dstr", "sstr", etc.
These are aliases for "d1", "s1", "d1s", and "s1s", respectively. This
form is deprecated and will be removed in the 0.4 series.
</p>
<p>
</p>
<p>
</p>
<p>
Two special parameters are "n" and "m", which determine the size of
the arrays in other parameters.
</p>
<p>
</p>
<p>
</p>
<p>
Data arrays are laid out such that rows are separated by the number
of bytes given by the corresponding stride. Elements in each row
are contiguous. If there is no stride parameter corresponding to an
array, the rows of the array are contiguous.
</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="liboil-liboilclass-unstable.details"></a><h2>Details</h2>
<div class="refsect2" title="OilFunctionClass">
<a name="OilFunctionClass"></a><h3>OilFunctionClass</h3>
<pre class="programlisting">typedef struct {
} OilFunctionClass;
</pre>
<p>
An opaque structure representing a function class.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="OIL_DECLARE_CLASS()">
<a name="OIL-DECLARE-CLASS--CAPS"></a><h3>OIL_DECLARE_CLASS()</h3>
<pre class="programlisting">#define OIL_DECLARE_CLASS(klass)</pre>
<p>
Declares the Liboil function class <em class="parameter"><code>klass</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td> the name of a function class (without the oil_ prefix)
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="OIL_DEFINE_CLASS_FULL()">
<a name="OIL-DEFINE-CLASS-FULL--CAPS"></a><h3>OIL_DEFINE_CLASS_FULL()</h3>
<pre class="programlisting">#define OIL_DEFINE_CLASS_FULL(klass, string, test)</pre>
<p>
Defines a <a class="link" href="liboil-liboilclass-unstable.html#OilFunctionClass" title="OilFunctionClass"><span class="type">OilFunctionClass</span></a> structure for <em class="parameter"><code>klass</code></em>. Classes
defined this way will be automatically at Liboil initialization
time.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td> name of class to declare (without oil_ prefix)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
<td> prototype of class
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
<td> test function
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="OIL_DEFINE_CLASS()">
<a name="OIL-DEFINE-CLASS--CAPS"></a><h3>OIL_DEFINE_CLASS()</h3>
<pre class="programlisting">#define OIL_DEFINE_CLASS(klass, string)</pre>
<p>
Defines a <a class="link" href="liboil-liboilclass-unstable.html#OilFunctionClass" title="OilFunctionClass"><span class="type">OilFunctionClass</span></a> structure for <em class="parameter"><code>klass</code></em>. Classes
defined this way will be automatically at Liboil initialization
time.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td> name of class to declare (without oil_ prefix)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
<td> prototype of class
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="oil_class_get_by_index ()">
<a name="oil-class-get-by-index"></a><h3>oil_class_get_by_index ()</h3>
<pre class="programlisting"><a class="link" href="liboil-liboilclass-unstable.html#OilFunctionClass" title="OilFunctionClass">OilFunctionClass</a> * oil_class_get_by_index (int i);</pre>
<p>
Returns a pointer to the function class with index <em class="parameter"><code>i</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td> index
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> an <em class="parameter"><code>OilFunctionClass</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="oil_class_get ()">
<a name="oil-class-get"></a><h3>oil_class_get ()</h3>
<pre class="programlisting"><a class="link" href="liboil-liboilclass-unstable.html#OilFunctionClass" title="OilFunctionClass">OilFunctionClass</a> * oil_class_get (const char *class_name);</pre>
<p>
Returns a pointer to the function class that has the given class
name. If no such class is found, NULL is returned.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>class_name</code></em> :</span></p></td>
<td> the name of the function class
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a pointer to a function class
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="oil_class_optimize ()">
<a name="oil-class-optimize"></a><h3>oil_class_optimize ()</h3>
<pre class="programlisting">void oil_class_optimize (<a class="link" href="liboil-liboilclass-unstable.html#OilFunctionClass" title="OilFunctionClass">OilFunctionClass</a> *klass);</pre>
<p>
Tests and profiles each implementation for the given function
class. Testing compares the output of running each implementation
on random input against the reference implementation for the
same input.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td> a function class
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="oil_class_get_n_classes ()">
<a name="oil-class-get-n-classes"></a><h3>oil_class_get_n_classes ()</h3>
<pre class="programlisting">int oil_class_get_n_classes (void);</pre>
<p>
Returns the number of function classes.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the number of function classes
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="oil_class_choose_by_name ()">
<a name="oil-class-choose-by-name"></a><h3>oil_class_choose_by_name ()</h3>
<pre class="programlisting">void oil_class_choose_by_name (<a class="link" href="liboil-liboilclass-unstable.html#OilFunctionClass" title="OilFunctionClass">OilFunctionClass</a> *klass,
const char *name);</pre>
<p>
Sets the chosen implementation for the given function class to
the implementation with the given name. If no implementation
having the given name is found, the chosen implementation is
not changed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td> a function class
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> the name of an implementation
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="oil_class_register_impl_by_name ()">
<a name="oil-class-register-impl-by-name"></a><h3>oil_class_register_impl_by_name ()</h3>
<pre class="programlisting">void oil_class_register_impl_by_name (const char *klass_name,
<a class="link" href="liboil-liboilimpl-unstable.html#OilFunctionImpl" title="OilFunctionImpl">OilFunctionImpl</a> *impl);</pre>
<p>
Adds <em class="parameter"><code>impl</code></em> to the list of implementations associated with
the function class given by <em class="parameter"><code>klass_name</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>klass_name</code></em> :</span></p></td>
<td> the name of the class
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>impl</code></em> :</span></p></td>
<td> an implementation
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="oil_class_register_impl ()">
<a name="oil-class-register-impl"></a><h3>oil_class_register_impl ()</h3>
<pre class="programlisting">void oil_class_register_impl (<a class="link" href="liboil-liboilclass-unstable.html#OilFunctionClass" title="OilFunctionClass">OilFunctionClass</a> *klass,
<a class="link" href="liboil-liboilimpl-unstable.html#OilFunctionImpl" title="OilFunctionImpl">OilFunctionImpl</a> *impl);</pre>
<p>
Adds <em class="parameter"><code>impl</code></em> to the list of implementations associated with
the function class given by <em class="parameter"><code>klass</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td> the class
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>impl</code></em> :</span></p></td>
<td> an implementation
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="oil_class_register_impl_full ()">
<a name="oil-class-register-impl-full"></a><h3>oil_class_register_impl_full ()</h3>
<pre class="programlisting">void oil_class_register_impl_full (<a class="link" href="liboil-liboilclass-unstable.html#OilFunctionClass" title="OilFunctionClass">OilFunctionClass</a> *klass,
void (funcvoid) (),
const char *name,
unsigned int flags);</pre>
<p>
Adds <em class="parameter"><code>func</code></em> to the list of implementations associated with
the function class given by <em class="parameter"><code>klass</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td> the class
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td> the function
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> name of the function
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td> CPU flags
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|