Prev Next ForSparseJac.cpp Headings

Forward Mode Jacobian Sparsity: Example and Test


# include <cppad/cppad.hpp>
namespace { // -------------------------------------------------------------
// define the template function ForSparseJacCases<Vector> in empty namespace
template <typename Vector> 
bool ForSparseJacCases(void)
{    bool ok = true;
     using CppAD::AD;

     // domain space vector
     size_t n = 2; 
     CPPAD_TEST_VECTOR< AD<double> > X(n);
     X[0] = 0.; 
     X[1] = 1.;

     // declare independent variables and start recording
     CppAD::Independent(X);

     // range space vector
     size_t m = 3;
     CPPAD_TEST_VECTOR< AD<double> > Y(m);
     Y[0] = X[0];
     Y[1] = X[0] * X[1];
     Y[2] = X[1];

     // create f: X -> Y and stop tape recording
     CppAD::ADFun<double> f(X, Y);

     // sparsity pattern for the identity matrix
     Vector r(n * n);
     size_t i, j;
     for(i = 0; i < n; i++)
     {    for(j = 0; j < n; j++)
               r[ i * n + j ] = false;
          r[ i * n + i ] = true;
     }

     // sparsity pattern for F'(x)
     Vector s(m * n);
     s = f.ForSparseJac(n, r);

     // check values
     ok &= (s[ 0 * n + 0 ] == true);  // Y[0] does     depend on X[0]
     ok &= (s[ 0 * n + 1 ] == false); // Y[0] does not depend on X[1]
     ok &= (s[ 1 * n + 0 ] == true);  // Y[1] does     depend on X[0]
     ok &= (s[ 1 * n + 1 ] == true);  // Y[1] does     depend on X[1]
     ok &= (s[ 2 * n + 0 ] == false); // Y[2] does not depend on X[0]
     ok &= (s[ 2 * n + 1 ] == true);  // Y[2] does     depend on X[1]

     return ok;
}
} // End empty namespace
# include <vector>
# include <valarray>
bool ForSparseJac(void)
{    bool ok = true;
     // Run with Vector equal to four different cases
     // all of which are Simple Vectors with elements of type bool.
     ok &= ForSparseJacCases< CppAD::vectorBool     >();
     ok &= ForSparseJacCases< CppAD::vector  <bool> >();
     ok &= ForSparseJacCases< std::vector    <bool> >(); 
     ok &= ForSparseJacCases< std::valarray  <bool> >(); 

     return ok;
}


Input File: example/for_sparse_jac.cpp