identifierInformationTapeInterface.hpp

/*
 * CoDiPack, a Code Differentiation Package
 *
 * Copyright (C) 2015-2026 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 "../data/position.hpp"
#include "../indices/indexManagerInterface.hpp"

namespace codi {
 
  template<typename T_Real, typename T_Gradient, typename T_Tape, typename T_Impl>
  struct LhsExpressionInterface;

  template<typename T_Real, typename T_Gradient, typename T_Identifier, typename T_ActiveTypeTapeData>
  struct IdentifierInformationTapeInterface {
    public:
 
      using Real = CODI_DD(T_Real, double);           
      using Gradient = CODI_DD(T_Gradient, double);   
      using Identifier = CODI_DD(T_Identifier, int);  
      using ActiveTypeTapeData = CODI_DD(T_ActiveTypeTapeData,
                                         Identifier);  
 
      /*******************************************************************************/

      static bool constexpr LinearIndexHandling = CODI_UNDEFINED_VALUE;
 
      Identifier getPassiveIndex() const;                      
      Identifier getInvalidIndex() const;                      
      bool isIdentifierActive(Identifier const& index) const;  
      IndexManagerInterface<Identifier>& getIndexManager();    
 
      Identifier getIdentifier(ActiveTypeTapeData const& data);  
      Identifier& getIdentifier(ActiveTypeTapeData& data);  

      template<typename Lhs, typename Tape>
      void deactivateValue(LhsExpressionInterface<Real, Gradient, Tape, Lhs>& value);
  };
}