CoDiPack  2.2.0
A Code Differentiation Package
SciComp TU Kaiserslautern
Loading...
Searching...
No Matches
reverseStatementEvaluator.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://www.scicomp.uni-kl.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://www.scicomp.uni-kl.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 <algorithm>
38#include <functional>
39#include <type_traits>
40
41#include "../../expressions/activeType.hpp"
42#include "../../misc/exceptions.hpp"
43#include "../../misc/macros.hpp"
44#include "../../misc/memberStore.hpp"
45#include "statementEvaluatorInterface.hpp"
46
48namespace codi {
49
57 template<typename T_Real>
59 using Real = CODI_DD(T_Real, double);
60
61 public:
62
63 /*******************************************************************************/
66
67 using Handle = void*;
68
70 template<typename Tape, typename... Args>
71 static Real callForward(Handle const& h, Args&&... args) {
72 CODI_UNUSED(h, args...);
73
74 CODI_EXCEPTION("ReverseStatementEvaluator does not support forward evaluation calls.");
75
76 return Real();
77 }
78
80 template<typename Tape, typename... Args>
81 static Real callPrimal(Handle const& h, Args&&... args) {
82 CODI_UNUSED(h, args...);
83
84 CODI_EXCEPTION("ReverseStatementEvaluator does not support primal evaluation calls.");
85
86 return Real();
87 }
88
90 template<typename Tape, typename... Args>
91 static void callReverse(Handle const& h, Args&&... args) {
93
94 func(std::forward<Args>(args)...);
95 }
96
98 template<typename Tape, typename Generator, typename Expr>
100 return (Handle*)Generator::template statementEvaluateReverse<Expr>;
101 }
102
104
105 protected:
106
108 template<typename Tape>
109 using HandleTyped = decltype(&Tape::template statementEvaluateReverse<ActiveType<Tape>>);
110 };
111}
#define CODI_DD(Type, Default)
Abbreviation for CODI_DECLARE_DEFAULT.
Definition: macros.hpp:94
CoDiPack - Code Differentiation Package.
Definition: codi.hpp:90
void CODI_UNUSED(Args const &...)
Disable unused warnings for an arbitrary number of arguments.
Definition: macros.hpp:46
Only stores the function handle for the reverse evaluation.
Definition: reverseStatementEvaluator.hpp:58
static Handle createHandle()
Definition: reverseStatementEvaluator.hpp:99
static void callReverse(Handle const &h, Args &&... args)
Definition: reverseStatementEvaluator.hpp:91
static Real callForward(Handle const &h, Args &&... args)
Throws CODI_EXCEPTION on call.
Definition: reverseStatementEvaluator.hpp:71
decltype(&Tape::template statementEvaluateReverse< ActiveType< Tape > >) HandleTyped
Full reverse function type.
Definition: reverseStatementEvaluator.hpp:109
static Real callPrimal(Handle const &h, Args &&... args)
Throws CODI_EXCEPTION on call.
Definition: reverseStatementEvaluator.hpp:81
void * Handle
Function pointer to the reverse evaluation.
Definition: reverseStatementEvaluator.hpp:67
T_Real Real
See ReverseStatementEvaluator.
Definition: reverseStatementEvaluator.hpp:59
Creation of handles for the evaluation of expressions in a context where the expression type is not a...
Definition: statementEvaluatorInterface.hpp:103