aGrUM
3.3.2
a C++ library for (probabilistic) graphical models
Toggle main menu visibility
observation_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
#include <
agrum/FMDP/learning/observation.h
>
44
45
namespace
gum
{
46
47
48
INLINE
Observation::Observation
() {
49
GUM_CONSTRUCTOR(
Observation
);
50
;
51
}
52
53
INLINE
Observation::~Observation
() {
54
GUM_DESTRUCTOR(
Observation
);
55
;
56
}
57
58
INLINE
void
* Observation::operator
new
(
size_t
s) {
59
return
SmallObjectAllocator::instance
().
allocate
(s);
60
}
61
62
INLINE
void
Observation::operator
delete
(
void
* p) {
63
SmallObjectAllocator::instance
().
deallocate
(p,
sizeof
(
Observation
));
64
}
65
66
INLINE
Idx
Observation::modality
(
const
DiscreteVariable
* var)
const
{
return
_varInst_
[var]; }
67
68
INLINE
Idx
Observation::rModality
(
const
DiscreteVariable
* var)
const
{
return
_rInst_
[var]; }
69
70
INLINE
void
Observation::setModality
(
const
DiscreteVariable
* var,
Idx
modality
) {
71
_varInst_
.insert(var,
modality
);
72
}
73
74
INLINE
void
Observation::setRModality
(
const
DiscreteVariable
* var,
Idx
modality
) {
75
_rInst_
.insert(var,
modality
);
76
}
77
78
INLINE
double
Observation::reward
()
const
{
return
_reward_
; }
79
80
INLINE
void
Observation::setReward
(
double
reward
) {
_reward_
=
reward
; }
81
82
INLINE
HashTableConstIteratorSafe< const DiscreteVariable*, Idx >
83
Observation::cbeginVariablesSafe
()
const
{
84
return
_varInst_
.cbeginSafe();
85
}
86
87
INLINE
HashTableConstIteratorSafe< const DiscreteVariable*, Idx >
88
Observation::cendVariablesSafe
()
const
{
89
return
_varInst_
.cendSafe();
90
}
91
92
}
// namespace gum
gum::DiscreteVariable
Base class for discrete random variable.
Definition
discreteVariable.h:80
gum::HashTableConstIteratorSafe
Safe Const Iterators for hashtables.
Definition
hashTable.h:1662
gum::Observation::cendVariablesSafe
HashTableConstIteratorSafe< const DiscreteVariable *, Idx > cendVariablesSafe() const
Returns an const safe iterator on the end of the list of variables in this observation.
Definition
observation_inl.h:88
gum::Observation::~Observation
~Observation()
Default destructor.
Definition
observation_inl.h:53
gum::Observation::_reward_
double _reward_
The reward associated to this transition.
Definition
observation.h:166
gum::Observation::modality
Idx modality(const DiscreteVariable *var) const
Returns the modality assumed by the given variable in this observation.
Definition
observation_inl.h:66
gum::Observation::reward
double reward() const
Returns the modality assumed by the given variable in this observation.
Definition
observation_inl.h:78
gum::Observation::setReward
void setReward(double reward)
Returns the modality assumed by the given variable in this observation.
Definition
observation_inl.h:80
gum::Observation::rModality
Idx rModality(const DiscreteVariable *var) const
Returns the modality assumed by the given variable in this observation.
Definition
observation_inl.h:68
gum::Observation::setRModality
void setRModality(const DiscreteVariable *var, Idx modality)
Returns the modality assumed by the given variable in this observation.
Definition
observation_inl.h:74
gum::Observation::_varInst_
HashTable< const DiscreteVariable *, Idx > _varInst_
Table giving for every variables its instantiation.
Definition
observation.h:162
gum::Observation::cbeginVariablesSafe
HashTableConstIteratorSafe< const DiscreteVariable *, Idx > cbeginVariablesSafe() const
Returns an const safe iterator on the beginning of the list of variables in this observation.
Definition
observation_inl.h:83
gum::Observation::Observation
Observation()
Default constructor.
Definition
observation_inl.h:48
gum::Observation::setModality
void setModality(const DiscreteVariable *var, Idx modality)
Sets the modality assumed by the given variable in this observation.
Definition
observation_inl.h:70
gum::Observation::_rInst_
HashTable< const DiscreteVariable *, Idx > _rInst_
Definition
observation.h:163
gum::SmallObjectAllocator::instance
static SmallObjectAllocator & instance()
Definition
smallObjectAllocator_inl.h:96
gum::SmallObjectAllocator::allocate
void * allocate(const size_t &objectSize)
Allocates a block.
Definition
smallObjectAllocator.cpp:72
gum::SmallObjectAllocator::deallocate
void deallocate(void *pDeallocatedObject, const size_t &objectSize)
Deallocates an object.
Definition
smallObjectAllocator_inl.h:116
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
observation.h
Headers of the Observation class.
aGrUM
3.3.2
© PHW&CG&others - 2022
DoXyGeN 1.18.0