aGrUM 3.0.0
a C++ library for (probabilistic) graphical models
GumIDWriter.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_WRITER_H
49#define GUM_ID_GUM_WRITER_H
50
51#include <cstdint>
52#include <fstream>
53#include <iostream>
54#include <sstream>
55#include <string>
56#include <vector>
57
58#include <agrum/agrum.h>
59
61
62namespace gum {
71 template < GUM_Numeric GUM_SCALAR >
72 class GumIDWriter: public IDWriter< GUM_SCALAR > {
73 public:
74 // ==========================================================================
76 // ==========================================================================
78
85 GumIDWriter(bool binary = false, int indent = -1);
86
87 ~GumIDWriter() override;
88
89 GumIDWriter(const GumIDWriter&) = delete;
90 GumIDWriter(GumIDWriter&&) noexcept = delete;
91 GumIDWriter& operator=(const GumIDWriter&) = delete;
92 GumIDWriter& operator=(GumIDWriter&&) noexcept = delete;
93
95
99 std::string toString(const InfluenceDiagram< GUM_SCALAR >& id);
100
108 void write(std::ostream& output, const InfluenceDiagram< GUM_SCALAR >& id) override;
109
117 void write(std::string_view filePath, InfluenceDiagram< GUM_SCALAR >& id) override;
118
126 void write(std::string_view filePath, const InfluenceDiagram< GUM_SCALAR >& id) override;
127
128 private:
131 };
132
133
134#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
135 extern template class GumIDWriter< double >;
136#endif
137} /* namespace gum */
138
140
141#endif // GUM_ID_GUM_WRITER_H
Head of abstract classe for export of influence diagram.
GumIDWriter(const GumIDWriter &)=delete
Default constructor.
std::string toString(const InfluenceDiagram< GUM_SCALAR > &id)
Serializes an InfluenceDiagram to a string in GUM json format.
~GumIDWriter() override
Default constructor.
GumIDWriter(GumIDWriter &&) noexcept=delete
Default constructor.
GumIDWriter(bool binary=false, int indent=-1)
Default constructor.
void write(std::ostream &output, const InfluenceDiagram< GUM_SCALAR > &id) override
Writes an InfluenceDiagram to the output stream.
IDWriter()
Default constructor.
Class representing an Influence Diagram.
gum is the global namespace for all aGrUM entities
Definition agrum.h:46
STL namespace.