CppAD: A C++ Algorithmic Differentiation Package  20130102
template<class Base >
void optimize_prototype ( const CppAD::vector< struct optimize_old_variable > &  tape,
size_t  current,
size_t  npar,
const Base *  par 
)

Documents arguments that are common to optimization helper functions (should not be called).

Parameters:
tapeis a vector that maps a variable index, in the old operation sequence, to an optimize_old_variable information record. Note that the index for this vector must be greater than or equal zero and less than tape.size().
  • tape[i].op is the operator in the old operation sequence corresponding to the old variable index i. Assertion: NumRes(tape[i].op) > 0.
  • tape[i].arg for j < NumArg( tape[i].op ), tape[i].arg[j] is the j-th the argument, in the old operation sequence, corresponding to the old variable index i. Assertion: tape[i].arg[j] < i.
  • tape[i].new_var Suppose i <= current, j < NumArg( tape[i].op ), and k = tape[i].arg[j], and j corresponds to a varialbe for operator tape[i].op. It follows that tape[k].new_var has alread been set to the variable in the new operation sequence corresponding to the old variable index k. This means that the new_var value has been set for all the possible arguments that come before current.
Parameters:
currentis the index in the old operation sequence for the variable corresponding to the result for the current operator. Assertions: current < tape.size(), NumRes( tape[current].op ) > 0.
nparis the number of paraemters corresponding to this operation sequence.
paris a vector of length npar containing the parameters for this operation sequence; i.e., given a parameter index i, the corresponding parameter value is par[i].

Definition at line 253 of file optimize.hpp.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines