UAIMRFReader.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                           *
 *                                                                          *
 ****************************************************************************/
 

 
#ifndef GUM_UAI_MRF_READER_H
#define GUM_UAI_MRF_READER_H
 
#include <iostream>
#include <string>
 
#include <agrum/agrum.h>
 
#include <agrum/MRF/io/MRFReader.h>
 
#include <string_view>
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
// including coco-generated PARSER and SCANNER; GUM_COCOR_PUBLIC is locally
// forced to this module's own export macro so the grammar is tagged
// correctly even in a translation unit (e.g. gumTest) that does not define
// AGRUM_MRF_EXPORTING.
#  undef _COCO_PARSER_H_
#  undef _COCO_SCANNER_H_
#  pragma push_macro("GUM_COCOR_PUBLIC")
#  undef GUM_COCOR_PUBLIC
#  define GUM_COCOR_PUBLIC GUM_PUBLIC_MRF
#  include <agrum/MRF/io/UAI/cocoR/Parser.h>
#  pragma pop_macro("GUM_COCOR_PUBLIC")
#endif   // DOXYGEN_SHOULD_SKIP_THIS
 
namespace gum {
  /* =========================================================================*/
  /* ===                               READERS === */
  /* =========================================================================*/
  template < GUM_Numeric GUM_SCALAR >
  class UAIMRFReader: public MRFReader< GUM_SCALAR > {
    public:
    UAIMRFReader(MarkovRandomField< GUM_SCALAR >* MN, std::string_view filename);

    ~UAIMRFReader() override;

    UAIMRF::Scanner& scanner();

    const std::string& streamName() const;

    bool trace() const;
    void trace(bool b);

    Size proceed() final;
 
    void buildFromQuartets(std::vector< std::tuple< float, int, int, int > > quartets);


    Size errors();
    Size warnings();

    Idx errLine(Idx i);
    Idx errCol(Idx i);
    bool errIsError(Idx i);
    std::string errMsg(Idx i);

    void showElegantErrors(std::ostream& o = std::cerr);

    void showElegantErrorsAndWarnings(std::ostream& o = std::cerr);

    void showErrorsAndWarnings(std::ostream& o = std::cerr);

    void showErrorCounts(std::ostream& o = std::cerr);
 
    protected:
    MarkovRandomField< GUM_SCALAR >* _mn_;
    UAIMRF::Scanner*                 _scanner_;
    UAIMRF::Parser*                  _parser_;
 
    std::string _streamName_;
    bool        _traceScanning_;
    bool        _parseDone_;
 
    // a boolean to throw the ioerror not in the constructor but in the
    // proceed()
    bool _ioerror_;
 
    void _addFatalError_(Idx lig, Idx col,
                         std::string_view s);   // throw an exception
    void _addError_(Idx lig, Idx col, std::string_view s);
    void _addWarning_(Idx lig, Idx col, std::string_view s);
  };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class GUM_PUBLIC_MRF UAIMRFReader< double >;
#endif
 
} /* namespace gum */
 
#include "UAIMRFReader_tpl.h"
 
#endif   // GUM_UAI_MRF_READER_H