CoDiPack  2.2.0
A Code Differentiation Package
SciComp TU Kaiserslautern
Loading...
Searching...
No Matches
primalAdjointVectorAccess.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 <cstddef>
38
39#include "../../config.h"
40#include "../../misc/macros.hpp"
41#include "adjointVectorAccess.hpp"
42
44namespace codi {
45
57 template<typename T_Real, typename T_Identifier, typename T_Gradient>
58 struct PrimalAdjointVectorAccess : public AdjointVectorAccess<T_Real, T_Identifier, T_Gradient> {
59 using Real = CODI_DD(T_Real, double);
60 using Identifier = CODI_DD(T_Identifier, int);
61 using Gradient = CODI_DD(T_Gradient, double);
62
64
65 private:
66
67 Real* primalVector;
68
69 public:
70
73 : Base(adjointVector), primalVector(primalVector) {}
74
75 /*******************************************************************************/
77
80 return new PrimalAdjointVectorAccess(this->adjointVector, this->primalVector);
81 }
82
83 /*******************************************************************************/
85
87 void setPrimal(Identifier const& index, Real const& primal) {
88 primalVector[index] = primal;
89 }
90
92 Real getPrimal(Identifier const& index) {
93 return primalVector[index];
94 }
95
98 bool hasPrimals() {
99 return true;
100 }
101 };
102}
#define CODI_DD(Type, Default)
Abbreviation for CODI_DECLARE_DEFAULT.
Definition macros.hpp:94
CoDiPack - Code Differentiation Package.
Definition codi.hpp:90
Implementation of VectorAccessInterface for adjoint vectors.
Definition adjointVectorAccess.hpp:59
Gradient * adjointVector
Pointer to the gradient vector.
Definition adjointVectorAccess.hpp:66
Implementation of VectorAccessInterface for adjoint and primal vectors.
Definition primalAdjointVectorAccess.hpp:58
T_Identifier Identifier
See PrimalAdjointVectorAccess.
Definition primalAdjointVectorAccess.hpp:60
VectorAccessInterface< Real, Identifier > * clone() const
Definition primalAdjointVectorAccess.hpp:79
void setPrimal(Identifier const &index, Real const &primal)
Set the primal value.
Definition primalAdjointVectorAccess.hpp:87
bool hasPrimals()
True if the tape/vector interface has primal values.
Definition primalAdjointVectorAccess.hpp:98
T_Gradient Gradient
See PrimalAdjointVectorAccess.
Definition primalAdjointVectorAccess.hpp:61
T_Real Real
See PrimalAdjointVectorAccess.
Definition primalAdjointVectorAccess.hpp:59
Real getPrimal(Identifier const &index)
Get the primal value.
Definition primalAdjointVectorAccess.hpp:92
PrimalAdjointVectorAccess(Gradient *adjointVector, Real *primalVector)
Constructor. See interface documentation for details about the vectors.
Definition primalAdjointVectorAccess.hpp:72
Unified access to the adjoint vector and primal vector in a tape evaluation.
Definition vectorAccessInterface.hpp:91