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

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

cppad_assert.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
<?xml version='1.0'?>
<html xmlns='http://www.w3.org/1999/xhtml'
      xmlns:math='http://www.w3.org/1998/Math/MathML'
>
<head>
<title>CppAD Assertions During Execution</title>
<meta http-equiv='Content-Type' content='text/html' charset='utf-8'/>
<meta name="description" id="description" content="CppAD Assertions During Execution"/>
<meta name="keywords" id="keywords" content=" assert error macro cppad assertions during execution syntax purpose ndebug Ndebug restriction known Cppad_assert_known unknown Cppad_assert_unknown exp msg handler "/>
<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='_cppad_assert_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="error_handler.cpp.xml" target="_top">Prev</a>
</td><td><a href="nearequal.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>ErrorHandler</option>
<option>cppad_assert</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>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_down1(this)'>
<option>ErrorHandler-&gt;</option>
<option>error_handler.cpp</option>
<option>cppad_assert</option>
</select>
</td>
<td>cppad_assert</td>
<td>
<select onchange='choose_current0(this)'>
<option>Headings-&gt;</option>
<option>Syntax</option>
<option>Purpose</option>
<option>NDEBUG</option>
<option>Restriction</option>
<option>---..Known</option>
<option>---..Unknown</option>
<option>Exp</option>
<option>Msg</option>
<option>Error Handler</option>
</select>
</td>
</tr></table><br/>







<center><b><big><big>CppAD Assertions During Execution</big></big></b></center>
<br/>
<b><big><a name="Syntax" id="Syntax">Syntax</a></big></b>

<br/>

<code><font color="blue"><span style='white-space: nowrap'>CPPAD_ASSERT_KNOWN(</span></font><i><font color="black"><span style='white-space: nowrap'>exp</span></font></i><font color="blue"><span style='white-space: nowrap'>,&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>msg</span></font></i><font color="blue"><span style='white-space: nowrap'>)<br/>
</span></font></code>

<code><font color="blue"><span style='white-space: nowrap'>CPPAD_ASSERT_UNKNOWN(</span></font><i><font color="black"><span style='white-space: nowrap'>exp</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/>
These CppAD macros are used to detect and report errors.
They are documented here because they correspond to the C++
source code that the error is reported at.

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

<br/>
If the preprocessor symbol 
<a href="faq.xml#Speed.NDEBUG" target="_top"><span style='white-space: nowrap'>NDEBUG</span></a>
 is defined,
these macros do nothing; i.e., they are optimized out.

<br/>
<br/>
<b><big><a name="Restriction" id="Restriction">Restriction</a></big></b>
<br/>
The CppAD user should not uses these macros.
You can however write your own macros that do not begin with <code><font color="blue">CPPAD</font></code>
and that call the <a href="errorhandler.xml" target="_top"><span style='white-space: nowrap'>CppAD&#xA0;error&#xA0;handler</span></a>
.

<br/>
<br/>
<b><a name="Restriction.Known" id="Restriction.Known">Known</a></b>

<br/>
The <code><font color="blue">CPPAD_ASSERT_KNOWN</font></code> macro is used to check for an error
with a known cause.
For example, many CppAD routines uses these macros
to make sure their arguments conform to their specifications.

<br/>
<br/>
<b><a name="Restriction.Unknown" id="Restriction.Unknown">Unknown</a></b>

<br/>
The <code><font color="blue">CPPAD_ASSERT_UNKNOWN</font></code> macro is used to check that the 
CppAD internal data structures conform as expected.
If this is not the case, CppAD does not know why the error has 
occurred; for example, the user may have written past the end
of an allocated array.

<br/>
<br/>
<b><big><a name="Exp" id="Exp">Exp</a></big></b>
<br/>
The argument 
<code><i><font color="black"><span style='white-space: nowrap'>exp</span></font></i></code>
 is a C++ source code expression
that results in a <code><font color="blue">bool</font></code> value that should be true.
If it is false, an error has occurred.
This expression may be execute any number of times 
(including zero times) so it must have not side effects.

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

<code><font color="blue"><span style='white-space: nowrap'><br/>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;const&#xA0;char&#xA0;*</span></font><i><font color="black"><span style='white-space: nowrap'>msg</span></font></i><font color="blue"><span style='white-space: nowrap'><br/>
</span></font></code>
and contains a <code><font color="blue">'\0'</font></code> terminated character string.
This string is a description of the error 
corresponding to 
<code><i><font color="black"><span style='white-space: nowrap'>exp</span></font></i></code>
 being false.

<br/>
<br/>
<b><big><a name="Error Handler" id="Error Handler">Error Handler</a></big></b>
<br/>
These macros use the 
<a href="errorhandler.xml" target="_top"><span style='white-space: nowrap'>CppAD&#xA0;error&#xA0;handler</span></a>
 to report errors.
This error handler can be replaced by the user.


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

</body>
</html>