chunk.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 <cstddef>
 
#include "../../config.h"
#include "../../misc/fileIo.hpp"
#include "../../misc/macros.hpp"
 
namespace codi {
 
  struct ChunkBase {
    public:
 
      /*******************************************************************************/
 
      static size_t constexpr EntrySize = CODI_UNDEFINED_VALUE;  
 
      /*******************************************************************************/
 
      template<typename... Data>
      CODI_INLINE void pushData(Data&&... dataEntries);  
 
      template<typename... Pointers>
      CODI_INLINE void dataPointer(size_t const& index,
                                   Pointers*&... pointers);  
 
      virtual void erase(size_t const& start, size_t const& end) = 0;  
 
      /*******************************************************************************/
 
      CODI_INLINE virtual void allocateData() = 0;            
      CODI_INLINE virtual void deleteData() = 0;              
      CODI_INLINE virtual void readData(FileIo& handle) = 0;  
      CODI_INLINE virtual void writeData(FileIo& handle) const = 0;  
 
      /*******************************************************************************/
 
      CODI_INLINE void swap(CODI_IMPLEMENTATION& other);  
 
    protected:
      size_t size;      
      size_t usedSize;  
 
    public:
 
      CODI_INLINE explicit ChunkBase(size_t const& size) : size(size), usedSize(0) {}
 
      CODI_INLINE virtual ~ChunkBase() {}
 
      /*******************************************************************************/
 
      CODI_INLINE size_t getSize() const {
        return size;
      }
 
      CODI_INLINE size_t getUnusedSize() const {
        return size - usedSize;
      }
 
      CODI_INLINE size_t getUsedSize() const {
        return usedSize;
      }
 
      CODI_INLINE void reset() {
        usedSize = 0;
      }
 
      CODI_INLINE void resize(size_t newSize) {
        deleteData();
        size = newSize;
        usedSize = 0;
        allocateData();
      }
 
      CODI_INLINE void setUsedSize(size_t const& usage) {
        usedSize = usage;
      }
 
 
    protected:
 
      CODI_INLINE void swap(ChunkBase& other) {
        std::swap(size, other.size);
        std::swap(usedSize, other.usedSize);
      }
  };
 
  template<typename Data1>
  struct Chunk1 final : public ChunkBase {
    public:
 
      using Base = ChunkBase;  
 
    private:
 
      Data1* data1;
 
    public:
 
      CODI_INLINE Chunk1(size_t const& size) : ChunkBase(size), data1(nullptr) {
        allocateData();
      }
 
      CODI_INLINE ~Chunk1() {
        deleteData();
      }
 
      /*******************************************************************************/
 
      static size_t constexpr EntrySize = sizeof(Data1);  
 
      CODI_INLINE void allocateData() {
        if (nullptr == data1) {
          data1 = new Data1[size];
        }
      }
 
      CODI_INLINE void dataPointer(size_t const& index, Data1*& pointer1) {
        codiAssert(index <= ChunkBase::size);
        pointer1 = &data1[index];
      }
 
      CODI_INLINE void deleteData() {
        if (nullptr != data1) {
          delete[] data1;
          data1 = nullptr;
        }
      }
 
      void erase(size_t const& start, size_t const& end) {
        codiAssert(start <= end);
        codiAssert(start < usedSize);
        codiAssert(end <= usedSize);
 
        if (start != end) {
          for (size_t i = 0; i < usedSize - end; ++i) {
            data1[start + i] = data1[end + i];
          }
          usedSize -= end - start;
        }
      }
 
      CODI_INLINE void pushData(Data1 const& value1) {
        codiAssert(getUnusedSize() != 0);
        data1[usedSize] = value1;
        usedSize += 1;
      }
 
      CODI_INLINE void readData(FileIo& handle) {
        allocateData();
 
        handle.readData(data1, size);
      }
 
      CODI_INLINE void swap(Chunk1<Data1>& other) {
        Base::swap(other);
 
        std::swap(data1, other.data1);
      }
 
      CODI_INLINE void writeData(FileIo& handle) const {
        handle.writeData(data1, size);
      }
 
  };
 
  template<typename Data1, typename Data2>
  struct Chunk2 final : public ChunkBase {
    public:
 
      using Base = ChunkBase;  
 
    private:
 
      Data1* data1;
      Data2* data2;
 
    public:
 
      CODI_INLINE Chunk2(size_t const& size) : ChunkBase(size), data1(nullptr), data2(nullptr) {
        allocateData();
      }
 
      CODI_INLINE ~Chunk2() {
        deleteData();
      }
 
      /*******************************************************************************/
 
      static size_t constexpr EntrySize = sizeof(Data1) + sizeof(Data2);  
 
      CODI_INLINE void allocateData() {
        if (nullptr == data1) {
          data1 = new Data1[size];
        }
 
        if (nullptr == data2) {
          data2 = new Data2[size];
        }
      }
 
      CODI_INLINE void dataPointer(size_t const& index, Data1*& pointer1, Data2*& pointer2) {
        codiAssert(index <= ChunkBase::size);
        pointer1 = &data1[index];
        pointer2 = &data2[index];
      }
 
      CODI_INLINE void deleteData() {
        if (nullptr != data1) {
          delete[] data1;
          data1 = nullptr;
        }
 
        if (nullptr != data2) {
          delete[] data2;
          data2 = nullptr;
        }
      }
 
      void erase(size_t const& start, size_t const& end) {
        codiAssert(start <= end);
        codiAssert(start < usedSize);
        codiAssert(end <= usedSize);
 
        if (start != end) {
          for (size_t i = 0; i < usedSize - end; ++i) {
            data1[start + i] = data1[end + i];
          }
          for (size_t i = 0; i < usedSize - end; ++i) {
            data2[start + i] = data2[end + i];
          }
          usedSize -= end - start;
        }
      }
 
      CODI_INLINE void pushData(Data1 const& value1, Data2 const& value2) {
        codiAssert(getUnusedSize() != 0);
        data1[usedSize] = value1;
        data2[usedSize] = value2;
        usedSize += 1;
      }
 
      CODI_INLINE void readData(FileIo& handle) {
        allocateData();
 
        handle.readData(data1, size);
        handle.readData(data2, size);
      }
 
      CODI_INLINE void swap(Chunk2<Data1, Data2>& other) {
        Base::swap(other);
 
        std::swap(data1, other.data1);
        std::swap(data2, other.data2);
      }
 
      CODI_INLINE void writeData(FileIo& handle) const {
        handle.writeData(data1, size);
        handle.writeData(data2, size);
      }
 
  };
 
  template<typename Data1, typename Data2, typename Data3>
  struct Chunk3 final : public ChunkBase {
    public:
 
      using Base = ChunkBase;  
 
    private:
 
      Data1* data1;
      Data2* data2;
      Data3* data3;
 
    public:
 
      CODI_INLINE Chunk3(size_t const& size) : ChunkBase(size), data1(nullptr), data2(nullptr), data3(nullptr) {
        allocateData();
      }
 
      CODI_INLINE ~Chunk3() {
        deleteData();
      }
 
      /*******************************************************************************/
 
      static size_t constexpr EntrySize =
          sizeof(Data1) + sizeof(Data2) + sizeof(Data3);  
 
      CODI_INLINE void allocateData() {
        if (nullptr == data1) {
          data1 = new Data1[size];
        }
 
        if (nullptr == data2) {
          data2 = new Data2[size];
        }
 
        if (nullptr == data3) {
          data3 = new Data3[size];
        }
      }
 
      CODI_INLINE void dataPointer(size_t const& index, Data1*& pointer1, Data2*& pointer2, Data3*& pointer3) {
        codiAssert(index <= ChunkBase::size);
        pointer1 = &data1[index];
        pointer2 = &data2[index];
        pointer3 = &data3[index];
      }
 
      CODI_INLINE void deleteData() {
        if (nullptr != data1) {
          delete[] data1;
          data1 = nullptr;
        }
 
        if (nullptr != data2) {
          delete[] data2;
          data2 = nullptr;
        }
 
        if (nullptr != data3) {
          delete[] data3;
          data3 = nullptr;
        }
      }
 
      void erase(size_t const& start, size_t const& end) {
        codiAssert(start <= end);
        codiAssert(start < usedSize);
        codiAssert(end <= usedSize);
 
        if (start != end) {
          for (size_t i = 0; i < usedSize - end; ++i) {
            data1[start + i] = data1[end + i];
          }
          for (size_t i = 0; i < usedSize - end; ++i) {
            data2[start + i] = data2[end + i];
          }
          for (size_t i = 0; i < usedSize - end; ++i) {
            data3[start + i] = data3[end + i];
          }
          usedSize -= end - start;
        }
      }
 
      CODI_INLINE void pushData(Data1 const& value1, Data2 const& value2, Data3 const& value3) {
        codiAssert(getUnusedSize() != 0);
        data1[usedSize] = value1;
        data2[usedSize] = value2;
        data3[usedSize] = value3;
        usedSize += 1;
      }
 
      CODI_INLINE void readData(FileIo& handle) {
        allocateData();
 
        handle.readData(data1, size);
        handle.readData(data2, size);
        handle.readData(data3, size);
      }
 
      CODI_INLINE void swap(Chunk3<Data1, Data2, Data3>& other) {
        Base::swap(other);
 
        std::swap(data1, other.data1);
        std::swap(data2, other.data2);
        std::swap(data3, other.data3);
      }
 
      CODI_INLINE void writeData(FileIo& handle) const {
        handle.writeData(data1, size);
        handle.writeData(data2, size);
        handle.writeData(data3, size);
      }
 
  };
 
  template<typename Data1, typename Data2, typename Data3, typename Data4>
  struct Chunk4 final : public ChunkBase {
    public:
 
      using Base = ChunkBase;  
 
    private:
 
      Data1* data1;
      Data2* data2;
      Data3* data3;
      Data4* data4;
 
    public:
 
      CODI_INLINE Chunk4(size_t const& size)
          : ChunkBase(size), data1(nullptr), data2(nullptr), data3(nullptr), data4(nullptr) {
        allocateData();
      }
 
      CODI_INLINE ~Chunk4() {
        deleteData();
      }
 
      /*******************************************************************************/
 
      static size_t constexpr EntrySize =
          sizeof(Data1) + sizeof(Data2) + sizeof(Data3) + sizeof(Data4);  
 
      CODI_INLINE void allocateData() {
        if (nullptr == data1) {
          data1 = new Data1[size];
        }
 
        if (nullptr == data2) {
          data2 = new Data2[size];
        }
 
        if (nullptr == data3) {
          data3 = new Data3[size];
        }
 
        if (nullptr == data4) {
          data4 = new Data4[size];
        }
      }
 
      CODI_INLINE void dataPointer(size_t const& index, Data1*& pointer1, Data2*& pointer2, Data3*& pointer3,
                                   Data4*& pointer4) {
        codiAssert(index <= ChunkBase::size);
        pointer1 = &data1[index];
        pointer2 = &data2[index];
        pointer3 = &data3[index];
        pointer4 = &data4[index];
      }
 
      CODI_INLINE void deleteData() {
        if (nullptr != data1) {
          delete[] data1;
          data1 = nullptr;
        }
 
        if (nullptr != data2) {
          delete[] data2;
          data2 = nullptr;
        }
 
        if (nullptr != data3) {
          delete[] data3;
          data3 = nullptr;
        }
 
        if (nullptr != data4) {
          delete[] data4;
          data4 = nullptr;
        }
      }
 
      void erase(size_t const& start, size_t const& end) {
        codiAssert(start <= end);
        codiAssert(start < usedSize);
        codiAssert(end <= usedSize);
 
        if (start != end) {
          for (size_t i = 0; i < usedSize - end; ++i) {
            data1[start + i] = data1[end + i];
          }
          for (size_t i = 0; i < usedSize - end; ++i) {
            data2[start + i] = data2[end + i];
          }
          for (size_t i = 0; i < usedSize - end; ++i) {
            data3[start + i] = data3[end + i];
          }
          for (size_t i = 0; i < usedSize - end; ++i) {
            data4[start + i] = data4[end + i];
          }
          usedSize -= end - start;
        }
      }
 
      CODI_INLINE void pushData(Data1 const& value1, Data2 const& value2, Data3 const& value3, Data4 const& value4) {
        codiAssert(getUnusedSize() != 0);
        data1[usedSize] = value1;
        data2[usedSize] = value2;
        data3[usedSize] = value3;
        data4[usedSize] = value4;
        usedSize += 1;
      }
 
      CODI_INLINE void readData(FileIo& handle) {
        allocateData();
 
        handle.readData(data1, size);
        handle.readData(data2, size);
        handle.readData(data3, size);
        handle.readData(data4, size);
      }
 
      CODI_INLINE void swap(Chunk4<Data1, Data2, Data3, Data4>& other) {
        Base::swap(other);
 
        std::swap(data1, other.data1);
        std::swap(data2, other.data2);
        std::swap(data3, other.data3);
        std::swap(data4, other.data4);
      }
 
      CODI_INLINE void writeData(FileIo& handle) const {
        handle.writeData(data1, size);
        handle.writeData(data2, size);
        handle.writeData(data3, size);
        handle.writeData(data4, size);
      }
 
  };
 
}