set_theory 1.0.0

A comprehensive mathematical set theory library implementing standard set operations, multisets, and set laws verification
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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
//! # Set Laws Verification
//!
//! Provides verification methods for standard set theory laws.
//!
//! These laws are fundamental identities in set algebra that can be used
//! to prove set equivalences and simplify set expressions.

use std::hash::Hash;

use crate::{CustomSet, SetOperations};

/// Provides verification methods for standard set theory laws.
///
/// Each method returns `true` if the law holds for the given sets.
///
/// # Examples
///
/// ```rust
/// use set_theory::models::CustomSet;
/// use set_theory::laws::SetLaws;
///
/// let a = CustomSet::from(vec![1, 2, 3]);
/// let b = CustomSet::from(vec![3, 4, 5]);
///
/// assert!(SetLaws::commutative_union(&a, &b));
/// assert!(SetLaws::de_morgan_union(&a, &b, &CustomSet::from(vec![1, 2, 3, 4, 5, 6, 7, 8, 9])));
/// ```
pub struct SetLaws;

impl SetLaws {
    /// Verifies the Identity Law for Union.
    ///
    /// # Law
    ///
    /// A ∪ ∅ = A
    ///
    /// # Examples
    ///
    /// ```rust
    /// use set_theory::models::CustomSet;
    /// use set_theory::laws::SetLaws;
    ///
    /// let a = CustomSet::from(vec![1, 2, 3]);
    /// assert!(SetLaws::identity_union(&a));
    /// ```
    pub fn identity_union<T: Eq + Hash + Clone>(a: &CustomSet<T>) -> bool {
        let empty = CustomSet::<T>::empty();
        SetOperations::union(a, &empty).equals(a)
    }

    /// Verifies the Identity Law for Intersection.
    ///
    /// # Law
    ///
    /// A ∩ U = A
    ///
    /// # Examples
    ///
    /// ```rust
    /// use set_theory::models::CustomSet;
    /// use set_theory::laws::SetLaws;
    ///
    /// let a = CustomSet::from(vec![1, 2, 3]);
    /// let universal = CustomSet::from(vec![1, 2, 3, 4, 5]);
    /// assert!(SetLaws::identity_intersection(&a, &universal));
    /// ```
    pub fn identity_intersection<T: Eq + Hash + Clone>(
        a: &CustomSet<T>,
        universal: &CustomSet<T>,
    ) -> bool {
        SetOperations::intersection(a, universal).equals(a)
    }

    /// Verifies the Null/Domination Law for Intersection.
    ///
    /// # Law
    ///
    /// A ∩ ∅ = ∅
    ///
    /// # Examples
    ///
    /// ```rust
    /// use set_theory::models::CustomSet;
    /// use set_theory::laws::SetLaws;
    ///
    /// let a = CustomSet::from(vec![1, 2, 3]);
    /// assert!(SetLaws::null_intersection(&a));
    /// ```
    pub fn null_intersection<T: Eq + Hash + Clone>(a: &CustomSet<T>) -> bool {
        let empty = CustomSet::<T>::empty();
        SetOperations::intersection(a, &empty).is_empty()
    }

    /// Verifies the Null/Domination Law for Union.
    ///
    /// # Law
    ///
    /// A ∪ U = U
    ///
    /// # Examples
    ///
    /// ```rust
    /// use set_theory::models::CustomSet;
    /// use set_theory::laws::SetLaws;
    ///
    /// let a = CustomSet::from(vec![1, 2, 3]);
    /// let universal = CustomSet::from(vec![1, 2, 3, 4, 5]);
    /// assert!(SetLaws::null_union(&a, &universal));
    /// ```
    pub fn null_union<T: Eq + Hash + Clone>(a: &CustomSet<T>, universal: &CustomSet<T>) -> bool {
        SetOperations::union(a, universal).equals(universal)
    }

    /// Verifies the Complement Law for Union.
    ///
    /// # Law
    ///
    /// A ∪ A' = U
    ///
    /// # Examples
    ///
    /// ```rust
    /// use set_theory::models::CustomSet;
    /// use set_theory::laws::SetLaws;
    ///
    /// let a = CustomSet::from(vec![1, 2, 3]);
    /// let universal = CustomSet::from(vec![1, 2, 3, 4, 5, 6, 7, 8, 9]);
    /// assert!(SetLaws::complement_union(&a, &universal));
    /// ```
    pub fn complement_union<T: Eq + Hash + Clone>(
        a: &CustomSet<T>,
        universal: &CustomSet<T>,
    ) -> bool {
        let complement = SetOperations::complement(a, universal);
        SetOperations::union(a, &complement).equals(universal)
    }

    /// Verifies the Complement Law for Intersection.
    ///
    /// # Law
    ///
    /// A ∩ A' = ∅
    ///
    /// # Examples
    ///
    /// ```rust
    /// use set_theory::models::CustomSet;
    /// use set_theory::laws::SetLaws;
    ///
    /// let a = CustomSet::from(vec![1, 2, 3]);
    /// let universal = CustomSet::from(vec![1, 2, 3, 4, 5, 6, 7, 8, 9]);
    /// assert!(SetLaws::complement_intersection(&a, &universal));
    /// ```
    pub fn complement_intersection<T: Eq + Hash + Clone>(
        a: &CustomSet<T>,
        universal: &CustomSet<T>,
    ) -> bool {
        let complement = SetOperations::complement(a, universal);
        SetOperations::intersection(a, &complement).is_empty()
    }

    /// Verifies the Idempotent Law for Union.
    ///
    /// # Law
    ///
    /// A ∪ A = A
    ///
    /// # Examples
    ///
    /// ```rust
    /// use set_theory::models::CustomSet;
    /// use set_theory::laws::SetLaws;
    ///
    /// let a = CustomSet::from(vec![1, 2, 3]);
    /// assert!(SetLaws::idempotent_union(&a));
    /// ```
    pub fn idempotent_union<T: Eq + Hash + Clone>(a: &CustomSet<T>) -> bool {
        SetOperations::union(a, a).equals(a)
    }

    /// Verifies the Idempotent Law for Intersection.
    ///
    /// # Law
    ///
    /// A ∩ A = A
    ///
    /// # Examples
    ///
    /// ```rust
    /// use set_theory::models::CustomSet;
    /// use set_theory::laws::SetLaws;
    ///
    /// let a = CustomSet::from(vec![1, 2, 3]);
    /// assert!(SetLaws::idempotent_intersection(&a));
    /// ```
    pub fn idempotent_intersection<T: Eq + Hash + Clone>(a: &CustomSet<T>) -> bool {
        SetOperations::intersection(a, a).equals(a)
    }

    /// Verifies the Involution Law.
    ///
    /// # Law
    ///
    /// (A')' = A
    ///
    /// # Examples
    ///
    /// ```rust
    /// use set_theory::models::CustomSet;
    /// use set_theory::laws::SetLaws;
    ///
    /// let a = CustomSet::from(vec![1, 2, 3]);
    /// let universal = CustomSet::from(vec![1, 2, 3, 4, 5, 6, 7, 8, 9]);
    /// assert!(SetLaws::involution(&a, &universal));
    /// ```
    pub fn involution<T: Eq + Hash + Clone>(a: &CustomSet<T>, universal: &CustomSet<T>) -> bool {
        let complement1 = SetOperations::complement(a, universal);
        let complement2 = SetOperations::complement(&complement1, universal);
        complement2.equals(a)
    }

    /// Verifies the Absorption Law for Union.
    ///
    /// # Law
    ///
    /// A ∪ (A ∩ B) = A
    ///
    /// # Examples
    ///
    /// ```rust
    /// use set_theory::models::CustomSet;
    /// use set_theory::laws::SetLaws;
    ///
    /// let a = CustomSet::from(vec![1, 2, 3]);
    /// let b = CustomSet::from(vec![3, 4, 5]);
    /// assert!(SetLaws::absorption_union(&a, &b));
    /// ```
    pub fn absorption_union<T: Eq + Hash + Clone>(a: &CustomSet<T>, b: &CustomSet<T>) -> bool {
        let intersection = SetOperations::intersection(a, b);
        SetOperations::union(a, &intersection).equals(a)
    }

    /// Verifies the Absorption Law for Intersection.
    ///
    /// # Law
    ///
    /// A ∩ (A ∪ B) = A
    ///
    /// # Examples
    ///
    /// ```rust
    /// use set_theory::models::CustomSet;
    /// use set_theory::laws::SetLaws;
    ///
    /// let a = CustomSet::from(vec![1, 2, 3]);
    /// let b = CustomSet::from(vec![3, 4, 5]);
    /// assert!(SetLaws::absorption_intersection(&a, &b));
    /// ```
    pub fn absorption_intersection<T: Eq + Hash + Clone>(
        a: &CustomSet<T>,
        b: &CustomSet<T>,
    ) -> bool {
        let union = SetOperations::union(a, b);
        SetOperations::intersection(a, &union).equals(a)
    }

    /// Verifies the Commutative Law for Union.
    ///
    /// # Law
    ///
    /// A ∪ B = B ∪ A
    ///
    /// # Examples
    ///
    /// ```rust
    /// use set_theory::models::CustomSet;
    /// use set_theory::laws::SetLaws;
    ///
    /// let a = CustomSet::from(vec![1, 2, 3]);
    /// let b = CustomSet::from(vec![3, 4, 5]);
    /// assert!(SetLaws::commutative_union(&a, &b));
    /// ```
    pub fn commutative_union<T: Eq + Hash + Clone>(a: &CustomSet<T>, b: &CustomSet<T>) -> bool {
        SetOperations::union(a, b).equals(&SetOperations::union(b, a))
    }

    /// Verifies the Commutative Law for Intersection.
    ///
    /// # Law
    ///
    /// A ∩ B = B ∩ A
    ///
    /// # Examples
    ///
    /// ```rust
    /// use set_theory::models::CustomSet;
    /// use set_theory::laws::SetLaws;
    ///
    /// let a = CustomSet::from(vec![1, 2, 3]);
    /// let b = CustomSet::from(vec![3, 4, 5]);
    /// assert!(SetLaws::commutative_intersection(&a, &b));
    /// ```
    pub fn commutative_intersection<T: Eq + Hash + Clone>(
        a: &CustomSet<T>,
        b: &CustomSet<T>,
    ) -> bool {
        SetOperations::intersection(a, b).equals(&SetOperations::intersection(b, a))
    }

    /// Verifies the Associative Law for Union.
    ///
    /// # Law
    ///
    /// A ∪ (B ∪ C) = (A ∪ B) ∪ C
    ///
    /// # Examples
    ///
    /// ```rust
    /// use set_theory::models::CustomSet;
    /// use set_theory::laws::SetLaws;
    ///
    /// let a = CustomSet::from(vec![1, 2, 3]);
    /// let b = CustomSet::from(vec![3, 4, 5]);
    /// let c = CustomSet::from(vec![5, 6, 7]);
    /// assert!(SetLaws::associative_union(&a, &b, &c));
    /// ```
    pub fn associative_union<T: Eq + Hash + Clone>(
        a: &CustomSet<T>,
        b: &CustomSet<T>,
        c: &CustomSet<T>,
    ) -> bool {
        let left = SetOperations::union(a, &SetOperations::union(b, c));
        let right = SetOperations::union(&SetOperations::union(a, b), c);
        left.equals(&right)
    }

    /// Verifies the Associative Law for Intersection.
    ///
    /// # Law
    ///
    /// A ∩ (B ∩ C) = (A ∩ B) ∩ C
    ///
    /// # Examples
    ///
    /// ```rust
    /// use set_theory::models::CustomSet;
    /// use set_theory::laws::SetLaws;
    ///
    /// let a = CustomSet::from(vec![1, 2, 3]);
    /// let b = CustomSet::from(vec![3, 4, 5]);
    /// let c = CustomSet::from(vec![5, 6, 7]);
    /// assert!(SetLaws::associative_intersection(&a, &b, &c));
    /// ```
    pub fn associative_intersection<T: Eq + Hash + Clone>(
        a: &CustomSet<T>,
        b: &CustomSet<T>,
        c: &CustomSet<T>,
    ) -> bool {
        let left = SetOperations::intersection(a, &SetOperations::intersection(b, c));
        let right = SetOperations::intersection(&SetOperations::intersection(a, b), c);
        left.equals(&right)
    }

    /// Verifies the Distributive Law for Union over Intersection.
    ///
    /// # Law
    ///
    /// A ∪ (B ∩ C) = (A ∪ B) ∩ (A ∪ C)
    ///
    /// # Examples
    ///
    /// ```rust
    /// use set_theory::models::CustomSet;
    /// use set_theory::laws::SetLaws;
    ///
    /// let a = CustomSet::from(vec![1, 2, 3]);
    /// let b = CustomSet::from(vec![3, 4, 5]);
    /// let c = CustomSet::from(vec![5, 6, 7]);
    /// assert!(SetLaws::distributive_union(&a, &b, &c));
    /// ```
    pub fn distributive_union<T: Eq + Hash + Clone>(
        a: &CustomSet<T>,
        b: &CustomSet<T>,
        c: &CustomSet<T>,
    ) -> bool {
        let left = SetOperations::union(a, &SetOperations::intersection(b, c));
        let right =
            SetOperations::intersection(&SetOperations::union(a, b), &SetOperations::union(a, c));
        left.equals(&right)
    }

    /// Verifies the Distributive Law for Intersection over Union.
    ///
    /// # Law
    ///
    /// A ∩ (B ∪ C) = (A ∩ B) ∪ (A ∩ C)
    ///
    /// # Examples
    ///
    /// ```rust
    /// use set_theory::models::CustomSet;
    /// use set_theory::laws::SetLaws;
    ///
    /// let a = CustomSet::from(vec![1, 2, 3]);
    /// let b = CustomSet::from(vec![3, 4, 5]);
    /// let c = CustomSet::from(vec![5, 6, 7]);
    /// assert!(SetLaws::distributive_intersection(&a, &b, &c));
    /// ```
    pub fn distributive_intersection<T: Eq + Hash + Clone>(
        a: &CustomSet<T>,
        b: &CustomSet<T>,
        c: &CustomSet<T>,
    ) -> bool {
        let left = SetOperations::intersection(a, &SetOperations::union(b, c));
        let right = SetOperations::union(
            &SetOperations::intersection(a, b),
            &SetOperations::intersection(a, c),
        );
        left.equals(&right)
    }

    /// Verifies De Morgan's Law for Union.
    ///
    /// # Law
    ///
    /// (A ∪ B)' = A' ∩ B'
    ///
    /// # Examples
    ///
    /// ```rust
    /// use set_theory::models::CustomSet;
    /// use set_theory::laws::SetLaws;
    ///
    /// let a = CustomSet::from(vec![1, 2, 3]);
    /// let b = CustomSet::from(vec![3, 4, 5]);
    /// let universal = CustomSet::from(vec![1, 2, 3, 4, 5, 6, 7, 8, 9]);
    /// assert!(SetLaws::de_morgan_union(&a, &b, &universal));
    /// ```
    pub fn de_morgan_union<T: Eq + Hash + Clone>(
        a: &CustomSet<T>,
        b: &CustomSet<T>,
        universal: &CustomSet<T>,
    ) -> bool {
        let union = SetOperations::union(a, b);
        let complement_union = SetOperations::complement(&union, universal);
        let complement_a = SetOperations::complement(a, universal);
        let complement_b = SetOperations::complement(b, universal);
        let intersection_complements = SetOperations::intersection(&complement_a, &complement_b);
        complement_union.equals(&intersection_complements)
    }

    /// Verifies De Morgan's Law for Intersection.
    ///
    /// # Law
    ///
    /// (A ∩ B)' = A' ∪ B'
    ///
    /// # Examples
    ///
    /// ```rust
    /// use set_theory::models::CustomSet;
    /// use set_theory::laws::SetLaws;
    ///
    /// let a = CustomSet::from(vec![1, 2, 3]);
    /// let b = CustomSet::from(vec![3, 4, 5]);
    /// let universal = CustomSet::from(vec![1, 2, 3, 4, 5, 6, 7, 8, 9]);
    /// assert!(SetLaws::de_morgan_intersection(&a, &b, &universal));
    /// ```
    pub fn de_morgan_intersection<T: Eq + Hash + Clone>(
        a: &CustomSet<T>,
        b: &CustomSet<T>,
        universal: &CustomSet<T>,
    ) -> bool {
        let intersection = SetOperations::intersection(a, b);
        let complement_intersection = SetOperations::complement(&intersection, universal);
        let complement_a = SetOperations::complement(a, universal);
        let complement_b = SetOperations::complement(b, universal);
        let union_complements = SetOperations::union(&complement_a, &complement_b);
        complement_intersection.equals(&union_complements)
    }

    /// Verifies the Law 0/1 for Empty Set Complement.
    ///
    /// # Law
    ///
    /// ∅' = U
    ///
    /// # Examples
    ///
    /// ```rust
    /// use set_theory::models::CustomSet;
    /// use set_theory::laws::SetLaws;
    ///
    /// let universal = CustomSet::from(vec![1, 2, 3, 4, 5]);
    /// assert!(SetLaws::law_zero(&universal));
    /// ```
    pub fn law_zero<T: Eq + Hash + Clone>(universal: &CustomSet<T>) -> bool {
        let empty = CustomSet::<T>::empty();
        SetOperations::complement(&empty, universal).equals(universal)
    }

    /// Verifies the Law 0/1 for Universal Set Complement.
    ///
    /// # Law
    ///
    /// U' = ∅
    ///
    /// # Examples
    ///
    /// ```rust
    /// use set_theory::models::CustomSet;
    /// use set_theory::laws::SetLaws;
    ///
    /// let universal = CustomSet::from(vec![1, 2, 3, 4, 5]);
    /// assert!(SetLaws::law_one(&universal));
    /// ```
    pub fn law_one<T: Eq + Hash + Clone>(universal: &CustomSet<T>) -> bool {
        SetOperations::complement(universal, universal).is_empty()
    }
}