Prev Next Index-> contents reference index search external Up-> CppAD library CheckSimpleVector CppAD-> Install Introduction AD ADFun preprocessor multi_thread library ipopt_solve Example speed Appendix library-> ErrorHandler NearEqual speed_test SpeedTest time_test NumericType CheckNumericType SimpleVector CheckSimpleVector nan pow_int Poly LuDetAndSolve RombergOne RombergMul Runge45 Rosen34 OdeErrControl OdeGear OdeGearControl CppAD_vector thread_alloc index_sort BenderQuad opt_val_hes LuRatio CheckSimpleVector-> check_simple_vector.cpp Headings-> Syntax Purpose x, y Restrictions Include Parallel Mode Example

Check Simple Vector Concept

Syntax  # include <cppad/check_simple_vector.hpp>   CheckSimpleVector<Scalar, Vector>()   CheckSimpleVector<Scalar, Vector>(x, y)

Purpose
Preforms compile and run time checks that the type specified by Vector satisfies all the requirements for a SimpleVector class with elements of type Scalar . If a requirement is not satisfied, a an error message makes it clear what condition is not satisfied.

x, y
If the arguments x and y are present, they have prototype       const Scalar& x      const Scalar& y  In addition, the check       x == x  will return the boolean value true, and       x == y  will return false.

Restrictions
If the arguments x and y are not present, the following extra assumption is made by CheckSimpleVector: If x is a Scalar object       x = 0      y = 1  assigns values to the objects x and y . In addition, x == x would return the boolean value true and x == y would return false.

Include
The file cppad/check_simple_vector.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_simple_vector.cpp contains an example and test of this function where S is the same as T . It returns true, if it succeeds an false otherwise. The comments in this example suggest a way to change the example so S is not the same as T .