aGrUM 3.0.0
a C++ library for (probabilistic) graphical models
variableselector_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
44
45namespace gum {
46
47
48 INLINE bool VariableSelector::isEmpty() const { return _remainingVars_.empty(); }
49
50 INLINE void VariableSelector::begin() { _rvi_ = _remainingVars_.beginSafe(); }
51
52 INLINE bool VariableSelector::hasNext() const { return _rvi_ != _remainingVars_.endSafe(); }
53
54 INLINE void VariableSelector::next() { ++_rvi_; }
55
56 INLINE const DiscreteVariable* VariableSelector::current() const { return *_rvi_; }
57
58} // namespace gum
Base class for discrete random variable.
SetIteratorSafe< const DiscreteVariable * > _rvi_
The set of remaining vars to select among.
bool hasNext() const
The set of remaining vars to select among.
gum::VariableSet _remainingVars_
The set of remaining vars to select among.
void begin()
The set of remaining vars to select among.
void next()
The set of remaining vars to select among.
bool isEmpty() const
The set of remaining vars to select among.
const DiscreteVariable * current() const
The set of remaining vars to select among.
gum is the global namespace for all aGrUM entities
Definition agrum.h:46
Headers of the Variable Selector class.