aGrUM
3.2.0
a C++ library for (probabilistic) graphical models
Toggle main menu visibility
multiDimInterface_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
50
51
// to ease IDE parser
52
#include <
agrum/base/multidim/implementations/multiDimInterface.h
>
53
54
namespace
gum
{
55
// Swap two variables in this multidim.
56
INLINE
57
void
MultiDimInterface::replace
(
const
DiscreteVariable
& x,
const
DiscreteVariable
& y) {
58
if
(!
contains
(x)) {
GUM_ERROR
(
NotFound
,
"could not find the variable"
) }
59
60
if
(
contains
(y)) {
GUM_ERROR
(
DuplicateElement
,
"variable "
<< y <<
" already in MultiDim"
) }
61
62
if
(x.
domainSize
() != y.
domainSize
()) {
63
GUM_ERROR
(
OperationNotAllowed
,
"incompatible variables"
)
64
}
65
66
replace_
(&x, &y);
67
}
68
69
}
/* namespace gum */
gum::DiscreteVariable
Base class for discrete random variable.
Definition
discreteVariable.h:80
gum::DiscreteVariable::domainSize
virtual Size domainSize() const =0
DuplicateElement
Exception : a similar element already exists.
gum::MultiDimInterface::replace
void replace(const DiscreteVariable &x, const DiscreteVariable &y)
Replace variables in this multidim.
Definition
multiDimInterface_inl.h:57
gum::MultiDimInterface::replace_
virtual void replace_(const DiscreteVariable *x, const DiscreteVariable *y)=0
This is called by MultiDimContainer::replace() to proceed with the replacing between x and y.
gum::MultiDimInterface::contains
virtual bool contains(const DiscreteVariable &v) const =0
Returns true if var is in *this.
NotFound
Exception : the element we looked for cannot be found.
OperationNotAllowed
Exception : operation not allowed.
GUM_ERROR
#define GUM_ERROR(type, msg)
Definition
exceptions.h:76
multiDimInterface.h
Headers of MultiDimInterface.
gum
gum is the global namespace for all aGrUM entities
Definition
agrum.h:46
aGrUM
3.2.0
© PHW&CG&others - 2022
DoXyGeN 1.18.0