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

Low level function entry on the tape. See LowLevelFunctionTapeInterface for details. More...

#include <lowLevelFunctionEntry.hpp>

Public Types

using FuncDel = void (*)(Tape* tape, ByteDataView& data)
 Call syntax for Delete calls.
 
using FuncEval = void (*)(Tape* tape, ByteDataView& data, VectorAccessInterface<Real, Identifier>* access)
 Call syntax for Forward, Reverse, and Primal calls.
 
using Identifier = T_Identifier
 See LowLevelFunctionEntry.
 
using Real = T_Real
 See LowLevelFunctionEntry.
 
using Tape = T_Tape
 See LowLevelFunctionEntry.
 

Public Member Functions

template<LowLevelFunctionEntryCallKind callType, typename... Args>
void call (Args &&... args) const
 Call the function corresponding to callType with the given arguments.
 
template<LowLevelFunctionEntryCallKind callType, typename... Args>
bool has (Args &&... args) const
 Check if a function is provided for the callType.
 
 LowLevelFunctionEntry (FuncEval reverse=nullptr, FuncEval forward=nullptr, FuncEval primal=nullptr, FuncDel del=nullptr)
 Constructors.
 

Detailed Description

template<typename T_Tape, typename T_Real, typename T_Identifier>
struct codi::LowLevelFunctionEntry< T_Tape, T_Real, T_Identifier >

Low level function entry on the tape. See LowLevelFunctionTapeInterface for details.

Template Parameters
T_TapeThe tape on which the entry is registered.
T_RealThe computation type of a tape, usually chosen as ActiveType::Real.
T_IdentifierThe adjoint/tangent identification type of a tape, usually chosen as ActiveType::Identifier.

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