CoDiPack  2.2.0
A Code Differentiation Package
SciComp TU Kaiserslautern
Loading...
Searching...
No Matches
codi::BinaryOperation< T_Real > Struct Template Reference

Interface for implementing the logic for a BinaryExpression. More...

#include <binaryExpression.hpp>

Inheritance diagram for codi::BinaryOperation< T_Real >:

Public Types

using Real = T_Real
 See BinaryOperation.
 

Static Public Member Functions

template<typename ArgA , typename ArgB >
static Real gradientA (ArgA const &argA, ArgB const &argB, Real const &result)
 
template<typename ArgA , typename ArgB >
static Real gradientB (ArgA const &argA, ArgB const &argB, Real const &result)
 
template<typename ArgA , typename ArgB >
static Real primal (ArgA const &argA, ArgB const &argB)
 

Detailed Description

template<typename T_Real>
struct codi::BinaryOperation< T_Real >

Interface for implementing the logic for a BinaryExpression.

See Expression design documentation for details about the expression system in CoDiPack.

Template Parameters
T_RealOriginal primal value of the statement/expression.

Member Function Documentation

◆ gradientA()

template<typename T_Real >
template<typename ArgA , typename ArgB >
static Real codi::BinaryOperation< T_Real >::gradientA ( ArgA const & argA,
ArgB const & argB,
Real const & result )
inlinestatic

Compute the gradient with respect to the first argument

The type of the arguments is the type of the result of a getValue call on the expressions.

◆ gradientB()

template<typename T_Real >
template<typename ArgA , typename ArgB >
static Real codi::BinaryOperation< T_Real >::gradientB ( ArgA const & argA,
ArgB const & argB,
Real const & result )
inlinestatic

Compute the gradient with respect to the second argument

The type of the arguments is the type of the result of a getValue call on the expressions.

◆ primal()

template<typename T_Real >
template<typename ArgA , typename ArgB >
static Real codi::BinaryOperation< T_Real >::primal ( ArgA const & argA,
ArgB const & argB )
inlinestatic

Compute the primal value from the arguments.

The type of the arguments is the result of a getValue call on the expressions.


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