CoDiPack  2.2.0
A Code Differentiation Package
SciComp TU Kaiserslautern
Loading...
Searching...
No Matches
externalFunctionTapeInterface.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/macros.hpp"
39
41namespace codi {
42
43 template<typename T_Tape>
44 struct ExternalFunction;
45
46 template<typename T_Real, typename T_Gradient, typename T_Tape, typename T_Impl>
47 struct LhsExpressionInterface;
48
75 template<typename T_Real, typename T_Gradient, typename T_Identifier>
77 public:
78
79 using Real = CODI_DD(T_Real, double);
80 using Gradient = CODI_DD(T_Gradient, double);
81 using Identifier = CODI_DD(T_Identifier, int);
82
83 /*******************************************************************************/
85
94 template<typename Lhs, typename Tape>
96
101 };
102}
#define CODI_DD(Type, Default)
Abbreviation for CODI_DECLARE_DEFAULT.
Definition macros.hpp:94
CoDiPack - Code Differentiation Package.
Definition codi.hpp:90
Add user defined functions to the tape evaluation.
Definition externalFunctionTapeInterface.hpp:76
Real registerExternalFunctionOutput(LhsExpressionInterface< Real, Gradient, Tape, Lhs > &value)
T_Gradient Gradient
See ExternalFunctionTapeInterface.
Definition externalFunctionTapeInterface.hpp:80
void pushExternalFunction(ExternalFunction< ExternalFunctionTapeInterface > const &extFunc)
T_Identifier Identifier
See ExternalFunctionTapeInterface.
Definition externalFunctionTapeInterface.hpp:81
T_Real Real
See ExternalFunctionTapeInterface.
Definition externalFunctionTapeInterface.hpp:79
User-defined evaluation functions for the taping process.
Definition externalFunction.hpp:102
Base class for all CoDiPack lvalue expression.
Definition lhsExpressionInterface.hpp:63