CoDiPack  2.2.0
A Code Differentiation Package
SciComp TU Kaiserslautern
Loading...
Searching...
No Matches
preaccumulationEvaluationTapeInterface.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#include "../data/position.hpp"
40#include "../misc/tapeParameters.hpp"
41#include "forwardEvaluationTapeInterface.hpp"
42#include "manualStatementPushTapeInterface.hpp"
43#include "positionalEvaluationTapeInterface.hpp"
44
46namespace codi {
47
65 template<typename T_Real, typename T_Gradient, typename T_Identifier, typename T_Position>
67 : public virtual PositionalEvaluationTapeInterface<T_Position>,
68 public virtual ForwardEvaluationTapeInterface<T_Position>,
69 public virtual ManualStatementPushTapeInterface<T_Real, T_Gradient, T_Identifier> {
70 public:
71
72 using Real = CODI_DD(T_Real, double);
73 using Gradient = CODI_DD(T_Gradient, double);
74 using Identifier = CODI_DD(T_Identifier, int);
75 using Position = CODI_DD(T_Position, EmptyPosition);
76
77 /*******************************************************************************/
79
87 void evaluateKeepState(Position const& start, Position const& end,
89
97 void evaluateForwardKeepState(Position const& start, Position const& end,
99 };
100}
#define CODI_DD(Type, Default)
Abbreviation for CODI_DECLARE_DEFAULT.
Definition macros.hpp:94
CoDiPack - Code Differentiation Package.
Definition codi.hpp:90
AdjointsManagement
Policies for management of the tape's interal adjoints.
Definition tapeParameters.hpp:98
@ Automatic
Manage internal adjoints automatically, including locking, bounds checking, and resizing.
Empty Position with no nested data.
Definition position.hpp:47
Forward AD evaluation of a recorded tape.
Definition forwardEvaluationTapeInterface.hpp:57
Add derivative information for custom operations to the tape.
Definition manualStatementPushTapeInterface.hpp:73
Reverse AD evaluation for parts of a recorded tape.
Definition positionalEvaluationTapeInterface.hpp:59
Perform tape evaluations but ensure that the state prior to evaluation equals the state after evaluat...
Definition preaccumulationEvaluationTapeInterface.hpp:69
T_Identifier Identifier
See PreaccumulationEvaluationTapeInterface.
Definition preaccumulationEvaluationTapeInterface.hpp:74
void evaluateKeepState(Position const &start, Position const &end, AdjointsManagement adjointsManagement=AdjointsManagement::Automatic)
Perform a tape evaluation but restore the state afterwards such that it is the same as when the evalu...
T_Real Real
See PreaccumulationEvaluationTapeInterface.
Definition preaccumulationEvaluationTapeInterface.hpp:72
T_Gradient Gradient
See PreaccumulationEvaluationTapeInterface.
Definition preaccumulationEvaluationTapeInterface.hpp:73
T_Position Position
See PreaccumulationEvaluationTapeInterface.
Definition preaccumulationEvaluationTapeInterface.hpp:75
void evaluateForwardKeepState(Position const &start, Position const &end, AdjointsManagement adjointsManagement=AdjointsManagement::Automatic)
Perform a tape evaluation but restore the state afterwards such that it is the same as when the evalu...