tagTapeBase.hpp

/*
 * CoDiPack, a Code Differentiation Package
 *
 * Copyright (C) 2015-2026 Chair for Scientific Computing (SciComp), RPTU University 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, RPTU University 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, RPTU University Kaiserslautern-Landau:
 *    - Max Sagebaum
 *    - Johannes Blühdorn
 *    - Former members:
 *      - Tim Albring
 */
#pragma once
 
#include "../../expressions/logic/helpers/forEachLeafLogic.hpp"
#include "../../expressions/aggregate/aggregatedActiveType.hpp"
#include "../../misc/enumBitset.hpp"
#include "../indices/indexManagerInterface.hpp"
#include "../interfaces/fullTapeInterface.hpp"
#include "../misc/adjointVectorAccess.hpp"
#include "tagData.hpp"

namespace codi {

  template<typename Real, typename Tag>
  struct ValidationEntry {
      bool isTagError;        
      bool isPropertyError;   
      Tag tagError;           
      TagFlags propertyError; 
      Real const* value;      
      Real newValue;          
  };

  template<typename Real, typename Tag>
  struct ValidationIndicator {
      std::vector<ValidationEntry<Real, Tag>> errorEntries = {};

      void addEntry(ValidationEntry<Real, Tag> const& entry) {
        errorEntries.push_back(entry);
      }

      void reset() {
        errorEntries.resize(0);
      }

      bool hasError() {
        return !errorEntries.empty();
      }
  };

  template<typename T_Real, typename T_Tag, typename T_Gradient, typename T_Impl>
  struct TagTapeBase {
      using Real = CODI_DD(T_Real, double);       
      using Tag = CODI_DD(T_Tag, int);            
      using Gradient = CODI_DD(T_Gradient, int);  
      using Impl = CODI_DD(T_Impl, TagTapeBase);  
 
      using Identifier = int;                   
      using ActiveTypeTapeData = TagData<Tag>;  

      using TagPropertyErrorCallback = void (*)(Real const& currentValue, Real const& newValue, TagFlags flag,
                                                void* userData);

      using TagErrorCallback = void (*)(Tag const& correctTag, Tag const& wrongTag, void* userData);

      using ErrorCallback = void (*)(ValidationEntry<Real, Tag> const& data, Tag const& curTag, void* userData);
 
      static Tag constexpr PassiveTag = Tag(0);   
      static Tag constexpr InvalidTag = Tag(-1);  
 
    protected:
 
      Tag curTag;  
 
      TagPropertyErrorCallback tagPropertyErrorCallback;  
      void* tagPropertyErrorUserData;                     
 
      TagErrorCallback tagErrorCallback;  
      void* tagErrorUserData;             
 
      ErrorCallback errorCallback;  
      void* errorUserData;          
 
      bool preaccumulationHandling;  
      Tag preaccumulationTag;        
 
      Identifier tempIdentifier = 0;           
      Identifier const activeIdentifier = 1;   
      Identifier const passiveIdentifier = 0;  
 
      ValidationIndicator<Real, Tag> vi = {}; 
      bool doActivityAnalysis = true;         
 
    public:

      TagTapeBase()
          : curTag(),
            tagPropertyErrorCallback(defaultPropertyErrorCallback),
            tagPropertyErrorUserData(nullptr),
            tagErrorCallback(defaultTagErrorCallback),
            tagErrorUserData(this),
            errorCallback(nullptr),
            errorUserData(nullptr),
            preaccumulationHandling(true),
            preaccumulationTag(1337) {}

      struct ValidateTags : public ForEachLeafLogic<ValidateTags> {
        public:

          template<typename Node>
          CODI_INLINE void handleActive(Node const& node, ValidationIndicator<Real, Tag>& vi, Impl& tape, bool& isActive) {
            ActiveTypeTapeData tagData = node.getTapeData();
 
            tape.verifyRhsAccess(node.getValue(), tagData, vi);
 
            isActive |= tagData.tag != 0;
          }
      };

      void swap(Impl& other) {
        std::swap(curTag, other.curTag);
        std::swap(tagPropertyErrorCallback, other.tagPropertyErrorCallback);
        std::swap(tagPropertyErrorUserData, other.tagPropertyErrorUserData);
        std::swap(tagErrorCallback, other.tagErrorCallback);
        std::swap(tagErrorUserData, other.tagErrorUserData);
        std::swap(preaccumulationHandling, other.preaccumulationHandling);
        std::swap(preaccumulationTag, other.preaccumulationTag);
        std::swap(vi, other.vi);
        std::swap(doActivityAnalysis, other.doActivityAnalysis);
      }
 
      /*******************************************************************************/

      CODI_INLINE Identifier const& getIdentifier(ActiveTypeTapeData const& data) {
        if (data.tag != 0) {
          return activeIdentifier;
        } else {
          return passiveIdentifier;
        }
      }

      CODI_INLINE Identifier& getIdentifier(ActiveTypeTapeData& data) {
        tempIdentifier = getIdentifier(std::as_const(data));
        return tempIdentifier;
      }

      /*******************************************************************************/
 
      static bool constexpr AllowJacobianOptimization = false;  

      template<typename Real>
      void initTapeData(Real& value, ActiveTypeTapeData& data) {
        CODI_UNUSED(value);
        data = ActiveTypeTapeData();
      }

      template<typename Real>
      void destroyTapeData(Real& value, ActiveTypeTapeData& data) {
        CODI_UNUSED(value, data);
      }

      template<typename Aggregated, typename Type, typename Lhs, typename Rhs>
      CODI_INLINE void store(AggregatedActiveType<Aggregated, Type, Lhs>& lhs,
                             ExpressionInterface<Aggregated, Rhs> const& rhs) {
        using AggregatedTraits = RealTraits::AggregatedTypeTraits<Aggregated>;
 
        int constexpr Elements = AggregatedTraits::Elements;
 
        std::array<bool, Elements> isActive = {};
 
        Aggregated real = rhs.cast().getValue();
 
        static_for<Elements>([this, &isActive, &lhs, &rhs, &real](auto i) CODI_LAMBDA_INLINE {
          ValidateTags validate;
 
          validate.eval(ArrayAccessExpression<Aggregated, i.value, Rhs>(rhs), vi, cast(), isActive[i.value]);
          verifyLhsWrite(lhs.values[i.value].getValue(), lhs.values[i.value].getTapeData(), AggregatedTraits::template arrayAccess<i.value>(real), vi);
 
          handleError(vi);
        });
 
        static_for<Elements>([this, &isActive, &lhs, &real](auto i) CODI_LAMBDA_INLINE {
          updateLhsTagData(lhs.values[i.value].getTapeData(), isActive[i.value]);
          lhs.values[i.value].value() = AggregatedTraits::template arrayAccess<i.value>(real);
        });
      }

      template<typename Aggregated, typename Type, typename Lhs, typename Rhs>
      CODI_INLINE void store(AggregatedActiveType<Aggregated, Type, Lhs>& lhs,
                             AggregatedActiveType<Aggregated, Type, Rhs> const& rhs) {
        store<Aggregated, Type, Lhs, Rhs>(lhs, static_cast<ExpressionInterface<Aggregated, Rhs> const&>(rhs));
      }

      template<typename Lhs, typename Rhs>
      void store(LhsExpressionInterface<Real, Gradient, Impl, Lhs>& lhs, ExpressionInterface<Real, Rhs> const& rhs) {
        ValidateTags validate;
        bool isActive = false;
        validate.eval(rhs, vi, cast(), isActive);
 
        verifyLhsWrite(lhs.cast().getValue(), lhs.cast().getTapeData(), rhs.cast().getValue(), vi);
 
        handleError(vi);
 
        updateLhsTagData(lhs.cast().getTapeData(), isActive);
        lhs.cast().value() = rhs.cast().getValue();
      }

      template<typename Lhs, typename Rhs>
      void store(LhsExpressionInterface<Real, Gradient, Impl, Lhs>& lhs,
                 LhsExpressionInterface<Real, Gradient, Impl, Rhs> const& rhs) {
        store<Lhs, Rhs>(lhs, static_cast<ExpressionInterface<Real, Rhs> const&>(rhs));
      }

      template<typename Lhs>
      void store(LhsExpressionInterface<Real, Gradient, Impl, Lhs>& lhs, Real const& rhs) {
        verifyLhsWrite(lhs.cast().getValue(), lhs.cast().getTapeData(), rhs, vi);
        handleError(vi);
 
        updateLhsTagData(lhs.cast().getTapeData(), false);
        lhs.cast().value() = rhs;
      }

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

      void setDoActivityAnalysis(bool active) {
        doActivityAnalysis = active;
      }

      void setCurTag(const Tag& tag) {
        this->curTag = tag;
      }

      Tag getCurTag() {
        return this->curTag;
      }

      template<typename Lhs>
      Tag getTagFromVariable(LhsExpressionInterface<Real, Gradient, Impl, Lhs>& value) {
        return value.cast().getTapeData().tag;
      }

      template<typename Lhs>
      void setTagOnVariable(LhsExpressionInterface<Real, Gradient, Impl, Lhs> const& value) {
        value.cast().getTapeData().tag = this->curTag;
      }

      template<typename Lhs>
      void clearTagOnVariable(LhsExpressionInterface<Real, Gradient, Impl, Lhs>& value) {
        value.cast().getTapeData().tag = Tag();
      }

      template<typename Lhs>
      void clearTagPropertiesOnVariable(LhsExpressionInterface<Real, Gradient, Impl, Lhs>& value) {
        value.cast().getTapeData().properties.reset();
      }

      template<typename Lhs>
      void setTagPropertyOnVariable(LhsExpressionInterface<Real, Gradient, Impl, Lhs>& value, TagFlags flag) {
        value.cast().getTapeData().properties.set(flag);
      }

      template<typename Lhs>
      bool hasTagPropertyOnVariable(LhsExpressionInterface<Real, Gradient, Impl, Lhs>& value, TagFlags flag) {
        return value.cast().getTapeData().properties.test(flag);
      }

      void setTagPropertyErrorCallback(TagPropertyErrorCallback const& callback, void* userData) {
        tagPropertyErrorCallback = callback;
        tagPropertyErrorUserData = userData;
      }

      void setTagErrorCallback(TagErrorCallback const& callback, void* userData) {
        tagErrorCallback = callback;
        tagErrorUserData = userData;
      }

      void setErrorCallback(ErrorCallback const& callback, void* userData) {
        errorCallback = callback;
        errorUserData = userData;
      }

      CODI_INLINE void setPreaccumulationHandlingEnabled(bool enabled) {
        preaccumulationHandling = enabled;
      }

      CODI_INLINE void setPreaccumulationHandlingTag(Tag tag) {
        preaccumulationTag = tag;
      }

      CODI_INLINE bool isPreaccumulationHandlingEnabled() {
        return preaccumulationHandling;
      }

      CODI_INLINE Tag getPreaccumulationHandlingTag() {
        return preaccumulationTag;
      }
 
    protected:

      ValidationEntry<Real, Tag> makeTagError(Tag tag, Real const* value) {
        return {true, false, tag, TagFlags::MaxElement, value, Real()};
      }

      ValidationEntry<Real, Tag> makeProeprtyError(TagFlags flag, Real const* value, Real newValue = {}) {
        return {false, true, 0, flag, value, newValue};
      }

      void updateLhsTagData(ActiveTypeTapeData& lhsData, bool isActive) const {
        if (!doActivityAnalysis || isActive) {
          setTag(lhsData.tag);
        } else {
          resetTag(lhsData.tag);
        }
        lhsData.properties.reset(TagFlags::DoNotUse);
      }

      void verifyRhsAccess(Real const& value, ActiveTypeTapeData const& data, ValidationIndicator<Real, Tag>& vi) {
        verifyRhsAccessForTag(value, data, vi);
        verifyRhsAccessForProperty(value, data, vi);
      }

      void verifyRhsAccessForTag(Real const& value, ActiveTypeTapeData const& data, ValidationIndicator<Real, Tag>& vi) {
        if (PassiveTag != data.tag && InvalidTag != data.tag) {
          if (data.tag != curTag) {
            vi.addEntry(makeTagError(data.tag, &value));
          }
        }
      }

      void verifyRhsAccessForProperty(Real const& value, ActiveTypeTapeData const& data, ValidationIndicator<Real, Tag>& vi) {
        if (data.properties.test(TagFlags::DoNotUse)) {
          vi.addEntry(makeProeprtyError(TagFlags::DoNotUse, &value));
        }
      }

      CODI_INLINE void verifyLhsWrite(Real const& lhsValue, ActiveTypeTapeData const& lhsData, Real const& rhsValue, ValidationIndicator<Real, Tag>& vi) {
        if (lhsData.properties.test(TagFlags::DoNotChange)) {
          if (lhsValue != rhsValue) {
            vi.addEntry(makeProeprtyError(TagFlags::DoNotChange, &lhsValue, rhsValue));
          }
        } else if (lhsData.properties.test(TagFlags::DoNotWrite)) {
          vi.addEntry(makeProeprtyError(TagFlags::DoNotWrite, &lhsValue));
        }
      }

      template<typename Lhs>
      CODI_INLINE void verifyRegisterValue(LhsExpressionInterface<Real, Gradient, Impl, Lhs>& value) {
        verifyRhsAccess(value.cast().getValue(), value.cast().getTapeData(), vi);
        verifyLhsWrite(value.cast().getValue(), value.cast().getTapeData(), value.cast().getValue(), vi);
 
        handleError(vi);
      }

      static void defaultPropertyErrorCallback(Real const& currentValue, Real const& newValue, TagFlags flag,
                                               void* userData) {
        CODI_UNUSED(userData);
 
        std::cerr << "Property error '" << std::to_string(flag) << "' on value. current value: " << currentValue
                  << " new value: " << newValue << "" << std::endl;
      }

      static void defaultTagErrorCallback(Tag const& correctTag, Tag const& wrongTag, void* userData) {
        TagTapeBase& impl = *static_cast<TagTapeBase*>(userData);
 
        // output default warning if no handle is defined.
        std::cerr << "Use of variable with bad tag '" << wrongTag << "', should be '" << correctTag << "'.";
        if (wrongTag == impl.preaccumulationTag) {
          std::cerr << " The value seems to be a preaccumulation output.";
        } else if (correctTag == impl.preaccumulationTag) {
          std::cerr << " The value seems to be used during a preaccumulation but is not declared as an input.";
        }
        std::cerr << std::endl;
      }

      static void defaultErrorCallback(ValidationEntry<Real, Tag> const& data, Tag const& curTag, void* userData) {
        if (data.isTagError) {
          defaultTagErrorCallback(curTag, data.tagError, userData);
        }
        if (data.isPropertyError) {
          defaultPropertyErrorCallback(*data.value, data.newValue, data.propertyError, userData);
        }
      }

      CODI_INLINE void handleError(ValidationIndicator<Real, Tag>& vi) const {
        if (vi.hasError()) {
          for(ValidationEntry<Real, Tag> const& entry : vi.errorEntries) {
            if(nullptr != errorCallback) {
              errorCallback(entry, curTag, errorUserData);
            } else {
              if (entry.isTagError) {
                tagErrorCallback(curTag, entry.tagError, tagErrorUserData);
              }
              if (entry.isPropertyError) {
                tagPropertyErrorCallback(*entry.value, entry.newValue, entry.propertyError, tagPropertyErrorUserData);
              }
            }
          }
        }
 
        vi.reset();
      }

      CODI_INLINE void setTag(Tag& tag) const {
        tag = curTag;
      }

      CODI_INLINE void resetTag(Tag& tag) const {
        tag = Tag();
      }

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