aGrUM 3.0.0
a C++ library for (probabilistic) graphical models
GumIDReader.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
47
48#ifndef GUM_ID_GUM_READER_H
49#define GUM_ID_GUM_READER_H
50
51#include <string>
52#include <vector>
53
54#include <agrum/agrum.h>
55
58
59namespace gum {
68 template < GUM_Numeric GUM_SCALAR >
69 class GumIDReader: public IDReader< GUM_SCALAR >, public ErrorsContainer {
70 public:
78 GumIDReader(InfluenceDiagram< GUM_SCALAR >* id, std::string_view filename, bool binary = false);
79
83
84 ~GumIDReader() override;
85
90 Size proceed() override;
91
94 Size proceedFromString(std::string_view content);
95
96 void showElegantErrorsAndWarnings(std::ostream& stream = std::cerr) const;
97 void showErrorCounts(std::ostream& stream = std::cerr) const;
98
99 private:
100 template < typename JsonType >
101 Size _proceedFromJson_(const JsonType& content);
102
104 std::string _streamName_;
107 };
108
109
110#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
111 extern template class GumIDReader< double >;
112#endif
113} /* namespace gum */
114
116
117#endif // GUM_ID_GUM_READER_H
Definition of abstract classes for import of Influence Diagram from a file.
ErrorsContainer()
Class Constructor.
Reads an InfluenceDiagram from a GUM (json) file.
Definition GumIDReader.h:69
void showElegantErrorsAndWarnings(std::ostream &stream=std::cerr) const
std::string _streamName_
InfluenceDiagram< GUM_SCALAR > * _id_
GumIDReader(InfluenceDiagram< GUM_SCALAR > *id, std::string_view filename, bool binary=false)
Constructor.
void showErrorCounts(std::ostream &stream=std::cerr) const
Size proceedFromString(std::string_view content)
Parse a jgum JSON string directly (no file I/O).
Size _proceedFromJson_(const JsonType &content)
Size proceed() override
Parses the file and populates the InfluenceDiagram.
GumIDReader(InfluenceDiagram< GUM_SCALAR > *id)
Constructor for string-based parsing only (no file). Use exclusively with proceedFromString(); callin...
~GumIDReader() override
IDReader(InfluenceDiagram< GUM_SCALAR > *infdiag, std::string_view filePath)
Constructor A reader is created to reading a defined file.
Class representing an Influence Diagram.
Errors container (at least) for parser.
std::size_t Size
In aGrUM, hashed values are unsigned long int.
Definition types.h:74
gum is the global namespace for all aGrUM entities
Definition agrum.h:46