GumMRFReader_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/MRF/io/GUM/GumMRFReader.h>   // to ease IDE parser
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
// to ease parsing in IDE
#  include <agrum/base/io/GumBinaryIO.h>
#  include <agrum/MRF/io/GUM/GumMRFReader.h>
 
#  include <agrum/base/external/json/json.hpp>
using json = nlohmann::json;
 
namespace gum {
  template < GUM_Numeric GUM_SCALAR >
  GumMRFReader< GUM_SCALAR >::GumMRFReader(MarkovRandomField< GUM_SCALAR >* mrf,
                                           std::string_view                 filename,
                                           bool binary) : MRFReader< GUM_SCALAR >(mrf, filename) {
    GUM_CONSTRUCTOR(GumMRFReader)
    _mrf_        = mrf;
    _streamName_ = filename;
    _parseDone_  = false;
    _binary_     = binary;
  }
 
  template < GUM_Numeric GUM_SCALAR >
  GumMRFReader< GUM_SCALAR >::GumMRFReader(MarkovRandomField< GUM_SCALAR >* mrf) :
      MRFReader< GUM_SCALAR >(mrf, "") {
    GUM_CONSTRUCTOR(GumMRFReader)
    _mrf_        = mrf;
    _streamName_ = "";
    _parseDone_  = false;
    _binary_     = false;
  }
 
  template < GUM_Numeric GUM_SCALAR >
  GumMRFReader< GUM_SCALAR >::~GumMRFReader() {
    GUM_DESTRUCTOR(GumMRFReader)
  }
 
  template < GUM_Numeric GUM_SCALAR >
  template < typename JsonType >
  Size GumMRFReader< GUM_SCALAR >::_proceedFromJson_(const JsonType& content) {
    Size nberrors = 0;
 
    if (content.contains("type") && content["type"].template get< std::string >() != "MRF") {
      addError("Invalid GUM file format: expected 'MRF' type, got '"
                   + content["type"].template get< std::string >() + "'",
               _streamName_,
               0,
               0);
      return ++nberrors;
    }
 
    if (!content.contains("nodes") || !content.contains("factors")) {
      addError("Invalid GUM file format: missing 'nodes' or 'factors' sections",
               _streamName_,
               0,
               0);
      return ++nberrors;
    }
 
    try {
      MarkovRandomField< GUM_SCALAR > tmp;
 
      // add nodes
      for (const auto& node: content["nodes"]) {
        tmp.add(node.template get< std::string >());
      }
 
      // parse all factor data once, then add topology, then fill values
      struct FactorData {
        std::vector< std::string > varnames;
        std::vector< double >      values;
      };
 
      std::vector< FactorData > factors;
      factors.reserve(content["factors"].size());
      for (const auto& factor: content["factors"]) {
        factors.push_back({factor["vars"].template get< std::vector< std::string > >(),
                           factor["values"].template get< std::vector< double > >()});
      }
 
      tmp.beginTopologyTransformation();
      for (const auto& fd: factors)
        tmp.addFactor(fd.varnames);
      tmp.endTopologyTransformation();
 
      for (const auto& fd: factors)
        tmp.factor(fd.varnames).fillWith(fd.values);
 
      // properties
      if (content.contains("properties")) {
        for (const auto& prop: content["properties"].items()) {
          tmp.setProperty(prop.key(), prop.value().template get< std::string >());
        }
      }
 
      *_mrf_      = std::move(tmp);
      _parseDone_ = true;
    } catch (const gum::Exception& e) {
      addError(e.errorContent(), _streamName_, 0, 0);
      return ++nberrors;
    }
    return nberrors;
  }
 
  template < GUM_Numeric GUM_SCALAR >
  Size GumMRFReader< GUM_SCALAR >::proceed() {
    if (_parseDone_) { return 0; }
    if (_streamName_.empty()) {
      GUM_ERROR(OperationNotAllowed,
                "GumMRFReader was constructed without a filename: use proceedFromString() instead "
                "of proceed()")
    }
    Size nberrors = 0;
 
    std::ifstream file(_streamName_, _binary_ ? std::ios::binary : std::ios::in);
    if (!file.is_open()) {
      addException("No such file " + _streamName_, _streamName_);
      return ++nberrors;
    }
    try {
      const auto content
          = _binary_ ? json::from_msgpack(_readVector_(file)) : json::parse(file, nullptr, false);
      file.close();
      if (content.is_discarded()) {
        addException("Error parsing file", _streamName_);
        return ++nberrors;
      }
      return _proceedFromJson_(content);
    } catch (const std::exception& e) {
      addException(std::string("Error reading binary file: ") + e.what(), _streamName_);
      return ++nberrors;
    }
  }
 
  template < GUM_Numeric GUM_SCALAR >
  Size GumMRFReader< GUM_SCALAR >::proceedFromString(std::string_view content) {
    if (_parseDone_) { return 0; }
    const auto j = json::parse(content, nullptr, false);
    if (j.is_discarded()) {
      addException("Invalid JSON string", _streamName_);
      return 1;
    }
    return _proceedFromJson_(j);
  }
 
  template < GUM_Numeric GUM_SCALAR >
  void GumMRFReader< GUM_SCALAR >::showElegantErrorsAndWarnings(std::ostream& stream) const {
    if (_parseDone_ || count() > 0) {
      elegantErrorsAndWarnings(stream);
    } else {
      GUM_ERROR(OperationNotAllowed, "File not parsed yet")
    }
  }
 
  template < GUM_Numeric GUM_SCALAR >
  void GumMRFReader< GUM_SCALAR >::showErrorCounts(std::ostream& stream) const {
    if (_parseDone_ || count() > 0) {
      syntheticResults(stream);
    } else {
      GUM_ERROR(OperationNotAllowed, "File not parsed yet")
    }
  }
}   // namespace gum
 
#endif   // DOXYGEN_SHOULD_SKIP_THIS