aGrUM
3.3.2
a C++ library for (probabilistic) graphical models
Toggle main menu visibility
GumBNReader.h
Go to the documentation of this file.
1
/****************************************************************************
2
* This file is part of the aGrUM/pyAgrum library. *
3
* *
4
* Copyright (c) 2005-2026 by *
5
* - Pierre-Henri WUILLEMIN(_at_LIP6) *
6
* - Christophe GONZALES(_at_AMU) *
7
* *
8
* The aGrUM/pyAgrum library is free software; you can redistribute it *
9
* and/or modify it under the terms of either : *
10
* *
11
* - the GNU Lesser General Public License as published by *
12
* the Free Software Foundation, either version 3 of the License, *
13
* or (at your option) any later version, *
14
* - the MIT license (MIT), *
15
* - or both in dual license, as here. *
16
* *
17
* (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html) *
18
* *
19
* This aGrUM/pyAgrum library is distributed in the hope that it will be *
20
* useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, *
21
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
22
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *
23
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
24
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, *
25
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR *
26
* OTHER DEALINGS IN THE SOFTWARE. *
27
* *
28
* See LICENCES for more details. *
29
* *
30
* SPDX-FileCopyrightText: Copyright 2005-2026 *
31
* - Pierre-Henri WUILLEMIN(_at_LIP6) *
32
* - Christophe GONZALES(_at_AMU) *
33
* SPDX-License-Identifier: LGPL-3.0-or-later OR MIT *
34
* *
35
* Contact : info_at_agrum_dot_org *
36
* homepage : http://agrum.gitlab.io *
37
* gitlab : https://gitlab.com/agrumery/agrum *
38
* *
39
****************************************************************************/
40
41
42
#ifndef GUM_BN_GUM_READER_H
43
#define GUM_BN_GUM_READER_H
44
#include <
agrum/base/core/errorsContainer.h
>
45
#include <
agrum/BN/io/BNReader.h
>
46
47
namespace
gum
{
56
template
< GUM_Numeric GUM_SCALAR >
57
class
GumBNReader
:
public
BNReader
< GUM_SCALAR >,
public
ErrorsContainer
{
58
public
:
70
GumBNReader
(BayesNet< GUM_SCALAR >* bn, std::string_view filename,
bool
binary =
false
);
71
74
explicit
GumBNReader
(BayesNet< GUM_SCALAR >* bn);
75
79
~GumBNReader
()
override
;
80
83
Size
proceed
() final;
84
87
Size
proceedFromString
(
std
::string_view content);
88
89
void
showElegantErrorsAndWarnings
(
std
::ostream& stream =
std
::cerr) const;
90
91
void
showErrorCounts
(
std
::ostream& stream =
std
::cerr) const;
92
93
94
private:
95
// Forward declaration: json is defined in the _tpl.h translation unit.
96
template < typename JsonType >
97
Size
_proceedFromJson_
(const JsonType& content);
98
99
BayesNet
< GUM_SCALAR >*
_bn_
;
100
std
::
string
_streamName_
;
101
bool
_parseDone_
;
102
bool
_binary_
;
103
};
104
105
106
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
107
extern
template
class
GUM_PUBLIC_BN
GumBNReader< double >
;
108
#endif
109
}
/* namespace gum */
110
111
#include <
agrum/BN/io/GUM/GumBNReader_tpl.h
>
112
113
#endif
// GUM_BN_READER_H
BNReader.h
Definition of abstract classes for file input manipulation of Bayesian networks.
GumBNReader_tpl.h
gum::BNReader::BNReader
BNReader(BayesNet< GUM_SCALAR > *bn, std::string_view filename)
Constructor A reader is defined for reading a defined file.
gum::BayesNet
Class representing a Bayesian network.
Definition
BayesNet.h:99
gum::ErrorsContainer::ErrorsContainer
ErrorsContainer()
Class Constructor.
gum::GumBNReader::showErrorCounts
void showErrorCounts(std::ostream &stream=std::cerr) const
gum::GumBNReader::proceedFromString
Size proceedFromString(std::string_view content)
Parse a jgum JSON string directly (no file I/O).
gum::GumBNReader::_streamName_
std::string _streamName_
Definition
GumBNReader.h:100
gum::GumBNReader::proceed
Size proceed() final
Parse the file given at construction.
gum::GumBNReader::GumBNReader
GumBNReader(BayesNet< GUM_SCALAR > *bn)
Constructor for string-based parsing only (no file). Use exclusively with proceedFromString(); callin...
gum::GumBNReader::_proceedFromJson_
Size _proceedFromJson_(const JsonType &content)
gum::GumBNReader::GumBNReader
GumBNReader(BayesNet< GUM_SCALAR > *bn, std::string_view filename, bool binary=false)
Constructor A reader is defined for reading a defined file.
gum::GumBNReader::_binary_
bool _binary_
If true, the input is in binary format, otherwise in text format.
Definition
GumBNReader.h:102
gum::GumBNReader::showElegantErrorsAndWarnings
void showElegantErrorsAndWarnings(std::ostream &stream=std::cerr) const
gum::GumBNReader::_parseDone_
bool _parseDone_
Definition
GumBNReader.h:101
gum::GumBNReader::~GumBNReader
~GumBNReader() override
Default destructor.
gum::GumBNReader::_bn_
BayesNet< GUM_SCALAR > * _bn_
Definition
GumBNReader.h:99
errorsContainer.h
Errors container (at least) for parser.
gum::Size
std::size_t Size
In aGrUM, hashed values are unsigned long int.
Definition
types.h:74
gum
gum is the global namespace for all aGrUM entities
Definition
agrum.h:46
gum::GumBNReader< double >
template class GUM_PUBLIC_BN GumBNReader< double >
Definition
GumBNReader.cpp:46
std
STL namespace.
aGrUM
3.3.2
© PHW&CG&others - 2022
DoXyGeN 1.18.0