aGrUM
3.2.0
a C++ library for (probabilistic) graphical models
Toggle main menu visibility
scorefNML_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-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
#pragma once
42
43
49
50
#include <
agrum/BN/learning/scores/scorefNML.h
>
// to ease IDE parser
51
#ifndef DOXYGEN_SHOULD_SKIP_THIS
52
53
# include <
agrum/BN/learning/scores/scorefNML.h
>
54
55
namespace
gum
{
56
57
namespace
learning
{
58
59
// Constructors and destructor are defined out-of-line in scorefNML.cpp
60
// on purpose -- see the comment there.
61
63
INLINE
ScorefNML
*
ScorefNML::clone
()
const
{
return
new
ScorefNML
(*
this
); }
64
66
INLINE std::string
ScorefNML::isPriorCompatible
(
const
Prior
& prior) {
67
return
isPriorCompatible
(prior.getType(), prior.weight());
68
}
69
71
INLINE std::string
ScorefNML::isPriorCompatible
()
const
{
72
return
isPriorCompatible
(*(this->
prior_
));
73
}
74
76
INLINE
const
Prior
&
ScorefNML::internalPrior
()
const
{
return
_internal_prior_; }
77
78
79
}
/* namespace learning */
80
81
}
/* namespace gum */
82
83
#endif
/* DOXYGEN_SHOULD_SKIP_THIS */
gum::learning::Prior
the base class for all a priori
Definition
prior.h:84
gum::learning::Score::prior_
Prior * prior_
the expert knowledge a priorwe add to the score
Definition
score.h:238
gum::learning::ScorefNML
the class for computing fNML scores
Definition
scorefNML.h:72
gum::learning::ScorefNML::clone
ScorefNML * clone() const override
virtual copy constructor
gum::learning::ScorefNML::isPriorCompatible
std::string isPriorCompatible() const final
indicates whether the prior is compatible (meaningful) with the score
gum::learning::ScorefNML::internalPrior
const Prior & internalPrior() const final
returns the internal prior of the score
gum::learning::ScorefNML::ScorefNML
ScorefNML(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
gum::learning
include the inlined functions if necessary
Definition
CSVParser.h:55
gum
gum is the global namespace for all aGrUM entities
Definition
agrum.h:46
scorefNML.h
the class for computing fNML scores
aGrUM
3.2.0
© PHW&CG&others - 2022
DoXyGeN 1.18.0