primalBinaryReaderWriter.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 "../../config.h"
#include "primalBaseReaderWriter.hpp"

namespace codi {
  template<typename T_Type>
  struct PrimalBinaryTapeWriter : public PrimalBaseTapeWriter<T_Type> {
      using Type = CODI_DD(T_Type, CODI_DEFAULT_LHS_EXPRESSION);  
      using Tape = typename Type::Tape;                           
 
      using Identifier = typename Type::Identifier;  
      using Real = typename Type::Real;              
      using EvalHandle = typename Tape::EvalHandle;  
 
      FILE* fileHandleBin = nullptr;  

      PrimalBinaryTapeWriter(std::string const& name, std::vector<Identifier> const& in,
                             std::vector<Identifier> const& out)
          : PrimalBaseTapeWriter<T_Type>(name, in, out) {};

      void start(Tape& tape) {
        if (Tape::TapeTypes::IsStaticIndexHandler) {
          printPrimals(tape);
        }
 
        this->printIoBinary(tape);
        this->openFile(fileHandleBin, this->fileName, "wb");
      }

      void writeStatement(WriteInfo const& info, Identifier const* lhsIdentifiers, Real const* primalValues,
                          Config::ArgumentSize const& nPassiveValues, Identifier const* const rhsIdentifiers,
                          Real const* const passiveValues, Real const* const constantValues,
                          EvalHandle stmtEvalHandle) {
        fwrite(&info.numberOfOutputArguments, sizeof(Config::ArgumentSize), 1, fileHandleBin);
        fwrite(lhsIdentifiers, sizeof(Identifier), info.numberOfOutputArguments, fileHandleBin);
        fwrite(primalValues, sizeof(Real), info.numberOfOutputArguments, fileHandleBin);
        fwrite(&nPassiveValues, sizeof(Config::ArgumentSize), 1, fileHandleBin);
 
        if (nPassiveValues == Config::StatementInputTag) CODI_Unlikely {
          // Do nothing.
        } else CODI_Likely {
          fwrite(&info.numberOfActiveArguments, sizeof(Config::ArgumentSize), 1, fileHandleBin);
          fwrite(rhsIdentifiers, sizeof(Identifier), info.numberOfActiveArguments, fileHandleBin);
          fwrite(passiveValues, sizeof(Real), nPassiveValues, fileHandleBin);
          fwrite(&info.numberOfConstantArguments, sizeof(Config::ArgumentSize), 1, fileHandleBin);
          fwrite(constantValues, sizeof(Real), info.numberOfConstantArguments, fileHandleBin);
        }
        // Register the statement expression (in the form of a string) for the evalHandleKey.
 
        size_t evalHandleIndex = this->getEvalHandleIndex(stmtEvalHandle, info.stmtExpression);
        fwrite(&evalHandleIndex, sizeof(size_t), 1, fileHandleBin);
      }

      void printPrimals(Tape& tape) {
        FILE* filePrimalBin = nullptr;
        size_t nPrimals = tape.getParameter(TapeParameters::PrimalSize);
 
        std::string fileNamePrimals = this->modifyFileName("Primals.dat");
 
        this->openFile(filePrimalBin, fileNamePrimals, "wb");
 
        // Print out the primals in a sparse vector representation.
        fwrite(&nPrimals, sizeof(size_t), 1, filePrimalBin);
        for (size_t indexCounter = 0; indexCounter < nPrimals; indexCounter++) {
          Real const curPrimal = tape.getPrimal(indexCounter);
          if (curPrimal != 0) {
            fwrite(&indexCounter, sizeof(Identifier), 1, filePrimalBin);
            fwrite(&curPrimal, sizeof(Real), 1, filePrimalBin);
          }
        }
 
        fclose(filePrimalBin);
      }

      void finish() {
        // Generate the handleCreator .hpp file.
        this->generateHandleCreatorFile();
 
        fclose(fileHandleBin);
      }
  };

  template<typename T_Type>
  struct PrimalBinaryTapeReader : public CommonBaseTapeReader<T_Type> {
      using Type = CODI_DD(T_Type, CODI_DEFAULT_LHS_EXPRESSION);  
      using Tape = typename Type::Tape;                           
      using Identifier = typename Type::Identifier;               
      using Real = typename Type::Real;                           
 
      std::vector<typename Tape::EvalHandle> evalHandles;  
      PrimalBinaryTapeReader(std::vector<typename Tape::EvalHandle> const& handles)
          : CommonBaseTapeReader<T_Type>(), evalHandles(handles) {}

      void readFile(std::string const& name) {
        FILE* fileHandleReadBin = nullptr;
 
        Config::ArgumentSize nOutputValues;
        std::vector<Identifier> lhsIdentifiers(Config::MaxArgumentSize, 0);
        std::vector<Real> primalValues(Config::MaxArgumentSize, 0.0);
        Config::ArgumentSize nPassiveValues;
        Config::ArgumentSize nActiveValues;
        std::vector<Identifier> rhsIdentifiers(Config::MaxArgumentSize, 0);
        std::vector<Real> rhsPrimalValues(Config::MaxArgumentSize, 0.0);
        Config::ArgumentSize nConstants;
        std::vector<Real> constants(Config::MaxArgumentSize, 0);
 
        EvalHandleKey evalHandleKey;
        this->fileName = name;
 
        // Restore IO and the primal vector, if the tape is a reuseType.
        this->restoreIoBinary();
        this->tape.getIndexManager().updateLargestCreatedIndex(this->largestIndex);
 
        if (Tape::TapeTypes::IsStaticIndexHandler) {
          restorePrimals();
        }
 
        this->openFile(fileHandleReadBin, this->fileName, "rb");
 
        while (fread(&nOutputValues, sizeof(Config::ArgumentSize), 1, fileHandleReadBin) == 1) {
          fread(lhsIdentifiers.data(), sizeof(Identifier), nOutputValues, fileHandleReadBin);
          fread(primalValues.data(), sizeof(Real), nOutputValues, fileHandleReadBin);
          fread(&nPassiveValues, sizeof(Config::ArgumentSize), 1, fileHandleReadBin);
 
          if (nPassiveValues == Config::StatementLowLevelFunctionTag) CODI_Unlikely {
            // TODO.
          } else if (nPassiveValues == Config::StatementInputTag) CODI_Unlikely {
            // Do nothing.
          } else CODI_Likely {
            fread(&nActiveValues, sizeof(Config::ArgumentSize), 1, fileHandleReadBin);
            fread(rhsIdentifiers.data(), sizeof(Identifier), nActiveValues, fileHandleReadBin);
            fread(rhsPrimalValues.data(), sizeof(Real), nPassiveValues, fileHandleReadBin);
            fread(&nConstants, sizeof(Config::ArgumentSize), 1, fileHandleReadBin);
            fread(constants.data(), sizeof(Real), nConstants, fileHandleReadBin);
          }
 
          fread(&evalHandleKey, sizeof(EvalHandleKey), 1, fileHandleReadBin);
          this->tape.createStatementManual(nOutputValues, lhsIdentifiers.data(), primalValues.data(), nActiveValues,
                                           rhsIdentifiers.data(), nPassiveValues, rhsPrimalValues.data(), nConstants,
                                           constants.data(), evalHandles[evalHandleKey]);
        }
 
        fclose(fileHandleReadBin);
      }

      void restorePrimals() {
        FILE* filePrimalBin = nullptr;
 
        size_t nPrimals;
        Identifier curIdentifier;
        Real curPrimal;
 
        this->openFile(filePrimalBin, this->modifyFileName("Primals.dat"), "rb");
 
        // Restore the primal vector from a sparse vector.
        fread(&nPrimals, sizeof(size_t), 1, filePrimalBin);
        // Resize the primal vector.
        this->tape.setParameter(TapeParameters::PrimalSize, nPrimals);
 
        while (fread(&curIdentifier, sizeof(Identifier), 1, filePrimalBin) == 1) {
          fread(&curPrimal, sizeof(Real), 1, filePrimalBin);
          this->tape.setPrimal(curIdentifier, curPrimal);
        }
      }
  };
}