Prev

Next

Index-> contents reference index search external

Up-> CppAD ADFun Independent

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

ADFun-> Independent FunConstruct Dependent abort_recording seq_property FunEval Drivers FunCheck optimize

Independent-> Independent.cpp

Headings-> Syntax Purpose Start Recording Stop Recording x VectorAD Parallel Mode Example

Declare Independent Variables and Start Recording
Syntax
Independent(x)

Purpose
Start recording AD of Base operations with x as the independent variable vector. Once the operation sequence is completed, it must be transferred to a function object; see below.

Start Recording
An operation sequence recording is started by the command
     Independent(x)

Stop Recording
The recording is stopped, and the operation sequence is transferred to the AD function object f , using either the function constructor
     ADFun<Base> f( x, y)
or the dependent variable specifier
     f.Dependent( x, y)
The only other way to stop a recording is using abort_recording . Between when the recording is started and when it stopped, we refer to the elements of x , and the values that depend on the elements of x , as AD<Base> variables.

x
The vector x has prototype
     VectorAD &x
(see VectorAD below). The size of the vector x , must be greater than zero, and is the number of independent variables for this AD operation sequence.

VectorAD
The type VectorAD must be a SimpleVector class with elements of type AD<Base> . The routine CheckSimpleVector will generate an error message if this is not the case.

Parallel Mode
The call to Independent, and the corresponding call to
     ADFun<Base> f( x, y)
or
     f.Dependent( x, y)
or abort_recording , must be preformed by the same thread; i.e., thread_alloc::thread_num must be the same.

Example
The file Independent.cpp contains an example and test of this operation. It returns true if it succeeds and false otherwise.

---

Input File: cppad/local/independent.hpp