doc/html/liboil-liboiltest.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>OilTest</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
   7 <link rel="home" href="index.html" title="Liboil Reference Manual">
   8 <link rel="up" href="ch02.html" title="Liboil Unstable API">
   9 <link rel="prev" href="liboil-liboilrandom.html" title="Random Number Generation">
  10 <link rel="next" href="liboil-liboiltypes.html" title="liboiltypes">
  11 <meta name="generator" content="GTK-Doc V1.11 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 <link rel="chapter" href="ch01.html" title="Liboil Stable API">
  14 <link rel="chapter" href="ch02.html" title="Liboil Unstable API">
  15 </head>
  16 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  17 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  18 <tr valign="middle">
  19 <td><a accesskey="p" href="liboil-liboilrandom.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  20 <td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  21 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  22 <th width="100%" align="center">Liboil Reference Manual</th>
  23 <td><a accesskey="n" href="liboil-liboiltypes.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  24 </tr>
  25 <tr><td colspan="5" class="shortcuts">
  26 <a href="#liboil-liboiltest.synopsis" class="shortcut">Top</a>
  27                  |
  28                 <a href="#liboil-liboiltest.description" class="shortcut">Description</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry" title="OilTest">
  32 <a name="liboil-liboiltest"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="liboil-liboiltest.top_of_page"></a>OilTest</span></h2>
  36 <p>OilTest — Test and profile function implementations.</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv" title="Synopsis">
  41 <a name="liboil-liboiltest.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">
  43                     <a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a>;
  44 void                (<a class="link" href="liboil-liboiltest.html#OilTestFunction" title="OilTestFunction ()">*OilTestFunction</a>)                  (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test);
  45 #define             <a class="link" href="liboil-liboiltest.html#OIL-TEST-HEADER--CAPS" title="OIL_TEST_HEADER">OIL_TEST_HEADER</a>
  46 #define             <a class="link" href="liboil-liboiltest.html#OIL-TEST-FOOTER--CAPS" title="OIL_TEST_FOOTER">OIL_TEST_FOOTER</a>
  47 <a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *           <a class="link" href="liboil-liboiltest.html#oil-test-new" title="oil_test_new ()">oil_test_new</a>                        (<a class="link" href="liboil-liboilclass-unstable.html#OilFunctionClass" title="OilFunctionClass">OilFunctionClass</a> *klass);
  48 void                <a class="link" href="liboil-liboiltest.html#oil-test-init" title="oil_test_init ()">oil_test_init</a>                       (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test);
  49 void                <a class="link" href="liboil-liboiltest.html#oil-test-free" title="oil_test_free ()">oil_test_free</a>                       (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test);
  50 void                <a class="link" href="liboil-liboiltest.html#oil-test-set-iterations" title="oil_test_set_iterations ()">oil_test_set_iterations</a>             (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
  51                                                          int iterations);
  52 void                <a class="link" href="liboil-liboiltest.html#oil-test-check-ref" title="oil_test_check_ref ()">oil_test_check_ref</a>                  (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test);
  53 int                 <a class="link" href="liboil-liboiltest.html#oil-test-check-impl" title="oil_test_check_impl ()">oil_test_check_impl</a>                 (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
  54                                                          <a class="link" href="liboil-liboilimpl-unstable.html#OilFunctionImpl" title="OilFunctionImpl">OilFunctionImpl</a> *impl);
  55 void                <a class="link" href="liboil-liboiltest.html#oil-test-cleanup" title="oil_test_cleanup ()">oil_test_cleanup</a>                    (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test);
  56 void *              <a class="link" href="liboil-liboiltest.html#oil-test-get-source-data" title="oil_test_get_source_data ()">oil_test_get_source_data</a>            (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
  57                                                          <a class="link" href="liboil-liboiltypes.html#OilArgType" title="enum OilArgType">OilArgType</a> arg_type);
  58 int                 <a class="link" href="liboil-liboiltest.html#oil-test-get-value" title="oil_test_get_value ()">oil_test_get_value</a>                  (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
  59                                                          <a class="link" href="liboil-liboiltypes.html#OilArgType" title="enum OilArgType">OilArgType</a> arg_type);
  60 void                <a class="link" href="liboil-liboiltest.html#oil-test-set-test-footer" title="oil_test_set_test_footer ()">oil_test_set_test_footer</a>            (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
  61                                                          <a class="link" href="liboil-liboilparameter.html#OilParameter" title="OilParameter">OilParameter</a> *p,
  62                                                          int test_footer);
  63 void                <a class="link" href="liboil-liboiltest.html#oil-test-set-test-header" title="oil_test_set_test_header ()">oil_test_set_test_header</a>            (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
  64                                                          <a class="link" href="liboil-liboilparameter.html#OilParameter" title="OilParameter">OilParameter</a> *p,
  65                                                          int test_header);
  66 </pre>
  67 </div>
  68 <div class="refsect1" title="Description">
  69 <a name="liboil-liboiltest.description"></a><h2>Description</h2>
  70 <p>
  71 </p>
  72 <p>
  73 </p>
  74 </div>
  75 <div class="refsect1" title="Details">
  76 <a name="liboil-liboiltest.details"></a><h2>Details</h2>
  77 <div class="refsect2" title="OilTest">
  78 <a name="OilTest"></a><h3>OilTest</h3>
  79 <pre class="programlisting">typedef struct {
  80 } OilTest;
  81 </pre>
  82 <p>
  83 An opaque structure describing how to test an OilFunctionImpl
  84 for an OilFunctionClass.</p>
  85 <p>
  86 </p>
  87 </div>
  88 <hr>
  89 <div class="refsect2" title="OilTestFunction ()">
  90 <a name="OilTestFunction"></a><h3>OilTestFunction ()</h3>
  91 <pre class="programlisting">void                (*OilTestFunction)                  (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test);</pre>
  92 <p>
  93 Typedef for functions that initialize special values
  94 in source arrays for a particular function class.</p>
  95 <p>
  96 </p>
  97 <div class="variablelist"><table border="0">
  98 <col align="left" valign="top">
  99 <tbody><tr>
 100 <td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
 101 <td> the <em class="parameter"><code>OilTest</code></em> structure
 102 </td>
 103 </tr></tbody>
 104 </table></div>
 105 </div>
 106 <hr>
 107 <div class="refsect2" title="OIL_TEST_HEADER">
 108 <a name="OIL-TEST-HEADER--CAPS"></a><h3>OIL_TEST_HEADER</h3>
 109 <pre class="programlisting">#define OIL_TEST_HEADER 256
 110 </pre>
 111 <p>
 112 Default number of bytes that are prepended to the array test area.</p>
 113 <p>
 114 </p>
 115 </div>
 116 <hr>
 117 <div class="refsect2" title="OIL_TEST_FOOTER">
 118 <a name="OIL-TEST-FOOTER--CAPS"></a><h3>OIL_TEST_FOOTER</h3>
 119 <pre class="programlisting">#define OIL_TEST_FOOTER 256
 120 </pre>
 121 <p>
 122 Default number of bytes that are appended to the array test area.</p>
 123 <p>
 124 </p>
 125 </div>
 126 <hr>
 127 <div class="refsect2" title="oil_test_new ()">
 128 <a name="oil-test-new"></a><h3>oil_test_new ()</h3>
 129 <pre class="programlisting"><a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *           oil_test_new                        (<a class="link" href="liboil-liboilclass-unstable.html#OilFunctionClass" title="OilFunctionClass">OilFunctionClass</a> *klass);</pre>
 130 <p>
 131 Creates a new OilTest for the OilFunctionClass represented by <em class="parameter"><code>klass</code></em>.</p>
 132 <p>
 133 </p>
 134 <div class="variablelist"><table border="0">
 135 <col align="left" valign="top">
 136 <tbody>
 137 <tr>
 138 <td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
 139 <td> an OilFunctionClass
 140 </td>
 141 </tr>
 142 <tr>
 143 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 144 <td> the new OilTest
 145 </td>
 146 </tr>
 147 </tbody>
 148 </table></div>
 149 </div>
 150 <hr>
 151 <div class="refsect2" title="oil_test_init ()">
 152 <a name="oil-test-init"></a><h3>oil_test_init ()</h3>
 153 <pre class="programlisting">void                oil_test_init                       (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test);</pre>
 154 <p>
 155 Intializes <em class="parameter"><code>test</code></em>.
 156 </p>
 157 <p>
 158 FIXME: needs work</p>
 159 <p>
 160 </p>
 161 <div class="variablelist"><table border="0">
 162 <col align="left" valign="top">
 163 <tbody><tr>
 164 <td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
 165 <td> the OilTest
 166 </td>
 167 </tr></tbody>
 168 </table></div>
 169 </div>
 170 <hr>
 171 <div class="refsect2" title="oil_test_free ()">
 172 <a name="oil-test-free"></a><h3>oil_test_free ()</h3>
 173 <pre class="programlisting">void                oil_test_free                       (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test);</pre>
 174 <p>
 175 Frees memory associated with <em class="parameter"><code>test</code></em>.</p>
 176 <p>
 177 </p>
 178 <div class="variablelist"><table border="0">
 179 <col align="left" valign="top">
 180 <tbody><tr>
 181 <td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
 182 <td> the OilTest
 183 </td>
 184 </tr></tbody>
 185 </table></div>
 186 </div>
 187 <hr>
 188 <div class="refsect2" title="oil_test_set_iterations ()">
 189 <a name="oil-test-set-iterations"></a><h3>oil_test_set_iterations ()</h3>
 190 <pre class="programlisting">void                oil_test_set_iterations             (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
 191                                                          int iterations);</pre>
 192 <p>
 193 Sets the number of iterations of <em class="parameter"><code>test</code></em> to <em class="parameter"><code>iterations</code></em>.</p>
 194 <p>
 195 </p>
 196 <div class="variablelist"><table border="0">
 197 <col align="left" valign="top">
 198 <tbody>
 199 <tr>
 200 <td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
 201 <td> the OilTest
 202 </td>
 203 </tr>
 204 <tr>
 205 <td><p><span class="term"><em class="parameter"><code>iterations</code></em> :</span></p></td>
 206 <td> the number of iterations
 207 </td>
 208 </tr>
 209 </tbody>
 210 </table></div>
 211 </div>
 212 <hr>
 213 <div class="refsect2" title="oil_test_check_ref ()">
 214 <a name="oil-test-check-ref"></a><h3>oil_test_check_ref ()</h3>
 215 <pre class="programlisting">void                oil_test_check_ref                  (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test);</pre>
 216 <p>
 217 Runs the test specified by <em class="parameter"><code>test</code></em> on the reference function of the
 218 class being tested.</p>
 219 <p>
 220 </p>
 221 <div class="variablelist"><table border="0">
 222 <col align="left" valign="top">
 223 <tbody><tr>
 224 <td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
 225 <td> the OilTest
 226 </td>
 227 </tr></tbody>
 228 </table></div>
 229 </div>
 230 <hr>
 231 <div class="refsect2" title="oil_test_check_impl ()">
 232 <a name="oil-test-check-impl"></a><h3>oil_test_check_impl ()</h3>
 233 <pre class="programlisting">int                 oil_test_check_impl                 (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
 234                                                          <a class="link" href="liboil-liboilimpl-unstable.html#OilFunctionImpl" title="OilFunctionImpl">OilFunctionImpl</a> *impl);</pre>
 235 <p>
 236 Runs the testing procedure described by <em class="parameter"><code>test</code></em> on the implementation
 237 <em class="parameter"><code>impl</code></em>.</p>
 238 <p>
 239 </p>
 240 <div class="variablelist"><table border="0">
 241 <col align="left" valign="top">
 242 <tbody>
 243 <tr>
 244 <td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
 245 <td> the OilTest
 246 </td>
 247 </tr>
 248 <tr>
 249 <td><p><span class="term"><em class="parameter"><code>impl</code></em> :</span></p></td>
 250 <td> an OilFunctionImpl
 251 </td>
 252 </tr>
 253 <tr>
 254 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 255 <td> 1 if <em class="parameter"><code>impl</code></em> passes the test, 0 if it fails
 256 </td>
 257 </tr>
 258 </tbody>
 259 </table></div>
 260 </div>
 261 <hr>
 262 <div class="refsect2" title="oil_test_cleanup ()">
 263 <a name="oil-test-cleanup"></a><h3>oil_test_cleanup ()</h3>
 264 <pre class="programlisting">void                oil_test_cleanup                    (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test);</pre>
 265 <p>
 266 Cleans up <em class="parameter"><code>test</code></em>.
 267 </p>
 268 <p>
 269 FIXME: needs work</p>
 270 <p>
 271 </p>
 272 <div class="variablelist"><table border="0">
 273 <col align="left" valign="top">
 274 <tbody><tr>
 275 <td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
 276 <td> the OilTest
 277 </td>
 278 </tr></tbody>
 279 </table></div>
 280 </div>
 281 <hr>
 282 <div class="refsect2" title="oil_test_get_source_data ()">
 283 <a name="oil-test-get-source-data"></a><h3>oil_test_get_source_data ()</h3>
 284 <pre class="programlisting">void *              oil_test_get_source_data            (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
 285                                                          <a class="link" href="liboil-liboiltypes.html#OilArgType" title="enum OilArgType">OilArgType</a> arg_type);</pre>
 286 <p>
 287 </p>
 288 <div class="variablelist"><table border="0">
 289 <col align="left" valign="top">
 290 <tbody>
 291 <tr>
 292 <td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
 293 <td>
 294 </td>
 295 </tr>
 296 <tr>
 297 <td><p><span class="term"><em class="parameter"><code>arg_type</code></em> :</span></p></td>
 298 <td>
 299 </td>
 300 </tr>
 301 <tr>
 302 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 303 <td>
 304 </td>
 305 </tr>
 306 </tbody>
 307 </table></div>
 308 </div>
 309 <hr>
 310 <div class="refsect2" title="oil_test_get_value ()">
 311 <a name="oil-test-get-value"></a><h3>oil_test_get_value ()</h3>
 312 <pre class="programlisting">int                 oil_test_get_value                  (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
 313                                                          <a class="link" href="liboil-liboiltypes.html#OilArgType" title="enum OilArgType">OilArgType</a> arg_type);</pre>
 314 <p>
 315 </p>
 316 <div class="variablelist"><table border="0">
 317 <col align="left" valign="top">
 318 <tbody>
 319 <tr>
 320 <td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
 321 <td>
 322 </td>
 323 </tr>
 324 <tr>
 325 <td><p><span class="term"><em class="parameter"><code>arg_type</code></em> :</span></p></td>
 326 <td>
 327 </td>
 328 </tr>
 329 <tr>
 330 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 331 <td>
 332 </td>
 333 </tr>
 334 </tbody>
 335 </table></div>
 336 </div>
 337 <hr>
 338 <div class="refsect2" title="oil_test_set_test_footer ()">
 339 <a name="oil-test-set-test-footer"></a><h3>oil_test_set_test_footer ()</h3>
 340 <pre class="programlisting">void                oil_test_set_test_footer            (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
 341                                                          <a class="link" href="liboil-liboilparameter.html#OilParameter" title="OilParameter">OilParameter</a> *p,
 342                                                          int test_footer);</pre>
 343 <p>
 344 Sets the number of bytes of guard footer for <em class="parameter"><code>p</code></em> to <em class="parameter"><code>test_footer</code></em>.</p>
 345 <p>
 346 </p>
 347 <div class="variablelist"><table border="0">
 348 <col align="left" valign="top">
 349 <tbody>
 350 <tr>
 351 <td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
 352 <td> the OilTest
 353 </td>
 354 </tr>
 355 <tr>
 356 <td><p><span class="term"><em class="parameter"><code>p</code></em> :</span></p></td>
 357 <td> the OilParameter to change the footer for
 358 </td>
 359 </tr>
 360 <tr>
 361 <td><p><span class="term"><em class="parameter"><code>test_footer</code></em> :</span></p></td>
 362 <td> the number of bytes of guard footer
 363 </td>
 364 </tr>
 365 </tbody>
 366 </table></div>
 367 </div>
 368 <hr>
 369 <div class="refsect2" title="oil_test_set_test_header ()">
 370 <a name="oil-test-set-test-header"></a><h3>oil_test_set_test_header ()</h3>
 371 <pre class="programlisting">void                oil_test_set_test_header            (<a class="link" href="liboil-liboiltest.html#OilTest" title="OilTest">OilTest</a> *test,
 372                                                          <a class="link" href="liboil-liboilparameter.html#OilParameter" title="OilParameter">OilParameter</a> *p,
 373                                                          int test_header);</pre>
 374 <p>
 375 Sets the number of bytes of guard header for <em class="parameter"><code>p</code></em> to <em class="parameter"><code>test_header</code></em>.</p>
 376 <p>
 377 </p>
 378 <div class="variablelist"><table border="0">
 379 <col align="left" valign="top">
 380 <tbody>
 381 <tr>
 382 <td><p><span class="term"><em class="parameter"><code>test</code></em> :</span></p></td>
 383 <td> the OilTest
 384 </td>
 385 </tr>
 386 <tr>
 387 <td><p><span class="term"><em class="parameter"><code>p</code></em> :</span></p></td>
 388 <td> the OilParameter to change the header for
 389 </td>
 390 </tr>
 391 <tr>
 392 <td><p><span class="term"><em class="parameter"><code>test_header</code></em> :</span></p></td>
 393 <td> the number of bytes of guard header
 394 </td>
 395 </tr>
 396 </tbody>
 397 </table></div>
 398 </div>
 399 </div>
 400 </div>
 401 <div class="footer">
 402 <hr>
 403           Generated by GTK-Doc V1.11</div>
 404 </body>
 405 </html>