BIFXMLIDWriter_tpl.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2026                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 
#pragma once
 
#include <fstream>
#include <sstream>
 
#include <agrum/ID/io/BIFXML/BIFXMLIDWriter.h>   // to ease IDE parser
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#  include <agrum/ID/io/BIFXML/BIFXMLIDWriter.h>
 
namespace gum {
  /*
   * Default constructor.
   */
  template < GUM_Numeric GUM_SCALAR >
  BIFXMLIDWriter< GUM_SCALAR >::BIFXMLIDWriter() {
    GUM_CONSTRUCTOR(BIFXMLIDWriter);
  }
 
  /*
   * Destructor.
   */
  template < GUM_Numeric GUM_SCALAR >
  BIFXMLIDWriter< GUM_SCALAR >::~BIFXMLIDWriter() {
    GUM_DESTRUCTOR(BIFXMLIDWriter);
  }
 
  /*
   * Writes an influence diagram in the given ouput stream.
   *
   * @param output The output stream.
   * @param infdiag The influence diagram writen in the stream.
   * @throws IOError Raised if an I/O error occurs.
   */
  template < GUM_Numeric GUM_SCALAR >
  void BIFXMLIDWriter< GUM_SCALAR >::write(std::ostream&                         output,
                                           const InfluenceDiagram< GUM_SCALAR >& infdiag) {
    if (!output.good()) { GUM_ERROR(IOError, "Input/Output error : stream not writable.") }
 
    output << _heading_() << std::endl;
    output << "<!-- Variables -->" << std::endl;
 
    for (const auto node: infdiag.nodes()) {
      int nodeType = 1;
 
      if (infdiag.isChanceNode(node)) nodeType = 2;
      else if (infdiag.isUtilityNode(node)) nodeType = 3;
 
      output << _variableBloc_(infdiag.variable(node), nodeType) << std::endl;
    }
 
    output << "<!-- Probability distributions -->" << std::endl;
 
    for (const auto node: infdiag.nodes())
      output << _variableDefinition_(node, infdiag);
 
    output << std::endl;
    output << _documentend_();
    output.flush();
 
    if (output.fail()) { GUM_ERROR(IOError, "Writing in the ostream failed.") }
  }
 
  /*
   * Writes an Influence Diagram in the file referenced by filePath.
   * If the file doesn't exists, it is created.
   * If the file exists, it's content will be erased.
   *
   * @param filePath The path to the file used to write the Influence Diagram.
   * @param infdiag The Influence Diagram writen in the file.
   * @throw IOError Raised if an I/O error occurs.
   */
  template < GUM_Numeric GUM_SCALAR >
  void BIFXMLIDWriter< GUM_SCALAR >::write(std::string_view                      filePath,
                                           const InfluenceDiagram< GUM_SCALAR >& infdiag) {
    std::ofstream output(std::filesystem::path{filePath}, std::ios_base::trunc);
 
    write(output, infdiag);
 
    output.close();
 
    if (output.fail()) { GUM_ERROR(IOError, "Writing in the ostream failed.") }
  }
 
  /*
   * Returns the header of the BIF file.
   */
  template < GUM_Numeric GUM_SCALAR >
  std::string BIFXMLIDWriter< GUM_SCALAR >::_heading_() {
    std::stringstream str;
 
    // Header for every xml
    str << "<?xml version=\"1.0\" ?>" << std::endl;
 
    // Document type definition of BIF 0.3
    /* https://www.cs.cmu.edu/afs/cs/user/fgcozman/www/Research/InterchangeFormat/ */
 
    // BIF version Tag
    str << std::endl << "<BIF VERSION=\"0.3\">" << std::endl;
 
    // Network declaration
    str << "<NETWORK>" << std::endl;
 
    return str.str();
  }
 
  /*
   * Returns a bloc defining a variable in the BIF format.
   */
  template < GUM_Numeric GUM_SCALAR >
  std::string BIFXMLIDWriter< GUM_SCALAR >::_variableBloc_(const DiscreteVariable& var,
                                                           int                     varType) {
    //<VARIABLE TYPE="nature|decision|utility">
    //<NAME>name</NAME>
    //<PROPERTY>description = ...</PROPERTY>
    //<PROPERTY>fast = A[4,5]</PROPERTY>PROPERTY>
    // <!- OUTCOMES are not used but are kept for compatibility->
    //<OUTCOME>outcome1</OUTCOME>
    //<OUTCOME>outcome2</OUTCOME>
    //<PROPERTY>property</PROPERTY>
    //</VARIABLE>
 
    std::stringstream str;
 
    // Declaration of variable and his type
    str << "<VARIABLE TYPE=\"";
 
    switch (varType) {
      case 1 : str << "decision"; break;
 
      case 2 : str << "nature"; break;
 
      case 3 : str << "utility"; break;
 
      default : break;
    }
 
    str << "\">" << std::endl;
 
    // Name and description
    str << std::format("\t<NAME>{}</NAME>\n", var.name());
    str << std::format("\t<PROPERTY>description = {}</PROPERTY>\n", var.description());
    str << std::format("\t<PROPERTY>fast = {}</PROPERTY>\n", var.toFast());
 
    // Outcomes
    str << "<!-- OUTCOME are not used in pyAgrum BIFXML (see fast property) but are kept for "
           "compatibility-->"
        << std::endl;
    for (Idx i = 0; i < var.domainSize(); i++)
      str << std::format("\t<OUTCOME>{}</OUTCOME>\n", var.label(i));
 
    //     //Closing tag
    str << "</VARIABLE>" << std::endl;
 
    return str.str();
  }
 
  /*
   * Returns a bloc defining a variable's CPT in the BIF format.
   */
  template < GUM_Numeric GUM_SCALAR >
  std::string BIFXMLIDWriter< GUM_SCALAR >::_variableDefinition_(
      const NodeId&                         varNodeId,
      const InfluenceDiagram< GUM_SCALAR >& infdiag) {
    //<DEFINITION>
    //<FOR>var</FOR>
    //<GIVEN>conditional var</GIVEN>
    //<TABLE>conditional probabilities</TABLE>
    //</DEFINITION>
    std::stringstream str;
 
    if (!((infdiag.isDecisionNode(varNodeId)) && (infdiag.parents(varNodeId).empty()))) {
      // Declaration
      str << "<DEFINITION>" << std::endl;
 
      // Variable
      str << std::format("\t<FOR>{}</FOR>", infdiag.variable(varNodeId).name());
 
      str << std::format("<!--{} | ", infdiag.variable(varNodeId).name());
      for (const auto n: infdiag.parents(varNodeId))
        str << infdiag.variable(n).name() << ",";
      str << "-->\n";
 
      // Conditional Parents for decision node
      if (infdiag.isDecisionNode(varNodeId)) {
        // finding the parents in the graph
        List< std::string > parentList;
 
        for (const auto par: infdiag.parents(varNodeId))
          parentList.pushBack(infdiag.variable(par).name());
 
        for (auto parentListIte = parentList.rbegin(); parentListIte != parentList.rend();
             --parentListIte)
          str << std::format("\t<GIVEN>{}</GIVEN>\n", *parentListIte);
      } else if (infdiag.isChanceNode(varNodeId))   // finding the parents in the cpt
        for (Idx i = infdiag.cpt(varNodeId).nbrDim(); i > 1;
             i--)                                   // the first dimension is not a parent
          str << std::format("\t<GIVEN>{}</GIVEN>\n",
                             infdiag.cpt(varNodeId).variable(i - 1).name());
      else if (infdiag.isUtilityNode(varNodeId))    // finding the parents in the utility
        for (Idx i = infdiag.utility(varNodeId).nbrDim(); i > 1;
             i--)                                   // the first dimension is not a parent
          str << std::format("\t<GIVEN>{}</GIVEN>\n",
                             infdiag.utility(varNodeId).variable(i - 1).name());
 
 
      if (infdiag.isChanceNode(varNodeId)) {
        Instantiation inst(infdiag.cpt(varNodeId));
        str << "\t<TABLE>";
 
        for (inst.setFirst(); !inst.end(); inst.inc())
          str << infdiag.cpt(varNodeId)[inst] << " ";
 
        str << "</TABLE>" << std::endl;
      } else if (infdiag.isUtilityNode(varNodeId)) {
        // Values
        Instantiation inst(infdiag.utility(varNodeId));
        str << "\t<TABLE>";
 
        for (inst.setFirst(); !inst.end(); inst.inc())
          str << infdiag.utility(varNodeId)[inst] << " ";
 
        str << "</TABLE>" << std::endl;
      }
 
      // Closing tag
      str << "</DEFINITION>" << std::endl;
    }
 
    return str.str();
  }
 
  /*
   * Returns the end of the BIF file.
   */
  template < GUM_Numeric GUM_SCALAR >
  std::string BIFXMLIDWriter< GUM_SCALAR >::_documentend_() {
    std::stringstream str;
 
    str << "</NETWORK>" << std::endl;
    str << "</BIF>" << std::endl;
 
    return str.str();
  }
} /* namespace gum */
 
#endif   // DOXYGEN_SHOULD_SKIP_THIS