pointerStore.hpp

/*
 * CoDiPack, a Code Differentiation Package
 *
 * Copyright (C) 2015-2024 Chair for Scientific Computing (SciComp), University of Kaiserslautern-Landau
 * Homepage: http://www.scicomp.uni-kl.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://www.scicomp.uni-kl.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 "chunk.hpp"
 
namespace codi {
 
  template<typename T_ChunkData>
  struct PointerStore {
    public:
 
      using ChunkData = CODI_DD(T_ChunkData, ChunkBase);  
 
      template<typename FuncObj, typename... Args>
      void call(FuncObj& func, Args&&... args);
 
      template<typename FuncObj, typename... Args>
      void callAndAppend(FuncObj& func, Args&&... args);
 
      template<int selectedDepth, typename Nested, typename... Args>
      CODI_INLINE void callNestedForward(Nested* nested, size_t& start, size_t const& end, Args&&... args);
 
      template<int selectedDepth, typename Nested, typename... Args>
      CODI_INLINE void callNestedReverse(Nested* nested, size_t& start, size_t const& end, Args&&... args);
 
      void setPointers(const size_t& dataPos, ChunkData* chunk);
  };
 
  template<typename T_Data1>
  struct PointerStore<Chunk1<T_Data1>> {
    public:
 
      using Data1 = CODI_DD(T_Data1, int);  
 
      using Chunk = Chunk1<Data1>;  
 
    private:
 
      Data1* p1;  
 
    public:
 
      template<typename FuncObj, typename... Args>
      void call(FuncObj& func, Args&&... args) {
        func(p1, std::forward<Args>(args)...);
      }
 
      template<typename FuncObj, typename... Args>
      void callAndAppend(FuncObj& func, Args&&... args) {
        func(std::forward<Args>(args)..., p1);
      }
 
      template<int selectedDepth, typename Nested, typename... Args>
      CODI_INLINE void callNestedForward(Nested* nested, size_t& start, size_t const& end, Args&&... args) {
        nested->template evaluateForward<selectedDepth>(std::forward<Args>(args)..., start, end, p1);
      }
 
      template<int selectedDepth, typename Nested, typename... Args>
      CODI_INLINE void callNestedReverse(Nested* nested, size_t& start, size_t const& end, Args&&... args) {
        nested->template evaluateReverse<selectedDepth>(std::forward<Args>(args)..., start, end, p1);
      }
 
      void setPointers(size_t const& dataPos, Chunk* chunk) {
        chunk->dataPointer(dataPos, p1);
      }
  };
 
  template<typename T_Data1, typename T_Data2>
  struct PointerStore<Chunk2<T_Data1, T_Data2>> {
    public:
 
      using Data1 = CODI_DD(T_Data1, int);  
      using Data2 = CODI_DD(T_Data2, int);  
 
      using Chunk = Chunk2<Data1, Data2>;  
 
    private:
      Data1* p1;  
      Data2* p2;  
 
    public:
 
      template<typename FuncObj, typename... Args>
      void call(FuncObj& func, Args&&... args) {
        func(p1, p2, std::forward<Args>(args)...);
      }
 
      template<typename FuncObj, typename... Args>
      void callAndAppend(FuncObj& func, Args&&... args) {
        func(std::forward<Args>(args)..., p1, p2);
      }
 
      template<int selectedDepth, typename Nested, typename... Args>
      CODI_INLINE void callNestedForward(Nested* nested, size_t& start, size_t const& end, Args&&... args) {
        nested->template evaluateForward<selectedDepth>(std::forward<Args>(args)..., start, end, p1, p2);
      }
 
      template<int selectedDepth, typename Nested, typename... Args>
      CODI_INLINE void callNestedReverse(Nested* nested, size_t& start, size_t const& end, Args&&... args) {
        nested->template evaluateReverse<selectedDepth>(std::forward<Args>(args)..., start, end, p1, p2);
      }
 
      void setPointers(size_t const& dataPos, Chunk* chunk) {
        chunk->dataPointer(dataPos, p1, p2);
      }
  };
 
  template<typename T_Data1, typename T_Data2, typename T_Data3>
  struct PointerStore<Chunk3<T_Data1, T_Data2, T_Data3>> {
    public:
 
      using Data1 = CODI_DD(T_Data1, int);  
      using Data2 = CODI_DD(T_Data2, int);  
      using Data3 = CODI_DD(T_Data3, int);  
 
      using Chunk = Chunk3<Data1, Data2, Data3>;  
 
    private:
      Data1* p1;  
      Data2* p2;  
      Data3* p3;  
 
    public:
 
      template<typename FuncObj, typename... Args>
      void call(FuncObj& func, Args&&... args) {
        func(p1, p2, p3, std::forward<Args>(args)...);
      }
 
      template<typename FuncObj, typename... Args>
      void callAndAppend(FuncObj& func, Args&&... args) {
        func(std::forward<Args>(args)..., p1, p2, p3);
      }
 
      template<int selectedDepth, typename Nested, typename... Args>
      CODI_INLINE void callNestedForward(Nested* nested, size_t& start, size_t const& end, Args&&... args) {
        nested->template evaluateForward<selectedDepth>(std::forward<Args>(args)..., start, end, p1, p2, p3);
      }
 
      template<int selectedDepth, typename Nested, typename... Args>
      CODI_INLINE void callNestedReverse(Nested* nested, size_t& start, size_t const& end, Args&&... args) {
        nested->template evaluateReverse<selectedDepth>(std::forward<Args>(args)..., start, end, p1, p2, p3);
      }
 
      void setPointers(size_t const& dataPos, Chunk* chunk) {
        chunk->dataPointer(dataPos, p1, p2, p3);
      }
  };
 
  template<typename T_Data1, typename T_Data2, typename T_Data3, typename T_Data4>
  struct PointerStore<Chunk4<T_Data1, T_Data2, T_Data3, T_Data4>> {
    public:
 
      using Data1 = CODI_DD(T_Data1, int);  
      using Data2 = CODI_DD(T_Data2, int);  
      using Data3 = CODI_DD(T_Data3, int);  
      using Data4 = CODI_DD(T_Data4, int);  
 
      using Chunk = Chunk4<Data1, Data2, Data3, Data4>;  
 
    private:
      Data1* p1;  
      Data2* p2;  
      Data3* p3;  
      Data4* p4;  
 
    public:
 
      template<typename FuncObj, typename... Args>
      void call(FuncObj& func, Args&&... args) {
        func(p1, p2, p3, p4, std::forward<Args>(args)...);
      }
 
      template<typename FuncObj, typename... Args>
      void callAndAppend(FuncObj& func, Args&&... args) {
        func(std::forward<Args>(args)..., p1, p2, p3, p4);
      }
 
      template<int selectedDepth, typename Nested, typename... Args>
      CODI_INLINE void callNestedForward(Nested* nested, size_t& start, size_t const& end, Args&&... args) {
        nested->template evaluateForward<selectedDepth>(std::forward<Args>(args)..., start, end, p1, p2, p3, p4);
      }
 
      template<int selectedDepth, typename Nested, typename... Args>
      CODI_INLINE void callNestedReverse(Nested* nested, size_t& start, size_t const& end, Args&&... args) {
        nested->template evaluateReverse<selectedDepth>(std::forward<Args>(args)..., start, end, p1, p2, p3, p4);
      }
 
      void setPointers(size_t const& dataPos, Chunk* chunk) {
        chunk->dataPointer(dataPos, p1, p2, p3, p4);
      }
  };
 
  template<typename T_Base>
  struct TerminatingPointerStore : public T_Base {
    public:
 
      using Base = CODI_DD(T_Base, CODI_T(PointerStore<ChunkBase>));  
 
      template<int selectedDepth, typename Nested, typename InnerPos, typename FunctionObject, typename... Args>
      CODI_INLINE void callNestedForward(Nested* nested, size_t& start, size_t const& end, InnerPos const&,
                                         InnerPos const&, FunctionObject function, Args&&... args) {
        CODI_UNUSED(nested);
 
        Base::callAndAppend(function, std::forward<Args>(args)..., start, end);
      }
 
      template<int selectedDepth, typename Nested, typename InnerPos, typename FunctionObject, typename... Args>
      CODI_INLINE void callNestedReverse(Nested* nested, size_t& start, size_t const& end, InnerPos const&,
                                         InnerPos const&, FunctionObject function, Args&&... args) {
        CODI_UNUSED(nested);
 
        Base::callAndAppend(function, std::forward<Args>(args)..., start, end);
      }
  };
}