aGrUM 2.3.2
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-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
52
53namespace gum {
54
55 namespace learning {
56
59 external_prior_(from.external_prior_->clone()),
60 score_internal_prior_(from.score_internal_prior_->clone()), counter_(from.counter_) {
61 GUM_CONS_CPY(ParamEstimator);
62 }
63
65 INLINE ParamEstimator::ParamEstimator(ParamEstimator&& from) :
66 external_prior_(from.external_prior_), score_internal_prior_(from.score_internal_prior_),
67 counter_(std::move(from.counter_)) {
68 from.external_prior_ = nullptr;
69 from.score_internal_prior_ = nullptr;
70 GUM_CONS_MOV(ParamEstimator);
71 }
72
74 INLINE void ParamEstimator::clear() { counter_.clear(); }
75
77 INLINE void ParamEstimator::setNumberOfThreads(Size nb) { counter_.setNumberOfThreads(nb); }
78
80 INLINE Size ParamEstimator::getNumberOfThreads() const { return counter_.getNumberOfThreads(); }
81
83 INLINE bool ParamEstimator::isGumNumberOfThreadsOverriden() const {
84 return counter_.isGumNumberOfThreadsOverriden();
85 }
86
89 INLINE void ParamEstimator::setMinNbRowsPerThread(const std::size_t nb) const {
90 counter_.setMinNbRowsPerThread(nb);
91 }
92
94 INLINE std::size_t ParamEstimator::minNbRowsPerThread() const {
95 return counter_.minNbRowsPerThread();
96 }
97
99 INLINE const std::vector< std::pair< std::size_t, std::size_t > >&
100 ParamEstimator::ranges() const {
101 return counter_.ranges();
102 }
103
105 INLINE std::vector< double > ParamEstimator::parameters(const NodeId target_node) {
106 return parameters(target_node, empty_nodevect_);
107 }
108
110 INLINE std::pair< std::vector< double >, double >
111 ParamEstimator::parametersAndLogLikelihood(const NodeId target_node) {
112 return parametersAndLogLikelihood(target_node, empty_nodevect_);
113 }
114
116 INLINE const Bijection< NodeId, std::size_t >& ParamEstimator::nodeId2Columns() const {
117 return counter_.nodeId2Columns();
118 }
119
121 INLINE const DatabaseTable& ParamEstimator::database() const { return counter_.database(); }
122
123
124 } /* namespace learning */
125
126} /* namespace gum */
127
128#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:54
gum is the global namespace for all aGrUM entities
Definition agrum.h:46
STL namespace.
the base class for estimating parameters of CPTs