aGrUM 3.0.0
a C++ library for (probabilistic) graphical models
cachedContingencyCounter_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#include <agrum/base/stattests/cachedContingencyCounter.h> // to ease IDE parser
50#ifndef DOXYGEN_SHOULD_SKIP_THIS
51
52namespace gum {
53
54 namespace learning {
55
57 const DBRowGeneratorParser& parser,
58 const Prior& prior,
59 const std::vector< std::pair< std::size_t, std::size_t > >& ranges,
60 const Bijection< NodeId, std::size_t >& nodeId2columns) :
61 prior_(prior.clone()), counter_(parser, ranges, nodeId2columns) {
62 GUM_CONSTRUCTOR(CachedContingencyCounter);
63 }
64
65 INLINE CachedContingencyCounter::CachedContingencyCounter(
66 const DBRowGeneratorParser& parser,
67 const Prior& prior,
68 const Bijection< NodeId, std::size_t >& nodeId2columns) :
69 prior_(prior.clone()), counter_(parser, nodeId2columns) {
70 GUM_CONSTRUCTOR(CachedContingencyCounter);
71 }
72
73 INLINE
74 CachedContingencyCounter::CachedContingencyCounter(const CachedContingencyCounter& from) :
75 prior_(from.prior_->clone()), counter_(from.counter_), cache_(from.cache_),
76 use_cache_(from.use_cache_) {
77 GUM_CONS_CPY(CachedContingencyCounter);
78 }
79
80 INLINE CachedContingencyCounter::CachedContingencyCounter(CachedContingencyCounter&& from) :
81 prior_(from.prior_), counter_(std::move(from.counter_)), cache_(std::move(from.cache_)),
82 use_cache_(from.use_cache_) {
83 from.prior_ = nullptr;
84 GUM_CONS_MOV(CachedContingencyCounter);
85 }
86
87 INLINE CachedContingencyCounter::~CachedContingencyCounter() {
88 if (prior_ != nullptr) delete prior_;
89 GUM_DESTRUCTOR(CachedContingencyCounter);
90 }
91
92 INLINE void CachedContingencyCounter::setNumberOfThreads(Size nb) {
93 counter_.setNumberOfThreads(nb);
94 }
95
96 INLINE Size CachedContingencyCounter::getNumberOfThreads() const {
97 return counter_.getNumberOfThreads();
98 }
99
100 INLINE bool CachedContingencyCounter::isGumNumberOfThreadsOverriden() const {
101 return counter_.isGumNumberOfThreadsOverriden();
102 }
103
104 INLINE void CachedContingencyCounter::setMinNbRowsPerThread(const std::size_t nb) const {
105 counter_.setMinNbRowsPerThread(nb);
106 }
107
108 INLINE std::size_t CachedContingencyCounter::minNbRowsPerThread() const {
109 return counter_.minNbRowsPerThread();
110 }
111
112 INLINE const std::vector< std::pair< std::size_t, std::size_t > >&
113 CachedContingencyCounter::ranges() const {
114 return counter_.ranges();
115 }
116
117 INLINE void CachedContingencyCounter::clear() {
118 counter_.clear();
119 cache_.clear();
120 }
121
122 INLINE void CachedContingencyCounter::clearCache() { cache_.clear(); }
123
124 INLINE void CachedContingencyCounter::useCache(const bool on_off) { use_cache_ = on_off; }
125
126 INLINE const Bijection< NodeId, std::size_t >&
127 CachedContingencyCounter::nodeId2Columns() const {
128 return counter_.nodeId2Columns();
129 }
130
131 INLINE const DatabaseTable& CachedContingencyCounter::database() const {
132 return counter_.database();
133 }
134
135 } /* namespace learning */
136
137} /* namespace gum */
138
139#endif /* DOXYGEN_SHOULD_SKIP_THIS */
Common counting infrastructure for independence tests and KNML scoring.
CachedContingencyCounter(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
the class used to read a row in the database and to transform it into a set of DBRow instances that c...
the base class for all a priori
Definition prior.h:83
include the inlined functions if necessary
Definition CSVParser.h:55
gum is the global namespace for all aGrUM entities
Definition agrum.h:46
STL namespace.