1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
//! Variable type definitions
/// The type of a planning variable.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum VariableType {
/// A genuine planning variable that the solver optimizes.
Genuine,
/// A list variable containing multiple values.
List,
/// A shadow variable computed from other variables.
Shadow(ShadowVariableKind),
}
/// The kind of shadow variable.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum ShadowVariableKind {
/// Custom shadow variable with user-defined listener.
Custom,
/// Inverse of another variable (bidirectional relationship).
InverseRelation,
/// Index within a list variable.
Index,
/// Next element in a list variable.
NextElement,
/// Previous element in a list variable.
PreviousElement,
/// Cascading update from other shadow variables.
Cascading,
/// Piggyback on another shadow variable's listener.
Piggyback,
}
/// The type of value range for a planning variable.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ValueRangeType {
/// A collection of discrete values.
Collection,
/// A countable range (e.g., integers from 1 to 100).
CountableRange {
/// Inclusive start of the range.
from: i64,
/// Exclusive end of the range.
to: i64,
},
/// An entity-dependent value range.
EntityDependent,
}
impl VariableType {
/// Returns true if this is a genuine (non-shadow) variable.
///
/// Genuine variables include scalar and list variables.
pub fn is_genuine(&self) -> bool {
matches!(self, VariableType::Genuine | VariableType::List)
}
/// Returns `true` for shadow variables.
pub fn is_shadow(&self) -> bool {
matches!(self, VariableType::Shadow(_))
}
/// Returns `true` for list variables.
pub fn is_list(&self) -> bool {
matches!(self, VariableType::List)
}
/// Returns `true` for genuine scalar variables.
pub fn is_basic(&self) -> bool {
matches!(self, VariableType::Genuine)
}
}
impl ShadowVariableKind {
/// Returns `true` for kinds updated by a listener (`Custom` and `Cascading`).
pub fn requires_listener(&self) -> bool {
matches!(
self,
ShadowVariableKind::Custom | ShadowVariableKind::Cascading
)
}
/// Returns `true` for kinds the solver maintains itself (`InverseRelation`,
/// `Index`, `NextElement`, `PreviousElement`).
pub fn is_automatic(&self) -> bool {
matches!(
self,
ShadowVariableKind::InverseRelation
| ShadowVariableKind::Index
| ShadowVariableKind::NextElement
| ShadowVariableKind::PreviousElement
)
}
/// Returns true if this shadow variable piggybacks on another
/// shadow variable's listener rather than having its own.
pub fn is_piggyback(&self) -> bool {
matches!(self, ShadowVariableKind::Piggyback)
}
}