byteDataView.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 <algorithm>
#include <vector>
 
#include "../config.h"
#include "macros.hpp"

namespace codi {

  struct ByteDataView {
    private:
 
      char* pointer;  
      size_t pos;     
 
      size_t start;  
      size_t end;    
 
    public:

      CODI_INLINE ByteDataView() = default;

      CODI_INLINE ByteDataView(char* pointer, size_t pos, size_t end)
          : pointer(pointer), pos(pos), start(pos), end(end) {
        codiAssert(pos <= end);
      }

      CODI_INLINE size_t getEnd() {
        return end;
      }

      CODI_INLINE size_t getPosition() {
        return pos;
      }

      CODI_INLINE size_t getStart() {
        return start;
      }

      CODI_INLINE void init(char* pointer, size_t pos, size_t end) {
        this->pointer = pointer;
        this->pos = pos;
        this->start = pos;
        this->end = end;
 
        codiAssert(pos <= end);
      }

      template<typename T>
      CODI_INLINE T* read(size_t size) {
        T* convPointer = cast<T>();
        pos += sizeof(T) * size;
 
        codiAssert(pos <= end);
 
        return convPointer;
      }

      template<typename T>
      CODI_INLINE T read() {
        return read<T>(1)[0];
      }

      template<typename T>
      CODI_INLINE T* reserve(size_t size) {
        T* convPointer = cast<T>();
        pos += sizeof(T) * size;
 
        codiAssert(pos <= end);
 
        return convPointer;
      }

      CODI_INLINE void reset() {
        pos = start;
      }

      template<typename T>
      CODI_INLINE T* write(T const& data) {
        return write(&data, 1);
      }

      template<typename T>
      CODI_INLINE T* write(T const* data, size_t size) {
        T* convPointer = cast<T>();
        for (size_t i = 0; i < size; i += 1) {
          convPointer[i] = data[i];
        }
        pos += sizeof(T) * size;
 
        codiAssert(pos <= end);
 
        return convPointer;
      }
 
    private:
 
      template<typename T>
      CODI_INLINE T* cast() {
        return reinterpret_cast<T*>(&pointer[pos]);
      }
  };
 
}