aGrUM
3.2.0
a C++ library for (probabilistic) graphical models
Toggle main menu visibility
noPrior.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
47
#ifndef GUM_LEARNING_PRIOR_NO_prior_H
48
#define GUM_LEARNING_PRIOR_NO_prior_H
49
50
#include <vector>
51
52
#include <
agrum/agrum.h
>
53
54
#include <
agrum/base/stattests/priors/prior.h
>
55
56
namespace
gum
{
57
58
namespace
learning
{
59
65
class
GUM_SHARED_PUBLIC
NoPrior
:
public
Prior
{
66
public
:
67
// ##########################################################################
69
// ##########################################################################
71
73
83
NoPrior
(
const
DatabaseTable
& database,
84
const
Bijection< NodeId, std::size_t >
& nodeId2columns
85
=
Bijection< NodeId, std::size_t >
());
86
88
NoPrior
(
const
NoPrior
& from);
89
91
NoPrior
(
NoPrior
&& from);
92
94
[[nodiscard]]
NoPrior
*
clone
()
const override
;
95
97
~NoPrior
()
override
;
98
100
101
102
// ##########################################################################
104
// ##########################################################################
106
108
NoPrior
&
operator=
(
const
NoPrior
& from);
109
111
NoPrior
&
operator=
(
NoPrior
&& from);
112
114
115
116
// ##########################################################################
118
// ##########################################################################
120
122
void
setWeight
(
const
double
weight
)
final
;
123
125
PriorType
getType
() const final;
126
128
135
bool
isInformative
() const final;
136
138
143
void
addJointPseudoCount
(const
IdCondSet
& idset,
std
::vector<
double
>& counts) final;
144
150
void
addConditioningPseudoCount
(const
IdCondSet
& idset,
std
::vector<
double
>& counts) final;
151
153
};
154
155
}
/* namespace learning */
156
157
}
/* namespace gum */
158
159
// include the inlined functions if necessary
160
#ifndef GUM_NO_INLINE
161
# include <
agrum/base/stattests/priors/noPrior_inl.h
>
162
#endif
/* GUM_NO_INLINE */
163
164
#endif
/* GUM_LEARNING_PRIOR_NO_prior_H */
agrum.h
gum::Bijection< NodeId, std::size_t >
gum::learning::DatabaseTable
The class representing a tabular database as used by learning tasks.
Definition
databaseTable.h:200
gum::learning::IdCondSet
A class for storing a pair of sets of NodeIds, the second one corresponding to a conditional set.
Definition
idCondSet.h:214
gum::learning::NoPrior::~NoPrior
~NoPrior() override
destructor
gum::learning::NoPrior::addConditioningPseudoCount
void addConditioningPseudoCount(const IdCondSet &idset, std::vector< double > &counts) final
adds the prior to a counting vectordefined over the right hand side of the idset
gum::learning::NoPrior::addJointPseudoCount
void addJointPseudoCount(const IdCondSet &idset, std::vector< double > &counts) final
adds the prior to a counting vector corresponding to the idset
gum::learning::NoPrior::clone
NoPrior * clone() const override
virtual copy constructor
gum::learning::NoPrior::getType
PriorType getType() const final
returns the type of the prior
gum::learning::NoPrior::setWeight
void setWeight(const double weight) final
sets the weight of the a prior(kind of effective sample size)
gum::learning::NoPrior::NoPrior
NoPrior(const DatabaseTable &database, const Bijection< NodeId, std::size_t > &nodeId2columns=Bijection< NodeId, std::size_t >())
default constructor
gum::learning::NoPrior::isInformative
bool isInformative() const final
indicates whether the prior is potentially informative
gum::learning::NoPrior::NoPrior
NoPrior(NoPrior &&from)
move constructor
gum::learning::NoPrior::NoPrior
NoPrior(const NoPrior &from)
copy constructor
gum::learning::NoPrior::operator=
NoPrior & operator=(NoPrior &&from)
move operator
gum::learning::NoPrior::operator=
NoPrior & operator=(const NoPrior &from)
copy operator
gum::learning::Prior::Prior
Prior(const DatabaseTable &database, const Bijection< NodeId, std::size_t > &nodeId2columns=Bijection< NodeId, std::size_t >())
default constructor
gum::learning::Prior::weight
double weight() const
returns the weight assigned to the prior
gum::learning
include the inlined functions if necessary
Definition
CSVParser.h:55
gum::learning::PriorType
PriorType
Definition
prior.h:59
gum
gum is the global namespace for all aGrUM entities
Definition
agrum.h:46
std
STL namespace.
noPrior_inl.h
the no a priorclass: corresponds to 0 weight-sample
prior.h
the base class for all a priori
aGrUM
3.2.0
© PHW&CG&others - 2022
DoXyGeN 1.18.0