CoDiPack  2.2.0
A Code Differentiation Package
SciComp TU Kaiserslautern
Loading...
Searching...
No Matches
lowLevelFunctionTapeInterface.hpp
1/*
2 * CoDiPack, a Code Differentiation Package
3 *
4 * Copyright (C) 2015-2024 Chair for Scientific Computing (SciComp), University of Kaiserslautern-Landau
5 * Homepage: http://scicomp.rptu.de
6 * Contact: Prof. Nicolas R. Gauger (codi@scicomp.uni-kl.de)
7 *
8 * Lead developers: Max Sagebaum, Johannes Blühdorn (SciComp, University of Kaiserslautern-Landau)
9 *
10 * This file is part of CoDiPack (http://scicomp.rptu.de/software/codi).
11 *
12 * CoDiPack is free software: you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation, either version 3 of the
15 * License, or (at your option) any later version.
16 *
17 * CoDiPack is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty
19 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
20 *
21 * See the GNU General Public License for more details.
22 * You should have received a copy of the GNU
23 * General Public License along with CoDiPack.
24 * If not, see <http://www.gnu.org/licenses/>.
25 *
26 * For other licensing options please contact us.
27 *
28 * Authors:
29 * - SciComp, University of Kaiserslautern-Landau:
30 * - Max Sagebaum
31 * - Johannes Blühdorn
32 * - Former members:
33 * - Tim Albring
34 */
35#pragma once
36
37#include "../../config.h"
38#include "../../misc/byteDataView.hpp"
39#include "../../misc/macros.hpp"
40#include "../../misc/temporaryMemory.hpp"
41#include "../misc/lowLevelFunctionEntry.hpp"
42
44namespace codi {
45
46 template<typename T_Tape>
47 struct ExternalFunction;
48
49 template<typename T_Real, typename T_Gradient, typename T_Tape, typename T_Impl>
50 struct LhsExpressionInterface;
51
67 template<typename T_Real, typename T_Gradient, typename T_Identifier>
69 public:
70
71 using Real = CODI_DD(T_Real, double);
72 using Gradient = CODI_DD(T_Gradient, double);
73 using Identifier = CODI_DD(T_Identifier, int);
74
75 /*******************************************************************************/
77
80
97 template<LowLevelFunctionEntryCallKind callType, typename... Args>
98 static void callLowLevelFunction(LowLevelFunctionTapeInterface& tape, bool forward, size_t& curLLFByteDataPos,
99 char* dataPtr, size_t& curLLFInfoDataPos,
100 Config::LowLevelFunctionToken* const tokenPtr,
101 Config::LowLevelFunctionDataSize* const dataSizePtr, Args&&... args);
102
114
118 };
119}
#define CODI_DD(Type, Default)
Abbreviation for CODI_DECLARE_DEFAULT.
Definition macros.hpp:94
uint16_t LowLevelFunctionDataSize
Size store type for a low level function.
Definition config.h:98
uint16_t LowLevelFunctionToken
Token type for low level functions in the tapes.
Definition config.h:108
CoDiPack - Code Differentiation Package.
Definition codi.hpp:90
LowLevelFunctionEntryCallKind
All possible call types for a low level function entry.
Definition lowLevelFunctionEntry.hpp:51
Definition byteDataView.hpp:51
Low level function entry on the tape. See LowLevelFunctionTapeInterface for details.
Definition lowLevelFunctionEntry.hpp:67
Add functions with custom derivatives to the tape. Can, e.g, be used to optimize small recurring func...
Definition lowLevelFunctionTapeInterface.hpp:68
T_Identifier Identifier
See LowLevelFunctionTapeInterface.
Definition lowLevelFunctionTapeInterface.hpp:73
TemporaryMemory & getTemporaryMemory()
Temporary memory that can be used for dynamic data both during the evaluation and the recording.
T_Gradient Gradient
See LowLevelFunctionTapeInterface.
Definition lowLevelFunctionTapeInterface.hpp:72
Config::LowLevelFunctionToken registerLowLevelFunction(LowLevelFunctionEntry< LowLevelFunctionTapeInterface, Real, Identifier > const &entry)
Register a low level function on the tape.
void pushLowLevelFunction(Config::LowLevelFunctionToken token, size_t size, ByteDataView &data)
Push a low level function to the tape.
T_Real Real
See LowLevelFunctionTapeInterface.
Definition lowLevelFunctionTapeInterface.hpp:71
static void callLowLevelFunction(LowLevelFunctionTapeInterface &tape, bool forward, size_t &curLLFByteDataPos, char *dataPtr, size_t &curLLFInfoDataPos, Config::LowLevelFunctionToken *const tokenPtr, Config::LowLevelFunctionDataSize *const dataSizePtr, Args &&... args)
Internal function for evaluating a low level function entry.
Allocator for temporary used memory.
Definition temporaryMemory.hpp:54