aGrUM 2.3.2
a C++ library for (probabilistic) graphical models
exactBNdistance.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
41
49#ifndef GUM_BRUTE_FORCE_KL_H
50#define GUM_BRUTE_FORCE_KL_H
51
53
54namespace gum {
55
87
88 template < typename GUM_SCALAR >
89 class ExactBNdistance: public BNdistance< GUM_SCALAR > {
90 public:
97
100 explicit ExactBNdistance(const BNdistance< GUM_SCALAR >& kl);
101
103 virtual ~ExactBNdistance();
104
105 protected:
106 void computeKL_() final;
107
108 using BNdistance< GUM_SCALAR >::p_;
109 using BNdistance< GUM_SCALAR >::q_;
110 using BNdistance< GUM_SCALAR >::hellinger_;
111 using BNdistance< GUM_SCALAR >::bhattacharya_;
112 using BNdistance< GUM_SCALAR >::jsd_;
113
114 using BNdistance< GUM_SCALAR >::klPQ_;
115 using BNdistance< GUM_SCALAR >::klQP_;
116
117 using BNdistance< GUM_SCALAR >::errorPQ_;
118 using BNdistance< GUM_SCALAR >::errorQP_;
119 };
120
121#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
122 extern template class ExactBNdistance< double >;
123#endif
124
125} // namespace gum
126
128
129#endif // GUM_BRUTE_FORCE_KL_H
algorithm for KL divergence between BNs
GUM_SCALAR hellinger_
Definition BNdistance.h:165
GUM_SCALAR klPQ_
Definition BNdistance.h:159
BNdistance(const IBayesNet< GUM_SCALAR > &P, const IBayesNet< GUM_SCALAR > &Q)
constructor must give 2 BNs
GUM_SCALAR jsd_
Definition BNdistance.h:167
GUM_SCALAR klQP_
Definition BNdistance.h:160
GUM_SCALAR bhattacharya_
Definition BNdistance.h:166
const IBayesNet< GUM_SCALAR > & q_
Definition BNdistance.h:157
const IBayesNet< GUM_SCALAR > & p_
Definition BNdistance.h:156
ExactBNdistance computes exactly the KL divergence betweens 2 BNs.
ExactBNdistance(const IBayesNet< GUM_SCALAR > &P, const IBayesNet< GUM_SCALAR > &Q)
constructor must give 2 BNs
virtual ~ExactBNdistance()
destructor
Class representing the minimal interface for Bayesian network with no numerical data.
Definition IBayesNet.h:75
KL divergence between BNs brute force implementation.
gum is the global namespace for all aGrUM entities
Definition agrum.h:46