BIFXMLBNWriter_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 <agrum/BN/io/BIFXML/BIFXMLBNWriter.h>   // to ease IDE parser
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#  include <agrum/BN/io/BIFXML/BIFXMLBNWriter.h>
 
namespace gum {
  /*
   * Default constructor.
   */
  template < GUM_Numeric GUM_SCALAR >
  BIFXMLBNWriter< GUM_SCALAR >::BIFXMLBNWriter() {
    GUM_CONSTRUCTOR(BIFXMLBNWriter);
  }
 
  /*
   * Destructor.
   */
  template < GUM_Numeric GUM_SCALAR >
  BIFXMLBNWriter< GUM_SCALAR >::~BIFXMLBNWriter() {
    GUM_DESTRUCTOR(BIFXMLBNWriter);
  }
 
  /*
   * Writes a bayes net in the given ouput stream.
   *
   * @param output The output stream.
   * @param bn The bayes net writen in the stream.
   * @throws IOError Raised if an I/O error occurs.
   */
  template < GUM_Numeric GUM_SCALAR >
  void BIFXMLBNWriter< GUM_SCALAR >::_doWrite(std::ostream&                  output,
                                              const IBayesNet< GUM_SCALAR >& bn) {
    if (!output.good()) { GUM_ERROR(IOError, "Input/Output error : stream not writable.") }
 
    output << _heading_(bn) << std::endl;
 
    output << "<!-- Variables -->" << std::endl;
 
    for (auto node: bn.nodes())
      output << _variableBloc_(bn.variable(node)) << std::endl;
 
    output << "<!-- Probability distributions -->" << std::endl;
 
    for (auto node: bn.nodes())
      output << _variableDefinition_(node, bn);
 
    output << std::endl;
 
    output << _documentend_();
 
    output.flush();
 
    if (output.fail()) { GUM_ERROR(IOError, "Writing in the ostream failed.") }
  }
 
  /*
   * Writes a bayes net 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 bayes net.
   * @param bn The bayes net writen in the file.
   * @throw IOError Raised if an I/O error occurs.
   */
  template < GUM_Numeric GUM_SCALAR >
  void BIFXMLBNWriter< GUM_SCALAR >::_doWrite(std::string_view               filePath,
                                              const IBayesNet< GUM_SCALAR >& bn) {
    std::ofstream output(std::filesystem::path{filePath}, std::ios_base::trunc);
 
    _doWrite(output, bn);
 
    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 BIFXMLBNWriter< GUM_SCALAR >::_heading_(const IBayesNet< GUM_SCALAR >& bn) {
    std::stringstream str;
 
    // Header for every xml
    str << "<?xml version=\"1.0\" ?>" << std::endl;
 
    // Document type definition of BIF 0.3
    /*str << "<!-- DTD for the XMLBIF 0.3 format -->" << std::endl;
    str << "<!DOCTYPE BIF [" << std::endl;
    str << "\t<!ELEMENT BIF ( NETWORK )*>" << std::endl;
    str << "\t\t<!ATTLIST BIF VERSION CDATA #REQUIRED>" << std::endl;
    str << "\t<!ELEMENT NETWORK ( NAME, ( PROPERTY | VARIABLE | DEFINITION )*
    )>" <<
    std::endl;
    str << "\t<!ELEMENT NAME (#PCDATA)>" << std::endl;
    str << "\t<!ELEMENT VARIABLE ( NAME, ( OUTCOME |  PROPERTY )* ) >" <<
    std::endl;
    str << "\t\t<!ATTLIST VARIABLE TYPE (nature|decision|utility) \"nature\">"
    <<
    std::endl;
    str << "\t<!ELEMENT OUTCOME (#PCDATA)>" << std::endl;
    str << "\t<!ELEMENT DEFINITION ( FOR | GIVEN | TABLE | PROPERTY )* >" <<
    std::endl;
    str << "\t<!ELEMENT FOR (#PCDATA)>" << std::endl;
    str << "\t<!ELEMENT GIVEN (#PCDATA)>" << std::endl;
    str << "\t<!ELEMENT TABLE (#PCDATA)>" << std::endl;
    str << "\t<!ELEMENT PROPERTY (#PCDATA)>" << std::endl;
    str << "]>" << std::endl;*/
 
    // BIF version Tag
    str << std::endl << "<BIF VERSION=\"0.3\">" << std::endl;
 
    // Network declaration
    str << "<NETWORK>" << std::endl;
    str << std::format("<NAME>{}</NAME>\n", bn.propertyWithDefault("name", "unnamedBN"));
    str << "<PROPERTY>software aGrUM</PROPERTY>" << std::endl;
 
    return str.str();
  }
 
  /*
   * Returns a bloc defining a variable in the BIF format.
   */
  template < GUM_Numeric GUM_SCALAR >
  std::string BIFXMLBNWriter< GUM_SCALAR >::_variableBloc_(const DiscreteVariable& var) {
    //<VARIABLE TYPE="nature|decision|utility">
    //<NAME>name</NAME>
    //<PROPERTY>description = ...</PROPERTY>
    //<PROPERTY>fast = A[4,5]</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=\"nature\">" << 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
      BIFXMLBNWriter< GUM_SCALAR >::_variableDefinition_(const NodeId&                  varNodeId,
                                                         const IBayesNet< GUM_SCALAR >& bn) {
    //<DEFINITION>
    //<FOR>var</FOR>
    //<GIVEN>conditional var</GIVEN>
    //<TABLE>conditional probabilities</TABLE>
    //</DEFINITION>
    std::stringstream str;
 
    // Declaration
    str << "<DEFINITION>" << std::endl;
 
    // Variable
    str << std::format("\t<FOR>{}</FOR>\n", bn.variable(varNodeId).name());
 
    // Table
    // For historical reason, the code is not the same betwen bIXML for BN and
    // for ID
    // ...
    const Tensor< GUM_SCALAR >& cpt = bn.cpt(varNodeId);
 
    // Conditional Parents
    for (Idx i = 1; i < cpt.nbrDim(); i++)
      str << std::format("\t<GIVEN>{}</GIVEN>\n", cpt.variable(i).name());
 
    Instantiation inst;
    inst << cpt.variable(0);
 
    for (Idx i = cpt.nbrDim() - 1; i > 0; i--)
      inst << cpt.variable(i);
 
    str << "\t<TABLE>";
 
    for (inst.setFirst(); !inst.end(); inst.inc()) {
      if (inst.val(0) == 0) str << std::endl << "\t\t";
      else str << " ";
 
      str << cpt[inst];
    }
 
    str << std::endl << "\t</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 BIFXMLBNWriter< GUM_SCALAR >::_documentend_() {
    std::stringstream str;
 
    str << "</NETWORK>" << std::endl;
    str << "</BIF>" << std::endl;
 
    return str.str();
  }
} /* namespace gum */
 
#endif   // DOXYGEN_SHOULD_SKIP_THIS