CppADCodeGen  HEAD
A C++ Algorithmic Differentiation Package with Source Code Generation
CppAD::cg::GenericModelExternalFunctionWrapper< Base > Class Template Reference
Inheritance diagram for CppAD::cg::GenericModelExternalFunctionWrapper< Base >:
Inheritance graph
Collaboration diagram for CppAD::cg::GenericModelExternalFunctionWrapper< Base >:
Collaboration graph

Public Member Functions

 GenericModelExternalFunctionWrapper (GenericModel< Base > &model)
 
virtual bool forward (FunctorGenericModel< Base > &libModel, int q, int p, const Array tx[], Array &ty)
 
virtual bool reverse (FunctorGenericModel< Base > &libModel, int p, const Array tx[], Array &px, const Array py[])
 

Detailed Description

template<class Base>
class CppAD::cg::GenericModelExternalFunctionWrapper< Base >

Definition at line 22 of file generic_model_external_function_wrapper.hpp.

Member Function Documentation

◆ forward()

template<class Base >
virtual bool CppAD::cg::GenericModelExternalFunctionWrapper< Base >::forward ( FunctorGenericModel< Base > &  libModel,
int  q,
int  p,
const Array  tx[],
Array ty 
)
inlinevirtual

Computes results during a forward mode sweep, the Taylor coefficients for dependent variables relative to independent variables.

Parameters
libModelThe model calling where this is being called from.
qLowest order for this forward mode calculation.
pHighest order for this forward mode calculation.
txIndependent variable Taylor coefficients.
tyDependent variable Taylor coefficients.
Returns
true if evaluation succeeded, false otherwise.

Implements CppAD::cg::ExternalFunctionWrapper< Base >.

Definition at line 34 of file generic_model_external_function_wrapper.hpp.

◆ reverse()

template<class Base >
virtual bool CppAD::cg::GenericModelExternalFunctionWrapper< Base >::reverse ( FunctorGenericModel< Base > &  libModel,
int  p,
const Array  tx[],
Array px,
const Array  py[] 
)
inlinevirtual

Computes results during a reverse mode sweep, the adjoints or partial derivatives of independent variables.

Parameters
libModelThe model calling where this is being called from.
pOrder for this reverse mode calculation.
txIndependent variable Taylor coefficients.
pxIndependent variable partial derivatives.
pyDependent variable partial derivatives.
Returns
true if evaluation succeeded, false otherwise.

Implements CppAD::cg::ExternalFunctionWrapper< Base >.

Definition at line 63 of file generic_model_external_function_wrapper.hpp.


The documentation for this class was generated from the following file: