aGrUM 3.3.2
a C++ library for (probabilistic) graphical models
multiDimNoisyORNet_tpl.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
50
52
53namespace gum {
54
55 // Default constructor
56 template < GUM_Numeric GUM_SCALAR >
58 GUM_SCALAR default_weight) :
59 MultiDimICIModel< GUM_SCALAR >(external_weight, default_weight) {
60 // virtual calls are not dispatched in the base constructor
61 checkCausalWeight_(external_weight, default_weight);
62 GUM_CONSTRUCTOR(MultiDimNoisyORNet);
63 }
64
65 template < GUM_Numeric GUM_SCALAR >
67 GUM_SCALAR causal_weight) const {
68 this->checkWeightsAreProbabilities_(external_weight, causal_weight);
69 }
70
71 // Default constructor
72 template < GUM_Numeric GUM_SCALAR >
77
78 // Copy constructor using a bijection to replace variables from source.
79 template < GUM_Numeric GUM_SCALAR >
85
86 // destructor
87 template < GUM_Numeric GUM_SCALAR >
91
92 template < GUM_Numeric GUM_SCALAR >
94 if (this->nbrDim() < 1) { GUM_ERROR(OperationNotAllowed, "Not enough variable for a NoisyOr ") }
95
96 const DiscreteVariable& C = this->variable((Idx)0);
97
98 if (i.val(C) > 1) return (GUM_SCALAR)0.0;
99
100 GUM_SCALAR ratio = (GUM_SCALAR)1.0 - this->externalWeight();
101
102 GUM_SCALAR fact = (GUM_SCALAR)ratio;
103
104 if (fact != (GUM_SCALAR)0) {
105 for (Idx j = 1; j < this->nbrDim(); j++) {
106 const DiscreteVariable& v = this->variable(j);
107
108 if (i.val(v) == 1) {
109 GUM_SCALAR pr = (1 - this->causalWeight(v));
110
111 if (pr == (GUM_SCALAR)0.0) {
112 fact = (GUM_SCALAR)0.0;
113 break;
114 } else {
115 fact *= pr;
116 }
117 }
118 }
119 }
120
121 return (i.val(C) != 1) ? fact : (GUM_SCALAR)1.0 - fact;
122 }
123
124 template < GUM_Numeric GUM_SCALAR >
126 std::stringstream s;
127 s << MultiDimImplementation< GUM_SCALAR >::variable(0) << "=noisyORNet(["
128 << this->externalWeight() << "]";
129
130 for (Idx i = 1; i < MultiDimImplementation< GUM_SCALAR >::nbrDim(); i++)
133
134 s << ")";
135 return s.str();
136 }
137
138 // For friendly displaying the content of the variable.
139 template < GUM_Numeric GUM_SCALAR >
140 std::ostream& operator<<(std::ostream& s, const MultiDimNoisyORNet< GUM_SCALAR >& ag) {
141 return s << ag.toString();
142 }
143
144 template < GUM_Numeric GUM_SCALAR >
148
149 // returns the name of the implementation
150 template < GUM_Numeric GUM_SCALAR >
151 const std::string& MultiDimNoisyORNet< GUM_SCALAR >::name() const {
152 static const std::string str = "MultiDimNoisyORNet";
153 return str;
154 }
155
156} /* namespace gum */
Set of pairs of elements with fast search for both elements.
Definition bijection.h:1640
Base class for discrete random variable.
Class for assigning/browsing values to tuples of discrete variables.
Idx val(Idx i) const
Returns the current value of the variable at position i.
static void checkWeightsAreProbabilities_(GUM_SCALAR external_weight, GUM_SCALAR causal_weight)
MultiDimICIModel(GUM_SCALAR external_weight, GUM_SCALAR default_weight=(GUM_SCALAR) 1.0)
GUM_SCALAR causalWeight(const DiscreteVariable &v) const
const DiscreteVariable & variable(Idx i) const override
Noisy OR representation.
MultiDimContainer< GUM_SCALAR > * newFactory() const override
This method creates a clone of this object, withouth its content (including variable),...
const std::string & name() const final
Returns the real name of the multiDimArray.
GUM_SCALAR get(const Instantiation &i) const final
Returns the real name of the multiDimArray.
std::string toString() const final
Returns the real name of the multiDimArray.
void checkCausalWeight_(GUM_SCALAR external_weight, GUM_SCALAR causal_weight) const override
The leak and the causal weights are probabilities.
MultiDimNoisyORNet(GUM_SCALAR external_weight, GUM_SCALAR default_weight=(GUM_SCALAR) 1.0)
Default constructor.
~MultiDimNoisyORNet() final
Destructor.
Exception : operation not allowed.
#define GUM_ERROR(type, msg)
Definition exceptions.h:76
Size Idx
Type for indexes.
Definition types.h:79
class for NoisyOR-net implementation as multiDim
gum is the global namespace for all aGrUM entities
Definition agrum.h:46
std::ostream & operator<<(std::ostream &stream, const AVLTree< Val, Cmp > &tree)
display the content of a tree