CoDiPack  2.2.0
A Code Differentiation Package
SciComp TU Kaiserslautern
Loading...
Searching...
No Matches
indexManagerInterface.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 <vector>
38
39#include "../../config.h"
40#include "../../misc/macros.hpp"
41#include "../misc/tapeValues.hpp"
42
44namespace codi {
45
77 template<typename T_Index>
79 public:
80
81 using Index = CODI_DD(T_Index, int);
82
83 /*******************************************************************************/
85
86 static Index constexpr InactiveIndex = Index(0);
87 static Index constexpr InvalidIndex =
88 Index(-1);
89
90 /*******************************************************************************/
92
93 static bool constexpr CopyNeedsStatement =
95 static bool constexpr IsLinear =
97
100
103 template<typename Tape>
104 bool assignIndex(Index& index);
105
108 template<typename Tape>
110
111 template<typename Tape>
112 void copyIndex(Index& lhs, Index const& rhs);
113
114 template<typename Tape>
115 void freeIndex(Index& index);
116
117 void reset();
118
119 /*******************************************************************************/
121
126 void addToTapeValues(TapeValues& values) const;
127
134 };
135
136 // clang-format off
137 template<typename Index>
139 template<typename Index>
141 // clang-format on
142}
#define CODI_DD(Type, Default)
Abbreviation for CODI_DECLARE_DEFAULT.
Definition macros.hpp:94
#define CODI_UNDEFINED_VALUE
Used in interface declarations for variables that have to be defined in the specializations.
Definition macros.hpp:117
CoDiPack - Code Differentiation Package.
Definition codi.hpp:90
Indices enable the mapping of primal values to their adjoint counterparts.
Definition indexManagerInterface.hpp:78
static Index constexpr InvalidIndex
Default invalid index for all index mangers (max value for unsigned types).
Definition indexManagerInterface.hpp:87
static Index constexpr InactiveIndex
Default inactive index for all index managers.
Definition indexManagerInterface.hpp:86
void reset()
Reset for a new recording.
bool assignUnusedIndex(Index &index)
Call on registering input values.
bool assignIndex(Index &index)
Call on assignment of a primal value, e.g. on w for w = a + b.
T_Index Index
See IndexManagerInterface.
Definition indexManagerInterface.hpp:81
void copyIndex(Index &lhs, Index const &rhs)
Call on copy of a primal value, e.g. w = a.
static bool constexpr NeedsStaticStorage
True if the index manager is specific to a tape type (and not a tape instance). See IndexManagerInter...
Definition indexManagerInterface.hpp:99
static bool constexpr CopyNeedsStatement
True if no copy optimization is implemented. See IndexManagerInterface.
Definition indexManagerInterface.hpp:93
static bool constexpr IsLinear
True if identifiers are coupled to the statements. See IndexManagerInterface.
Definition indexManagerInterface.hpp:95
void freeIndex(Index &index)
Call on destruction of a primal value. Usually called from the destructor.
void addToTapeValues(TapeValues &values) const
Add storage and other information to the tape values.
Index getLargestCreatedIndex() const
Returns the largest created index.
Tape information that can be printed in a pretty print format or a table format.
Definition tapeValues.hpp:73