Prev

Next

Index-> contents reference index search external

Up-> CppAD AD Convert Integer

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

AD-> Default ad_copy Convert ADValued BoolValued VecAD base_require

Convert-> Value Integer Output PrintFor Var2Par

Integer-> Integer.cpp

Headings-> Syntax Purpose i x ---..Real Types ---..Complex Types ---..AD Types Operation Sequence Example

Convert From AD to Integer
Syntax
i = Integer(x)

Purpose
Converts from an AD type to the corresponding integer value.

i
The result i has prototype
     int i

x

Real Types
If the argument x has either of the following prototypes:
     const float                  &x
     const double                 &x
the fractional part is dropped to form the integer value. For example, if x is 1.5, i is 1. In general, if $\mathit{x}\ge 0$ , i is the greatest integer less than or equal x. If $\mathit{x}\le 0$ , i is the smallest integer greater than or equal x.

Complex Types
If the argument x has either of the following prototypes:
     const std::complex<float>    &x
     const std::complex<double>   &x
The result i is given by
     i = Integer(x.real())

AD Types
If the argument x has either of the following prototypes:
     const AD<Base>               &x
     const VecAD<Base>::reference &x
Base must support the Integer function and the conversion has the same meaning as for Base.

Operation Sequence
The result of this operation is not an AD of Base object. Thus it will not be recorded as part of an AD of Base operation sequence .

Example
The file Integer.cpp contains an example and test of this operation.

---

Input File: cppad/local/integer.hpp