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

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

Public Types
using	Super = BaseAbstractAtomicFun< Base >

using	CGB = CppAD::cg::CG< Base >

using	Arg = Argument< Base >

Public Member Functions
template<class ADVector >
void	operator() (const ADVector &ax, ADVector &ay, size_t id=0)

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 Member Functions
	CGAbstractAtomicFun (const std::string &name, bool standAlone=false)

virtual void	zeroOrderDependency (const CppAD::vector< bool > &vx, CppAD::vector< bool > &vy, const CppAD::vector< CGB > &x)=0

virtual bool	atomicForward (size_t q, size_t p, const CppAD::vector< Base > &tx, CppAD::vector< Base > &ty)=0

virtual bool	atomicReverse (size_t p, const CppAD::vector< Base > &tx, const CppAD::vector< Base > &ty, CppAD::vector< Base > &px, const CppAD::vector< Base > &py)=0

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
const size_t	id_

bool	standAlone_

Detailed Description

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

An atomic function for source code generation

Author: Joao Leal

Definition at line 28 of file abstract_atomic_fun.hpp.

Constructor & Destructor Documentation

◆ CGAbstractAtomicFun()

template<class Base>

CppAD::cg::CGAbstractAtomicFun< Base >::CGAbstractAtomicFun	(	const std::string &	name,
		bool	standAlone = `false`
	)

inlineexplicitprotected

Creates a new atomic function that is responsible for defining the dependencies to calls of a user atomic function.

Parameters

name	The atomic function name.
standAlone	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 57 of file abstract_atomic_fun.hpp.

Member Function Documentation

◆ atomicForward()

template<class Base>

virtual bool CppAD::cg::CGAbstractAtomicFun< Base >::atomicForward	(	size_t	q,
		size_t	p,
		const CppAD::vector< Base > &	tx,
		CppAD::vector< Base > &	ty
	)

protectedpure virtual

Used to evaluate function values and forward mode function values and derivatives.

Parameters

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

Returns: true on success, false otherwise

Implemented in CppAD::cg::CGAtomicFunBridge< Base >, and CppAD::cg::CGAtomicFun< Base >.

Referenced by CppAD::cg::CGAbstractAtomicFun< ScalarOut >::createNewAtomicFunctionID().

◆ atomicReverse()

template<class Base>

virtual bool CppAD::cg::CGAbstractAtomicFun< Base >::atomicReverse	(	size_t	p,
		const CppAD::vector< Base > &	tx,
		const CppAD::vector< Base > &	ty,
		CppAD::vector< Base > &	px,
		const CppAD::vector< Base > &	py
	)

protectedpure virtual

Used to evaluate reverse mode function derivatives.

Parameters

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

Returns: true on success, false otherwise

Implemented in CppAD::cg::CGAtomicFunBridge< Base >, and CppAD::cg::CGAtomicFun< Base >.

Referenced by CppAD::cg::CGAbstractAtomicFun< ScalarOut >::createNewAtomicFunctionID().

◆ createNewAtomicFunctionID()

template<class Base>

static size_t CppAD::cg::CGAbstractAtomicFun< Base >::createNewAtomicFunctionID ( )

inlinestatic

Uses an internal counter to produce IDs for atomic functions.

Definition at line 495 of file abstract_atomic_fun.hpp.

◆ forward()

template<class Base>

bool CppAD::cg::CGAbstractAtomicFun< Base >::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
	)

inlineoverride

Use the jacobian sparsity to determine which elements will always be zero

Definition at line 94 of file abstract_atomic_fun.hpp.

◆ getId()

template<class Base>

size_t CppAD::cg::CGAbstractAtomicFun< Base >::getId ( ) const

inline

Provides a unique identifier for this atomic function type.

Returns: a unique identifier ID

Definition at line 81 of file abstract_atomic_fun.hpp.

◆ hessianSparsitySet()

template<class Base>

virtual CppAD::vector<std::set<size_t> > CppAD::cg::CGAbstractAtomicFun< Base >::hessianSparsitySet	(	const CppAD::vector< bool > &	s,
		const CppAD::vector< CGB > &	x
	)

inlinevirtual

Determine the sparsity pattern p for Hessian of w^T F

Definition at line 462 of file abstract_atomic_fun.hpp.

◆ isStandAlone()

template<class Base>

bool CppAD::cg::CGAbstractAtomicFun< Base >::isStandAlone ( ) const

inline

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.

◆ reverse()

template<class Base>

bool CppAD::cg::CGAbstractAtomicFun< Base >::reverse	(	size_t	p,
		const CppAD::vector< CGB > &	tx,
		const CppAD::vector< CGB > &	ty,
		CppAD::vector< CGB > &	px,
		const CppAD::vector< CGB > &	py
	)

inlineoverride

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.

Member Data Documentation

◆ id_

template<class Base>

const size_t CppAD::cg::CGAbstractAtomicFun< Base >::id_

protected

A unique identifier for this atomic function type

Definition at line 37 of file abstract_atomic_fun.hpp.

Referenced by CppAD::cg::CGAbstractAtomicFun< ScalarOut >::getId().

◆ standAlone_

template<class Base>

bool CppAD::cg::CGAbstractAtomicFun< Base >::standAlone_

protected

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< ScalarOut >::isStandAlone().

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

include/cppad/cg/abstract_atomic_fun.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

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

Constructor & Destructor Documentation

◆ CGAbstractAtomicFun()

Member Function Documentation

◆ atomicForward()

◆ atomicReverse()

◆ createNewAtomicFunctionID()

◆ forward()

◆ getId()

◆ hessianSparsitySet()

◆ isStandAlone()

◆ reverse()

Member Data Documentation

◆ id_

◆ standAlone_

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