Prev

Next

Index-> contents reference index search external

Up-> CppAD utility CheckNumericType

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

CheckNumericType-> check_numeric_type.cpp

Headings-> Syntax Purpose Include Parallel Mode Example

@(@\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}} }@)@Check NumericType Class Concept
Syntax
# include <cppad/utility/check_numeric_type.hpp>
CheckNumericType<NumericType>()

Purpose
The syntax
     CheckNumericType<NumericType>()
preforms compile and run time checks that the type specified by NumericType satisfies all the requirements for a NumericType class. If a requirement is not satisfied, a an error message makes it clear what condition is not satisfied.

Include
The file cppad/check_numeric_type.hpp is included by cppad/cppad.hpp but it can also be included separately with out the rest if the CppAD include files.

Parallel Mode
The routine thread_alloc::parallel_setup must be called before it can be used in parallel mode.

Example
The file check_numeric_type.cpp contains an example and test of this function. It returns true, if it succeeds an false otherwise. The comments in this example suggest a way to change the example so an error message occurs.

---

Input File: cppad/utility/check_numeric_type.hpp