CoDiPack  2.2.0
A Code Differentiation Package
SciComp TU Kaiserslautern
Loading...
Searching...
No Matches
reverseTapeInterface.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 <iostream>
38
39#include "../../config.h"
40#include "../../expressions/logic/traversalLogic.hpp"
41#include "../../misc/macros.hpp"
42#include "../../traits/expressionTraits.hpp"
43#include "../../traits/realTraits.hpp"
44#include "../misc/tapeParameters.hpp"
45#include "../misc/tapeValues.hpp"
46#include "gradientAccessTapeInterface.hpp"
47#include "internalStatementRecordingTapeInterface.hpp"
48
50namespace codi {
51
52 template<typename T_Real, typename T_Gradient, typename T_Tape, typename T_Impl>
53 struct LhsExpressionInterface;
54
76 template<typename T_Real, typename T_Gradient, typename T_Identifier>
78 public virtual GradientAccessTapeInterface<T_Gradient, T_Identifier> {
79 public:
80 using Real = CODI_DD(T_Real, double);
81 using Gradient = CODI_DD(T_Gradient, double);
82 using Identifier = CODI_DD(T_Identifier, int);
83
85
86 /*******************************************************************************/
88
93 template<typename Lhs, typename Tape>
99 template<typename Lhs, typename Tape>
101
102 void setActive();
103 void setPassive();
104 bool isActive() const;
105
106 /*******************************************************************************/
108
116
117 /*******************************************************************************/
119
126
134 void reset(bool resetAdjoints = true, AdjointsManagement adjointsManagement = AdjointsManagement::Automatic);
135
136 /*******************************************************************************/
138
140 template<typename Stream = std::ostream>
141 void printStatistics(Stream& out = std::cout) const;
143 template<typename Stream = std::ostream>
144 void printTableHeader(Stream& out = std::cout) const;
146 template<typename Stream = std::ostream>
147 void printTableRow(Stream& out = std::cout) const;
150 };
151}
#define CODI_DD(Type, Default)
Abbreviation for CODI_DECLARE_DEFAULT.
Definition macros.hpp:94
typename TraitsImplementation< Type >::PassiveReal PassiveReal
The original computation type, that was used in the application.
Definition realTraits.hpp:117
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.
Allow for a direct access to the gradient information computed by the tape.
Definition gradientAccessTapeInterface.hpp:67
Internal tape interface that is used by active types to trigger the storing of an expression.
Definition internalStatementRecordingTapeInterface.hpp:65
Base class for all CoDiPack lvalue expression.
Definition lhsExpressionInterface.hpp:63
Minimum tape interface for a working reverse tape implementation.
Definition reverseTapeInterface.hpp:78
TapeValues getTapeValues() const
Get current tape values.
T_Identifier Identifier
See ReverseTapeInterface.
Definition reverseTapeInterface.hpp:82
void setPassive()
Stop/interrupt recording of statements.
bool isActive() const
Check if the tape is recording.
T_Real Real
See ReverseTapeInterface.
Definition reverseTapeInterface.hpp:80
void printTableHeader(Stream &out=std::cout) const
Table header output of TapeValues.
void evaluate(AdjointsManagement adjointsManagement=AdjointsManagement::Automatic)
Perform a full reverse evaluation of the tape.
void registerInput(LhsExpressionInterface< Real, Gradient, Tape, Lhs > &value)
void printTableRow(Stream &out=std::cout) const
Table row output of TapeValues.
void setActive()
Start/continue recording of statements.
void clearAdjoints(AdjointsManagement adjointsManagement=AdjointsManagement::Automatic)
Clear all adjoint values, that is, set them to zero.
void reset(bool resetAdjoints=true, AdjointsManagement adjointsManagement=AdjointsManagement::Automatic)
Reset the tape to the initial state for a fresh recording.
void printStatistics(Stream &out=std::cout) const
Default formatting of TapeValues.
RealTraits::PassiveReal< Real > PassiveReal
Basic computation type.
Definition reverseTapeInterface.hpp:84
void registerOutput(LhsExpressionInterface< Real, Gradient, Tape, Lhs > &value)
T_Gradient Gradient
See ReverseTapeInterface.
Definition reverseTapeInterface.hpp:81
Tape information that can be printed in a pretty print format or a table format.
Definition tapeValues.hpp:73