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

Low level function entry implementation for external functions. More...

#include <externalFunction.hpp>

Public Types

using ExtFunc = ExternalFunction<Tape>
 
using Identifier = T_Identifier
 See ExternalFunctionLowLevelEntryMapper.
 
using Real = T_Real
 See ExternalFunctionLowLevelEntryMapper.
 
using Tape = T_Tape
 See ExternalFunctionLowLevelEntryMapper.
 
using VectorAccess = VectorAccessInterface<typename Tape::Real, typename Tape::Identifier>
 Shortcut for VectorAccessInterface.
 

Static Public Member Functions

static LowLevelFunctionEntry< Tape, Real, Identifiercreate ()
 Create the function entry for the tape registration.
 
static void del (Tape *tape, ByteDataView &data)
 Recovers the external function data and calls deleteData on it.
 
static void forward (Tape *tape, ByteDataView &data, VectorAccess *access)
 Recovers the external function data and calls evaluateForward on it.
 
static void primal (Tape *tape, ByteDataView &data, VectorAccess *access)
 Recovers the external function data and calls evaluatePrimal on it.
 
static void reverse (Tape *tape, ByteDataView &data, VectorAccess *access)
 Recovers the external function data and calls evaluateReverse on it.
 
static void store (Tape &tape, Config::LowLevelFunctionToken token, ExtFunc const &extFunc)
 Store an external function on the tape.
 

Detailed Description

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

Low level function entry implementation for external functions.

Stores the ExternalFunction object in the byte data stream.

Template Parameters
T_TapeThe associated tape type.
T_GradientThe gradient type of a tape, usually chosen as ActiveType::Gradient.
T_IdentifierThe adjoint/tangent identification of a tape, usually chosen as ActiveType::Identifier.

Member Typedef Documentation

◆ ExtFunc

template<typename T_Tape , typename T_Real , typename T_Identifier >
using codi::ExternalFunctionLowLevelEntryMapper< T_Tape, T_Real, T_Identifier >::ExtFunc = ExternalFunction<Tape>

Abbreviation for ExternalFunction.


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