CoDiPack  2.2.0
A Code Differentiation Package
 SciComp TU Kaiserslautern
Loading...
Searching...
No Matches
Public Types | Static Public Member Functions | List of all members
codi::OperationMin< T_Real > Struct Template Reference

BinaryOperation implementation for min. More...

#include <binaryOperators.hpp>

Inheritance diagram for codi::OperationMin< T_Real >:
Inheritance graph
[legend]

Public Types

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

Static Public Member Functions

template<typename ArgA , typename ArgB >
static RealTraits::PassiveReal< Real > gradientA (ArgA const &argA, ArgB const &argB, Real const &result)
 
template<typename ArgA , typename ArgB >
static RealTraits::PassiveReal< 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)
 
- Static Public Member Functions inherited from codi::BinaryOperation< T_Real >
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::OperationMin< T_Real >

BinaryOperation implementation for min.

Member Function Documentation

◆ gradientA()

template<typename T_Real >
template<typename ArgA , typename ArgB >
static RealTraits::PassiveReal< Real > codi::OperationMin< 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 RealTraits::PassiveReal< Real > codi::OperationMin< 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::OperationMin< 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: