CppAD: A C++ Algorithmic Differentiation Package  20171217
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
template<class Base >
template<class VectorSet >
VectorSet CppAD::ADFun< Base >::ForSparseJac ( size_t  q,
const VectorSet &  r,
bool  transpose = false,
bool  dependency = false 
)

User API for Jacobian sparsity patterns using forward mode.

The C++ source code corresponding to this operation is 

     s = f.ForSparseJac(q, r, transpose, dependency)
Template Parameters
Baseis the base type for this recording.
VectorSetis a simple vector with elements of type bool or std::set<size_t>.
Parameters
qis the number of columns in the matrix $ R $.
ris a sparsity pattern for the matrix $ R $.
transposeare sparsity patterns for $ R $ and $ S(x) $ transposed.
dependencyAre the derivatives with respect to left and right of the expression below considered to be non-zero:
CondExpRel(left, right, if_true, if_false)
This is used by the optimizer to obtain the correct dependency relations.
Returns
The value of transpose is false (true), the return value is a sparsity pattern for $ S(x) $ ( $ S(x)^T $) where

\[ S(x) = F^{(1)} (x) * R \]

where $ F $ is the function corresponding to the operation sequence and x is any argument value. If VectorSet::value_type is bool, the return value has size $ m * q $ ( $ q * m $). where m is the number of dependent variables corresponding to the operation sequence stored in f. If VectorSet::value_type is std::set<size_t>, the return value has size $ m $ ( $ q $ ) and with all its elements between zero and $ q - 1 $ ( $ m - 1 $).
Side Effects
If VectorSet::value_type is bool, the forward sparsity pattern for all of the variables on the tape is stored in for_jac_sparse_pack__. In this case 
     for_jac_sparse_pack_.n_set() == num_var_tape_
     for_jac_sparse_pack_.end() == q
     for_jac_sparse_set_.n_set()  == 0
     for_jac_sparse_set_.end()  == 0


If VectorSet::value_type is std::set<size_t>, the forward sparsity pattern for all of the variables on the tape is stored in for_jac_sparse_set__. In this case 
     for_jac_sparse_set_.n_set()   == num_var_tape_
     for_jac_sparse_set_.end()   == q
     for_jac_sparse_pack_.n_set()  == 0
     for_jac_sparse_pack_.end()  == 0

Definition at line 560 of file for_sparse_jac.hpp.

Referenced by CppAD::ipopt::solve_callback< Dvector, ADvector, FG_eval >::solve_callback().