binaryExpression.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 "../traits/expressionTraits.hpp"
#include "expressionInterface.hpp"
#include "logic/compileTimeTraversalLogic.hpp"
#include "logic/nodeInterface.hpp"
#include "logic/traversalLogic.hpp"
 
namespace codi {
 
  template<typename T_Real>
  struct BinaryOperation {
    public:
 
      using Real = CODI_DD(T_Real, double);  
 
      template<typename ArgA, typename ArgB>
      static CODI_INLINE Real primal(ArgA const& argA, ArgB const& argB);
 
      template<typename ArgA, typename ArgB>
      static CODI_INLINE Real gradientA(ArgA const& argA, ArgB const& argB, Real const& result);
 
      template<typename ArgA, typename ArgB>
      static CODI_INLINE Real gradientB(ArgA const& argA, ArgB const& argB, Real const& result);
  };
 
  template<typename T_Real, typename T_ArgA, typename T_ArgB, template<typename> class T_Operation>
  struct BinaryExpression : public ExpressionInterface<T_Real, BinaryExpression<T_Real, T_ArgA, T_ArgB, T_Operation> > {
    public:
      using Real = CODI_DD(T_Real, double);                                                 
      using ArgA = CODI_DD(T_ArgA, CODI_T(ExpressionInterface<double, CODI_ANY>));          
      using ArgB = CODI_DD(T_ArgB, CODI_T(ExpressionInterface<double, CODI_ANY>));          
      using Operation = CODI_DD(CODI_T(T_Operation<Real>), CODI_T(BinaryOperation<Real>));  
 
      typename ArgA::StoreAs argA;  
      typename ArgB::StoreAs argB;  
      Real result;                  
 
      template<typename RealA, typename RealB>
      CODI_INLINE explicit BinaryExpression(ExpressionInterface<RealA, ArgA> const& argA,
                                            ExpressionInterface<RealB, ArgB> const& argB)
          : argA(argA.cast()),
            argB(argB.cast()),
            result(Operation::primal(this->argA.getValue(), this->argB.getValue())) {}
 
      /*******************************************************************************/
 
      using StoreAs = BinaryExpression;  
      using ActiveResult =
          typename ExpressionTraits::ValidateResult<typename ArgA::ActiveResult, typename ArgB::ActiveResult>::
              ActiveResult;  
 
      CODI_INLINE Real const& getValue() const {
        return result;
      }
 
      template<size_t argNumber>
      CODI_INLINE Real getJacobian() const {
        if (0 == argNumber) {
          return Operation::gradientA(argA.getValue(), argB.getValue(), result);
        } else {
          return Operation::gradientB(argA.getValue(), argB.getValue(), result);
        }
      }
 
      /*******************************************************************************/
 
      static bool constexpr EndPoint = false;  
 
      template<typename Logic, typename... Args>
      CODI_INLINE void forEachLink(TraversalLogic<Logic>& logic, Args&&... args) const {
        logic.cast().template link<0>(argA, *this, std::forward<Args>(args)...);
        logic.cast().template link<1>(argB, *this, std::forward<Args>(args)...);
      }
 
      template<typename CompileTimeLogic, typename... Args>
      CODI_INLINE static typename CompileTimeLogic::ResultType constexpr forEachLinkConstExpr(Args&&... args) {
        return CompileTimeLogic::reduce(
            CompileTimeLogic::template link<0, ArgA, BinaryExpression>(std::forward<Args>(args)...),
            CompileTimeLogic::template link<1, ArgB, BinaryExpression>(std::forward<Args>(args)...));
      }
 
  };
}