Implements BinaryOperation for functions where the gradients can be computed and transposed. More...

#include <computeExpression.hpp>

Inheritance diagram for codi::BinaryJacobianOperation< T_Real, T_Impl >:

[legend]

Public Types
using	Impl = T_Impl
	See BinaryJacobianOperation.

using	Real = T_Real
	See BinaryJacobianOperation.

Public Types inherited from codi::BinaryOperation< T_Real, T_Impl >
using	Impl = T_Impl
	See BinaryOperation.

using	Real = T_Real
	See BinaryOperation.

Public Types inherited from codi::ComputeOperation< T_Real >
using	Real = T_Real
	See ComputeOperation.

Static Public Member Functions
template<typename Adjoint, typename ArgA, typename ArgB>
static inlineArgA	applyAdjointArgA (Adjoint const &adjoint, Real const &result, ArgA const &argA, ArgB const &argB)

template<typename Adjoint, typename ArgA, typename ArgB>
static inlineArgB	applyAdjointArgB (Adjoint const &adjoint, Real const &result, ArgA const &argA, ArgB const &argB)

template<typename Tangent, typename ArgA, typename ArgB>
static inlineauto	applyTangentArgA (Tangent const &tangent, Real const &result, ArgA const &argA, ArgB const &argB)

template<typename Tangent, typename ArgA, typename ArgB>
static inlineauto	applyTangentArgB (Tangent const &tangent, Real const &result, ArgA const &argA, ArgB const &argB)

template<typename ArgA, typename ArgB>
static inlineauto	gradientA (ArgA const &argA, ArgB const &argB, Real const &result)
	Compute $\frac{\d f}{\d a}$ .

template<typename ArgA, typename ArgB>
static inlineauto	gradientB (ArgA const &argA, ArgB const &argB, Real const &result)
	Compute $\frac{\d f}{\d b}$ .

template<typename ArgA, typename ArgB>
static inlineReal	primal (ArgA const &argA, ArgB const &argB)

Static Public Member Functions inherited from codi::BinaryOperation< T_Real, T_Impl >
template<size_t argNumber, typename Adjoint, typename ArgA, typename ArgB>
static inlineauto	applyAdjoint (Adjoint const &adjoint, Real const &result, ArgA const &argA, ArgB const &argB)

template<typename Adjoint, typename ArgA, typename ArgB>
static inlineauto	applyAdjointArgA (Adjoint const &adjoint, Real const &result, ArgA const &argA, ArgB const &argB)

template<typename Adjoint, typename ArgA, typename ArgB>
static inlineauto	applyAdjointArgB (Adjoint const &adjoint, Real const &result, ArgA const &argA, ArgB const &argB)

template<size_t argNumber, typename Tangent, typename ArgA, typename ArgB>
static inlineauto	applyTangent (Tangent const &tangent, Real const &result, ArgA const &argA, ArgB const &argB)

template<typename Tangent, typename ArgA, typename ArgB>
static inlineauto	applyTangentArgA (Tangent const &tangent, Real const &result, ArgA const &argA, ArgB const &argB)

template<typename Tangent, typename ArgA, typename ArgB>
static inlineauto	applyTangentArgB (Tangent const &tangent, Real const &result, ArgA const &argA, ArgB const &argB)

template<typename ArgA, typename ArgB>
static inlineReal	primal (ArgA const &argA, ArgB const &argB)

Static Public Member Functions inherited from codi::ComputeOperation< T_Real >
template<size_t argNumber, typename Adjoint, typename... Args>
static inlineauto	applyAdjoint (Adjoint const &adjoint, Real const &result, Args const &... args)

template<size_t argNumber, typename Tangent, typename... Args>
static inlineauto	applyTangent (Tangent const &tangent, Real const &result, Args const &... args)

static inlinestd::string	getMathRep ()
	Get the math symbol of the operation. E.g. `+` for operators and `pow()` for functions.

template<typename... Args>
static inlineReal	primal (Args const &... args)

Detailed Description

template<typename T_Real, typename T_Impl>
struct codi::BinaryJacobianOperation< T_Real, T_Impl >

Implements BinaryOperation for functions where the gradients can be computed and transposed.

Implementations need to define primal, gradientA and gradientB.

See BinaryOperation for details.

Template Parameters

T_Real	Original primal value of the statement/expression.
T_Impl	Final implementation of the operation.

Member Function Documentation

◆ applyAdjointArgA()

template<typename T_Real, typename T_Impl>

template<typename Adjoint, typename ArgA, typename ArgB>

static inlineArgA codi::BinaryJacobianOperation< T_Real, T_Impl >::applyAdjointArgA	(	Adjoint const &	adjoint,
		Real const &	result,
		ArgA const &	argA,
		ArgB const &	argB )

inlinestatic

Apply the reverse AD mode with respect to argument a on the adjoint and return the result. Computes $\bar a = \frac{\d f}{\d a}^T \bar w$

Calls gradientB, transposes the result and multiplies with adjoint.

◆ applyAdjointArgB()

template<typename T_Real, typename T_Impl>

template<typename Adjoint, typename ArgA, typename ArgB>

static inlineArgB codi::BinaryJacobianOperation< T_Real, T_Impl >::applyAdjointArgB	(	Adjoint const &	adjoint,
		Real const &	result,
		ArgA const &	argA,
		ArgB const &	argB )

inlinestatic

Apply the reverse AD mode with respect to argument b on the adjoint and return the result. Computes $\bar b = \frac{\d f}{\d b}^T \bar w$

Calls gradientB, transposes the result and multiplies with adjoint.

◆ applyTangentArgA()

template<typename T_Real, typename T_Impl>

template<typename Tangent, typename ArgA, typename ArgB>

static inlineauto codi::BinaryJacobianOperation< T_Real, T_Impl >::applyTangentArgA	(	Tangent const &	tangent,
		Real const &	result,
		ArgA const &	argA,
		ArgB const &	argB )

inlinestatic

Apply the forward AD mode with respect to argument a on the tangent and return the result. Computes $\dot w = \frac{\d f}{\d a} \dot a$

Calls gradientA and multiplies with tangent.

◆ applyTangentArgB()

template<typename T_Real, typename T_Impl>

template<typename Tangent, typename ArgA, typename ArgB>

static inlineauto codi::BinaryJacobianOperation< T_Real, T_Impl >::applyTangentArgB	(	Tangent const &	tangent,
		Real const &	result,
		ArgA const &	argA,
		ArgB const &	argB )