Prev

Next

Index-> contents reference index search external

Up-> CppAD AD base_require

CppAD-> Install Introduction AD ADFun multi_thread library cppad_ipopt_nlp Example preprocessor Appendix

AD-> Default ad_copy Convert ADValued BoolValued VecAD base_require

base_require-> base_cond_exp base_identical base_ordered base_std_math base_float.hpp base_double.hpp base_complex.hpp base_adolc.hpp

Headings-> Syntax Warning Purpose ---..Standard Base Types Include Order Numeric Type Integer ---..Suggestion epsilon isnan Contents

AD<Base> Requirements for Base Type
Syntax
include <cppad/base_require.hpp>

Warning
This is a preliminary version of these specifications and it is subject to change in future versions of CppAD.

Purpose
This section lists the requirements that the type Base so that the type AD<Base> can be used.

Standard Base Types
In the case where Base is float, double, std::complex<float>, std::complex<double>, or AD<Other> , these requirements are provided by including the file cppad/cppad.hpp.

Include Order
If you are linking a non-standard base type to CppAD, you must first include the file cppad/base_require.hpp/, then provide the specifications below, and then include the file cppad/cppad.hpp.

Numeric Type
The type Base must support all the operations for a NumericType .

Integer
The type Base must support the syntax
     i = CppAD::Integer(x)
which converts x to an int. The argument x has prototype
     const Base& x
and the return value i has prototype
     int i

Suggestion
In many cases, the Base version of the Integer function can be defined by
namespace CppAD {
     inline int Integer(const Base& x)
     {    return static_cast<int>(x); }
}
For example, see float , double , and complex .

epsilon
The template specialization
     Base CppAD::epsilon<Base>()
must return machine epsilon for the type Base . For example, see float , float , and float ,

isnan
If Base defines the isnan function, you may also have to provide a definition in the CppAD namespace (to avoid a function ambiguity). For example, complex isnan .

Contents

base_cond_exp	Base Type Requirements for Conditional Expressions
base_identical	Base Type Requirements for Identically Equal Comparisons
base_ordered	Base Type Requirements for Ordered Comparisons
base_std_math	Base Type Requirements for Standard Math Functions
base_float.hpp	Enable use of AD<Base> where Base is float
base_double.hpp	Enable use of AD<Base> where Base is double
base_complex.hpp	Enable use of AD<Base> where Base is std::complex<double>
base_adolc.hpp	Enable use of AD<Base> where Base is Adolc's adouble Type

---

Input File: cppad/base_require.hpp