aGrUM 3.0.0
a C++ library for (probabilistic) graphical models
GumMRFWriter.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_MRF_GUM_WRITER_H
49#define GUM_MRF_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 {
74 template < GUM_Numeric GUM_SCALAR >
75 class GumMRFWriter: public MRFWriter< GUM_SCALAR > {
76 public:
77 // ==========================================================================
79 // ==========================================================================
81
88 GumMRFWriter(bool binary = false, int indent = -1);
89
90 ~GumMRFWriter() override;
91
92 GumMRFWriter(const GumMRFWriter&) = delete;
93 GumMRFWriter(GumMRFWriter&&) noexcept = delete;
94 GumMRFWriter& operator=(const GumMRFWriter&) = delete;
95 GumMRFWriter& operator=(GumMRFWriter&&) noexcept = delete;
96
98
102 std::string toString(const IMarkovRandomField< GUM_SCALAR >& mrf);
103
111 void write(std::ostream& output, const IMarkovRandomField< GUM_SCALAR >& mrf) override;
112
120 void write(std::string_view filePath, IMarkovRandomField< GUM_SCALAR >& mrf) override;
121
129 void write(std::string_view filePath, const IMarkovRandomField< GUM_SCALAR >& mrf) override;
130
131 private:
134 };
135
136
137#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
138 extern template class GumMRFWriter< double >;
139#endif
140} /* namespace gum */
141
143
144#endif // GUM_MRF_GUM_WRITER_H
Definition of abstract classes for file output manipulation of Markov random fields.
std::string toString(const IMarkovRandomField< GUM_SCALAR > &mrf)
Serializes a MarkovRandomField to a string in GUM json format.
~GumMRFWriter() override
Default constructor.
void write(std::ostream &output, const IMarkovRandomField< GUM_SCALAR > &mrf) override
Writes a MarkovRandomField to the output stream.
GumMRFWriter(GumMRFWriter &&) noexcept=delete
Default constructor.
GumMRFWriter(const GumMRFWriter &)=delete
Default constructor.
GumMRFWriter(bool binary=false, int indent=-1)
Default constructor.
Class representing the minimal interface for Markov random field.
MRFWriter()
Default constructor.
gum is the global namespace for all aGrUM entities
Definition agrum.h:46
STL namespace.