DSLWriter_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/DSL/DSLWriter.h>   // to ease IDE parser
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
// to ease automatic parser
#  include <agrum/BN/IBayesNet.h>
#  include <agrum/BN/io/DSL/DSLWriter.h>
 
namespace gum {
  /* =========================================================================*/
  /* ===                           GUM_DSL_WRITER === */
  /* =========================================================================*/
  // Default constructor.
  template < GUM_Numeric GUM_SCALAR >
  DSLWriter< GUM_SCALAR >::DSLWriter() {
    GUM_CONSTRUCTOR(DSLWriter);
  }
 
  // Default destructor.
  template < GUM_Numeric GUM_SCALAR >
  DSLWriter< GUM_SCALAR >::~DSLWriter() {
    GUM_DESTRUCTOR(DSLWriter);
  }

  template < GUM_Numeric GUM_SCALAR >
  void DSLWriter< GUM_SCALAR >::_doWrite(std::ostream& output, const IBayesNet< GUM_SCALAR >& bn) {
    if (!output.good()) { GUM_ERROR(IOError, "Input/Output error : stream not writable.") }
 
    output << "net " << bn.propertyWithDefault("name", "unnamedBN") << std::endl
           << "{" << std::endl;
 
    output << "// property softwar aGrUM " << GUM_VERSION << std::endl << std::endl;
 
    for (auto node: bn.topologicalOrder()) {
      output << _variableBloc_(bn, bn.variable(node));
    }
 
    output << "};";
 
    output.flush();
 
    if (output.fail()) { GUM_ERROR(IOError, "Writing in the ostream failed.") }
  }

  template < GUM_Numeric GUM_SCALAR >
  void DSLWriter< 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.") }
  }

  template < GUM_Numeric GUM_SCALAR >
  std::string DSLWriter< GUM_SCALAR >::_variableBloc_(const IBayesNet< GUM_SCALAR >& bn,
                                                      const DiscreteVariable&        var) {
    NodeId             id;
    std::ostringstream oss;
 
    id = bn.idFromName(var.name());
 
    oss << std::format("\tnode {}\n\t{{\n", this->_onlyValidCharsInName(var.name()));
 
    oss << "\t\tTYPE = CPT;\n";
 
    oss << "\t\tHEADER =\n\t\t{\n";
    oss << std::format("\t\t\tID = {};\n", this->_onlyValidCharsInName(var.name()));
    oss << std::format("\t\t\tNAME = \"{}\";\n", this->_onlyValidCharsInName(var.name()));
    oss << "\t\t};\n";
 
    oss << "\t\tPARENTS = (";
    const Sequence< const DiscreteVariable* >& tmp_vars = bn.cpt(id).variablesSequence();
 
    for (Idx i = tmp_vars.size() - 1; i > 0; i--) {
      if (i < tmp_vars.size() - 1) oss << ", ";
 
      oss << this->_onlyValidCharsInName(tmp_vars[i]->name());
    }
 
    oss << ");\n";
 
    oss << "\t\tDEFINITION =\n\t\t{\n";

    oss << "\t\t\tNAMESTATES = (";
 
    for (Idx i = 0; i < var.domainSize(); i++) {
      if (i != 0) oss << ", ";
 
      oss << this->_onlyValidCharsInName(var.label(i));
    }
 
    oss << ");\n";


    oss << "\t\t\tPROBABILITIES = (";
    Idx i = 0;
 
    Instantiation iter(*bn.cpt(id).content());
    for (iter.setFirst(); i < bn.cpt(id).domainSize(); ++iter, ++i) {
      if (i != 0) oss << ", ";
      oss << bn.cpt(id)[iter];
    }
 
    oss << ");\n";

 
    oss << "\t\t};\n";
 
    oss << "\t};\n\n";
 
    return oss.str();
  }
 
  template < GUM_Numeric GUM_SCALAR >
  void DSLWriter< GUM_SCALAR >::_syntacticalCheck(const IBayesNet< GUM_SCALAR >& bn) {
    this->_validCharInNamesCheck(bn);
  }
} /* namespace gum */
 
#endif   // DOXYGEN_SHOULD_SKIP_THIS