aGrUM 3.1.1
a C++ library for (probabilistic) graphical models
paramEstimator_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/paramUtils/paramEstimator.h> // to ease IDE parser
51#ifndef DOXYGEN_SHOULD_SKIP_THIS
52
54
55namespace gum {
56
57 namespace learning {
58
61 external_prior_(from.external_prior_->clone()),
62 score_internal_prior_(from.score_internal_prior_->clone()), counter_(from.counter_) {
63 GUM_CONS_CPY(ParamEstimator);
64 }
65
67 INLINE ParamEstimator::ParamEstimator(ParamEstimator&& from) noexcept :
68 external_prior_(from.external_prior_), score_internal_prior_(from.score_internal_prior_),
69 counter_(std::move(from.counter_)) {
70 from.external_prior_ = nullptr;
71 from.score_internal_prior_ = nullptr;
72 GUM_CONS_MOV(ParamEstimator);
73 }
74
76 INLINE void ParamEstimator::clear() { counter_.clear(); }
77
79 INLINE void ParamEstimator::setNumberOfThreads(Size nb) { counter_.setNumberOfThreads(nb); }
80
82 INLINE Size ParamEstimator::getNumberOfThreads() const { return counter_.getNumberOfThreads(); }
83
85 INLINE bool ParamEstimator::isGumNumberOfThreadsOverriden() const {
86 return counter_.isGumNumberOfThreadsOverriden();
87 }
88
91 INLINE void ParamEstimator::setMinNbRowsPerThread(const std::size_t nb) const {
92 counter_.setMinNbRowsPerThread(nb);
93 }
94
96 INLINE std::size_t ParamEstimator::minNbRowsPerThread() const {
97 return counter_.minNbRowsPerThread();
98 }
99
101 INLINE const std::vector< std::pair< std::size_t, std::size_t > >&
102 ParamEstimator::ranges() const {
103 return counter_.ranges();
104 }
105
107 INLINE std::vector< double > ParamEstimator::parameters(const NodeId target_node) {
108 return parameters(target_node, empty_nodevect_);
109 }
110
112 INLINE std::pair< std::vector< double >, double >
113 ParamEstimator::parametersAndLogLikelihood(const NodeId target_node) {
114 return parametersAndLogLikelihood(target_node, empty_nodevect_);
115 }
116
118 INLINE const Bijection< NodeId, std::size_t >& ParamEstimator::nodeId2Columns() const {
119 return counter_.nodeId2Columns();
120 }
121
123 INLINE const DatabaseTable& ParamEstimator::database() const { return counter_.database(); }
124
125
126 } /* namespace learning */
127
128} /* namespace gum */
129
130#endif /* DOXYGEN_SHOULD_SKIP_THIS */
The base class for estimating parameters of CPTs.
ParamEstimator(const DBRowGeneratorParser &parser, const Prior &external_prior, const Prior &_score_internal_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
include the inlined functions if necessary
Definition CSVParser.h:55
gum is the global namespace for all aGrUM entities
Definition agrum.h:46
the base class for estimating parameters of CPTs