# Changeset 2920

Ignore:
Timestamp:
Oct 11, 2013 8:40:52 AM (6 years ago)
Message:

cond_op.hpp: Change 'Common documentation' to 'Shared documentation'
load_op.hpp: Change 'Common documentation' to 'Shared documentation'
optimize.hpp: FIx copydetails.

Location:
trunk/cppad/local
Files:
3 edited

Unmodified
Added
Removed
• ## trunk/cppad/local/cond_op.hpp

 r2918 /*! Common documentation for conditional expressions forward and reverse mode. Shared documentation for conditional expressions (not called). /*! Common documentation for conditional expression sparse operations. Shared documentation for conditional expression sparse operations (not called).
• ## trunk/cppad/local/load_op.hpp

 r2919 /*! Prototype for zero order forward mode implementation of op = LdpOp or LdvOp. Shared documentation for zero order forward mode implementation of op = LdpOp or LdvOp (not called). The C++ source code corresponding to this operation is } /*! Prototype sparsity operations corresponding to op = LdpOp or LdvOp. Shared documentation for sparsity operations corresponding to op = LdpOp or LdvOp (not called).
• ## trunk/cppad/local/optimize.hpp

 r2910 /*! Documents arguments that are common to optimization helper functions (should not be called). Shared documentation for optimization helper functions (not called). \param tape is a vector that maps a variable index, in the old operation sequence, given a parameter index \c i, the corresponding parameter value is par[i]. */ template can be used inplace of the result for current operator. \copydetails optimize_prototype \param tape is 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(). \li tape[i].op is the operator in the old operation sequence corresponding to the old variable index \c i. Assertion: NumRes(tape[i].op) > 0. \li 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 \c i. Assertion: tape[i].arg[j] < i. \li tape[i].new_var Suppose i <= current, j < NumArg( tape[i].op ), and k = tape[i].arg[j], and \c j corresponds to a variable 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 \c k. This means that the \c new_var value has been set for all the possible arguments that come before \a current. \param current is 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. \param npar is the number of parameters corresponding to this operation sequence. \param par is a vector of length \a npar containing the parameters for this operation sequence; i.e., given a parameter index \c i, the corresponding parameter value is par[i]. \param hash_table_var Check a binary operator for a complete match with a previous operator, \copydetails optimize_unary_match \param tape is 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(). \li tape[i].op is the operator in the old operation sequence corresponding to the old variable index \c i. Assertion: NumRes(tape[i].op) > 0. \li 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 \c i. Assertion: tape[i].arg[j] < i. \li tape[i].new_var Suppose i <= current, j < NumArg( tape[i].op ), and k = tape[i].arg[j], and \c j corresponds to a variable 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 \c k. This means that the \c new_var value has been set for all the possible arguments that come before \a current. \param current is 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. \param npar is the number of parameters corresponding to this operation sequence. \param par is a vector of length \a npar containing the parameters for this operation sequence; i.e., given a parameter index \c i, the corresponding parameter value is par[i]. \param hash_table_var is a vector with size CPPAD_HASH_TABLE_SIZE that maps a hash code to the corresponding variable index in the old operation sequence. All the values in this table must be less than \a current. \param code The input value of code does not matter. The output value of code is the hash code corresponding to this operation in the new operation sequence. \return If the return value is zero, no match was found. If the return value is greater than zero, it is the index of a new variable that can be used to replace the old variable. \par Restrictions: The binary operator must be an addition, subtraction, multiplication, division or power operator. or power operator.  NumArg( tape[current].op ) == 1. */ template Record an operation of the form (parameter op variable). \copydetails optimize_prototype \param tape is 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(). \li tape[i].op is the operator in the old operation sequence corresponding to the old variable index \c i. Assertion: NumRes(tape[i].op) > 0. \li 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 \c i. Assertion: tape[i].arg[j] < i. \li tape[i].new_var Suppose i <= current, j < NumArg( tape[i].op ), and k = tape[i].arg[j], and \c j corresponds to a variable 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 \c k. This means that the \c new_var value has been set for all the possible arguments that come before \a current. \param current is 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. \param npar is the number of parameters corresponding to this operation sequence. \param par is a vector of length \a npar containing the parameters for this operation sequence; i.e., given a parameter index \c i, the corresponding parameter value is par[i]. \param rec Record an operation of the form (variable op parameter). \copydetails optimize_prototype \param tape is 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(). \li tape[i].op is the operator in the old operation sequence corresponding to the old variable index \c i. Assertion: NumRes(tape[i].op) > 0. \li 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 \c i. Assertion: tape[i].arg[j] < i. \li tape[i].new_var Suppose i <= current, j < NumArg( tape[i].op ), and k = tape[i].arg[j], and \c j corresponds to a variable 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 \c k. This means that the \c new_var value has been set for all the possible arguments that come before \a current. \param current is 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. \param npar is the number of parameters corresponding to this operation sequence. \param par is a vector of length \a npar containing the parameters for this operation sequence; i.e., given a parameter index \c i, the corresponding parameter value is par[i]. \param rec Record an operation of the form (variable op variable). \copydetails optimize_prototype \param tape is 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(). \li tape[i].op is the operator in the old operation sequence corresponding to the old variable index \c i. Assertion: NumRes(tape[i].op) > 0. \li 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 \c i. Assertion: tape[i].arg[j] < i. \li tape[i].new_var Suppose i <= current, j < NumArg( tape[i].op ), and k = tape[i].arg[j], and \c j corresponds to a variable 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 \c k. This means that the \c new_var value has been set for all the possible arguments that come before \a current. \param current is 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. \param npar is the number of parameters corresponding to this operation sequence. \param par is a vector of length \a npar containing the parameters for this operation sequence; i.e., given a parameter index \c i, the corresponding parameter value is par[i]. \param rec Recording a cummulative cummulative summation starting at its highest parrent. \copydetails optimize_prototype \param tape is 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(). \li tape[i].op is the operator in the old operation sequence corresponding to the old variable index \c i. Assertion: NumRes(tape[i].op) > 0. \li 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 \c i. Assertion: tape[i].arg[j] < i. \li tape[i].new_var Suppose i <= current, j < NumArg( tape[i].op ), and k = tape[i].arg[j], and \c j corresponds to a variable 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 \c k. This means that the \c new_var value has been set for all the possible arguments that come before \a current. \param current is 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. \param npar is the number of parameters corresponding to this operation sequence. \param par is a vector of length \a npar containing the parameters for this operation sequence; i.e., given a parameter index \c i, the corresponding parameter value is par[i]. \param rec
Note: See TracChangeset for help on using the changeset viewer.