BIFReader.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_BIF_READER_H
#define GUM_BIF_READER_H
 
#include <fstream>
#include <iostream>
#include <string>
 
#include <agrum/BN/io/BNReader.h>
 
#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_BN_EXPORTING.
#  pragma push_macro("GUM_COCOR_PUBLIC")
#  undef GUM_COCOR_PUBLIC
#  define GUM_COCOR_PUBLIC GUM_PUBLIC_BN
#  include <agrum/BN/io/BIF/cocoR/Parser.h>
#  pragma pop_macro("GUM_COCOR_PUBLIC")
#endif   // DOXYGEN_SHOULD_SKIP_THIS
 
namespace gum {
  template < GUM_Numeric GUM_SCALAR >
  class BIFReader final: public BNReader< GUM_SCALAR > {
    public:
    BIFReader(BayesNet< GUM_SCALAR >* bn, std::string_view filename);
 
    ~BIFReader() override;

    BIF::Scanner& scanner();

    const std::string& streamName() const;

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

    Size proceed() override;


    Size errors() const;
    Size warnings() const;

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

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

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

    void showErrorCounts(std::ostream& o = std::cerr) const;
 
    private:
    BayesNet< GUM_SCALAR >*        _bn_;
    BayesNetFactory< GUM_SCALAR >* _factory_;
    BIF::Scanner*                  _scanner_;
    BIF::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_;
  };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class GUM_PUBLIC_BN BIFReader< double >;
#endif
}   // namespace gum
 
#include <agrum/BN/io/BIF/BIFReader_tpl.h>
 
#endif   // GUM_BIF_READER_H