aGrUM 3.0.0
a C++ library for (probabilistic) graphical models
GumBNWriter.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
51
52#ifndef GUM_GUM_BN_WRITER_H
53#define GUM_GUM_BN_WRITER_H
54
55#include <cstdint>
56#include <fstream>
57#include <iostream>
58#include <istream>
59#include <ostream>
60#include <sstream>
61#include <string>
62#include <vector>
63
64#include <agrum/agrum.h>
65
67
68namespace gum {
79 template < GUM_Numeric GUM_SCALAR >
80 class GumBNWriter: public BNWriter< GUM_SCALAR > {
81 public:
82 // ==========================================================================
84 // ==========================================================================
86
96 GumBNWriter(bool binary = false, int indent = -1);
97
101 ~GumBNWriter() override;
102
103 GumBNWriter(const GumBNWriter&) = delete;
104 GumBNWriter(GumBNWriter&&) noexcept = delete;
105 GumBNWriter& operator=(const GumBNWriter&) = delete;
106 GumBNWriter& operator=(GumBNWriter&&) noexcept = delete;
107
109
110 protected:
118 void _doWrite(std::ostream& output, const IBayesNet< GUM_SCALAR >& bn) final;
119
128 void _doWrite(std::string_view filePath, const IBayesNet< GUM_SCALAR >& bn) final;
129
130 private:
131 bool _binary_;
133 };
134
135
136#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
137 extern template class GumBNWriter< double >;
138#endif
139} /* namespace gum */
140
142
143#endif /* GUM_GUM_BN_WRITER_H */
Definition of abstract classes for file output manipulation of Bayesian networks.
BNWriter()
Default constructor.
int _indent_
The indentation level for the output.
GumBNWriter(const GumBNWriter &)=delete
Default constructor.
bool _binary_
If true, the output will be in binary format, otherwise in text format.
GumBNWriter(GumBNWriter &&) noexcept=delete
Default constructor.
~GumBNWriter() override
Destructor.
void _doWrite(std::ostream &output, const IBayesNet< GUM_SCALAR > &bn) final
Writes a Bayesian network in the output stream using the BN format.
GumBNWriter(bool binary=false, int indent=-1)
Default constructor.
Class representing the minimal interface for Bayesian network with no numerical data.
Definition IBayesNet.h:75
gum is the global namespace for all aGrUM entities
Definition agrum.h:46
STL namespace.