assignmentOperators.hpp

/*
 * CoDiPack, a Code Differentiation Package
 *
 * Copyright (C) 2015-2025 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 "lhsExpressionInterface.hpp"

namespace codi {

  template<typename T_Real, bool T_JacobianOptimization, typename T_Impl>
  struct AssignmentOperatorsPassiveJacobianOptimization {
    public:
 
      using Real = CODI_DD(T_Real, double);  
      static bool constexpr JacobianOptimization =
          CODI_DD(T_JacobianOptimization, false);  
      using Impl = CODI_DD(T_Impl,
                           CODI_T(LhsExpressionInterface<double, int, Tape, T_Impl>));  
 
      using PassiveReal = RealTraits::PassiveReal<Real>;  

      CODI_INLINE Impl& operator+=(PassiveReal const& rhs) {
        cast() = (cast() + rhs);
        return cast();
      }

      CODI_INLINE Impl& operator-=(PassiveReal const& rhs) {
        cast() = (cast() - rhs);
        return cast();
      }
 
    private:

      CODI_INLINE Impl& cast() {
        return static_cast<Impl&>(*this);
      }
  };

  template<typename T_Real, typename T_Impl>
  struct AssignmentOperatorsPassiveJacobianOptimization<T_Real, true, T_Impl> {
    public:
 
      using Real = CODI_DD(T_Real, double);               
      static bool constexpr JacobianOptimization = true;  
      using Impl = CODI_DD(T_Impl,
                           CODI_T(LhsExpressionInterface<double, int, Tape, T_Impl>));  
 
      using PassiveReal = RealTraits::PassiveReal<Real>;  

      CODI_INLINE Impl& operator+=(PassiveReal const& rhs) {
        cast().value() += rhs;
        return cast();
      }

      CODI_INLINE Impl& operator-=(PassiveReal const& rhs) {
        cast().value() -= rhs;
        return cast();
      }
 
    private:

      CODI_INLINE Impl& cast() {
        return static_cast<Impl&>(*this);
      }
  };

  template<typename T_Real, bool T_JacobianOptimization, typename T_Impl>
  struct AssignmentOperators
      : public AssignmentOperatorsPassiveJacobianOptimization<T_Real, T_JacobianOptimization, T_Impl> {
    public:
 
      using Real = CODI_DD(T_Real, double);                                                
      static bool constexpr JacobianOptimization = CODI_DD(T_JacobianOptimization, true);  
      using Impl = CODI_DD(T_Impl,
                           CODI_T(LhsExpressionInterface<double, double, Tape, T_Impl>));  
 
      using Base =
          AssignmentOperatorsPassiveJacobianOptimization<T_Real, T_JacobianOptimization, T_Impl>;  
      using PassiveReal = RealTraits::PassiveReal<Real>;  

      /// Operator += for expressions.
      template<typename Rhs>
      CODI_INLINE Impl& operator+=(ExpressionInterface<Real, Rhs> const& rhs) {
        return cast() = (cast() + rhs);
      }

      template<typename Rhs>
      CODI_INLINE Impl& operator-=(ExpressionInterface<Real, Rhs> const& rhs) {
        return cast() = (cast() - rhs);
      }

      template<typename Rhs>
      CODI_INLINE Impl& operator*=(ExpressionInterface<Real, Rhs> const& rhs) {
        return cast() = (cast() * rhs);
      }

      template<typename Rhs>
      CODI_INLINE Impl& operator/=(ExpressionInterface<Real, Rhs> const& rhs) {
        return cast() = (cast() / rhs);
      }
 
      using Base::operator+=;
      using Base::operator-=;

      CODI_INLINE Impl& operator*=(PassiveReal const& rhs) {
        return cast() = (cast() * rhs);
      }

      CODI_INLINE Impl& operator/=(PassiveReal const& rhs) {
        return cast() = (cast() / rhs);
      }
 
    private:

      CODI_INLINE Impl& cast() {
        return static_cast<Impl&>(*this);
      }
  };
}