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

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

eigen_prefix.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
<?xml version='1.0'?>
<html xmlns='http://www.w3.org/1999/xhtml'
      xmlns:math='http://www.w3.org/1998/Math/MathML'
>
<head>
<title>Including the Eigen Examples and Tests</title>
<meta http-equiv='Content-Type' content='text/html' charset='utf-8'/>
<meta name="description" id="description" content="Including the Eigen Examples and Tests"/>
<meta name="keywords" id="keywords" content=" including the eigen examples and tests example test purpose eigen_prefix prefix vector get_eigen get "/>
<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='_eigen_prefix_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="get_colpack.sh.xml" target="_top">Prev</a>
</td><td><a href="get_eigen.sh.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>Install</option>
<option>cmake</option>
<option>eigen_prefix</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>Install-&gt;</option>
<option>download</option>
<option>cmake</option>
<option>cmake_check</option>
<option>pkgconfig</option>
<option>InstallUnix</option>
</select>
</td>
<td>
<select onchange='choose_down1(this)'>
<option>cmake-&gt;</option>
<option>adolc_prefix</option>
<option>colpack_prefix</option>
<option>eigen_prefix</option>
<option>fadbad_prefix</option>
<option>ipopt_prefix</option>
<option>sacado_prefix</option>
<option>cppad_testvector</option>
</select>
</td>
<td>
<select onchange='choose_down0(this)'>
<option>eigen_prefix-&gt;</option>
<option>get_eigen.sh</option>
</select>
</td>
<td>
<select onchange='choose_current0(this)'>
<option>Headings-&gt;</option>
<option>Purpose</option>
<option>eigen_prefix</option>
<option>Examples</option>
<option>Test Vector</option>
<option>get_eigen</option>
</select>
</td>
</tr></table><br/>




<center><b><big><big>Including the Eigen Examples and Tests</big></big></b></center>
<br/>
<b><big><a name="Purpose" id="Purpose">Purpose</a></big></b>
<br/>
CppAD can include the following examples and tests that 
use the linear algebra package <a href="http://eigen.tuxfamily.org" target="_top"><span style='white-space: nowrap'>Eigen</span></a>
:
<table><tr><td align='left'  valign='top'>

<a href="cppad_eigen.hpp.xml" target="_top">cppad_eigen.hpp</a></td><td>
Enable Use of Eigen Linear Algebra Package with CppAD</td></tr>
<tr><td>

<a href="eigen_array.cpp.xml" target="_top">eigen_array.cpp</a></td><td>
Using Eigen Arrays: Example and Test</td></tr>
<tr><td>

<a href="eigen_det.cpp.xml" target="_top">eigen_det.cpp</a></td><td>
Using Eigen To Compute Determinant: Example and Test</td></tr>
<tr><td>

</td></tr>
</table>
<br/>
<b><big><a name="eigen_prefix" id="eigen_prefix">eigen_prefix</a></big></b>


<br/>
If Eigen is installed on your system, you can 
specify a value for its install 
<code><i><font color="black"><span style='white-space: nowrap'>eigen_prefix</span></font></i></code>
 on the
<a href="cmake.xml" target="_top"><span style='white-space: nowrap'>cmake</span></a>
 command line.
The value of 
<code><i><font color="black"><span style='white-space: nowrap'>eigen_prefix</span></font></i></code>
 must be such that,
for one of the directories 
<code><i><font color="black"><span style='white-space: nowrap'>dir</span></font></i></code>
 in
<a href="cmake.xml#cmake_install_includedirs" target="_top"><span style='white-space: nowrap'>cmake_install_includedirs</span></a>
,

<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'>eigen_prefix</span></font></i><font color="blue"><span style='white-space: nowrap'>/</span></font><i><font color="black"><span style='white-space: nowrap'>dir</span></font></i><font color="blue"><span style='white-space: nowrap'>/Eigen/Core<br/>
</span></font></code>
is a valid way to reference to the include file <code><font color="blue">Core</font></code>;

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


<br/>
If you include 
<code><i><font color="black"><span style='white-space: nowrap'>eigen_prefix</span></font></i></code>
 on the <a href="cmake.xml" target="_top"><span style='white-space: nowrap'>cmake</span></a>
 command line,
you will be able to run the Eigen examples list above
by executing the following commands starting in the
<a href="download.xml#Distribution Directory" target="_top"><span style='white-space: nowrap'>distribution&#xA0;directory</span></a>
:

<code><font color="blue"><span style='white-space: nowrap'><br/>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;cd&#xA0;build/example<br/>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;make&#xA0;check_example<br/>
</span></font></code>
If you do this,
you will see an indication that the examples
<code><font color="blue">eigen_array</font></code> and <code><font color="blue">eigen_det</font></code>
have passed their correctness check.

options to this program.

<br/>
<br/>
<b><big><a name="Test Vector" id="Test Vector">Test Vector</a></big></b>


<br/>
If you have specified 
<code><i><font color="black"><span style='white-space: nowrap'>eigen_prefix</span></font></i></code>
 you can choose

<code><font color="blue"><span style='white-space: nowrap'><br/>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;-D&#xA0;cppad_testvector=eigen<br/>
</span></font></code>
on the <a href="cmake.xml#CMake Command" target="_top"><span style='white-space: nowrap'>cmake&#xA0;command</span></a>
 line.
This we set the CppAD <a href="testvector.xml" target="_top"><span style='white-space: nowrap'>testvector</span></a>
 to use Eigen vectors. 


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


<br/>
If you are using Unix, you can download and install
a copy of Eigen using <a href="get_eigen.sh.xml" target="_top"><span style='white-space: nowrap'>get_eigen.sh</span></a>
.
The corresponding 
<code><i><font color="black"><span style='white-space: nowrap'>eigen_prefix</span></font></i></code>
 would be
<code><font color="blue">build/prefix</font></code>.




<hr/>Input File: omh/install/eigen_prefix.omh

</body>
</html>