Codebase list cppad / upstream/2015.00.00.7 doc / speedtest.xml
upstream/2015.00.00.7

Tree @upstream/2015.00.00.7 (Download .tar.gz)

speedtest.xml @upstream/2015.00.00.7 — raw · history · blame 

  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
<?xml version='1.0'?>
<html xmlns='http://www.w3.org/1999/xhtml'
      xmlns:math='http://www.w3.org/1998/Math/MathML'
>
<head>
<title>Run One Speed Test and Print Results</title>
<meta http-equiv='Content-Type' content='text/html' charset='utf-8'/>
<meta name="description" id="description" content="Run One Speed Test and Print Results"/>
<meta name="keywords" id="keywords" content=" Speedtest test speed run one and print results syntax purpose motivation include size repeat name first last inc rate errors example "/>
<style type='text/css'>
body { color : black }
body { background-color : white }
A:link { color : blue }
A:visited { color : purple }
A:active { color : purple }
</style>
<script type='text/javascript' language='JavaScript' src='_speedtest_xml.js'>
</script>
</head>
<body>
<table><tr>
<td>
<a href="http://www.coin-or.org/CppAD/" target="_top"><img border="0" src="_image.gif"/></a>
</td>
<td><a href="speed_test.cpp.xml" target="_top">Prev</a>
</td><td><a href="speed_program.cpp.xml" target="_top">Next</a>
</td><td>
<select onchange='choose_across0(this)'>
<option>Index-&gt;</option>
<option>contents</option>
<option>reference</option>
<option>index</option>
<option>search</option>
<option>external</option>
</select>
</td>
<td>
<select onchange='choose_up0(this)'>
<option>Up-&gt;</option>
<option>CppAD</option>
<option>library</option>
<option>SpeedTest</option>
</select>
</td>
<td>
<select onchange='choose_down2(this)'>
<option>CppAD-&gt;</option>
<option>Install</option>
<option>Introduction</option>
<option>AD</option>
<option>ADFun</option>
<option>preprocessor</option>
<option>multi_thread</option>
<option>library</option>
<option>ipopt_solve</option>
<option>Example</option>
<option>speed</option>
<option>Appendix</option>
</select>
</td>
<td>
<select onchange='choose_down1(this)'>
<option>library-&gt;</option>
<option>ErrorHandler</option>
<option>NearEqual</option>
<option>speed_test</option>
<option>SpeedTest</option>
<option>time_test</option>
<option>NumericType</option>
<option>CheckNumericType</option>
<option>SimpleVector</option>
<option>CheckSimpleVector</option>
<option>nan</option>
<option>pow_int</option>
<option>Poly</option>
<option>LuDetAndSolve</option>
<option>RombergOne</option>
<option>RombergMul</option>
<option>Runge45</option>
<option>Rosen34</option>
<option>OdeErrControl</option>
<option>OdeGear</option>
<option>OdeGearControl</option>
<option>CppAD_vector</option>
<option>thread_alloc</option>
<option>index_sort</option>
<option>BenderQuad</option>
<option>opt_val_hes</option>
<option>LuRatio</option>
</select>
</td>
<td>
<select onchange='choose_down0(this)'>
<option>SpeedTest-&gt;</option>
<option>speed_program.cpp</option>
</select>
</td>
<td>
<select onchange='choose_current0(this)'>
<option>Headings-&gt;</option>
<option>Syntax</option>
<option>Purpose</option>
<option>Motivation</option>
<option>Include</option>
<option>Test</option>
<option>---..size</option>
<option>---..repeat</option>
<option>---..name</option>
<option>first</option>
<option>last</option>
<option>inc</option>
<option>rate</option>
<option>Errors</option>
<option>Example</option>
</select>
</td>
</tr></table><br/>






<center><b><big><big>Run One Speed Test and Print Results</big></big></b></center>
<br/>
<b><big><a name="Syntax" id="Syntax">Syntax</a></big></b>


<code><font color="blue"><br/>
# include &lt;cppad/speed_test.hpp&gt;</font></code>
<code><span style='white-space: nowrap'><br/>
</span></code>
<code><font color="blue"><span style='white-space: nowrap'>SpeedTest(</span></font><i><font color="black"><span style='white-space: nowrap'>Test</span></font></i><font color="blue"><span style='white-space: nowrap'>,&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>first</span></font></i><font color="blue"><span style='white-space: nowrap'>,&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>inc</span></font></i><font color="blue"><span style='white-space: nowrap'>,&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>last</span></font></i><font color="blue"><span style='white-space: nowrap'>)</span></font></code>



<br/>
<br/>
<b><big><a name="Purpose" id="Purpose">Purpose</a></big></b>
<br/>
The <code><font color="blue">SpeedTest</font></code> function executes a speed test
for various sized problems
and reports the results on standard output; i.e. <code><font color="blue">std::cout</font></code>.
The size of each test problem is included in its report
(unless 
<code><i><font color="black"><span style='white-space: nowrap'>first</span></font></i></code>
 is equal to 
<code><i><font color="black"><span style='white-space: nowrap'>last</span></font></i></code>
).

<br/>
<br/>
<b><big><a name="Motivation" id="Motivation">Motivation</a></big></b>
<br/>
It is important to separate small calculation units
and test them individually.
This way individual changes can be tested in the context of the
routine that they are in.
On many machines, accurate timing of a very short execution 
sequences is not possible.
In addition,
there may be set up time for a test that
we do not really want included in the timing.
For this reason <code><font color="blue">SpeedTest</font></code>
automatically determines how many times to 
repeat the section of the test that we wish to time.


<br/>
<br/>
<b><big><a name="Include" id="Include">Include</a></big></b>
<br/>
The file <code><font color="blue">speed_test.hpp</font></code> contains the 
<code><font color="blue">SpeedTest</font></code> function.
This file is included by <code><font color="blue">cppad/cppad.hpp</font></code>
but it can also be included separately with out the rest of 
the <code><font color="blue">CppAD</font></code> routines.

<br/>
<br/>
<b><big><a name="Test" id="Test">Test</a></big></b>
<br/>
The <code><font color="blue">SpeedTest</font></code> argument 
<code><i><font color="black"><span style='white-space: nowrap'>Test</span></font></i></code>
 is a function with the syntax

<code><font color="blue"><span style='white-space: nowrap'><br/>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>name</span></font></i><font color="blue"><span style='white-space: nowrap'>&#xA0;=&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>Test</span></font></i><font color="blue"><span style='white-space: nowrap'>(</span></font><i><font color="black"><span style='white-space: nowrap'>size</span></font></i><font color="blue"><span style='white-space: nowrap'>,&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>repeat</span></font></i><font color="blue"><span style='white-space: nowrap'>)<br/>
</span></font></code>
<br/>
<b><a name="Test.size" id="Test.size">size</a></b>
<br/>
The 
<code><i><font color="black"><span style='white-space: nowrap'>Test</span></font></i></code>
 argument 
<code><i><font color="black"><span style='white-space: nowrap'>size</span></font></i></code>
 has prototype

<code><font color="blue"><span style='white-space: nowrap'><br/>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;size_t&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>size</span></font></i><font color="blue"><span style='white-space: nowrap'><br/>
</span></font></code>
It specifies the size for this test.

<br/>
<br/>
<b><a name="Test.repeat" id="Test.repeat">repeat</a></b>
<br/>
The 
<code><i><font color="black"><span style='white-space: nowrap'>Test</span></font></i></code>
 argument 
<code><i><font color="black"><span style='white-space: nowrap'>repeat</span></font></i></code>
 has prototype

<code><font color="blue"><span style='white-space: nowrap'><br/>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;size_t&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>repeat</span></font></i><font color="blue"><span style='white-space: nowrap'><br/>
</span></font></code>
It specifies the number of times to repeat the test.

<br/>
<br/>
<b><a name="Test.name" id="Test.name">name</a></b>
<br/>
The 
<code><i><font color="black"><span style='white-space: nowrap'>Test</span></font></i></code>
 result 
<code><i><font color="black"><span style='white-space: nowrap'>name</span></font></i></code>
 has prototype

<code><font color="blue"><span style='white-space: nowrap'><br/>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;std::string&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>name</span></font></i><font color="blue"><span style='white-space: nowrap'><br/>
</span></font></code>
The results for this test are reported on <code><font color="blue">std::cout</font></code>
with 
<code><i><font color="black"><span style='white-space: nowrap'>name</span></font></i></code>
 as an identifier for the test.
It is assumed that,
for the duration of this call to <code><font color="blue">SpeedTest</font></code>,

<code><i><font color="black"><span style='white-space: nowrap'>Test</span></font></i></code>
 will always return 
the same value for 
<code><i><font color="black"><span style='white-space: nowrap'>name</span></font></i></code>
.
If 
<code><i><font color="black"><span style='white-space: nowrap'>name</span></font></i></code>
 is the empty string, 
no test name is reported by <code><font color="blue">SpeedTest</font></code>.

<br/>
<br/>
<b><big><a name="first" id="first">first</a></big></b>
<br/>
The <code><font color="blue">SpeedTest</font></code> argument 
<code><i><font color="black"><span style='white-space: nowrap'>first</span></font></i></code>
 has prototype

<code><font color="blue"><span style='white-space: nowrap'><br/>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;size_t&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>first</span></font></i><font color="blue"><span style='white-space: nowrap'><br/>
</span></font></code>
It specifies the size of the first test problem reported by this call to 
<code><font color="blue">SpeedTest</font></code>.
	
<br/>
<br/>
<b><big><a name="last" id="last">last</a></big></b>
<br/>
The <code><font color="blue">SpeedTest</font></code> argument 
<code><i><font color="black"><span style='white-space: nowrap'>last</span></font></i></code>
 has prototype

<code><font color="blue"><span style='white-space: nowrap'><br/>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;size_t&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>last</span></font></i><font color="blue"><span style='white-space: nowrap'><br/>
</span></font></code>
It specifies the size of the last test problem reported by this call to 
<code><font color="blue">SpeedTest</font></code>.

<br/>
<br/>
<b><big><a name="inc" id="inc">inc</a></big></b>
<br/>
The <code><font color="blue">SpeedTest</font></code> argument 
<code><i><font color="black"><span style='white-space: nowrap'>inc</span></font></i></code>
 has prototype

<code><font color="blue"><span style='white-space: nowrap'><br/>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;int&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>inc</span></font></i><font color="blue"><span style='white-space: nowrap'><br/>
</span></font></code>
It specifies the increment between problem sizes; i.e.,
all values of 
<code><i><font color="black"><span style='white-space: nowrap'>size</span></font></i></code>
 in calls to 
<code><i><font color="black"><span style='white-space: nowrap'>Test</span></font></i></code>
 are given by

<code><font color="blue"><span style='white-space: nowrap'><br/>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>size</span></font></i><font color="blue"><span style='white-space: nowrap'>&#xA0;=&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>first</span></font></i><font color="blue"><span style='white-space: nowrap'>&#xA0;+&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>j</span></font></i><font color="blue"><span style='white-space: nowrap'>&#xA0;*&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>inc</span></font></i><font color="blue"><span style='white-space: nowrap'><br/>
</span></font></code>
where 
<code><i><font color="black"><span style='white-space: nowrap'>j</span></font></i></code>
 is a positive integer.
The increment can be positive or negative but it cannot be zero.
The values 
<code><i><font color="black"><span style='white-space: nowrap'>first</span></font></i></code>
, 
<code><i><font color="black"><span style='white-space: nowrap'>last</span></font></i></code>
 and 
<code><i><font color="black"><span style='white-space: nowrap'>inc</span></font></i></code>
 must 
satisfy the relation

<math xmlns="http://www.w3.org/1998/Math/MathML" display="block"><mrow>
<mi mathvariant='italic'>inc</mi>
<mo stretchy="false">*</mo>
<mo stretchy="false">(</mo>
<mi mathvariant='italic'>last</mi>
<mo stretchy="false">-</mo>
<mi mathvariant='italic'>first</mi>
<mo stretchy="false">)</mo>
<mo stretchy="false">&#x02265;</mo>
<mn>0</mn>
</mrow></math>

<br/>
<b><big><a name="rate" id="rate">rate</a></big></b>
<br/>
The value displayed in the <code><font color="blue">rate</font></code> column on <code><font color="blue">std::cout</font></code>
is defined as the value of 
<code><i><font color="black"><span style='white-space: nowrap'>repeat</span></font></i></code>
 divided by the 
corresponding elapsed execution time in seconds.
The elapsed execution time is measured by the difference in
<code><font color='blue'><pre style='display:inline'> 
	(double) clock() / (double) CLOCKS_PER_SEC
</pre></font></code>

in the context of the standard <code><font color="blue">&lt;ctime&gt;</font></code> definitions.


<br/>
<br/>
<b><big><a name="Errors" id="Errors">Errors</a></big></b>
<br/>
If one of the restrictions above is violated,
the CppAD error handler is used to report the error.
You can redefine this action using the instructions in
<a href="errorhandler.xml" target="_top"><span style='white-space: nowrap'>ErrorHandler</span></a>


<br/>
<br/>
<b><big><a name="Example" id="Example">Example</a></big></b>

<br/>
The program <a href="speed_program.cpp.xml" target="_top"><span style='white-space: nowrap'>speed_program.cpp</span></a>
 is an example usage
of <code><font color="blue">SpeedTest</font></code>.


<hr/>Input File: cppad/speed_test.hpp

</body>
</html>