indexManagerInterface.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 <vector>
 
#include "../../config.h"
#include "../../misc/macros.hpp"
#include "../misc/tapeValues.hpp"

namespace codi {

  template<typename T_Index>
  struct IndexManagerInterface {
    public:
 
      using Index = CODI_DD(T_Index, int);                
      using ActiveTypeIndexData = CODI_DD(T_Index, int);  
 
      /*******************************************************************************/
 
      static Index constexpr InactiveIndex = Index(0);  
      static Index constexpr InvalidIndex =
          Index(-1);  
 
      /*******************************************************************************/
 
      static bool constexpr CopyNeedsStatement =
          CODI_UNDEFINED_VALUE;  
      static bool constexpr IsLinear =
          CODI_UNDEFINED_VALUE;  

      static bool constexpr NeedsStaticStorage = CODI_UNDEFINED_VALUE;
 
      void initIndex(ActiveTypeIndexData& index);  

      template<typename Tape>
      bool assignIndex(ActiveTypeIndexData& index);

      void updateLargestCreatedIndex(ActiveTypeIndexData const& index);

      template<typename Tape>
      bool assignUnusedIndex(ActiveTypeIndexData& index);
 
      template<typename Tape>
      void copyIndex(ActiveTypeIndexData& lhs,
                     ActiveTypeIndexData const& rhs);  
 
      template<typename Tape>
      void freeIndex(ActiveTypeIndexData& index);  
 
      void reset();  
 
      Index const& getIndex(ActiveTypeIndexData const& data);  
      Index& getIndex(ActiveTypeIndexData& data);              
 
      void validateRhsIndex(ActiveTypeIndexData const& data) const;  
 
      /*******************************************************************************/

      void addToTapeValues(TapeValues& values) const;

      Index getLargestCreatedIndex() const;
  };
 
  // clang-format off
  template<typename Index>
  CODI_DD(Index, int) constexpr IndexManagerInterface<Index>::InactiveIndex;

  template<typename Index>
  CODI_DD(Index, int) constexpr IndexManagerInterface<Index>::InvalidIndex;
  // clang-format on
}