graphWriters.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 "../../traits/tapeTraits.hpp"
#include "commonReaderWriterBase.hpp"

namespace codi {
  template<typename T_Type>
  struct JacobianGraphTapeWriter : public CommonTextTapeWriter<T_Type> {
      using Type = CODI_DD(T_Type, CODI_DEFAULT_LHS_EXPRESSION);  
      using Base = CommonTextTapeWriter<T_Type>;                  
 
      using Tape = typename Type::Tape;              
      using Identifier = typename Type::Identifier;  
      using Real = typename Type::Real;              
 
      bool printJacobians;  

      JacobianGraphTapeWriter(std::string const& name, std::vector<Identifier> const& in,
                              std::vector<Identifier> const& out, bool ifJacobians)
          : Base(true, name, in, out), printJacobians(ifJacobians) {};

      void writeStatement(Identifier const& curLhsIdentifier, size_t& curJacobianPos, Real const* const rhsJacobians,
                          Identifier const* const rhsIdentifiers, Config::ArgumentSize const& nJacobians) {
        std::string node;
        if (nJacobians == Config::StatementInputTag) CODI_Unlikely {
          // Do nothing.
        } else CODI_Likely {
          //  Ensure that the all the rhsIdentifiers have been added before connecting edges to them.
          Base::placeUnusedRhsNodes(&rhsIdentifiers[curJacobianPos], nJacobians);
 
          // Add the curLhsIdentifier node.
          std::string to = Base::createNode(1, &curLhsIdentifier, "");
 
          // Loop through rhsIdentifiers and create the edges. The this->identifierExtensions is used to find the
          // current extension for each of the rhsIdentifiers.
          for (size_t argCount = 0; argCount < nJacobians; argCount++) {
            std::string labelText = "";
            if (printJacobians) {
              labelText = std::to_string(rhsJacobians[curJacobianPos + argCount]);
            }
            Base::createEdge(rhsIdentifiers[curJacobianPos + argCount], to, labelText);
          }
 
          Base::updateLhsIdentifiers(1, &curLhsIdentifier);
        }
      }
  };

  template<typename T_Type>
  struct PrimalGraphTapeWriter : public CommonTextTapeWriter<T_Type> {
      using Type = CODI_DD(T_Type, CODI_DEFAULT_LHS_EXPRESSION);  
      using Base = CommonTextTapeWriter<T_Type>;                  
 
      using Tape = typename Type::Tape;              
      using Identifier = typename Type::Identifier;  
      using Real = typename Type::Real;              
      using EvalHandle = typename Tape::EvalHandle;  

      PrimalGraphTapeWriter(std::string const& name, std::vector<Identifier> const& in,
                            std::vector<Identifier> const& out)
          : Base(true, name, in, out) {};

      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) {
        CODI_UNUSED(primalValues, passiveValues, constantValues, stmtEvalHandle);
 
        std::string node;
        if (nPassiveValues == Config::StatementInputTag) CODI_Unlikely {
          // Do nothing.
        } else CODI_Likely {
          //  Ensure that the all the rhsIdentifiers have been added before connecting edges to them. The mathRep string
          //  is also modified to include the identifier and value.
          Base::placeUnusedRhsNodes(rhsIdentifiers, info.numberOfActiveArguments);
 
          // The mathRep string is modified to include the identifier and value.
          std::string mathRep =
              Base::modifyMathRep(info.mathRepresentation, rhsIdentifiers, info.numberOfActiveArguments);
          // Add the curLhsIdentifier node.
          std::string lhsNodeName = Base::createNode(info.numberOfOutputArguments, lhsIdentifiers, mathRep);
 
          // Loop through rhsIdentifiers and create the edges. The identifierExtensions is used to find the current
          // extension for each of the rhsIdentifiers.
          for (size_t argCount = 0; argCount < info.numberOfActiveArguments; argCount++) {
            Base::createEdge(rhsIdentifiers[argCount], lhsNodeName);
          }
 
          // Only record the increased extension after recording the edges. This ensure that if the lhs equals the rhs,
          // that it results in two unique nodes.
          Base::updateLhsIdentifiers(info.numberOfOutputArguments, lhsIdentifiers);
        }
      }
  };
}