tapeReaderWriterInterface.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 "../../expressions/lhsExpressionInterface.hpp"
#include "../../traits/tapeTraits.hpp"
#include "../data/position.hpp"

namespace codi {
  using EvalHandleKey = size_t;  

  enum class FileType {
    Text,
    Binary,
    Graph,
    Math,
    Invalid
  };

  enum class IdentifierType {
    Input,
    Output,
    Temp
  };

  struct WriteInfo {
      size_t numberOfOutputArguments;    
      size_t numberOfActiveArguments;    
      size_t numberOfConstantArguments;  
      std::string stmtExpression;        
      std::string mathRepresentation;  
  };

  template<typename T_Type>
  struct TapeWriterInterface {
      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;  
 
      virtual ~TapeWriterInterface() {};  

      virtual void start(Tape& tape) {
        CODI_UNUSED(tape);
      }

      virtual void writeStatement(Identifier const& curLhsIdentifier, size_t& curJacobianPos,
                                  Real const* const rhsJacobians, Identifier const* const rhsIdentifiers,
                                  Config::ArgumentSize const& nJacobians) {
        CODI_UNUSED(curLhsIdentifier, curJacobianPos, rhsJacobians, rhsIdentifiers, nJacobians);
      }

      virtual void writeStatement(WriteInfo const& info, Identifier const* lhsIdentifiers, Real const* lhsPrimalValues,
                                  Config::ArgumentSize const& nPassiveValues, Identifier const* const rhsIdentifiers,
                                  Real const* const passiveValues, Real const* const constantValues,
                                  EvalHandle stmtEvalHandle) {
        CODI_UNUSED(info, lhsIdentifiers, lhsPrimalValues, nPassiveValues, rhsIdentifiers, passiveValues,
                    constantValues, stmtEvalHandle);
      }

      virtual void writeLowLevelFunction(size_t& curLLFByteDataPos, char* dataPtr, size_t& curLLFInfoDataPos,
                                         Config::LowLevelFunctionToken* const tokenPtr,
                                         Config::LowLevelFunctionDataSize* const dataSizePtr) {
        CODI_UNUSED(curLLFByteDataPos, dataPtr, curLLFInfoDataPos, tokenPtr, dataSizePtr);
      }

      virtual void finish() {}
  };

  template<typename T_Type>
  struct TapeReaderInterface {
      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;                           
 
      virtual ~TapeReaderInterface() {}  

      virtual void readFile(std::string const& name) {
        CODI_UNUSED(name);
      }
 
      virtual Tape& getTape() = 0;  
 
      virtual std::vector<Identifier> const& getInputs() const& = 0;  
 
      virtual std::vector<Identifier> const& getOutputs() const& = 0;  
  };
}