CppADCodeGen 2.4.3
A C++ Algorithmic Differentiation Package with Source Code Generation
|
#include <atomic_fun.hpp>
Public Types | |
using | Super = BaseAbstractAtomicFun< Base > |
using | Arg = Argument< Base > |
Public Member Functions | |
CGAtomicFun (atomic_base< Base > &atomicFun, const CppAD::vector< Base > &xSparsity, bool standAlone=false) | |
CGAtomicFun (atomic_base< Base > &atomicFun, ArrayView< const Base > xSparsity, bool standAlone=false) | |
CGAtomicFun (atomic_base< Base > &atomicFun, ArrayView< const CppAD::AD< Base > > xSparsity, bool standAlone=false) | |
template<class ADVector > | |
void | operator() (const ADVector &ax, ADVector &ay, size_t id=0) |
bool | for_sparse_jac (size_t q, const CppAD::vector< std::set< size_t > > &r, CppAD::vector< std::set< size_t > > &s, const CppAD::vector< CGB > &x) override |
bool | for_sparse_jac (size_t q, const CppAD::vector< std::set< size_t > > &r, CppAD::vector< std::set< size_t > > &s) override |
bool | for_sparse_jac (size_t q, const CppAD::vector< bool > &r, CppAD::vector< bool > &s, const CppAD::vector< CGB > &x) override |
bool | for_sparse_jac (size_t q, const CppAD::vector< bool > &r, CppAD::vector< bool > &s) override |
bool | rev_sparse_jac (size_t q, const CppAD::vector< std::set< size_t > > &rt, CppAD::vector< std::set< size_t > > &st, const CppAD::vector< CGB > &x) override |
bool | rev_sparse_jac (size_t q, const CppAD::vector< std::set< size_t > > &rt, CppAD::vector< std::set< size_t > > &st) override |
bool | rev_sparse_jac (size_t q, const CppAD::vector< bool > &rt, CppAD::vector< bool > &st, const CppAD::vector< CGB > &x) override |
bool | rev_sparse_jac (size_t q, const CppAD::vector< bool > &rt, CppAD::vector< bool > &st) override |
bool | rev_sparse_hes (const CppAD::vector< bool > &vx, const CppAD::vector< bool > &s, CppAD::vector< bool > &t, size_t q, const CppAD::vector< std::set< size_t > > &r, const CppAD::vector< std::set< size_t > > &u, CppAD::vector< std::set< size_t > > &v, const CppAD::vector< CGB > &x) override |
bool | rev_sparse_hes (const CppAD::vector< bool > &vx, const CppAD::vector< bool > &s, CppAD::vector< bool > &t, size_t q, const CppAD::vector< std::set< size_t > > &r, const CppAD::vector< std::set< size_t > > &u, CppAD::vector< std::set< size_t > > &v) override |
bool | rev_sparse_hes (const CppAD::vector< bool > &vx, const CppAD::vector< bool > &s, CppAD::vector< bool > &t, size_t q, const CppAD::vector< bool > &r, const CppAD::vector< bool > &u, CppAD::vector< bool > &v, const CppAD::vector< CGB > &x) override |
bool | rev_sparse_hes (const CppAD::vector< bool > &vx, const CppAD::vector< bool > &s, CppAD::vector< bool > &t, size_t q, const CppAD::vector< bool > &r, const CppAD::vector< bool > &u, CppAD::vector< bool > &v) override |
size_t | getId () const |
bool | isStandAlone () const |
bool | forward (size_t q, size_t p, const CppAD::vector< bool > &vx, CppAD::vector< bool > &vy, const CppAD::vector< CGB > &tx, CppAD::vector< CGB > &ty) override |
bool | reverse (size_t p, const CppAD::vector< CGB > &tx, const CppAD::vector< CGB > &ty, CppAD::vector< CGB > &px, const CppAD::vector< CGB > &py) override |
virtual CppAD::vector< std::set< size_t > > | jacobianForwardSparsitySet (size_t m, const CppAD::vector< CGB > &x) |
virtual CppAD::vector< std::set< size_t > > | jacobianReverseSparsitySet (size_t m, const CppAD::vector< CGB > &x) |
virtual CppAD::vector< std::set< size_t > > | hessianSparsitySet (size_t m, const CppAD::vector< CGB > &x) |
virtual CppAD::vector< std::set< size_t > > | hessianSparsitySet (const CppAD::vector< bool > &s, const CppAD::vector< CGB > &x) |
Static Public Member Functions | |
static size_t | createNewAtomicFunctionID () |
Protected Types | |
using | CGB = CG< Base > |
Protected Member Functions | |
void | zeroOrderDependency (const CppAD::vector< bool > &vx, CppAD::vector< bool > &vy, const CppAD::vector< CGB > &x) override |
bool | atomicForward (size_t q, size_t p, const CppAD::vector< Base > &tx, CppAD::vector< Base > &ty) override |
bool | atomicReverse (size_t p, const CppAD::vector< Base > &tx, const CppAD::vector< Base > &ty, CppAD::vector< Base > &px, const CppAD::vector< Base > &py) override |
Static Protected Member Functions | |
static void | appendAsArguments (typename std::vector< Arg >::iterator begin, const CppAD::vector< CGB > &tx) |
static OperationNode< Base > * | makeArray (CodeHandler< Base > &handler, const CppAD::vector< CGB > &tx) |
static OperationNode< Base > * | makeArray (CodeHandler< Base > &handler, const CppAD::vector< CGB > &tx, size_t p, size_t k) |
static OperationNode< Base > * | makeZeroArray (CodeHandler< Base > &handler, size_t size) |
static OperationNode< Base > * | makeEmptySparseArray (CodeHandler< Base > &handler, size_t size) |
static OperationNode< Base > * | makeSparseArray (CodeHandler< Base > &handler, const CppAD::vector< CGB > &py, size_t p, size_t k) |
static bool | isParameters (const CppAD::vector< CGB > &tx) |
static bool | isValuesDefined (const CppAD::vector< CGB > &tx) |
Protected Attributes | |
atomic_base< Base > & | atomicFun_ |
const CppAD::vector< Base > | xSparsity_ |
const size_t | id_ |
bool | standAlone_ |
An atomic function for source code generation
Definition at line 28 of file atomic_fun.hpp.
|
inherited |
Definition at line 32 of file abstract_atomic_fun.hpp.
|
protected |
Definition at line 30 of file atomic_fun.hpp.
|
inherited |
Definition at line 30 of file abstract_atomic_fun.hpp.
|
inline |
Creates a new atomic function wrapper that is responsible for defining the dependencies to calls of a user atomic function.
atomicFun | The atomic function to the called by the compiled source. |
xSparsity | Default independent vector used to determine sparsity patterns when the provided independent vector using the CG data type does not have all values defined. |
standAlone | Whether or not forward and reverse function calls do not require the Taylor coefficients for the dependent variables (ty) and the previous evaluation of other forward/reverse modes. |
Definition at line 50 of file atomic_fun.hpp.
|
inline |
Definition at line 58 of file atomic_fun.hpp.
|
inline |
Definition at line 64 of file atomic_fun.hpp.
|
inlinestaticprotectedinherited |
Definition at line 58 of file base_abstract_atomic_fun.hpp.
|
inlineoverrideprotectedvirtual |
Used to evaluate function values and forward mode function values and derivatives.
q | Lowest order for this forward mode calculation. |
p | Highest order for this forward mode calculation. |
vx | If size not zero, which components of x are variables |
vy | If size not zero, which components of y are variables |
tx | Taylor coefficients corresponding to x for this calculation |
ty | Taylor coefficient corresponding to y for this calculation |
Implements CppAD::cg::CGAbstractAtomicFun< Base >.
Definition at line 202 of file atomic_fun.hpp.
|
inlineoverrideprotectedvirtual |
Used to evaluate reverse mode function derivatives.
p | Highest order for this forward mode calculation. |
tx | Taylor coefficients corresponding to x for this calculation |
ty | Taylor coefficient corresponding to y for this calculation |
px | Partials w.r.t. the x Taylor coefficients. |
py | Partials w.r.t. the y Taylor coefficients |
Implements CppAD::cg::CGAbstractAtomicFun< Base >.
Definition at line 210 of file atomic_fun.hpp.
|
inlinestaticinherited |
Uses an internal counter to produce IDs for atomic functions.
Definition at line 495 of file abstract_atomic_fun.hpp.
|
inlineoverride |
Definition at line 99 of file atomic_fun.hpp.
|
inlineoverride |
Definition at line 92 of file atomic_fun.hpp.
|
inlineoverride |
Definition at line 86 of file atomic_fun.hpp.
|
inlineoverride |
Definition at line 79 of file atomic_fun.hpp.
|
inlineoverrideinherited |
Use the jacobian sparsity to determine which elements will always be zero
Definition at line 94 of file abstract_atomic_fun.hpp.
|
inlineinherited |
Provides a unique identifier for this atomic function type.
Definition at line 81 of file abstract_atomic_fun.hpp.
|
inlinevirtualinherited |
Determine the sparsity pattern p for Hessian of w^T F
Definition at line 462 of file abstract_atomic_fun.hpp.
|
inlinevirtualinherited |
Definition at line 453 of file abstract_atomic_fun.hpp.
|
inlinestaticprotectedinherited |
Definition at line 131 of file base_abstract_atomic_fun.hpp.
|
inlineinherited |
Whether or not forward and reverse function calls do not require the Taylor coefficients for the dependent variables (ty) and any previous evaluation of other forward/reverse modes.
Definition at line 90 of file abstract_atomic_fun.hpp.
|
inlinestaticprotectedinherited |
Definition at line 140 of file base_abstract_atomic_fun.hpp.
|
inlinevirtualinherited |
Definition at line 419 of file abstract_atomic_fun.hpp.
|
inlinevirtualinherited |
Definition at line 435 of file abstract_atomic_fun.hpp.
|
inlinestaticprotectedinherited |
Definition at line 71 of file base_abstract_atomic_fun.hpp.
|
inlinestaticprotectedinherited |
Definition at line 79 of file base_abstract_atomic_fun.hpp.
|
inlinestaticprotectedinherited |
Definition at line 101 of file base_abstract_atomic_fun.hpp.
|
inlinestaticprotectedinherited |
Definition at line 106 of file base_abstract_atomic_fun.hpp.
|
inlinestaticprotectedinherited |
Definition at line 93 of file base_abstract_atomic_fun.hpp.
|
inline |
Definition at line 73 of file atomic_fun.hpp.
|
inlineoverride |
Definition at line 163 of file atomic_fun.hpp.
|
inlineoverride |
Definition at line 152 of file atomic_fun.hpp.
|
inlineoverride |
Definition at line 142 of file atomic_fun.hpp.
|
inlineoverride |
Definition at line 131 of file atomic_fun.hpp.
|
inlineoverride |
Definition at line 125 of file atomic_fun.hpp.
|
inlineoverride |
Definition at line 118 of file atomic_fun.hpp.
|
inlineoverride |
Definition at line 112 of file atomic_fun.hpp.
|
inlineoverride |
Definition at line 105 of file atomic_fun.hpp.
|
inlineoverrideinherited |
Use the Jacobian sparsity to determine which elements will always be zero
Use the Hessian sparsity to determine which elements will always be zero
Definition at line 233 of file abstract_atomic_fun.hpp.
|
inlineoverrideprotectedvirtual |
Implements CppAD::cg::CGAbstractAtomicFun< Base >.
Definition at line 175 of file atomic_fun.hpp.
|
protected |
Definition at line 32 of file atomic_fun.hpp.
|
protectedinherited |
A unique identifier for this atomic function type
Definition at line 37 of file abstract_atomic_fun.hpp.
Referenced by CppAD::cg::CGAbstractAtomicFun< Base >::forward(), CppAD::cg::CGAbstractAtomicFun< Base >::getId(), and CppAD::cg::CGAbstractAtomicFun< Base >::reverse().
|
protectedinherited |
Whether or not forward and reverse function calls do not require the Taylor coefficients for the dependent variables (ty) and any previous evaluation of other forward/reverse modes.
Definition at line 43 of file abstract_atomic_fun.hpp.
Referenced by CppAD::cg::CGAbstractAtomicFun< Base >::isStandAlone(), and CppAD::cg::CGAbstractAtomicFun< Base >::reverse().
|
protected |
Definition at line 33 of file atomic_fun.hpp.