aGrUM 2.3.2
a C++ library for (probabilistic) graphical models
rangeVariable.cpp
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
41
48
50
51#ifdef GUM_NO_INLINE
53#endif /* GUM_NO_INLINE */
54
55namespace gum {
56
57 // ==========================================================================
58 // constructors
59 // ==========================================================================
60 RangeVariable::RangeVariable(const std::string& aName,
61 const std::string& aDesc,
62 long minVal,
63 long maxVal) :
65 GUM_CONSTRUCTOR(RangeVariable);
66 }
67
68 RangeVariable::RangeVariable(const std::string& aName, const std::string& aDesc) :
69 DiscreteVariable(aName, aDesc), _minBound_(0), _maxBound_(1) {
70 GUM_CONSTRUCTOR(RangeVariable);
71 }
72
73 // ==========================================================================
74 // Copy Constructor.
75 // If aDRV haves any listener, it will not be copied.
76 // @param aDRV the variable we copy
77 // ==========================================================================
82
83 // ==========================================================================
84 // destructor
85 // ==========================================================================
87 GUM_DESTRUCTOR(RangeVariable);
88 ;
89 }
90
91 std::string RangeVariable::domain() const {
92 std::stringstream s;
93 s << "[" << minVal() << "," << maxVal() << "]";
94 return s.str();
95 }
96
97 std::string RangeVariable::toFast() const {
98 std::stringstream s;
99 s << name();
100 if (const auto m = minVal(); m != 0) {
101 s << "[" << m << "," << maxVal() << "]";
102 } else {
103 s << "[" << maxVal() + 1 << "]";
104 }
105 return s.str();
106 }
107} /* namespace gum */
DiscreteVariable(const std::string &aName, const std::string &aDesc)
Default constructor.
long maxVal() const
Returns the upper bound.
long _minBound_
The upper bound.
std::string toFast() const final
returns the size of the random discrete variable domain
std::string domain() const final
string represent the domain of the variable
RangeVariable(const std::string &aName, const std::string &aDesc, long minVal, long maxVal)
constructors
long minVal() const
Returns the lower bound.
~RangeVariable() final
destructor
long _maxBound_
The upper bound.
const std::string & name() const
returns the name of the variable
gum is the global namespace for all aGrUM entities
Definition agrum.h:46
Header of gumRangeVariable.
Inline implementation of gumRangeVariable.