dataInterface.hpp

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

namespace codi {

  template<typename T_NestedData = void, typename T_InternalPosHandle = size_t>
  struct DataInterface {
    public:
 
      using NestedData = T_NestedData;                                 
      using InternalPosHandle = CODI_DD(T_InternalPosHandle, size_t);  
 
      using Position = EmptyPosition;  
 
#if CODI_IDE
      DataInterface(size_t chunkSize) {
        CODI_UNUSED(chunkSize);
      }
#endif
 
      /*******************************************************************************/

      CODI_INLINE void addDataSize(size_t const& size);

      template<typename... Data>
      CODI_INLINE void getDataPointers(Data*&... pointers);

      template<typename... Data>
      CODI_INLINE void pushData(Data const&... data);

      CODI_INLINE InternalPosHandle reserveItems(size_t const& items);
 
      /*******************************************************************************/
 
      void resize(size_t const& totalSize); 
 
      void reset();     
      void resetHard(); 
      void resetTo(Position const& pos); 

      void erase(Position const& start, Position const& end, bool recursive = true);
 
      /*******************************************************************************/
 
      CODI_INLINE size_t getDataSize() const;   
      CODI_INLINE Position getPosition() const; 
      CODI_INLINE size_t getPushedDataCount(InternalPosHandle const& startPos); 
      CODI_INLINE Position getZeroPosition() const; 
 
      /*******************************************************************************/

      void addToTapeValues(TapeValues& values) const;

      template<typename TargetPosition>
      CODI_INLINE TargetPosition extractPosition(Position const& pos) const;
 
      void setNested(NestedData* v); 
      void swap(DataInterface& other); 
 
      /*******************************************************************************/

      template<int selectedDepth = -1, typename FunctionObject, typename... Args>
      CODI_INLINE void evaluateForward(Position const& start, Position const& end, FunctionObject function,
                                       Args&&... args);

      template<int selectedDepth = -1, typename FunctionObject, typename... Args>
      CODI_INLINE void evaluateReverse(Position const& start, Position const& end, FunctionObject function,
                                       Args&&... args);

      template<typename FunctionObject, typename... Args>
      CODI_INLINE void forEachChunk(FunctionObject& function, bool recursive, Args&&... args);

      template<typename FunctionObject, typename... Args>
      CODI_INLINE void forEachForward(Position const& start, Position const& end, FunctionObject function,
                                      Args&&... args);

      template<typename FunctionObject, typename... Args>
      CODI_INLINE void forEachReverse(Position const& start, Position const& end, FunctionObject function,
                                      Args&&... args);
  };
}