O3prmBNWriter_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/PRM/o3prm/O3prmBNWriter.h>   // to ease IDE parser
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#  include <agrum/PRM/o3prm/O3prmBNWriter.h>
 
#  define O3PRM_INDENT "  "
 
namespace gum {
  /*
   * Default constructor.
   */
  template < GUM_Numeric GUM_SCALAR >
  O3prmBNWriter< GUM_SCALAR >::O3prmBNWriter() {
    GUM_CONSTRUCTOR(O3prmBNWriter)
  }
 
  /*
   * Destructor.
   */
  template < GUM_Numeric GUM_SCALAR >
  O3prmBNWriter< GUM_SCALAR >::~O3prmBNWriter() {
    GUM_DESTRUCTOR(O3prmBNWriter)
  }
 
  /*
   * Writes a bayes net in the given output 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 O3prmBNWriter< GUM_SCALAR >::_doWrite(std::ostream&                  output,
                                             const IBayesNet< GUM_SCALAR >& bn) {
    if (!output.good()) { GUM_ERROR(IOError, "Input/Output error : stream not writable.") }
    std::string bnName = bn.propertyWithDefault("name", "");
    if (bnName.empty()) bnName = "bayesnet";
 
    output << "class " << bnName << " {" << std::endl;
 
    for (auto node: bn.nodes()) {
      output << _extractAttribute_(bn, node) << std::endl;
    }
 
    output << "}" << std::endl;
 
    output << std::endl;
 
    output.flush();
 
    if (output.fail()) { GUM_ERROR(IOError, "Writing in the ostream failed.") }
  }
 
  template < GUM_Numeric GUM_SCALAR >
  std::string O3prmBNWriter< GUM_SCALAR >::_extractAttribute_(const IBayesNet< GUM_SCALAR >& bn,
                                                              NodeId                         node) {
    std::stringstream str;
    str << O3PRM_INDENT;
    str << _extractType_(bn, node) << " ";
    str << _extractName_(bn, node) << " ";
    if (bn.parents(node).size() > 0) { str << "dependson " << _extractParents_(bn, node) << " "; }
    str << " {" << _extractCPT_(bn, node) << "};" << std::endl;
    return str.str();
  }
 
  template < GUM_Numeric GUM_SCALAR >
  std::string O3prmBNWriter< GUM_SCALAR >::_extractParents_(const IBayesNet< GUM_SCALAR >& bn,
                                                            NodeId                         node) {
    std::stringstream str;
    auto              var = &(bn.variable(node));
    for (auto parent: bn.cpt(node).variablesSequence()) {
      if (var != parent) { str << parent->name() << ", "; }
    }
    return str.str().substr(0, str.str().size() - 2);
  }
 
  template < GUM_Numeric GUM_SCALAR >
  std::string O3prmBNWriter< GUM_SCALAR >::_extractCPT_(const IBayesNet< GUM_SCALAR >& bn,
                                                        NodeId                         node) {
    std::stringstream str;
    bool              first = true;
    Instantiation     inst(bn.cpt(node));
 
    str << "[";
    if (inst.nbrDim() == 1) {
      // 1D tensor
      for (inst.setFirst(); !inst.end(); inst.inc()) {
        if (!first) {
          str << ", ";
        } else {
          first = false;
        }
        str << bn.cpt(node)[inst];
      }
    } else {
      // (>1)D tensor (with parents)
      Instantiation jnst;
      for (auto var = inst.variablesSequence().rbegin(); var != inst.variablesSequence().rend();
           --var) {
        jnst.add(**var);
      }
      inst.setFirst();
      auto currentval = inst.val(0) + 1;
      for (jnst.setFirst(); !jnst.end(); jnst.inc()) {
        inst.setVals(jnst);
        if (!first) {
          str << ", ";
        } else {
          first = false;
        }
        if (currentval != inst.val(0)) {   // begins line
          str << std::endl << O3PRM_INDENT << O3PRM_INDENT;
          currentval = inst.val(0);
        }
        str << bn.cpt(node)[inst];
      }
      str << std::endl << O3PRM_INDENT;
    }
 
    str << "]";
    return str.str();
  }
 
  template < GUM_Numeric GUM_SCALAR >
  std::string O3prmBNWriter< GUM_SCALAR >::_extractType_(const IBayesNet< GUM_SCALAR >& bn,
                                                         NodeId                         node) {
    switch (bn.variable(node).varType()) {
      case gum::VarType::DISCRETIZED : {
        auto double_var = static_cast< const DiscretizedVariable< double >* >(&(bn.variable(node)));
        return _extractDiscretizedType_< DiscretizedVariable< double > >(double_var);
      }
      case gum::VarType::RANGE : {
        return _extractRangeType_(bn, node);
      }
      default : {
        return _extractLabelizedType_(bn, node);
      }
    }
  }
 
  template < GUM_Numeric GUM_SCALAR >
  std::string O3prmBNWriter< GUM_SCALAR >::_extractRangeType_(const IBayesNet< GUM_SCALAR >& bn,
                                                              NodeId                         node) {
    const auto& var = static_cast< const RangeVariable& >(bn.variable(node));
    return std::format("int ({}, {})", var.minVal(), var.maxVal());
  }
 
  template < GUM_Numeric GUM_SCALAR >
  std::string O3prmBNWriter< GUM_SCALAR >::_extractLabelizedType_(const IBayesNet< GUM_SCALAR >& bn,
                                                                  NodeId node) {
    std::stringstream str;
    str << "labels(";
    for (auto l: bn.variable(node).labels()) {
      str << l << ", ";
    }
    return str.str().substr(0, str.str().size() - 2) + ")";
  }
 
  template < GUM_Numeric GUM_SCALAR >
  template < typename VARTYPE >
  std::string O3prmBNWriter< GUM_SCALAR >::_extractDiscretizedType_(const VARTYPE* var) {
    std::stringstream str;
    if (var->ticks().size() >= 3) {
      str << "real(" << var->ticks()[0];
      for (size_t i = 1; i < var->ticks().size(); ++i) {
        str << ", " << var->ticks()[i];
      }
      str << ")";
      return str.str();
    }
    GUM_ERROR(InvalidArgument, "discretized variable does not have enough ticks")
  }
 
  template < GUM_Numeric GUM_SCALAR >
  std::string O3prmBNWriter< GUM_SCALAR >::_extractName_(const IBayesNet< GUM_SCALAR >& bn,
                                                         NodeId                         node) {
    if (!bn.variable(node).name().empty()) {
      return bn.variable(node).name();
    } else {
      return std::to_string(node);
    }
  }
 
  /*
   * Writes a bayes net in the file referenced by filePath.
   * If the file doesn't exist, 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 O3prmBNWriter< 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.") }
  }
 
} /* namespace gum */
 
#endif   // DOXYGEN_SHOULD_SKIP_THIS