aGrUM 2.3.2
a C++ library for (probabilistic) graphical models
scoreK2_inl.h
Go to the documentation of this file.
1/****************************************************************************
2 * This file is part of the aGrUM/pyAgrum library. *
3 * *
4 * Copyright (c) 2005-2025 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-2025 *
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#pragma once
41
42
48
49#ifndef DOXYGEN_SHOULD_SKIP_THIS
50
51# include <sstream>
52
54
55namespace gum {
56
57 namespace learning {
58
60 INLINE ScoreK2::ScoreK2(const DBRowGeneratorParser& parser,
61 const Prior& prior,
62 const std::vector< std::pair< std::size_t, std::size_t > >& ranges,
63 const Bijection< NodeId, std::size_t >& nodeId2columns) :
64 Score(parser, prior, ranges, nodeId2columns),
65 _internal_prior_(parser.database(), nodeId2columns) {
66 GUM_CONSTRUCTOR(ScoreK2);
67 }
68
70 INLINE ScoreK2::ScoreK2(const DBRowGeneratorParser& parser,
71 const Prior& prior,
72 const Bijection< NodeId, std::size_t >& nodeId2columns) :
73 Score(parser, prior, nodeId2columns), _internal_prior_(parser.database(), nodeId2columns) {
74 GUM_CONSTRUCTOR(ScoreK2);
75 }
76
78 INLINE ScoreK2::ScoreK2(const ScoreK2& from) :
79 Score(from), _internal_prior_(from._internal_prior_), _gammalog2_(from._gammalog2_) {
80 GUM_CONS_CPY(ScoreK2);
81 }
82
84 INLINE ScoreK2::ScoreK2(ScoreK2&& from) :
85 Score(std::move(from)), _internal_prior_(std::move(from._internal_prior_)),
86 _gammalog2_(std::move(from._gammalog2_)) {
87 GUM_CONS_MOV(ScoreK2);
88 }
89
91 INLINE ScoreK2* ScoreK2::clone() const { return new ScoreK2(*this); }
92
94 INLINE ScoreK2::~ScoreK2() { GUM_DESTRUCTOR(ScoreK2); }
95
97 INLINE std::string ScoreK2::isPriorCompatible(const Prior& prior) {
98 return isPriorCompatible(prior.getType(), prior.weight());
99 }
100
102 INLINE std::string ScoreK2::isPriorCompatible() const {
103 return isPriorCompatible(*(this->prior_));
104 }
105
107 INLINE const Prior& ScoreK2::internalPrior() const { return _internal_prior_; }
108
109 } /* namespace learning */
110
111} /* namespace gum */
112
113#endif /* DOXYGEN_SHOULD_SKIP_THIS */
the class used to read a row in the database and to transform it into a set of DBRow instances that c...
the base class for all a priori
Definition prior.h:83
ScoreK2(const DBRowGeneratorParser &parser, const Prior &prior, const std::vector< std::pair< std::size_t, std::size_t > > &ranges, const Bijection< NodeId, std::size_t > &nodeId2columns=Bijection< NodeId, std::size_t >())
default constructor
The base class for all the scores used for learning (BIC, BDeu, etc).
Definition score.h:68
include the inlined functions if necessary
Definition CSVParser.h:54
gum is the global namespace for all aGrUM entities
Definition agrum.h:46
STL namespace.
the class for computing K2 scores (actually their log2 value)