kure2 0.3.0

Safe bindings for Kure2, a C library which provides manipulation of relations and operations of relation algebra
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318

use kure2_sys as ffi;

use crate::{Context, context};

mod basic;
pub mod fmt;
pub mod iter;

/// A relation, represented using a binary decision diagram (BDD).
pub struct Relation {
    pub(crate) ptr: *mut ffi::KureRel,
    pub(crate) ctx: Context,
}

// Factories
impl Relation {
    /// Creates an empty relation with the given number of rows and columns in the given [`Context`].
    pub fn empty(rows: &rug::Integer, cols: &rug::Integer) -> Self {
        Self::empty_with_context(context(), rows, cols)
    }

    /// Creates an empty relation with the given number of rows and columns in the given [`Context`].
    pub fn empty_i32(rows: i32, cols: i32) -> Self {
        Self::empty_i32_with_context(context(), rows, cols)
    }

    /// Creates an identity relation with the given size in the given [`Context`].
    pub fn identity(size: &rug::Integer) -> Self {
        Self::identity_with_context(context(), size)
    }

    /// Creates an identity relation with the given size in the given [`Context`].
    pub fn identity_i32(size: i32) -> Self {
        Self::identity_i32_with_context(context(), size)
    }

    /// Creates a universal relation with the given number of rows and columns in the given [`Context`].
    pub fn all(rows: &rug::Integer, cols: &rug::Integer) -> Self {
        Self::all_with_context(context(), rows, cols)
    }

    /// Creates a universal relation with the given number of rows and columns in the given [`Context`].
    pub fn all_i32(rows: i32, cols: i32) -> Self {
        Self::all_i32_with_context(context(), rows, cols)
    }

    /// Creates an empty relation with the given number of rows and columns in the given [`Context`].
    pub fn empty_with_context(ctx: Context, rows: &rug::Integer, cols: &rug::Integer) -> Self {
        let ptr = unsafe { ffi::kure_rel_new_with_size(ctx.ptr, rows.as_raw(), cols.as_raw()) };
        if ptr.is_null() {
            ctx.panic_with_error();
        }

        Self { ptr, ctx }
    }

    /// Creates an empty relation with the given number of rows and columns in the given [`Context`].
    pub fn empty_i32_with_context(ctx: Context, rows: i32, cols: i32) -> Self {
        let ptr = unsafe { ffi::kure_rel_new_with_size_si(ctx.ptr, rows, cols) };
        if ptr.is_null() {
            ctx.panic_with_error();
        }

        Self { ptr, ctx }
    }

    /// Creates an identity relation with the given size in the given [`Context`].
    pub fn identity_with_context(ctx: Context, size: &rug::Integer) -> Self {
        let mut relation = Self::empty_with_context(ctx, size, size);
        relation.identity_mut();
        relation
    }

    /// Creates an identity relation with the given size in the given [`Context`].
    pub fn identity_i32_with_context(ctx: Context, size: i32) -> Self {
        let mut relation = Self::empty_i32_with_context(ctx, size, size);
        relation.identity_mut();
        relation
    }

    /// Creates a universal relation with the given number of rows and columns in the given [`Context`].
    pub fn all_with_context(ctx: Context, rows: &rug::Integer, cols: &rug::Integer) -> Self {
        let mut relation = Self::empty_with_context(ctx, rows, cols);
        relation.all_mut();
        relation
    }

    /// Creates a universal relation with the given number of rows and columns in the given [`Context`].
    pub fn all_i32_with_context(ctx: Context, rows: i32, cols: i32) -> Self {
        let mut relation = Self::empty_i32_with_context(ctx, rows, cols);
        relation.all_mut();
        relation
    }

    /// Returns the context associated with this relation.
    pub fn context(&self) -> &Context {
        &self.ctx
    }

    /// Sets the given relation to the empty relation.
    pub fn empty_mut(&mut self) {
        let success = unsafe { ffi::kure_O(self.ptr) };
        if success == 0 {
            self.ctx.panic_with_error();
        }
    }

    /// Sets the given relation to the identity relation.
    pub fn identity_mut(&mut self) {
        let success = unsafe { ffi::kure_I(self.ptr) };
        if success == 0 {
            self.ctx.panic_with_error();
        }
    }

    /// Sets the given relation to the universal relation.
    pub fn all_mut(&mut self) {
        let success = unsafe { ffi::kure_L(self.ptr) };
        if success == 0 {
            self.ctx.panic_with_error();
        }
    }
}

impl Clone for Relation {
    fn clone(&self) -> Self {
        let ptr = unsafe { ffi::kure_rel_new_copy(self.ptr) };
        if ptr.is_null() {
            self.ctx.panic_with_error();
        }
        Self {
            ptr,
            ctx: self.ctx.clone(),
        }
    }
}

impl Drop for Relation {
    fn drop(&mut self) {
        unsafe { ffi::kure_rel_destroy(self.ptr) };
    }
}

#[cfg(test)]
mod tests {
    use crate::Relation;

    #[test]
    fn test_create_empty() {
        let rows = rug::Integer::from(3);
        let cols = rug::Integer::from(4);

        let relation = Relation::empty(&rows, &cols);

        assert_eq!(relation.rows(), rows);
        assert_eq!(relation.cols(), cols);
        for i in 0..3 {
            let i = rug::Integer::from(i);
            for j in 0..4 {
                let j = rug::Integer::from(j);
                assert!(!relation.bit(&i, &j));
            }
        }
    }

    #[test]
    fn test_create_empty_i32() {
        let rows = 3;
        let cols = 4;

        let relation = Relation::empty_i32(rows, cols);

        assert_eq!(relation.rows_i32(), rows);
        assert_eq!(relation.cols_i32(), cols);
        for i in 0..rows {
            for j in 0..cols {
                assert!(!relation.bit_i32(i, j));
            }
        }
    }

    #[test]
    fn test_create_identity() {
        let size = rug::Integer::from(3);

        let relation = Relation::identity(&size);

        assert_eq!(relation.rows(), size);
        assert_eq!(relation.cols(), size);
        for i in 0..3 {
            let i = rug::Integer::from(i);
            for j in 0..3 {
                let j = rug::Integer::from(j);
                assert_eq!(relation.bit(&i, &j), i == j);
            }
        }
    }

    #[test]
    fn test_create_identity_i32() {
        let size = 3;

        let relation = Relation::identity_i32(size);

        assert_eq!(relation.rows_i32(), size);
        assert_eq!(relation.cols_i32(), size);
        for i in 0..size {
            for j in 0..size {
                assert_eq!(relation.bit_i32(i, j), i == j);
            }
        }
    }

    #[test]
    fn test_create_all() {
        let rows = rug::Integer::from(3);
        let cols = rug::Integer::from(4);

        let relation = Relation::all(&rows, &cols);

        assert_eq!(relation.rows(), rows);
        assert_eq!(relation.cols(), cols);
        for i in 0..3 {
            let i = rug::Integer::from(i);
            for j in 0..4 {
                let j = rug::Integer::from(j);
                assert!(relation.bit(&i, &j));
            }
        }
    }

    #[test]
    fn test_create_all_i32() {
        let rows = 3;
        let cols = 4;

        let relation = Relation::all_i32(rows, cols);

        assert_eq!(relation.rows_i32(), rows);
        assert_eq!(relation.cols_i32(), cols);
        for i in 0..rows {
            for j in 0..cols {
                assert!(relation.bit_i32(i, j));
            }
        }
    }

    #[test]
    fn test_make_empty() {
        let rows = 3;
        let cols = 4;
        let mut relation = Relation::all_i32(rows, cols);

        relation.empty_mut();

        assert_eq!(relation.rows_i32(), rows);
        assert_eq!(relation.cols_i32(), cols);
        for i in 0..rows {
            for j in 0..cols {
                assert!(!relation.bit_i32(i, j));
            }
        }
    }

    #[test]
    fn test_make_identity() {
        let size = 3;
        let mut relation = Relation::empty_i32(size, size);

        relation.identity_mut();

        assert_eq!(relation.rows_i32(), size);
        assert_eq!(relation.cols_i32(), size);
        for i in 0..size {
            for j in 0..size {
                assert_eq!(relation.bit_i32(i, j), i == j);
            }
        }
    }

    #[test]
    #[should_panic]
    fn test_make_identity_non_homogenous() {
        let rows = 3;
        let cols = 4;
        let mut relation = Relation::empty_i32(rows, cols);

        relation.identity_mut();
    }

    #[test]
    fn test_make_all() {
        let rows = 3;
        let cols = 4;
        let mut relation = Relation::empty_i32(rows, cols);

        relation.all_mut();

        assert_eq!(relation.rows_i32(), rows);
        assert_eq!(relation.cols_i32(), cols);
        for i in 0..rows {
            for j in 0..cols {
                assert!(relation.bit_i32(i, j));
            }
        }
    }

    #[test]
    fn test_clone() {
        let mut relation = Relation::empty_i32(3, 4);
        relation.set_bit_i32(1, 2, true);

        let cloned = relation.clone();

        assert!(cloned.bit_i32(1, 2));
        assert!(!cloned.bit_i32(0, 0));
    }
}