activeTypeBase.hpp

/*
 * CoDiPack, a Code Differentiation Package
 *
 * Copyright (C) 2015-2026 Chair for Scientific Computing (SciComp), University of Kaiserslautern-Landau
 * Homepage: http://scicomp.rptu.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://scicomp.rptu.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 "assignmentOperators.hpp"
#include "incrementOperators.hpp"
#include "lhsExpressionInterface.hpp"

namespace codi {

  template<typename T_Tape, typename T_Impl>
  struct ActiveTypeBase
      : public LhsExpressionInterface<typename T_Tape::Real, typename T_Tape::Gradient, T_Tape, T_Impl>,
        public AssignmentOperators<typename T_Tape::Real, T_Tape::AllowJacobianOptimization, T_Impl>,
        public IncrementOperators<T_Tape, T_Impl> {
    public:

      using Tape = CODI_DD(T_Tape, CODI_DEFAULT_TAPE);

      using Impl = CODI_DD(T_Impl, CODI_DEFAULT_LHS_EXPRESSION);
 
      using Real = typename Tape::Real;                    
      using PassiveReal = RealTraits::PassiveReal<Real>;   
      using Identifier = typename Tape::Identifier;        
      using Gradient = typename Tape::Gradient;            
      using TapeData = typename Tape::ActiveTypeTapeData;  
 
      using Base = LhsExpressionInterface<Real, Gradient, T_Tape, T_Impl>;  
 
    private:
 
      Real primalValue;
      TapeData tapeData;
 
    public:

      /// Cast to the implementation.
      CODI_INLINE Impl& cast() {
        return static_cast<Impl&>(*this);
      }

      CODI_INLINE ActiveTypeBase() : primalValue(), tapeData() {
        Base::init(Real(), EventHints::Statement::Passive);
      }

      /// Constructor
      template<typename U = Real, typename = RealTraits::EnableIfNotPassiveReal<U>>
      CODI_INLINE ActiveTypeBase(PassiveReal const& value) : primalValue(value), tapeData() {
        Base::init(value, EventHints::Statement::Passive);
      }

      CODI_INLINE ActiveTypeBase(ActiveTypeBase const& v) : primalValue(), tapeData() {
        Base::init(v.getValue(), EventHints::Statement::Copy);
        cast().getTape().store(*this, v);
      }

      CODI_INLINE ActiveTypeBase(Real const& value) : primalValue(value), tapeData() {
        Base::init(value, EventHints::Statement::Passive);
      }

      template<typename Rhs>
      CODI_INLINE ActiveTypeBase(ExpressionInterface<Real, Rhs> const& rhs) : primalValue(), tapeData() {
        Base::init(rhs.cast().getValue(), EventHints::Statement::Expression);
        cast().getTape().store(*this, rhs.cast());
      }

      template<typename Rhs, typename U = Real, typename = RealTraits::EnableIfNotPassiveReal<U>>
      CODI_INLINE ActiveTypeBase(ExpressionInterface<typename U::Real, Rhs> const& rhs)
          : primalValue(rhs.cast()), tapeData() {
        Base::init(rhs.cast().getValue(), EventHints::Statement::Passive);
      }

      CODI_INLINE ~ActiveTypeBase() {
        Base::destroy();
      }

      CODI_INLINE Impl& operator=(ActiveTypeBase const& v) {
        static_cast<LhsExpressionInterface<Real, Gradient, Tape, Impl>&>(*this) = v;
        return cast();
      }
      using Base::operator=;
 
      /*******************************************************************************/
 
      using StoreAs = Impl const&;  
      using ADLogic = Tape;         

      /*******************************************************************************/

      CODI_INLINE Identifier& getIdentifier() {
        return Impl::getTape().getIdentifier(tapeData);
      }

      CODI_INLINE Identifier const& getIdentifier() const {
        return Impl::getTape().getIdentifier(tapeData);
      }

      CODI_INLINE TapeData& getTapeData() {
        return tapeData;
      }

      CODI_INLINE TapeData const& getTapeData() const {
        return tapeData;
      }

      CODI_INLINE Real& value() {
        return primalValue;
      }

      CODI_INLINE Real const& value() const {
        return primalValue;
      }
 
      // getTape must be implemented in the derived type

  };
}