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

namespace codi {
  template<typename T_Type>
  struct JacobianTextTapeWriter : public CommonBaseTapeWriter<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;                           
 
      FILE* fileHandleTxt = nullptr;  
      Tape* tape = nullptr;           
 
      bool printIO;                      
      bool printColumnNames;             
      bool printInputStatements = true;  

      JacobianTextTapeWriter(std::string const& name, std::vector<Identifier> const& in,
                             std::vector<Identifier> const& out, bool ifIO, bool ifColumnNames)
          : CommonBaseTapeWriter<T_Type>(name, in, out), printIO(ifIO), printColumnNames(ifColumnNames) {};

      void setInputStatementOutput(bool value) {
        printInputStatements = value;
      }

      void start(Tape& tape) {
        this->tape = &tape;
        if (printIO) {
          this->printIoText(tape);
        }
 
        this->openFile(fileHandleTxt, this->fileName, "w");
        if (printColumnNames) {
          fprintf(fileHandleTxt, "|  LHS Index  |  # of Args  |  RHS Indices  | RHS Jacobian Values |");
        }
      }

      void writeStatement(Identifier const& curLhsIdentifier, size_t& curJacobianPos, Real const* const rhsJacobians,
                          Identifier const* const rhsIdentifiers, Config::ArgumentSize const& nJacobians) {
        if (nJacobians == Config::StatementInputTag) CODI_Unlikely {
          if (printInputStatements) {
            fprintf(fileHandleTxt, "\n%d  %hhu  []", curLhsIdentifier, static_cast<Config::ArgumentSize>(nJacobians));
          }
        } else CODI_Likely {
          fprintf(fileHandleTxt, "\n%d  %hhu  [", curLhsIdentifier, static_cast<Config::ArgumentSize>(nJacobians));
 
          for (size_t argCount = 0; argCount < nJacobians; argCount++) {
            fprintf(fileHandleTxt, " %d ", rhsIdentifiers[curJacobianPos + argCount]);
          }
 
          fprintf(fileHandleTxt, "]  [");
          for (size_t argCount = 0; argCount < nJacobians; argCount++) {
            fprintf(fileHandleTxt, " %0.12e ", rhsJacobians[curJacobianPos + argCount]);
          }
 
          fprintf(fileHandleTxt, "]");
        }
      }

      void writeLowLevelFunction(LowLevelFunctionEntry<Tape, Real, Identifier> const* func, ByteDataView& data) {
        std::vector<Identifier> inputs;
        std::vector<Identifier> outputs;
 
        func->template call<LowLevelFunctionEntryCallKind::IterateInputs>(tape, data, addIdentifier, &inputs);
        data.reset();
        func->template call<LowLevelFunctionEntryCallKind::IterateOutputs>(tape, data, addIdentifier, &outputs);
 
        fprintf(fileHandleTxt, "\n%d [", (int)outputs.size());
        for (size_t i = 0; i < outputs.size(); i += 1) {
          fprintf(fileHandleTxt, " %d ", outputs[i]);
        }
        fprintf(fileHandleTxt, "] %d [", (int)inputs.size());
        for (size_t i = 0; i < inputs.size(); i += 1) {
          fprintf(fileHandleTxt, " %d ", inputs[i]);
        }
        fprintf(fileHandleTxt, "]");
      }

      void finish() {
        fclose(fileHandleTxt);
      }
 
    private:
      static void addIdentifier(Identifier* id, void* userData) {
        std::vector<Identifier>* vec = (std::vector<Identifier>*)userData;
        vec->push_back(*id);
      }
  };

  template<typename T_Type>
  struct JacobianTextTapeReader : public JacobianBaseTapeReader<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;                           
 
      JacobianTextTapeReader() : JacobianBaseTapeReader<T_Type>() {}  

      void readFile(std::string const& name) {
        FILE* fileHandleReadTxt = nullptr;
 
        bool isFirstIdentifier = true;
        Identifier lowestIndex = 0;
 
        Identifier lhsIdentifier;
        Config::ArgumentSize nArgs;
 
        std::vector<Identifier> rhsIdentifiers(Config::MaxArgumentSize, 0);
        std::vector<Real> rhsJacobians(Config::MaxArgumentSize, 0);
        this->fileName = name;
 
        this->restoreIoText();
        this->tape.getIndexManager().updateLargestCreatedIndex(this->largestIndex);
 
        this->openFile(fileHandleReadTxt, this->fileName, "r+");
 
        // Read and discard column titles.
        fscanf(fileHandleReadTxt, "|  LHS Index  |  # of Args  |  RHS Indices  | RHS Jacobian Values |");
 
        // Read the statements.
        while (fscanf(fileHandleReadTxt, "\n%d  ", &lhsIdentifier) == 1) {
          int next = getc(fileHandleReadTxt);
          if (next == '[') {
            CODI_EXCEPTION("Can not read tape files with low level functions.");
          }
          ungetc(next, fileHandleReadTxt);
 
          fscanf(fileHandleReadTxt, "%hhu  [", &nArgs);
          if (nArgs == Config::StatementLowLevelFunctionTag) CODI_Unlikely {
            // Will throw in previous if.
          } else if (nArgs == Config::StatementInputTag) CODI_Unlikely {
            // Do nothing.
          } else CODI_Likely {
            for (size_t argumentCount = 0; argumentCount < nArgs; argumentCount++) {
              fscanf(fileHandleReadTxt, " %d ", &rhsIdentifiers[argumentCount]);
            }
            fscanf(fileHandleReadTxt, "]  [");
            for (size_t argumentCount = 0; argumentCount < nArgs; argumentCount++) {
              fscanf(fileHandleReadTxt, " %lf ", &rhsJacobians[argumentCount]);
            }
          }
          fscanf(fileHandleReadTxt, "]");
 
          this->registerStatement(lhsIdentifier, nArgs, rhsIdentifiers, rhsJacobians, lowestIndex, isFirstIdentifier);
        }
 
        /* Update the user provided IO with a potential offset in the linear case. The registerStatement() returns
           the offset.*/
        this->updateUserIO(lowestIndex);
 
        fclose(fileHandleReadTxt);
      }
  };
}