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

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

test_vector.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
<?xml version='1.0'?>
<html xmlns='http://www.w3.org/1999/xhtml'
      xmlns:math='http://www.w3.org/1998/Math/MathML'
>
<head>
<title>Choosing The Vector Testing Template Class</title>
<meta http-equiv='Content-Type' content='text/html' charset='utf-8'/>
<meta name="description" id="description" content="Choosing The Vector Testing Template Class"/>
<meta name="keywords" id="keywords" content=" Cppad_test_vector vector test choosing the testing template class deprecated syntax introduction ms windows cppad::vector std::vector boost::numeric::ublas::vector cppadvector "/>
<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='_test_vector_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="epsilon.xml" target="_top">Prev</a>
</td><td><a href="cppad_ipopt_nlp.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>Appendix</option>
<option>deprecated</option>
<option>test_vector</option>
</select>
</td>
<td>
<select onchange='choose_down3(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_down2(this)'>
<option>Appendix-&gt;</option>
<option>Faq</option>
<option>Theory</option>
<option>glossary</option>
<option>Bib</option>
<option>Bugs</option>
<option>WishList</option>
<option>whats_new</option>
<option>deprecated</option>
<option>compare_c</option>
<option>License</option>
</select>
</td>
<td>
<select onchange='choose_down1(this)'>
<option>deprecated-&gt;</option>
<option>include_deprecated</option>
<option>FunDeprecated</option>
<option>omp_max_thread</option>
<option>TrackNewDel</option>
<option>omp_alloc</option>
<option>memory_leak</option>
<option>epsilon</option>
<option>test_vector</option>
<option>cppad_ipopt_nlp</option>
<option>old_atomic</option>
</select>
</td>
<td>test_vector</td>
<td>
<select onchange='choose_current0(this)'>
<option>Headings-&gt;</option>
<option>Deprecated</option>
<option>Syntax</option>
<option>Introduction</option>
<option>MS Windows</option>
<option>CppAD::vector</option>
<option>std::vector</option>
<option>boost::numeric::ublas::vector</option>
<option>CppADvector</option>
</select>
</td>
</tr></table><br/>
<center><b><big><big>Choosing The Vector Testing Template Class</big></big></b></center>
<br/>
<b><big><a name="Deprecated" id="Deprecated">Deprecated</a></big></b>

<br/>
The <code><font color="blue">CPPAD_TEST_VECTOR</font></code> macro has been deprecated,
use <a href="testvector.xml" target="_top"><span style='white-space: nowrap'>CPPAD_TESTVECTOR</span></a>
 instead.

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

<br/>

<code><font color="blue"><span style='white-space: nowrap'>CPPAD_TEST_VECTOR&lt;</span></font><i><font color="black"><span style='white-space: nowrap'>Scalar</span></font></i><font color="blue"><span style='white-space: nowrap'>&gt;<br/>
</span></font></code>
<br/>
<b><big><a name="Introduction" id="Introduction">Introduction</a></big></b>
<br/>
Many of the CppAD <a href="example.xml" target="_top"><span style='white-space: nowrap'>examples</span></a>
 and tests use 
the <code><font color="blue">CPPAD_TEST_VECTOR</font></code> template class to pass information.
The default definition for this template class is
<a href="cppad_vector.xml" target="_top"><span style='white-space: nowrap'>CppAD::vector</span></a>
.

<br/>
<br/>
<b><big><a name="MS Windows" id="MS Windows">MS Windows</a></big></b>
<br/>
The include path for boost is not defined in the Windows project files.
If we are using Microsofts compiler, the following code overrides the setting
of <code><font color="blue">CPPAD_BOOSTVECTOR</font></code>:
<code><font color='blue'><pre style='display:inline'> 
// The next 7 lines are C++ source code.
# ifdef _MSC_VER
# if CPPAD_BOOSTVECTOR
# undef  CPPAD_BOOSTVECTOR
# define CPPAD_BOOSTVECTOR 0
# undef  CPPAD_CPPADVECTOR
# define CPPAD_CPPADVECTOR 1
# endif
# endif
</pre></font></code>


<br/>
<br/>
<b><big><a name="CppAD::vector" id="CppAD::vector">CppAD::vector</a></big></b>
<br/>
By default <code><font color="blue">CPPAD_CPPADVECTOR</font></code> is true
and <code><font color="blue">CPPAD_TEST_VECTOR</font></code> is defined by the following source code
<code><font color='blue'><pre style='display:inline'> 
// The next 3 line are C++ source code.
# if CPPAD_CPPADVECTOR
# define CPPAD_TEST_VECTOR CppAD::vector
# endif
</pre></font></code>

If you specify <code><font color="blue">--with-eigenvector</font></code> on the 
<a href="installunix.xml#Configure" target="_top"><span style='white-space: nowrap'>configure</span></a>
 command line,
<code><font color="blue">CPPAD_EIGENVECTOR</font></code> is true.
This vector type cannot be supported by <code><font color="blue">CPPAD_TEST_VECTOR</font></code>
(use <a href="testvector.xml" target="_top"><span style='white-space: nowrap'>CPPAD_TESTVECTOR</span></a>
 for this support)
so <code><font color="blue">CppAD::vector</font></code> is used in this case
<code><font color='blue'><pre style='display:inline'> 
// The next 3 line are C++ source code.
# if CPPAD_EIGENVECTOR
# define CPPAD_TEST_VECTOR CppAD::vector
# endif
</pre></font></code>



<br/>
<br/>
<b><big><a name="std::vector" id="std::vector">std::vector</a></big></b>
<br/>
If you specify <code><font color="blue">--with-stdvector</font></code> on the 
<a href="installunix.xml#Configure" target="_top"><span style='white-space: nowrap'>configure</span></a>

command line during CppAD installation,
<code><font color="blue">CPPAD_STDVECTOR</font></code> is true
and <code><font color="blue">CPPAD_TEST_VECTOR</font></code> is defined by the following source code
<code><font color='blue'><pre style='display:inline'> 
// The next 4 lines are C++ source code.
# if CPPAD_STDVECTOR
# include &lt;vector&gt;
# define CPPAD_TEST_VECTOR std::vector
# endif
</pre></font></code>

In this case CppAD will use <code><font color="blue">std::vector</font></code> for its examples and tests.
Use of <code><font color="blue">CppAD::vector</font></code>, <code><font color="blue">std::vector</font></code>,
and <code><font color="blue">std::valarray</font></code> with CppAD is always tested to some degree.
Specifying <code><font color="blue">--with-stdvector</font></code> will increase the amount of
<code><font color="blue">std::vector</font></code> testing. 

<br/>
<br/>
<b><big><a name="boost::numeric::ublas::vector" id="boost::numeric::ublas::vector">boost::numeric::ublas::vector</a></big></b>
<br/>
If you specify a value for 
<code><i><font color="black"><span style='white-space: nowrap'>boost_dir</span></font></i></code>
 on the configure
command line during CppAD installation,
<code><font color="blue">CPPAD_BOOSTVECTOR</font></code> is true 
and <code><font color="blue">CPPAD_TEST_VECTOR</font></code> is defined by the following source code
<code><font color='blue'><pre style='display:inline'> 
// The next 4 lines are C++ source code.
# if CPPAD_BOOSTVECTOR
# include &lt;boost/numeric/ublas/vector.hpp&gt;
# define CPPAD_TEST_VECTOR boost::numeric::ublas::vector
# endif
</pre></font></code>

In this case CppAD will use Ublas vectors for its examples and tests.
Use of <code><font color="blue">CppAD::vector</font></code>, <code><font color="blue">std::vector</font></code>,
and <code><font color="blue">std::valarray</font></code> with CppAD is always tested to some degree.
Specifying 
<code><i><font color="black"><span style='white-space: nowrap'>boost_dir</span></font></i></code>
 will increase the amount of
Ublas vector testing. 

<br/>
<br/>
<b><big><a name="CppADvector" id="CppADvector">CppADvector</a></big></b>
<br/>
The preprocessor symbol <code><font color="blue">CppADvector</font></code> is defined to
have the same value as <code><font color="blue">CPPAD_TEST_VECTOR</font></code> but its use is deprecated:
<code><font color='blue'><pre style='display:inline'> 
# define CppADvector CPPAD_TEST_VECTOR
</pre></font></code>


<hr/>Input File: cppad/local/test_vector.hpp

</body>
</html>