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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
>
<refentry id="liboil-liboiltest">
<refmeta>
<refentrytitle role="top_of_page" id="liboil-liboiltest.top_of_page">OilTest</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBOIL Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>OilTest</refname>
<refpurpose>Test and profile function implementations.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="liboil-liboiltest.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="OilTest">OilTest</link>;
<link linkend="void">void</link> (<link linkend="OilTestFunction">*OilTestFunction</link>) (<link linkend="OilTest">OilTest</link> *test);
#define <link linkend="OIL-TEST-HEADER:CAPS">OIL_TEST_HEADER</link>
#define <link linkend="OIL-TEST-FOOTER:CAPS">OIL_TEST_FOOTER</link>
<link linkend="OilTest">OilTest</link>* <link linkend="oil-test-new">oil_test_new</link> (<link linkend="OilFunctionClass">OilFunctionClass</link> *klass);
<link linkend="void">void</link> <link linkend="oil-test-init">oil_test_init</link> (<link linkend="OilTest">OilTest</link> *test);
<link linkend="void">void</link> <link linkend="oil-test-free">oil_test_free</link> (<link linkend="OilTest">OilTest</link> *test);
<link linkend="void">void</link> <link linkend="oil-test-set-iterations">oil_test_set_iterations</link> (<link linkend="OilTest">OilTest</link> *test,
<link linkend="int">int</link> iterations);
<link linkend="void">void</link> <link linkend="oil-test-check-ref">oil_test_check_ref</link> (<link linkend="OilTest">OilTest</link> *test);
<link linkend="int">int</link> <link linkend="oil-test-check-impl">oil_test_check_impl</link> (<link linkend="OilTest">OilTest</link> *test,
<link linkend="OilFunctionImpl">OilFunctionImpl</link> *impl);
<link linkend="void">void</link> <link linkend="oil-test-cleanup">oil_test_cleanup</link> (<link linkend="OilTest">OilTest</link> *test);
<link linkend="void">void</link>* <link linkend="oil-test-get-source-data">oil_test_get_source_data</link> (<link linkend="OilTest">OilTest</link> *test,
<link linkend="OilArgType">OilArgType</link> arg_type);
<link linkend="int">int</link> <link linkend="oil-test-get-value">oil_test_get_value</link> (<link linkend="OilTest">OilTest</link> *test,
<link linkend="OilArgType">OilArgType</link> arg_type);
<link linkend="void">void</link> <link linkend="oil-test-set-test-footer">oil_test_set_test_footer</link> (<link linkend="OilTest">OilTest</link> *test,
<link linkend="OilParameter">OilParameter</link> *p,
<link linkend="int">int</link> test_footer);
<link linkend="void">void</link> <link linkend="oil-test-set-test-header">oil_test_set_test_header</link> (<link linkend="OilTest">OilTest</link> *test,
<link linkend="OilParameter">OilParameter</link> *p,
<link linkend="int">int</link> test_header);
</synopsis>
</refsynopsisdiv>
<refsect1 id="liboil-liboiltest.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
<para>
</para>
</refsect1>
<refsect1 id="liboil-liboiltest.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="OilTest" role="struct">
<title>OilTest</title>
<indexterm zone="OilTest"><primary>OilTest</primary></indexterm><programlisting>typedef struct {
} OilTest;
</programlisting>
<para>
An opaque structure describing how to test an OilFunctionImpl
for an OilFunctionClass.</para>
<para>
</para></refsect2>
<refsect2 id="OilTestFunction" role="function">
<title>OilTestFunction ()</title>
<indexterm zone="OilTestFunction"><primary>OilTestFunction</primary></indexterm><programlisting><link linkend="void">void</link> (*OilTestFunction) (<link linkend="OilTest">OilTest</link> *test);</programlisting>
<para>
Typedef for functions that initialize special values
in source arrays for a particular function class.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>test</parameter> :</term>
<listitem><simpara> the <parameter>OilTest</parameter> structure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="OIL-TEST-HEADER:CAPS" role="macro">
<title>OIL_TEST_HEADER</title>
<indexterm zone="OIL-TEST-HEADER:CAPS"><primary>OIL_TEST_HEADER</primary></indexterm><programlisting>#define OIL_TEST_HEADER 256
</programlisting>
<para>
Default number of bytes that are prepended to the array test area.</para>
<para>
</para></refsect2>
<refsect2 id="OIL-TEST-FOOTER:CAPS" role="macro">
<title>OIL_TEST_FOOTER</title>
<indexterm zone="OIL-TEST-FOOTER:CAPS"><primary>OIL_TEST_FOOTER</primary></indexterm><programlisting>#define OIL_TEST_FOOTER 256
</programlisting>
<para>
Default number of bytes that are appended to the array test area.</para>
<para>
</para></refsect2>
<refsect2 id="oil-test-new" role="function">
<title>oil_test_new ()</title>
<indexterm zone="oil-test-new"><primary>oil_test_new</primary></indexterm><programlisting><link linkend="OilTest">OilTest</link>* oil_test_new (<link linkend="OilFunctionClass">OilFunctionClass</link> *klass);</programlisting>
<para>
Creates a new OilTest for the OilFunctionClass represented by <parameter>klass</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>klass</parameter> :</term>
<listitem><simpara> an OilFunctionClass
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new OilTest
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oil-test-init" role="function">
<title>oil_test_init ()</title>
<indexterm zone="oil-test-init"><primary>oil_test_init</primary></indexterm><programlisting><link linkend="void">void</link> oil_test_init (<link linkend="OilTest">OilTest</link> *test);</programlisting>
<para>
Intializes <parameter>test</parameter>.
</para>
<para>
FIXME: needs work</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>test</parameter> :</term>
<listitem><simpara> the OilTest
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oil-test-free" role="function">
<title>oil_test_free ()</title>
<indexterm zone="oil-test-free"><primary>oil_test_free</primary></indexterm><programlisting><link linkend="void">void</link> oil_test_free (<link linkend="OilTest">OilTest</link> *test);</programlisting>
<para>
Frees memory associated with <parameter>test</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>test</parameter> :</term>
<listitem><simpara> the OilTest
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oil-test-set-iterations" role="function">
<title>oil_test_set_iterations ()</title>
<indexterm zone="oil-test-set-iterations"><primary>oil_test_set_iterations</primary></indexterm><programlisting><link linkend="void">void</link> oil_test_set_iterations (<link linkend="OilTest">OilTest</link> *test,
<link linkend="int">int</link> iterations);</programlisting>
<para>
Sets the number of iterations of <parameter>test</parameter> to <parameter>iterations</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>test</parameter> :</term>
<listitem><simpara> the OilTest
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iterations</parameter> :</term>
<listitem><simpara> the number of iterations
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oil-test-check-ref" role="function">
<title>oil_test_check_ref ()</title>
<indexterm zone="oil-test-check-ref"><primary>oil_test_check_ref</primary></indexterm><programlisting><link linkend="void">void</link> oil_test_check_ref (<link linkend="OilTest">OilTest</link> *test);</programlisting>
<para>
Runs the test specified by <parameter>test</parameter> on the reference function of the
class being tested.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>test</parameter> :</term>
<listitem><simpara> the OilTest
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oil-test-check-impl" role="function">
<title>oil_test_check_impl ()</title>
<indexterm zone="oil-test-check-impl"><primary>oil_test_check_impl</primary></indexterm><programlisting><link linkend="int">int</link> oil_test_check_impl (<link linkend="OilTest">OilTest</link> *test,
<link linkend="OilFunctionImpl">OilFunctionImpl</link> *impl);</programlisting>
<para>
Runs the testing procedure described by <parameter>test</parameter> on the implementation
<parameter>impl</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>test</parameter> :</term>
<listitem><simpara> the OilTest
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>impl</parameter> :</term>
<listitem><simpara> an OilFunctionImpl
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 1 if <parameter>impl</parameter> passes the test, 0 if it fails
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oil-test-cleanup" role="function">
<title>oil_test_cleanup ()</title>
<indexterm zone="oil-test-cleanup"><primary>oil_test_cleanup</primary></indexterm><programlisting><link linkend="void">void</link> oil_test_cleanup (<link linkend="OilTest">OilTest</link> *test);</programlisting>
<para>
Cleans up <parameter>test</parameter>.
</para>
<para>
FIXME: needs work</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>test</parameter> :</term>
<listitem><simpara> the OilTest
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oil-test-get-source-data" role="function">
<title>oil_test_get_source_data ()</title>
<indexterm zone="oil-test-get-source-data"><primary>oil_test_get_source_data</primary></indexterm><programlisting><link linkend="void">void</link>* oil_test_get_source_data (<link linkend="OilTest">OilTest</link> *test,
<link linkend="OilArgType">OilArgType</link> arg_type);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>test</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg_type</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oil-test-get-value" role="function">
<title>oil_test_get_value ()</title>
<indexterm zone="oil-test-get-value"><primary>oil_test_get_value</primary></indexterm><programlisting><link linkend="int">int</link> oil_test_get_value (<link linkend="OilTest">OilTest</link> *test,
<link linkend="OilArgType">OilArgType</link> arg_type);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>test</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg_type</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oil-test-set-test-footer" role="function">
<title>oil_test_set_test_footer ()</title>
<indexterm zone="oil-test-set-test-footer"><primary>oil_test_set_test_footer</primary></indexterm><programlisting><link linkend="void">void</link> oil_test_set_test_footer (<link linkend="OilTest">OilTest</link> *test,
<link linkend="OilParameter">OilParameter</link> *p,
<link linkend="int">int</link> test_footer);</programlisting>
<para>
Sets the number of bytes of guard footer for <parameter>p</parameter> to <parameter>test_footer</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>test</parameter> :</term>
<listitem><simpara> the OilTest
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>p</parameter> :</term>
<listitem><simpara> the OilParameter to change the footer for
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>test_footer</parameter> :</term>
<listitem><simpara> the number of bytes of guard footer
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oil-test-set-test-header" role="function">
<title>oil_test_set_test_header ()</title>
<indexterm zone="oil-test-set-test-header"><primary>oil_test_set_test_header</primary></indexterm><programlisting><link linkend="void">void</link> oil_test_set_test_header (<link linkend="OilTest">OilTest</link> *test,
<link linkend="OilParameter">OilParameter</link> *p,
<link linkend="int">int</link> test_header);</programlisting>
<para>
Sets the number of bytes of guard header for <parameter>p</parameter> to <parameter>test_header</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>test</parameter> :</term>
<listitem><simpara> the OilTest
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>p</parameter> :</term>
<listitem><simpara> the OilParameter to change the header for
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>test_header</parameter> :</term>
<listitem><simpara> the number of bytes of guard header
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
