entire_call.hpp

Go to the documentation of this file.

# ifndef CPPAD_LOCAL_SUBGRAPH_ENTIRE_CALL_HPP
# define CPPAD_LOCAL_SUBGRAPH_ENTIRE_CALL_HPP
/* --------------------------------------------------------------------------
CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-17 Bradley M. Bell

CppAD is distributed under multiple licenses. This distribution is under
the terms of the
                    Eclipse Public License Version 1.0.

A copy of this license is included in the COPYING file of this distribution.
Please visit http://www.coin-or.org/CppAD/ for information on other licenses.
-------------------------------------------------------------------------- */

# include <cppad/local/pod_vector.hpp>

// BEGIN_CPPAD_LOCAL_SUBGRAPH_NAMESPACE
namespace CppAD { namespace local { namespace subgraph {
/*!
\file entire_call.hpp
include entire function call in a subgraph
*/
// ===========================================================================
/*!
Convert from just firt UserOp to entire atomic function call in a subgraph.

\tparam Base
this operation sequence was recording using AD<Base>.

\param play
is the operation sequence corresponding to the ADFun<Base> function.

\param subgraph
It a set of operator indices in this recording.
If the corresponding operator is a UserOp, it assumed to be the
first one in the corresponding atomic function call.
The other call operators are included in the subgraph.
*/
template <typename Base>
void entire_call(
     const player<Base>*       play         ,
     pod_vector<addr_t>&       subgraph     )
{
     // add extra operators corresponding to rest of atomic function calls
     size_t n_sub = subgraph.size();
     for(size_t k = 0; k < n_sub; ++k)
     {    size_t i_op = subgraph[k];
          //
          if( play->GetOp(i_op) == UserOp )
          {    // This is the first UserOp of this atomic function call
               while( play->GetOp(++i_op) != UserOp )
               {    switch(play->GetOp(i_op))
                    {
                         case UsravOp:
                         case UsrrvOp:
                         case UsrrpOp:
                         case UsrapOp:
                         subgraph.push_back( addr_t(i_op) );
                         break;

                         default:
                         // cannot find second UserOp in this call
                         CPPAD_ASSERT_UNKNOWN(false);
                         break;
                    }
               }
               // THis is the second UserOp of this atomic function call
               subgraph.push_back( addr_t(i_op) );
          }
     }

}

} } } // END_CPPAD_LOCAL_SUBGRAPH_NAMESPACE

# endif