selen 0.15.5

Constraint Satisfaction Problem (CSP) solver
Documentation 
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

//! Reified constraint methods for Model
//!
//! This module provides convenient methods on the Model struct for posting
//! reified constraints. These methods delegate to the generic functions from
//! the constraints::functions module.
//!
//! ## Available Methods
//!
//! - `model.eq_reif(x, y, b)` - b ⇔ (x == y)
//! - `model.ne_reif(x, y, b)` - b ⇔ (x != y)
//! - `model.lt_reif(x, y, b)` - b ⇔ (x < y)
//! - `model.le_reif(x, y, b)` - b ⇔ (x <= y)
//! - `model.gt_reif(x, y, b)` - b ⇔ (x > y)
//! - `model.ge_reif(x, y, b)` - b ⇔ (x >= y)
//!
//! All methods work with both integer and float variables.

use crate::model::Model;
use crate::variables::VarId;

impl Model {
    /// Post a reified equality constraint: `b ⇔ (x == y)`.
    ///
    /// The boolean variable `b` is true if and only if `x` equals `y`.
    /// Works with both integer and float variables.
    ///
    /// # Arguments
    /// * `x` - First variable
    /// * `y` - Second variable
    /// * `b` - Boolean variable that reflects the result
    ///
    /// # Examples
    /// ```
    /// # use selen::prelude::*;
    /// let mut model = Model::default();
    /// let x = model.int(0, 10);
    /// let y = model.int(0, 10);
    /// let b = model.bool();
    /// model.eq_reif(x, y, b); // b is true iff x == y
    /// ```
    pub fn eq_reif(&mut self, x: VarId, y: VarId, b: VarId) {
        crate::constraints::functions::eq_reif(self, x, y, b);
    }

    /// Post a reified not-equal constraint: `b ⇔ (x != y)`.
    ///
    /// The boolean variable `b` is true if and only if `x` does not equal `y`.
    /// Works with both integer and float variables.
    ///
    /// # Arguments
    /// * `x` - First variable
    /// * `y` - Second variable
    /// * `b` - Boolean variable that reflects the result
    ///
    /// # Examples
    /// ```
    /// # use selen::prelude::*;
    /// let mut model = Model::default();
    /// let x = model.int(0, 10);
    /// let y = model.int(0, 10);
    /// let b = model.bool();
    /// model.ne_reif(x, y, b); // b is true iff x != y
    /// ```
    pub fn ne_reif(&mut self, x: VarId, y: VarId, b: VarId) {
        crate::constraints::functions::ne_reif(self, x, y, b);
    }

    /// Post a reified less-than constraint: `b ⇔ (x < y)`.
    ///
    /// The boolean variable `b` is true if and only if `x` is less than `y`.
    /// Works with both integer and float variables.
    ///
    /// # Arguments
    /// * `x` - First variable
    /// * `y` - Second variable
    /// * `b` - Boolean variable that reflects the result
    ///
    /// # Examples
    /// ```
    /// # use selen::prelude::*;
    /// let mut model = Model::default();
    /// let x = model.int(0, 10);
    /// let y = model.int(0, 10);
    /// let b = model.bool();
    /// model.lt_reif(x, y, b); // b is true iff x < y
    /// ```
    pub fn lt_reif(&mut self, x: VarId, y: VarId, b: VarId) {
        crate::constraints::functions::lt_reif(self, x, y, b);
    }

    /// Post a reified less-than-or-equal constraint: `b ⇔ (x <= y)`.
    ///
    /// The boolean variable `b` is true if and only if `x` is less than or equal to `y`.
    /// Works with both integer and float variables.
    ///
    /// # Arguments
    /// * `x` - First variable
    /// * `y` - Second variable
    /// * `b` - Boolean variable that reflects the result
    ///
    /// # Examples
    /// ```
    /// # use selen::prelude::*;
    /// let mut model = Model::default();
    /// let x = model.int(0, 10);
    /// let y = model.int(0, 10);
    /// let b = model.bool();
    /// model.le_reif(x, y, b); // b is true iff x <= y
    /// ```
    pub fn le_reif(&mut self, x: VarId, y: VarId, b: VarId) {
        crate::constraints::functions::le_reif(self, x, y, b);
    }

    /// Post a reified greater-than constraint: `b ⇔ (x > y)`.
    ///
    /// The boolean variable `b` is true if and only if `x` is greater than `y`.
    /// Works with both integer and float variables.
    ///
    /// # Arguments
    /// * `x` - First variable
    /// * `y` - Second variable
    /// * `b` - Boolean variable that reflects the result
    ///
    /// # Examples
    /// ```
    /// # use selen::prelude::*;
    /// let mut model = Model::default();
    /// let x = model.int(0, 10);
    /// let y = model.int(0, 10);
    /// let b = model.bool();
    /// model.gt_reif(x, y, b); // b is true iff x > y
    /// ```
    pub fn gt_reif(&mut self, x: VarId, y: VarId, b: VarId) {
        crate::constraints::functions::gt_reif(self, x, y, b);
    }

    /// Post a reified greater-than-or-equal constraint: `b ⇔ (x >= y)`.
    ///
    /// The boolean variable `b` is true if and only if `x` is greater than or equal to `y`.
    /// Works with both integer and float variables.
    ///
    /// # Arguments
    /// * `x` - First variable
    /// * `y` - Second variable
    /// * `b` - Boolean variable that reflects the result
    ///
    /// # Examples
    /// ```
    /// # use selen::prelude::*;
    /// let mut model = Model::default();
    /// let x = model.int(0, 10);
    /// let y = model.int(0, 10);
    /// let b = model.bool();
    /// model.ge_reif(x, y, b); // b is true iff x >= y
    /// ```
    pub fn ge_reif(&mut self, x: VarId, y: VarId, b: VarId) {
        crate::constraints::functions::ge_reif(self, x, y, b);
    }
}