Prev

Next

Index-> contents reference index search external

Up-> CppAD utility ErrorHandler cppad_assert

CppAD-> Install Introduction AD ADFun preprocessor multi_thread utility ipopt_solve Example speed Appendix

utility-> ErrorHandler NearEqual speed_test SpeedTest time_test test_boolofvoid NumericType CheckNumericType SimpleVector CheckSimpleVector nan pow_int Poly LuDetAndSolve RombergOne RombergMul Runge45 Rosen34 OdeErrControl OdeGear OdeGearControl CppAD_vector thread_alloc index_sort to_string set_union sparse_rc sparse_rcv

ErrorHandler-> error_handler.cpp cppad_assert

cppad_assert

Headings-> Syntax Purpose NDEBUG Restriction Known Unknown Exp Msg Error Handler

@(@\newcommand{\W}[1]{ \; #1 \; } \newcommand{\R}[1]{ {\rm #1} } \newcommand{\B}[1]{ {\bf #1} } \newcommand{\D}[2]{ \frac{\partial #1}{\partial #2} } \newcommand{\DD}[3]{ \frac{\partial^2 #1}{\partial #2 \partial #3} } \newcommand{\Dpow}[2]{ \frac{\partial^{#1}}{\partial {#2}^{#1}} } \newcommand{\dpow}[2]{ \frac{ {\rm d}^{#1}}{{\rm d}\, {#2}^{#1}} }@)@CppAD Assertions During Execution
Syntax
CPPAD_ASSERT_KNOWN(exp, msg)
CPPAD_ASSERT_UNKNOWN(exp)

Purpose
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.

NDEBUG
If the preprocessor symbol NDEBUG is defined, these macros do nothing; i.e., they are optimized out.

Restriction
The CppAD user should not uses these macros. You can however write your own macros that do not begin with CPPAD and that call the CppAD error handler .

Known
The CPPAD_ASSERT_KNOWN 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.

Unknown
The CPPAD_ASSERT_UNKNOWN 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.

Exp
The argument exp is a C++ source code expression that results in a bool 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.

Msg
The argument msg has prototype
     const char *msg
and contains a '\0' terminated character string. This string is a description of the error corresponding to exp being false.

Error Handler
These macros use the CppAD error handler to report errors. This error handler can be replaced by the user.

---

Input File: cppad/core/cppad_assert.hpp