primalValueLinearTape.hpp

/*
 * CoDiPack, a Code Differentiation Package
 *
 * Copyright (C) 2015-2024 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 <algorithm>
#include <functional>
#include <type_traits>
 
#include "../config.h"
#include "../expressions/lhsExpressionInterface.hpp"
#include "../expressions/logic/compileTimeTraversalLogic.hpp"
#include "../expressions/logic/constructStaticContext.hpp"
#include "../expressions/logic/traversalLogic.hpp"
#include "../misc/macros.hpp"
#include "../misc/memberStore.hpp"
#include "../traits/expressionTraits.hpp"
#include "data/chunk.hpp"
#include "indices/indexManagerInterface.hpp"
#include "primalValueBaseTape.hpp"
 
namespace codi {
 
  template<typename T_TapeTypes>
  struct PrimalValueLinearTape : public PrimalValueBaseTape<T_TapeTypes, PrimalValueLinearTape<T_TapeTypes>> {
    public:
 
      using TapeTypes =
          CODI_DD(T_TapeTypes,
                  CODI_T(PrimalValueTapeTypes<double, double, IndexManagerInterface<int>, StatementEvaluatorInterface,
                                              DefaultChunkedData>));  
 
      using Base = PrimalValueBaseTape<T_TapeTypes, PrimalValueLinearTape<T_TapeTypes>>;  
      friend Base;  
 
      using Real = typename TapeTypes::Real;                              
      using Gradient = typename TapeTypes::Gradient;                      
      using IndexManager = typename TapeTypes::IndexManager;              
      using Identifier = typename TapeTypes::Identifier;                  
      using PassiveReal = RealTraits::PassiveReal<Real>;                  
      using StatementEvaluator = typename TapeTypes::StatementEvaluator;  
      using EvalHandle = typename TapeTypes::EvalHandle;                  
      using Position = typename Base::Position;                           
 
      PrimalValueLinearTape() : Base() {}
 
      using Base::clearAdjoints;
 
      void clearAdjoints(Position const& start, Position const& end,
                         AdjointsManagement adjointsManagement = AdjointsManagement::Automatic) {
        CODI_UNUSED(adjointsManagement);
 
        using IndexPosition = CODI_DD(typename IndexManager::Position, int);
        IndexPosition startIndex = this->llfByteData.template extractPosition<IndexPosition>(start);
        IndexPosition endIndex = this->llfByteData.template extractPosition<IndexPosition>(end);
 
        startIndex = std::min(startIndex, (IndexPosition)this->adjoints.size() - 1);
        endIndex = std::min(endIndex, (IndexPosition)this->adjoints.size() - 1);
 
        for (IndexPosition curPos = endIndex + 1; curPos <= startIndex; curPos += 1) {
          this->adjoints[curPos] = Gradient();
        }
      }
 
      template<typename AdjointVector>
      void clearCustomAdjoints(Position const& start, Position const& end, AdjointVector data) {
        using IndexPosition = CODI_DD(typename IndexManager::Position, int);
        IndexPosition startIndex = this->llfByteData.template extractPosition<IndexPosition>(start);
        IndexPosition endIndex = this->llfByteData.template extractPosition<IndexPosition>(end);
 
        for (IndexPosition curPos = endIndex + 1; curPos <= startIndex; curPos += 1) {
          data[curPos] = AdjointVectorTraits::Gradient<AdjointVector>();
        }
      }
 
    protected:
 
      CODI_INLINE static void internalEvaluateForward_EvalStatements(
          /* data from call */
          PrimalValueLinearTape& tape, Real* primalVector, ADJOINT_VECTOR_TYPE* adjointVector,
          /* data from low level function byte data vector */
          size_t& curLLFByteDataPos, size_t const& endLLFByteDataPos, char* dataPtr,
          /* data from low level function info data vector */
          size_t& curLLFInfoDataPos, size_t const& endLLFInfoDataPos, Config::LowLevelFunctionToken* const tokenPtr,
          Config::LowLevelFunctionDataSize* const dataSizePtr,
          /* data from constantValueData */
          size_t& curConstantPos, size_t const& endConstantPos, PassiveReal const* const constantValues,
          /* data from passiveValueData */
          size_t& curPassivePos, size_t const& endPassivePos, Real const* const passiveValues,
          /* data from rhsIdentifiersData */
          size_t& curRhsIdentifiersPos, size_t const& endRhsIdentifiersPos, Identifier const* const rhsIdentifiers,
          /* data from statementData */
          size_t& curStatementPos, size_t const& endStatementPos,
          Config::ArgumentSize const* const numberOfPassiveArguments, EvalHandle const* const stmtEvalHandle,
          /* data from index handler */
          size_t const& startAdjointPos, size_t const& endAdjointPos) {
        CODI_UNUSED(endLLFByteDataPos, endLLFInfoDataPos, endConstantPos, endPassivePos, endRhsIdentifiersPos,
                    endStatementPos);
 
        size_t curAdjointPos = startAdjointPos;
 
#if !CODI_VariableAdjointInterfaceInPrimalTapes
        typename Base::template VectorAccess<Gradient*> vectorAccess(adjointVector, primalVector);
#endif
 
        while (curAdjointPos < endAdjointPos) CODI_Likely {
          curAdjointPos += 1;
 
          Config::ArgumentSize nPassiveValues = numberOfPassiveArguments[curStatementPos];
 
          if (Config::StatementLowLevelFunctionTag == nPassiveValues) CODI_Unlikely {
            Base::template callLowLevelFunction<LowLevelFunctionEntryCallKind::Forward>(
                tape, true, curLLFByteDataPos, dataPtr, curLLFInfoDataPos, tokenPtr, dataSizePtr,
#if CODI_VariableAdjointInterfaceInPrimalTapes
                adjointVector
#else
                &vectorAccess
#endif
            );
          } else if (Config::StatementInputTag == nPassiveValues) CODI_Unlikely {
            // Do nothing.
          } else CODI_Likely {
            Gradient lhsTangent = Gradient();
 
            primalVector[curAdjointPos] = StatementEvaluator::template callForward<PrimalValueLinearTape>(
                stmtEvalHandle[curStatementPos], primalVector, adjointVector, lhsTangent, nPassiveValues,
                curConstantPos, constantValues, curPassivePos, passiveValues, curRhsIdentifiersPos, rhsIdentifiers);
 
#if CODI_VariableAdjointInterfaceInPrimalTapes
            adjointVector->setLhsTangent(curAdjointPos);
            EventSystem<PrimalValueLinearTape>::notifyStatementEvaluateListeners(
                tape, curAdjointPos, adjointVector->getVectorSize(), adjointVector->getAdjointVec(curAdjointPos));
#else
            adjointVector[curAdjointPos] = lhsTangent;
 
            EventSystem<PrimalValueLinearTape>::notifyStatementEvaluateListeners(
                tape, curAdjointPos, GradientTraits::dim<Gradient>(), GradientTraits::toArray(lhsTangent).data());
#endif
            EventSystem<PrimalValueLinearTape>::notifyStatementEvaluatePrimalListeners(tape, curAdjointPos,
                                                                                       primalVector[curAdjointPos]);
          }
 
          curStatementPos += 1;
        }
      }
 
      CODI_INLINE static void internalEvaluatePrimal_EvalStatements(
          /* data from call */
          PrimalValueLinearTape& tape, Real* primalVector,
          /* data from low level function byte data vector */
          size_t& curLLFByteDataPos, size_t const& endLLFByteDataPos, char* dataPtr,
          /* data from low level function info data vector */
          size_t& curLLFInfoDataPos, size_t const& endLLFInfoDataPos, Config::LowLevelFunctionToken* const tokenPtr,
          Config::LowLevelFunctionDataSize* const dataSizePtr,
          /* data from constantValueData */
          size_t& curConstantPos, size_t const& endConstantPos, PassiveReal const* const constantValues,
          /* data from passiveValueData */
          size_t& curPassivePos, size_t const& endPassivePos, Real const* const passiveValues,
          /* data from rhsIdentifiersData */
          size_t& curRhsIdentifiersPos, size_t const& endRhsIdentifiersPos, Identifier const* const rhsIdentifiers,
          /* data from statementData */
          size_t& curStatementPos, size_t const& endStatementPos,
          Config::ArgumentSize const* const numberOfPassiveArguments, EvalHandle const* const stmtEvalHandle,
          /* data from index handler */
          size_t const& startAdjointPos, size_t const& endAdjointPos) {
        CODI_UNUSED(endLLFByteDataPos, endLLFInfoDataPos, endConstantPos, endPassivePos, endRhsIdentifiersPos,
                    endStatementPos);
 
        size_t curAdjointPos = startAdjointPos;
 
        typename Base::template VectorAccess<Gradient*> vectorAccess(nullptr, primalVector);
 
        while (curAdjointPos < endAdjointPos) CODI_Likely {
          curAdjointPos += 1;
 
          Config::ArgumentSize nPassiveValues = numberOfPassiveArguments[curStatementPos];
 
          if (Config::StatementLowLevelFunctionTag == nPassiveValues) CODI_Unlikely {
            Base::template callLowLevelFunction<LowLevelFunctionEntryCallKind::Primal>(
                tape, true, curLLFByteDataPos, dataPtr, curLLFInfoDataPos, tokenPtr, dataSizePtr, &vectorAccess);
          } else if (Config::StatementInputTag == nPassiveValues) CODI_Unlikely {
            // Do nothing.
          } else CODI_Likely {
            primalVector[curAdjointPos] = StatementEvaluator::template callPrimal<PrimalValueLinearTape>(
                stmtEvalHandle[curStatementPos], primalVector, nPassiveValues, curConstantPos, constantValues,
                curPassivePos, passiveValues, curRhsIdentifiersPos, rhsIdentifiers);
 
            EventSystem<PrimalValueLinearTape>::notifyStatementEvaluatePrimalListeners(tape, curAdjointPos,
                                                                                       primalVector[curAdjointPos]);
          }
 
          curStatementPos += 1;
        }
      }
 
      CODI_INLINE static void internalEvaluateReverse_EvalStatements(
          /* data from call */
          PrimalValueLinearTape& tape, Real* primalVector, ADJOINT_VECTOR_TYPE* adjointVector,
          /* data from low level function byte data vector */
          size_t& curLLFByteDataPos, size_t const& endLLFByteDataPos, char* dataPtr,
          /* data from low level function info data vector */
          size_t& curLLFInfoDataPos, size_t const& endLLFInfoDataPos, Config::LowLevelFunctionToken* const tokenPtr,
          Config::LowLevelFunctionDataSize* const dataSizePtr,
          /* data from constantValueData */
          size_t& curConstantPos, size_t const& endConstantPos, PassiveReal const* const constantValues,
          /* data from passiveValueData */
          size_t& curPassivePos, size_t const& endPassivePos, Real const* const passiveValues,
          /* data from rhsIdentifiersData */
          size_t& curRhsIdentifiersPos, size_t const& endRhsIdentifiersPos, Identifier const* const rhsIdentifiers,
          /* data from statementData */
          size_t& curStatementPos, size_t const& endStatementPos,
          Config::ArgumentSize const* const numberOfPassiveArguments, EvalHandle const* const stmtEvalHandle,
          /* data from index handler */
          size_t const& startAdjointPos, size_t const& endAdjointPos) {
        CODI_UNUSED(endLLFByteDataPos, endLLFInfoDataPos, endConstantPos, endPassivePos, endRhsIdentifiersPos,
                    endStatementPos);
 
        size_t curAdjointPos = startAdjointPos;
 
#if !CODI_VariableAdjointInterfaceInPrimalTapes
        typename Base::template VectorAccess<Gradient*> vectorAccess(adjointVector, primalVector);
#endif
 
        while (curAdjointPos > endAdjointPos) CODI_Likely {
          curStatementPos -= 1;
 
          Config::ArgumentSize nPassiveValues = numberOfPassiveArguments[curStatementPos];
 
          if (Config::StatementLowLevelFunctionTag == nPassiveValues) CODI_Unlikely {
            Base::template callLowLevelFunction<LowLevelFunctionEntryCallKind::Reverse>(
                tape, false, curLLFByteDataPos, dataPtr, curLLFInfoDataPos, tokenPtr, dataSizePtr,
#if CODI_VariableAdjointInterfaceInPrimalTapes
                adjointVector
#else
                &vectorAccess
#endif
            );
          } else if (Config::StatementInputTag == nPassiveValues) CODI_Unlikely {
            // Do nothing.
          } else CODI_Likely {
#if CODI_VariableAdjointInterfaceInPrimalTapes
 
            EventSystem<PrimalValueLinearTape>::notifyStatementEvaluateListeners(
                tape, curAdjointPos, adjointVector->getVectorSize(), adjointVector->getAdjointVec(curAdjointPos));
 
            Gradient const lhsAdjoint{};
            adjointVector->setLhsAdjoint(curAdjointPos);
#else
            Gradient const lhsAdjoint = adjointVector[curAdjointPos];
 
            EventSystem<PrimalValueLinearTape>::notifyStatementEvaluateListeners(
                tape, curAdjointPos, GradientTraits::dim<Gradient>(), GradientTraits::toArray(lhsAdjoint).data());
 
            if (Config::ReversalZeroesAdjoints) {
              adjointVector[curAdjointPos] = Gradient();
            }
#endif
            EventSystem<PrimalValueLinearTape>::notifyStatementEvaluatePrimalListeners(tape, curAdjointPos,
                                                                                       primalVector[curAdjointPos]);
 
            StatementEvaluator::template callReverse<PrimalValueLinearTape>(
                stmtEvalHandle[curStatementPos], primalVector, adjointVector, lhsAdjoint, nPassiveValues,
                curConstantPos, constantValues, curPassivePos, passiveValues, curRhsIdentifiersPos, rhsIdentifiers);
          }
 
          curAdjointPos -= 1;
        }
      }
 
      template<typename TapeTypes>
      CODI_INLINE static void internalWriteTape(
          /* data from call */
          Real* primalVector,
          /* file interface pointer*/
          codi::TapeWriterInterface<TapeTypes>* writer,
          /* data from low level function byte data vector */
          size_t& curLLFByteDataPos, size_t const& endLLFByteDataPos, char* dataPtr,
          /* data from low level function info data vector */
          size_t& curLLFInfoDataPos, size_t const& endLLFInfoDataPos, Config::LowLevelFunctionToken* const tokenPtr,
          Config::LowLevelFunctionDataSize* const dataSizePtr,
          /* data from constantValueData */
          size_t& curConstantPos, size_t const& endConstantPos, PassiveReal const* const constantValues,
          /* data from passiveValueData */
          size_t& curPassivePos, size_t const& endPassivePos, Real const* const passiveValues,
          /* data from rhsIdentifiersData */
          size_t& curRhsIdentifiersPos, size_t const& endRhsIdentifiersPos, Identifier const* const rhsIdentifiers,
          /* data from statementData */
          size_t& curStatementPos, size_t const& endStatementPos,
          Config::ArgumentSize const* const numberOfPassiveArguments, EvalHandle const* const stmtEvalHandle,
          /* data from index handler */
          size_t const& startAdjointPos, size_t const& endAdjointPos) {
        CODI_UNUSED(endLLFByteDataPos, endLLFInfoDataPos, endConstantPos, endPassivePos, endRhsIdentifiersPos,
                    endStatementPos);
 
        size_t curAdjointPos = startAdjointPos;
 
        while (curAdjointPos < endAdjointPos) {
          curAdjointPos += 1;
          Config::ArgumentSize nPassiveValues = numberOfPassiveArguments[curStatementPos];
 
          if (Config::StatementLowLevelFunctionTag == nPassiveValues) CODI_Unlikely {
            writer->writeLowLevelFunction(curLLFByteDataPos, dataPtr, curLLFInfoDataPos, tokenPtr, dataSizePtr);
          } else CODI_Likely {
            WriteInfo writeInfo = StatementEvaluator::template getWriteInformation<PrimalValueLinearTape>(
                stmtEvalHandle[curStatementPos], primalVector, nPassiveValues, curConstantPos, constantValues,
                curPassivePos, passiveValues, curRhsIdentifiersPos, rhsIdentifiers);
 
            if (Config::StatementInputTag == nPassiveValues) CODI_Unlikely {
              writer->writeStatement(writeInfo, curAdjointPos, primalVector[curAdjointPos], nPassiveValues,
                                     curRhsIdentifiersPos, rhsIdentifiers, curPassivePos, passiveValues, curConstantPos,
                                     constantValues, stmtEvalHandle[curStatementPos]);
 
            } else CODI_Likely {
              writer->writeStatement(writeInfo, curAdjointPos, primalVector[curAdjointPos], nPassiveValues,
                                     curRhsIdentifiersPos, rhsIdentifiers, curPassivePos, passiveValues, curConstantPos,
                                     constantValues, stmtEvalHandle[curStatementPos]);
 
              curRhsIdentifiersPos += writeInfo.numberOfActiveArguments;
              curConstantPos += writeInfo.numberOfConstantArguments;
              curPassivePos += nPassiveValues;
            }
          }
 
          curStatementPos += 1;
        }
      }
 
      CODI_INLINE void internalResetPrimalValues(Position const& pos) {
        CODI_UNUSED(pos);
 
        // Nothing to do.
      }
 
      CODI_INLINE void pushStmtData(Identifier const& index, Config::ArgumentSize const& numberOfPassiveArguments,
                                    Real const& oldPrimalValue, EvalHandle evalHandle) {
        CODI_UNUSED(index, oldPrimalValue);
 
        Base::statementData.pushData(numberOfPassiveArguments, evalHandle);
      }
 
    public:
      void revertPrimals(Position const& pos) {
        CODI_UNUSED(pos);
 
        // Primal values do not need to be reset.
      }
  };
}