Prev Next Index-> contents reference index search external Up-> CppAD ADFun drivers RevOne CppAD-> Install Introduction AD ADFun preprocessor multi_thread utility ipopt_solve Example speed Appendix ADFun-> record_adfun drivers Forward Reverse sparsity_pattern sparse_derivative optimize abs_normal FunCheck check_for_nan drivers-> Jacobian Hessian ForOne RevOne ForTwo RevTwo RevOne-> rev_one.cpp Headings-> Syntax Purpose f x i dw Vector RevOne Uses Forward Example

First Order Derivative: Driver Routine

Syntax
dw = f.RevOne(x, i)

Purpose
We use $F : B^n \rightarrow B^m$ to denote the AD function corresponding to f . The syntax above sets dw to the derivative of $F_i$ with respect to $x$; i.e., $$dw = F_i^{(1)} (x) = \left[ \D{ F_i }{ x_0 } (x) , \cdots , \D{ F_i }{ x_{n-1} } (x) \right]$$

f
The object f has prototype       ADFun<Base> f  Note that the ADFun object f is not const (see RevOne Uses Forward below).

x
The argument x has prototype       const Vector &x  (see Vector below) and its size must be equal to n , the dimension of the domain space for f . It specifies that point at which to evaluate the derivative.

i
The index i has prototype       size_t i  and is less than $m$, the dimension of the range space for f . It specifies the component of $F$ that we are computing the derivative of.

dw
The result dw has prototype       Vector dw  (see Vector below) and its size is n , the dimension of the domain space for f . The value of dw is the derivative of $F_i$ evaluated at x ; i.e., for $j = 0 , \ldots , n - 1$ $$. dw[ j ] = \D{ F_i }{ x_j } ( x )$$

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

RevOne Uses Forward
After each call to Forward , the object f contains the corresponding Taylor coefficients . After a call to RevOne, the zero order Taylor coefficients correspond to f.Forward(0, x) and the other coefficients are unspecified.

Example
The routine RevOne is both an example and test. It returns true, if it succeeds and false otherwise.