CoDiPack  2.2.0
A Code Differentiation Package
SciComp TU Kaiserslautern
Loading...
Searching...
No Matches
immutableActiveType.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 "../tapes/interfaces/fullTapeInterface.hpp"
40#include "../traits/realTraits.hpp"
41#include "activeType.hpp"
42#include "assignmentOperators.hpp"
43#include "incrementOperators.hpp"
44#include "lhsExpressionInterface.hpp"
45
47namespace codi {
48
60 template<typename T_ActiveType>
62 : public LhsExpressionInterface<typename T_ActiveType::Real, typename T_ActiveType::Gradient,
63 typename T_ActiveType::Tape, ImmutableActiveType<T_ActiveType>>,
64 public AssignmentOperators<typename T_ActiveType::Tape, ImmutableActiveType<T_ActiveType>>,
65 public IncrementOperators<typename T_ActiveType::Tape, ImmutableActiveType<T_ActiveType>> {
66 public:
67
69 using Tape = typename ActiveType::Tape;
70
71 using Real = typename Tape::Real;
73 using Identifier = typename Tape::Identifier;
74 using Gradient = typename Tape::Gradient;
75
77
78 private:
79
80 Real const primalValue;
81 Identifier const identifier;
82
83 public:
84
88 : primalValue(value), identifier(identifier) {
89 // deliberately left empty
90 }
91
95 : primalValue(value.getValue()), identifier(value.getIdentifier()) {
96 // deliberately left empty
97 }
98
102 // deliberately left empty
103 }
104
107
108 /*******************************************************************************/
111
114
116 /*******************************************************************************/
122
125 return identifier;
126 }
127
129 CODI_INLINE Real const& value() const {
130 return primalValue;
131 }
132
135 return ActiveType::getTape();
136 }
137
139 };
140} // end of namespace codi
#define CODI_INLINE
See codi::Config::ForcedInlines.
Definition config.h:457
#define CODI_DD(Type, Default)
Abbreviation for CODI_DECLARE_DEFAULT.
Definition macros.hpp:94
#define CODI_T(...)
Abbreviation for CODI_TEMPLATE.
Definition macros.hpp:111
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
T_Tape Tape
See ActiveType.
Definition activeType.hpp:55
static Tape & getTape()
Get a reference to the tape which manages this expression.
Definition activeType.hpp:99
Impl ActiveResult
Type into which the expression can be converted. Usually also the type from which it is constructed.
Definition activeTypeBase.hpp:148
Implementation of assignment operators for LhsExpressionInterface implementations.
Definition assignmentOperators.hpp:54
Creates a pseudo active type from a data value. Can be used to overlay existing data with immutable a...
Definition immutableActiveType.hpp:65
typename ActiveType::Tape Tape
See ActiveType.
Definition immutableActiveType.hpp:69
typename ActiveType::ActiveResult ActiveResult
Type into which the expression can be converted. Usually also the type from which it is constructed.
Definition immutableActiveType.hpp:113
Real const & value() const
Get a constant reference to the lvalue represented by the expression.
Definition immutableActiveType.hpp:129
typename Tape::Identifier Identifier
See LhsExpressionInterface.
Definition immutableActiveType.hpp:73
ImmutableActiveType< ActiveType > & operator=(ImmutableActiveType< ActiveType > const &v)=delete
This class is immutable, delete all assignment operators.
typename Tape::Real Real
See LhsExpressionInterface.
Definition immutableActiveType.hpp:71
typename Tape::Gradient Gradient
See LhsExpressionInterface.
Definition immutableActiveType.hpp:74
Identifier const & getIdentifier() const
Definition immutableActiveType.hpp:124
ImmutableActiveType const & StoreAs
Defines how this expression is stored in an expression tree.
Definition immutableActiveType.hpp:112
ImmutableActiveType(Real const &value, Identifier const &identifier)
Definition immutableActiveType.hpp:87
~ImmutableActiveType()
Definition immutableActiveType.hpp:101
T_ActiveType ActiveType
See ImmutableActiveType.
Definition immutableActiveType.hpp:68
static Tape & getTape()
Get a reference to the tape which manages this expression.
Definition immutableActiveType.hpp:134
ImmutableActiveType(ActiveType const &value)
Definition immutableActiveType.hpp:94
RealTraits::PassiveReal< Real > PassiveReal
Basic computation type.
Definition immutableActiveType.hpp:72
Implementation of increment operators for LhsExpressionInterface implementations.
Definition incrementOperators.hpp:54
Base class for all CoDiPack lvalue expression.
Definition lhsExpressionInterface.hpp:63
Real const & getValue() const
Get the primal value of this lvalue.
Definition lhsExpressionInterface.hpp:125