aGrUM
3.2.0
a C++ library for (probabilistic) graphical models
Toggle main menu visibility
IDiscretizedVariable.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
42
#ifndef GUM_I_DISCRETIZED_VARIABLE_H
43
#define GUM_I_DISCRETIZED_VARIABLE_H
44
45
#include <iostream>
46
#include <vector>
47
48
#include <
agrum/agrum.h
>
49
50
#include <
agrum/base/variables/discreteVariable.h
>
51
52
namespace
gum
{
53
59
class
GUM_SHARED_PUBLIC
IDiscretizedVariable
:
public
DiscreteVariable
{
60
public
:
61
// ############################################################################
63
// ############################################################################
65
67
IDiscretizedVariable
(std::string_view aName, std::string_view aDesc);
68
75
IDiscretizedVariable
(
const
IDiscretizedVariable
& from);
76
78
~IDiscretizedVariable
()
override
;
79
81
[[nodiscard]]
IDiscretizedVariable
*
clone
()
const override
= 0;
82
84
85
86
// ############################################################################
88
// ############################################################################
90
95
bool
isEmpirical
() const final;
96
101
void
setEmpirical
(
bool
state);
102
104
virtual
std
::vector<
double
>
ticksAsDoubles
() const = 0;
105
107
virtual
double
draw
(
Idx
indice) const = 0;
109
110
111
protected:
112
bool
_is_empirical
;
114
IDiscretizedVariable
& operator=(const
IDiscretizedVariable
& from);
115
};
116
117
118
}
/* namespace gum */
119
120
121
#ifndef GUM_NO_INLINE
122
# include <
agrum/base/variables/IDiscretizedVariable_inl.h
>
123
#endif
/* GUM_NO_INLINE */
124
125
#endif
/* GUM_I_DISCRETIZED_VARIABLE_H */
IDiscretizedVariable_inl.h
agrum.h
gum::DiscreteVariable::DiscreteVariable
DiscreteVariable(std::string_view aName, std::string_view aDesc)
Default constructor.
gum::IDiscretizedVariable::~IDiscretizedVariable
~IDiscretizedVariable() override
destructor
gum::IDiscretizedVariable::ticksAsDoubles
virtual std::vector< double > ticksAsDoubles() const =0
return the list of ticks as a vector of doubles
gum::IDiscretizedVariable::IDiscretizedVariable
IDiscretizedVariable(std::string_view aName, std::string_view aDesc)
Default constructor.
gum::IDiscretizedVariable::_is_empirical
bool _is_empirical
Definition
IDiscretizedVariable.h:112
gum::IDiscretizedVariable::clone
IDiscretizedVariable * clone() const override=0
Copy Factory.
gum::IDiscretizedVariable::IDiscretizedVariable
IDiscretizedVariable(const IDiscretizedVariable &from)
Copy Constructor.
gum::IDiscretizedVariable::isEmpirical
bool isEmpirical() const final
gum::IDiscretizedVariable::setEmpirical
void setEmpirical(bool state)
gum::IDiscretizedVariable::draw
virtual double draw(Idx indice) const =0
get a (double) random value in the intervall indice
discreteVariable.h
Base class for discrete random variable.
gum::Idx
Size Idx
Type for indexes.
Definition
types.h:79
gum
gum is the global namespace for all aGrUM entities
Definition
agrum.h:46
std
STL namespace.
aGrUM
3.2.0
© PHW&CG&others - 2022
DoXyGeN 1.18.0