statementPushHelper.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 "../../expressions/lhsExpressionInterface.hpp"
#include "../../misc/macros.hpp"
#include "../../tapes/interfaces/fullTapeInterface.hpp"
#include "../../traits/tapeTraits.hpp"
 
namespace codi {
 
  template<typename T_Type, typename T_Impl>
  struct StatementPushHelperBase {
    public:
 
      using Type = CODI_DD(T_Type, CODI_DEFAULT_LHS_EXPRESSION);
 
      using Impl = CODI_DD(T_Impl, CODI_T(StatementPushHelperBase<CODI_ANY, CODI_ANY>));
 
      using Real = typename Type::Real;  
 
      /*******************************************************************************/
 
      void endPushStatement(Type& lhs, Real const& primal);
 
      void pushArgument(Type const& arg, Real const& jacobian);
 
      void startPushStatement();
 
      /*******************************************************************************/
 
      template<typename ArgIter, typename JacobiIter>
      CODI_INLINE void pushStatement(Type& lhs, Real const& primal, ArgIter const startArg, ArgIter const endArg,
                                     JacobiIter const startJac) {
        cast().startPushStatement();
 
        JacobiIter jacPos = startJac;
        ArgIter argPos = startArg;
        while (argPos != endArg) {
          cast().pushArgument(*argPos, *jacPos);
 
          ++jacPos;
          ++argPos;
        }
 
        cast().endPushStatement(lhs, primal);
      }
 
      template<typename ArgVector, typename JacobiVector>
      CODI_INLINE void pushStatement(Type& lhs, Real const& primal, ArgVector const& arguments,
                                     JacobiVector const& jacobians, size_t const size) {
        cast().startPushStatement();
 
        for (size_t i = 0; i < size; ++i) {
          cast().pushArgument(arguments[i], jacobians[i]);
        }
 
        cast().endPushStatement(lhs, primal);
      }
 
 
    private:
 
      CODI_INLINE Impl& cast() {
        return static_cast<Impl&>(*this);
      }
  };
 
  template<typename T_Type, typename = void>
  struct StatementPushHelper : public StatementPushHelperBase<T_Type, StatementPushHelper<T_Type>> {
    public:
 
      using Type = CODI_DD(T_Type, CODI_DEFAULT_LHS_EXPRESSION);
 
      using Real = typename Type::Real;              
      using Identifier = typename Type::Identifier;  
      using Tape = typename Type::Tape;
 
    protected:
      Identifier indexData[Config::MaxArgumentSize];  
      Real jacobianData[Config::MaxArgumentSize];     
      size_t dataPos;                                 
 
    public:
 
      /*******************************************************************************/
 
      void startPushStatement() {
        dataPos = 0;
      }
 
      void pushArgument(Type const& arg, Real const& jacobian) {
        Tape& tape = Type::getTape();
 
        if (Config::MaxArgumentSize <= dataPos) {
          CODI_EXCEPTION("Adding more than %zu arguments to a statement.", Config::MaxArgumentSize);
        }
 
        if (CODI_ENABLE_CHECK(Config::CheckTapeActivity, tape.isActive())) {
          if (CODI_ENABLE_CHECK(Config::CheckZeroIndex, 0 != arg.getIdentifier())) {
            if (CODI_ENABLE_CHECK(Config::IgnoreInvalidJacobians, RealTraits::isTotalFinite(jacobian))) {
              if (CODI_ENABLE_CHECK(Config::CheckJacobianIsZero, !RealTraits::isTotalZero(jacobian))) {
                indexData[dataPos] = arg.getIdentifier();
                jacobianData[dataPos] = jacobian;
                dataPos += 1;
              }
            }
          }
        }
      }
 
      void endPushStatement(Type& lhs, Real const& primal) {
        Tape& tape = Type::getTape();
 
        if (CODI_ENABLE_CHECK(Config::CheckTapeActivity, tape.isActive())) {
          if (0 != dataPos) {
            tape.storeManual(primal, lhs.getIdentifier(), dataPos);
 
            for (size_t i = 0; i < dataPos; ++i) {
              tape.pushJacobianManual(jacobianData[i], 0.0, indexData[i]);
            }
          }
        }
 
        lhs.value() = primal;
      }
 
  };
 
#ifndef DOXYGEN_DISABLE
 
  template<typename T_Type>
  struct StatementPushHelper<T_Type, TapeTraits::EnableIfForwardTape<typename T_Type::Tape>>
      : public StatementPushHelperBase<T_Type, StatementPushHelper<T_Type>> {
    public:
 
      using Type = CODI_DD(T_Type, CODI_DEFAULT_LHS_EXPRESSION);
 
      using Real = typename Type::Real;          
      using Gradient = typename Type::Gradient;  
 
    protected:
 
      Gradient lhsTangent;  
 
    public:
 
      /*******************************************************************************/
 
      void startPushStatement() {
        lhsTangent = Gradient();
      }
 
      void pushArgument(Type const& arg, Real const& jacobian) {
        if (CODI_ENABLE_CHECK(Config::IgnoreInvalidJacobians, RealTraits::isTotalFinite(jacobian))) {
          lhsTangent += jacobian * arg.getGradient();
        }
      }
 
      void endPushStatement(Type& lhs, Real const& primal) {
        lhs.gradient() = lhsTangent;
        lhs.value() = primal;
      }
 
  };
 
  template<>
  struct StatementPushHelper<double, void> {
    public:
 
      using Type = double;  
      using Real = double;  
 
      /*******************************************************************************/
 
      void startPushStatement() {}
 
      void pushArgument(Type const& arg, Real const& jacobian) {
        CODI_UNUSED(arg, jacobian);
      }
 
      void endPushStatement(Type& lhs, Real const& primal) {
        lhs = primal;
      }
 
      template<typename ArgIter, typename JacobiIter>
      void pushStatement(Type& lhs, Real const& primal, ArgIter const startArg, ArgIter const endArg,
                         JacobiIter const startJac) {
        CODI_UNUSED(startArg, endArg, startJac);
 
        endPushStatement(lhs, primal);
      }
 
      template<typename ArgVector, typename JacobiVector>
      void pushStatement(Type& lhs, Real const& primal, ArgVector const& arguments, JacobiVector const& jacobians,
                         size_t const size) {
        CODI_UNUSED(arguments, jacobians, size);
 
        endPushStatement(lhs, primal);
      }
 
  };
#endif
}