immutableActiveType.hpp

/*
 * CoDiPack, a Code Differentiation Package
 *
 * Copyright (C) 2015-2024 Chair for Scientific Computing (SciComp), University of Kaiserslautern-Landau
 * Homepage: http://www.scicomp.uni-kl.de
 * Contact:  Prof. Nicolas R. Gauger (codi@scicomp.uni-kl.de)
 *
 * Lead developers: Max Sagebaum, Johannes Blühdorn (SciComp, University of Kaiserslautern-Landau)
 *
 * This file is part of CoDiPack (http://www.scicomp.uni-kl.de/software/codi).
 *
 * CoDiPack is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * CoDiPack is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * See the GNU General Public License for more details.
 * You should have received a copy of the GNU
 * General Public License along with CoDiPack.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * For other licensing options please contact us.
 *
 * Authors:
 *  - SciComp, University of Kaiserslautern-Landau:
 *    - Max Sagebaum
 *    - Johannes Blühdorn
 *    - Former members:
 *      - Tim Albring
 */
#pragma once
 
#include "../config.h"
#include "../misc/macros.hpp"
#include "../tapes/interfaces/fullTapeInterface.hpp"
#include "../traits/realTraits.hpp"
#include "activeType.hpp"
#include "assignmentOperators.hpp"
#include "incrementOperators.hpp"
#include "lhsExpressionInterface.hpp"
 
namespace codi {
 
  template<typename T_ActiveType>
  struct ImmutableActiveType
      : public LhsExpressionInterface<typename T_ActiveType::Real, typename T_ActiveType::Gradient,
                                      typename T_ActiveType::Tape, ImmutableActiveType<T_ActiveType>>,
        public AssignmentOperators<typename T_ActiveType::Tape, ImmutableActiveType<T_ActiveType>>,
        public IncrementOperators<typename T_ActiveType::Tape, ImmutableActiveType<T_ActiveType>> {
    public:
 
      using ActiveType = CODI_DD(T_ActiveType, CODI_T(ActiveType<CODI_DEFAULT_TAPE>));  
      using Tape = typename ActiveType::Tape;                                           
 
      using Real = typename Tape::Real;                   
      using PassiveReal = RealTraits::PassiveReal<Real>;  
      using Identifier = typename Tape::Identifier;       
      using Gradient = typename Tape::Gradient;           
 
      using Base = LhsExpressionInterface<Real, Gradient, Tape, ImmutableActiveType>;  
 
    private:
 
      Real const primalValue;
      Identifier const identifier;
 
    public:
 
      CODI_INLINE ImmutableActiveType(Real const& value, Identifier const& identifier)
          : primalValue(value), identifier(identifier) {
        // deliberately left empty
      }
 
      CODI_INLINE ImmutableActiveType(ActiveType const& value)
          : primalValue(value.getValue()), identifier(value.getIdentifier()) {
        // deliberately left empty
      }
 
      CODI_INLINE ~ImmutableActiveType() {
        // deliberately left empty
      }
 
      CODI_INLINE ImmutableActiveType<ActiveType>& operator=(ImmutableActiveType<ActiveType> const& v) = delete;
 
      /*******************************************************************************/
 
      using StoreAs = ImmutableActiveType const&;              
      using ActiveResult = typename ActiveType::ActiveResult;  
 
      /*******************************************************************************/
 
      CODI_INLINE Identifier const& getIdentifier() const {
        return identifier;
      }
 
      CODI_INLINE Real const& value() const {
        return primalValue;
      }
 
      static CODI_INLINE Tape& getTape() {
        return ActiveType::getTape();
      }
 
  };
}  // end of namespace codi