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

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

compare.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
<?xml version='1.0'?>
<html xmlns='http://www.w3.org/1999/xhtml'
      xmlns:math='http://www.w3.org/1998/Math/MathML'
>
<head>
<title>AD Binary Comparison Operators</title>
<meta http-equiv='Content-Type' content='text/html' charset='utf-8'/>
<meta name="description" id="description" content="AD Binary Comparison Operators"/>
<meta name="keywords" id="keywords" content=" binary Ad compare operator &lt; &lt;= &gt; &gt;= == != ad comparison operators syntax purpose op x y b operation sequence assumptions 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='_compare_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="boolvalued.xml" target="_top">Prev</a>
</td><td><a href="compare.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>AD</option>
<option>BoolValued</option>
<option>Compare</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>AD-&gt;</option>
<option>ad_ctor</option>
<option>ad_assign</option>
<option>Convert</option>
<option>ADValued</option>
<option>BoolValued</option>
<option>VecAD</option>
<option>base_require</option>
</select>
</td>
<td>
<select onchange='choose_down1(this)'>
<option>BoolValued-&gt;</option>
<option>Compare</option>
<option>NearEqualExt</option>
<option>BoolFun</option>
<option>ParVar</option>
<option>EqualOpSeq</option>
</select>
</td>
<td>
<select onchange='choose_down0(this)'>
<option>Compare-&gt;</option>
<option>compare.cpp</option>
</select>
</td>
<td>
<select onchange='choose_current0(this)'>
<option>Headings-&gt;</option>
<option>Syntax</option>
<option>Purpose</option>
<option>Op</option>
<option>x</option>
<option>y</option>
<option>b</option>
<option>Operation Sequence</option>
<option>Assumptions</option>
<option>Example</option>
</select>
</td>
</tr></table><br/>
<center><b><big><big>AD Binary Comparison Operators</big></big></b></center>
<br/>
<b><big><a name="Syntax" id="Syntax">Syntax</a></big></b>


<br/>

<code><i><font color="black"><span style='white-space: nowrap'>b</span></font></i><font color="blue"><span style='white-space: nowrap'>&#xA0;=&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>x</span></font></i><font color="blue"><span style='white-space: nowrap'>&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>Op</span></font></i><font color="blue"><span style='white-space: nowrap'>&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>y</span></font></i></code>



<br/>
<br/>
<b><big><a name="Purpose" id="Purpose">Purpose</a></big></b>
<br/>
Compares two operands where one of the operands is an

<code><font color="blue"><span style='white-space: nowrap'>AD&lt;</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>&gt;</span></font></code>
 object.
The comparison has the same interpretation as for 
the 
<code><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i></code>
 type.


<br/>
<br/>
<b><big><a name="Op" id="Op">Op</a></big></b>
<br/>
The operator 
<code><i><font color="black"><span style='white-space: nowrap'>Op</span></font></i></code>
 is one of the following:
<table><tr><td align='left'  valign='top'>

<b>Op</b> <code><span style='white-space: nowrap'>&#xA0;</span></code>  </td><td align='left'  valign='top'>
 <b>Meaning</b>                           </td></tr><tr><td align='left'  valign='top'>

<code><font color="blue">&lt;</font></code>   </td><td align='left'  valign='top'>
 is 
<code><i><font color="black"><span style='white-space: nowrap'>x</span></font></i></code>
 less than 
<code><i><font color="black"><span style='white-space: nowrap'>y</span></font></i></code>
              </td></tr><tr><td align='left'  valign='top'>

<code><font color="blue">&lt;=</font></code>  </td><td align='left'  valign='top'>
 is 
<code><i><font color="black"><span style='white-space: nowrap'>x</span></font></i></code>
 less than or equal 
<code><i><font color="black"><span style='white-space: nowrap'>y</span></font></i></code>
     </td></tr><tr><td align='left'  valign='top'>

<code><font color="blue">&gt;</font></code>   </td><td align='left'  valign='top'>
 is 
<code><i><font color="black"><span style='white-space: nowrap'>x</span></font></i></code>
 greater than 
<code><i><font color="black"><span style='white-space: nowrap'>y</span></font></i></code>
           </td></tr><tr><td align='left'  valign='top'>

<code><font color="blue">&gt;=</font></code>  </td><td align='left'  valign='top'>
 is 
<code><i><font color="black"><span style='white-space: nowrap'>x</span></font></i></code>
 greater than or equal 
<code><i><font color="black"><span style='white-space: nowrap'>y</span></font></i></code>
  </td></tr><tr><td align='left'  valign='top'>

<code><font color="blue">==</font></code>  </td><td align='left'  valign='top'>
 is 
<code><i><font color="black"><span style='white-space: nowrap'>x</span></font></i></code>
 equal to 
<code><i><font color="black"><span style='white-space: nowrap'>y</span></font></i></code>
               </td></tr><tr><td align='left'  valign='top'>

<code><font color="blue">!=</font></code>  </td><td align='left'  valign='top'>
 is 
<code><i><font color="black"><span style='white-space: nowrap'>x</span></font></i></code>
 not equal to 
<code><i><font color="black"><span style='white-space: nowrap'>y</span></font></i></code>

</td></tr>
</table>
<br/>
<b><big><a name="x" id="x">x</a></big></b>
<br/>
The operand 
<code><i><font color="black"><span style='white-space: nowrap'>x</span></font></i></code>
 has prototype

<code><font color="blue"><span style='white-space: nowrap'><br/>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;const&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>Type</span></font></i><font color="blue"><span style='white-space: nowrap'>&#xA0;&amp;</span></font><i><font color="black"><span style='white-space: nowrap'>x</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'>Type</span></font></i></code>
 is 
<code><font color="blue"><span style='white-space: nowrap'>AD&lt;</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>&gt;</span></font></code>
, 
<code><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i></code>
, or <code><font color="blue">int</font></code>.

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

<code><font color="blue"><span style='white-space: nowrap'><br/>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;const&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>Type</span></font></i><font color="blue"><span style='white-space: nowrap'>&#xA0;&amp;</span></font><i><font color="black"><span style='white-space: nowrap'>y</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'>Type</span></font></i></code>
 is 
<code><font color="blue"><span style='white-space: nowrap'>AD&lt;</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>&gt;</span></font></code>
, 
<code><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i></code>
, or <code><font color="blue">int</font></code>.

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

<code><font color="blue"><span style='white-space: nowrap'><br/>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;bool&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>b</span></font></i><font color="blue"><span style='white-space: nowrap'><br/>
</span></font></code>
<br/>
<b><big><a name="Operation Sequence" id="Operation Sequence">Operation Sequence</a></big></b>
<br/>
The result of this operation is a <code><font color="blue">bool</font></code> value
(not an <a href="glossary.xml#AD of Base" target="_top"><span style='white-space: nowrap'>AD&#xA0;of&#xA0;Base</span></a>
 object).
Thus it will not be recorded as part of an
AD of 
<code><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i></code>

<a href="glossary.xml#Operation.Sequence" target="_top"><span style='white-space: nowrap'>operation&#xA0;sequence</span></a>
.
<code><span style='white-space: nowrap'><br/>
<br/>
</span></code>For example, suppose 

<code><i><font color="black"><span style='white-space: nowrap'>x</span></font></i></code>
 and 
<code><i><font color="black"><span style='white-space: nowrap'>y</span></font></i></code>
 are 
<code><font color="blue"><span style='white-space: nowrap'>AD&lt;</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>&gt;</span></font></code>
 objects,
the tape corresponding to 
<code><font color="blue"><span style='white-space: nowrap'>AD&lt;</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>&gt;</span></font></code>
 is recording,

<code><i><font color="black"><span style='white-space: nowrap'>b</span></font></i></code>
 is true,
and the subsequent code is

<code><font color="blue"><span style='white-space: nowrap'><br/>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;if(&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>b</span></font></i><font color="blue"><span style='white-space: nowrap'>&#xA0;)<br/>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>y</span></font></i><font color="blue"><span style='white-space: nowrap'>&#xA0;=&#xA0;cos(</span></font><i><font color="black"><span style='white-space: nowrap'>x</span></font></i><font color="blue"><span style='white-space: nowrap'>);<br/>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;else&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>y</span></font></i><font color="blue"><span style='white-space: nowrap'>&#xA0;=&#xA0;sin(</span></font><i><font color="black"><span style='white-space: nowrap'>x</span></font></i><font color="blue"><span style='white-space: nowrap'>);&#xA0;<br/>
</span></font></code>
only the assignment 
<code><i><font color="black"><span style='white-space: nowrap'>y</span></font></i><font color="blue"><span style='white-space: nowrap'>&#xA0;=&#xA0;cos(</span></font><i><font color="black"><span style='white-space: nowrap'>x</span></font></i><font color="blue"><span style='white-space: nowrap'>)</span></font></code>
 is recorded on the tape
(if 
<code><i><font color="black"><span style='white-space: nowrap'>x</span></font></i></code>
 is a <a href="glossary.xml#Parameter" target="_top"><span style='white-space: nowrap'>parameter</span></a>
, 
nothing is recorded).
The <a href="comparechange.xml" target="_top"><span style='white-space: nowrap'>CompareChange</span></a>
 function can yield
some information about changes in comparison operation results.
You can use <a href="condexp.xml" target="_top"><span style='white-space: nowrap'>CondExp</span></a>
 to obtain comparison operations
that depends on the 
<a href="glossary.xml#Tape.Independent Variable" target="_top"><span style='white-space: nowrap'>independent&#xA0;variable</span></a>
 
values with out re-taping the AD sequence of operations.

<br/>
<br/>
<b><big><a name="Assumptions" id="Assumptions">Assumptions</a></big></b>
<br/>
If one of the 
<code><i><font color="black"><span style='white-space: nowrap'>Op</span></font></i></code>
 operators listed above
is used with an 
<code><font color="blue"><span style='white-space: nowrap'>AD&lt;</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>&gt;</span></font></code>
 object,
it is assumed that the same operator is supported by the base type 

<code><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i></code>
.

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

<br/>
The file
<a href="compare.cpp.xml" target="_top"><span style='white-space: nowrap'>compare.cpp</span></a>

contains an example and test of these operations.
It returns true if it succeeds and false otherwise.


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

</body>
</html>