CoDiPack  2.2.0
A Code Differentiation Package
SciComp TU Kaiserslautern
Loading...
Searching...
No Matches
customAdjointVectorEvaluationTapeInterface.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
44namespace codi {
45
64 template<typename T_Position>
66 public:
67
68 using Position = CODI_DD(T_Position, EmptyPosition);
69
70 /*******************************************************************************/
72
78 template<typename Adjoint>
79 void evaluate(Position const& start, Position const& end, Adjoint* data);
80
81 // clang-format off
87 // clang-format on
88 template<typename Adjoint>
89 void evaluateForward(Position const& start, Position const& end, Adjoint* data);
90 };
91}
#define CODI_DD(Type, Default)
Abbreviation for CODI_DECLARE_DEFAULT.
Definition macros.hpp:94
CoDiPack - Code Differentiation Package.
Definition codi.hpp:90
Allows user defined vectors for the forward and adjoint evaluation.
Definition customAdjointVectorEvaluationTapeInterface.hpp:65
void evaluate(Position const &start, Position const &end, Adjoint *data)
Perform a reverse evaluation for a part of the tape. It hast to hold start >= end.
void evaluateForward(Position const &start, Position const &end, Adjoint *data)
Perform a forward evaluation of a part of the tape. It has to hold start <= end.
T_Position Position
See CustomAdjointVectorEvaluationTapeInterface.
Definition customAdjointVectorEvaluationTapeInterface.hpp:68
Empty Position with no nested data.
Definition position.hpp:47
Forward AD evaluation of a recorded tape.
Definition forwardEvaluationTapeInterface.hpp:57