BIFWriter_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/BIF/BIFWriter.h>   // to ease IDE parser
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#  include <agrum/agrum.h>
 
// to ease parsing in IDE
#  include <agrum/BN/io/BIF/BIFWriter.h>
 
namespace gum {
 
  /* =========================================================================*/
  /* ===                           GUM_BIF_WRITER                         === */
  /* =========================================================================*/
  // Default constructor.
  template < GUM_Numeric GUM_SCALAR >
  BIFWriter< GUM_SCALAR >::BIFWriter() {
    GUM_CONSTRUCTOR(BIFWriter);
  }
 
  // Default destructor.
  template < GUM_Numeric GUM_SCALAR >
  BIFWriter< GUM_SCALAR >::~BIFWriter() {
    GUM_DESTRUCTOR(BIFWriter);
  }
 
  //
  // Writes a Bayesian network in the output stream using the BIF format.
  //
  // @param ouput The output stream.
  // @param bn The Bayesian network writen in output.
  // @throws Raised if an I/O error occurs.
  template < GUM_Numeric GUM_SCALAR >
  void BIFWriter< GUM_SCALAR >::_doWrite(std::ostream& output, const IBayesNet< GUM_SCALAR >& bn) {
    if (!output.good()) { GUM_ERROR(IOError, "Input/Output error : stream not writable.") }
 
    output << _header_(bn) << std::endl;
 
    for (const auto node: bn.nodes()) {
      output << _variableBloc_(bn.variable(node)) << std::endl;
    }
 
    for (const auto node: bn.nodes()) {
      const Tensor< GUM_SCALAR >& proba = bn.cpt(node);
      output << _variableCPT_(proba);
    }
 
    output << std::endl;
 
    output.flush();
 
    if (output.fail()) { GUM_ERROR(IOError, "Writing in the ostream failed.") }
  }
 
  // Writes a Bayesian network in the referenced file using the BIF format.
  // 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 Bayesian network.
  // @param bn The Bayesian network writed in the file.
  // @throws Raised if an I/O error occurs.
  template < GUM_Numeric GUM_SCALAR >
  void BIFWriter< 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 a bloc defining a variable's CPT in the BIF format.
  template < GUM_Numeric GUM_SCALAR >
  std::string BIFWriter< GUM_SCALAR >::_variableCPT_(const Tensor< GUM_SCALAR >& cpt) {
    std::stringstream str;
    std::string       tab = "   ";   // poor tabulation
 
    if (cpt.nbrDim() == 1) {
      Instantiation inst(cpt);
      str << std::format("probability ({}) {{\n",
                         this->_onlyValidCharsInName(cpt.variable(0).name()));
      str << tab << "table";
 
      for (inst.setFirst(); !inst.end(); ++inst) {
        str << std::format(" {}", cpt[inst]);
      }
 
      str << ";" << std::endl << "}" << std::endl;
    } else if (cpt.domainSize() > 1) {
      Instantiation inst(cpt);
      Instantiation condVars;   // Instantiation on the conditioning variables
      const Sequence< const DiscreteVariable* >& varsSeq = cpt.variablesSequence();
      str << std::format("probability ({} | ",
                         this->_onlyValidCharsInName((varsSeq[(Idx)0])->name()));
 
      for (Idx i = 1; i < varsSeq.size(); i++) {
        if (i > 1) str << ", ";
        str << this->_onlyValidCharsInName(varsSeq[i]->name());
        condVars << *(varsSeq[i]);
      }
      str << ") {" << std::endl;
 
      for (inst.setFirstIn(condVars); !inst.end(); inst.incIn(condVars)) {
        str << std::format("{}({})", tab, _variablesLabels_(varsSeq, inst));
        // Writing the probabilities of the variable
 
        for (inst.setFirstOut(condVars); !inst.end(); inst.incOut(condVars)) {
          str << std::format(" {}", cpt[inst]);
        }
 
        str << ";" << std::endl;
 
        inst.unsetOverflow();
      }
 
      str << "}" << std::endl;
    }
 
    return str.str();
  }
 
  // Returns the header of the BIF file.
  template < GUM_Numeric GUM_SCALAR >
  std::string BIFWriter< GUM_SCALAR >::_header_(const IBayesNet< GUM_SCALAR >& bn) {
    std::stringstream str;
    std::string       tab = "   ";   // poor tabulation
    str << std::format("network \"{}\" {{\n", bn.propertyWithDefault("name", "unnamedBN"));
    str << std::format("// written by aGrUM {}\n", GUM_VERSION);
    str << "}" << std::endl;
    return str.str();
  }
 
  // Returns a bloc defining a variable in the BIF format.
  template < GUM_Numeric GUM_SCALAR >
  std::string BIFWriter< GUM_SCALAR >::_variableBloc_(const DiscreteVariable& var) {
    std::stringstream str;
    std::string       tab = "   ";   // poor tabulation
    str << std::format("variable {} {{\n", this->_onlyValidCharsInName(var.name()));
    str << std::format("{}type discrete[{}] {{", tab, var.domainSize());
 
    for (Idx i = 0; i < var.domainSize(); i++) {
      if (i > 0) str << ", ";
      str << this->_onlyValidCharsInName(var.label(i));
    }
 
    str << "};" << std::endl;
 
    str << "}" << std::endl;
    return str.str();
  }
 
  // Returns the modalities labels of the variables in varsSeq
  template < GUM_Numeric GUM_SCALAR >
  std::string
      BIFWriter< GUM_SCALAR >::_variablesLabels_(const Sequence< const DiscreteVariable* >& varsSeq,
                                                 const Instantiation&                       inst) {
    std::stringstream       str;
    const DiscreteVariable* varPtr = nullptr;
 
    for (Idx i = 1; i < varsSeq.size(); i++) {
      if (i > 1) str << ", ";
      varPtr = varsSeq[i];
      str << this->_onlyValidCharsInName(varPtr->label(inst.val(*varPtr)));
    }
    return str.str();
  }
 
  template < GUM_Numeric GUM_SCALAR >
  void BIFWriter< GUM_SCALAR >::_syntacticalCheck(const IBayesNet< GUM_SCALAR >& bn) {
    this->_validCharInNamesCheck(bn);
  }
} /* namespace gum */
 
#endif   // DOXYGEN_SHOULD_SKIP_THIS