aGrUM 2.3.2
a C++ library for (probabilistic) graphical models
prior_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
51namespace gum::learning {
52
54 INLINE Prior::Prior(const DatabaseTable& database,
55 const Bijection< NodeId, std::size_t >& nodeId2columns) :
56 database_(&database), nodeId2columns_(nodeId2columns) {
57 GUM_CONSTRUCTOR(Prior);
58 }
59
61 INLINE Prior::Prior(const Prior& from) :
62 weight_(from.weight_), database_(from.database_), nodeId2columns_(from.nodeId2columns_) {
63 GUM_CONS_CPY(Prior);
64 }
65
67 INLINE Prior::Prior(Prior&& from) :
68 weight_(from.weight_), database_(from.database_),
69 nodeId2columns_(std::move(from.nodeId2columns_)) {
70 GUM_CONS_MOV(Prior);
71 }
72
74 INLINE Prior::~Prior() { GUM_DESTRUCTOR(Prior); }
75
77 INLINE void Prior::setWeight(const double weight) {
78 if (weight < 0.0) {
79 GUM_ERROR(OutOfBounds, "A negative weight (" << weight << ") is forbidden for an prior");
80 }
81 weight_ = weight;
82 }
83
85 INLINE double Prior::weight() const { return weight_; }
86
87
88} // namespace gum::learning
89
90#endif /* DOXYGEN_SHOULD_SKIP_THIS */
Exception : out of bound.
The class representing a tabular database as used by learning tasks.
Prior(const DatabaseTable &database, const Bijection< NodeId, std::size_t > &nodeId2columns=Bijection< NodeId, std::size_t >())
default constructor
#define GUM_ERROR(type, msg)
Definition exceptions.h:72
include the inlined functions if necessary
Definition CSVParser.h:54
STL namespace.