CppAD::cg::ExternalFunctionWrapper< Base > Class Template Reference

Inheritance diagram for CppAD::cg::ExternalFunctionWrapper< Base >:

Collaboration diagram for CppAD::cg::ExternalFunctionWrapper< Base >:

Public Member Functions
virtual bool	forward (FunctorGenericModel< Base > &libModel, int q, int p, const Array tx[], Array &ty)=0
virtual bool	reverse (FunctorGenericModel< Base > &libModel, int p, const Array tx[], Array &px, const Array py[])=0

Detailed Description

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

Definition at line 22 of file external_function_wrapper.hpp.

Member Function Documentation

forward()

template<class Base >

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

pure virtual

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

Parameters

libModel	The model calling where this is being called from.
q	Lowest order for this forward mode calculation.
p	Highest order for this forward mode calculation.
tx	Independent variable Taylor coefficients.
ty	Dependent variable Taylor coefficients.

Returns

true if evaluation succeeded, false otherwise.

Implemented in CppAD::cg::AtomicExternalFunctionWrapper< Base >, and CppAD::cg::GenericModelExternalFunctionWrapper< Base >.

reverse()

template<class Base >

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

pure virtual

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

Parameters

libModel	The model calling where this is being called from.
p	Order for this reverse mode calculation.
tx	Independent variable Taylor coefficients.
px	Independent variable partial derivatives.
py	Dependent variable partial derivatives.

Returns

true if evaluation succeeded, false otherwise.

Implemented in CppAD::cg::GenericModelExternalFunctionWrapper< Base >, and CppAD::cg::AtomicExternalFunctionWrapper< Base >.

---

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

• include/cppad/cg/model/external_function_wrapper.hpp