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
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
use std::fmt::Display;
/// Maximum domain size supported by SparseSet
///
/// This limit is enforced to prevent performance issues and excessive memory usage.
/// Domains larger than this should be rejected during model construction.
pub const MAX_SPARSE_SET_DOMAIN_SIZE: u64 = 1_000_000;
/// State snapshot for backtracking in SparseSet
#[doc(hidden)]
#[derive(Clone, Debug, PartialEq)]
pub struct SparseSetState {
pub size: u32,
pub min: u32,
pub max: u32,
}
#[doc(hidden)]
#[derive(Debug, Clone)]
pub struct SparseSet {
off: i32, // the domain offset (fixed)
n: u32, // total number of values in domain
min: u32, // current minimum value in the set
max: u32, // current maximum value in the set
size: u32, // domain size
ind: Vec<u32>, // sparse set indices
val: Vec<u32>, // sparse set values
}
impl Display for SparseSet {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut s = String::new();
use std::fmt::Write;
write!(s, "[").expect("writing to String should never fail");
if self.size == 0 {
write!(s, "|").expect("writing to String should never fail");
}
for i in 0..self.n {
write!(s, "{},", (self.val[i as usize] as i32 + self.off)).expect("writing to String should never fail");
if i + 1 == self.size {
s.pop(); // remove comma
write!(s, "|").expect("writing to String should never fail");
}
}
if self.size != self.n {
s.pop(); // remove comma
}
write!(s, "]").expect("writing to String should never fail");
write!(f, "{}", s)
}
}
impl SparseSet {
pub fn new(min: i32, max: i32) -> Self {
if min > max {
// Handle invalid range by swapping
return Self::new(max, min);
}
let maxmin = (max - min) as u32;
let n = (maxmin + 1) as u32;
// Pre-allocate vectors with known capacity
let mut ind = Vec::with_capacity(n as usize);
let mut val = Vec::with_capacity(n as usize);
// Fill with consecutive values
for i in 0..n {
ind.push(i);
val.push(i);
}
SparseSet {
off: min,
min: 0,
max: maxmin,
n,
size: n,
ind,
val,
}
}
/// Create a SparseSet without bound checking - may create invalid domains
/// This is used to create intentionally invalid domains that validation can catch
pub fn new_unchecked(min: i32, max: i32) -> Self {
if min > max {
// Create an invalid domain that preserves the original bounds
// We'll create a domain where the universe bounds show the invalid range
// but the domain itself is empty
SparseSet {
off: min,
min: 0,
max: 0,
n: 0,
size: 0,
ind: Vec::new(),
val: Vec::new(),
}
} else {
// Valid bounds - use normal creation
Self::new(min, max)
}
}
/// Create a SparseSet from a vector of specific values
/// Memory efficient - creates full range then removes unwanted values
pub fn new_from_values(values: Vec<i32>) -> Self {
if values.is_empty() {
// Return empty sparse set with minimal footprint
return SparseSet {
off: 0,
min: 0,
max: 0,
n: 0,
size: 0,
ind: Vec::new(),
val: Vec::new(),
};
}
// Sort and deduplicate values
let mut sorted_values = values;
sorted_values.sort_unstable();
sorted_values.dedup();
let min_val = sorted_values[0];
let max_val = sorted_values[sorted_values.len() - 1];
// Create sparse set with full range - this ensures compatibility with all operations
let mut sparse_set = SparseSet::new(min_val, max_val);
// Remove all values that are not in our desired set
for i in min_val..=max_val {
if !sorted_values.contains(&i) {
sparse_set.remove(i);
}
}
sparse_set
}
#[inline]
pub fn min(&self) -> i32 {
debug_assert!(!self.is_empty());
self.min as i32 + self.off
}
#[inline]
pub fn max(&self) -> i32 {
debug_assert!(!self.is_empty());
self.max as i32 + self.off
}
#[inline]
pub fn size(&self) -> usize {
self.size as usize
}
// If variable domain is fixed to value
#[inline]
pub fn is_fixed(&self) -> bool {
self.size == 1
}
#[inline]
pub fn is_empty(&self) -> bool {
self.size == 0
}
#[inline]
pub fn contains(&self, v: i32) -> bool {
// outside range
if v < self.off {
return false;
}
let v = v - self.off;
self.contains_intl(v as u32)
}
// This method operates on the shifted value (one cannot shift now).
#[inline]
fn contains_intl(&self, v: u32) -> bool {
if v >= self.n {
false
} else {
self.ind[v as usize] < self.size
}
}
pub fn exchange(&mut self, val1: u32, val2: u32) {
let v1 = val1;
let v2 = val2;
let i1 = self.ind[v1 as usize];
let i2 = self.ind[v2 as usize];
self.val[i1 as usize] = v2;
self.val[i2 as usize] = v1;
self.ind[v1 as usize] = i2;
self.ind[v2 as usize] = i1;
}
fn update_bounds_val_removed(&mut self, val: u32) {
self.update_max_val_removed(val);
self.update_min_val_removed(val);
}
// update after max value is removed
fn update_max_val_removed(&mut self, val: u32) {
if !self.is_empty() && self.max == val {
// The maximum was removed, search the new one
for v in (self.min..val).rev() {
if self.contains_intl(v) {
self.max = v;
return;
}
}
}
}
// update after min value is removed
fn update_min_val_removed(&mut self, val: u32) {
if !self.is_empty() && self.min == val {
// The minimum was removed, search the new one
let vv = val + 1;
let vvv = self.max + 1;
for v in vv..vvv {
if self.contains_intl(v) {
self.min = v;
return;
}
}
}
}
pub fn remove(&mut self, val: i32) -> bool {
if !self.contains(val) {
// The value has already been removed
return false;
}
let val = (val - self.off) as u32;
self.exchange(val, self.val[self.size() - 1]);
self.size = self.size - 1;
self.update_bounds_val_removed(val);
return true;
}
pub fn remove_all(&mut self) {
self.size = 0;
}
// Removes all the element from the set except the given value.
pub fn remove_all_but(&mut self, v: i32) {
// if out of domain range
if !self.contains(v) {
self.remove_all();
return;
}
let v = (v - self.off) as u32;
let val = self.val[0];
let index = self.ind[v as usize];
self.ind[v as usize] = 0;
self.val[0] = v;
self.ind[val as usize] = index;
self.val[index as usize] = val;
self.min = v;
self.max = v;
self.size = 1;
}
pub fn remove_below(&mut self, val: i32) {
if self.is_empty() { return; }
if self.max() < val {
self.remove_all();
} else {
for v in self.min()..val {
self.remove(v);
}
}
}
pub fn remove_above(&mut self, val: i32) {
if self.is_empty() { return; }
if self.min() > val {
self.remove_all();
} else {
let x = (val + 1)..(self.max() + 1);
for v in x {
self.remove(v);
}
}
}
/// Get an iterator over the values in the set
pub fn iter(&self) -> impl Iterator<Item = i32> + '_ {
self.val[0..self.size as usize]
.iter()
.map(move |&v| v as i32 + self.off)
}
/// Get the first value in the set (arbitrary order)
pub fn first(&self) -> Option<i32> {
if self.is_empty() {
None
} else {
Some(self.val[0] as i32 + self.off)
}
}
/// Get the last value in the set (arbitrary order)
pub fn last(&self) -> Option<i32> {
if self.is_empty() {
None
} else {
Some(self.val[self.size as usize - 1] as i32 + self.off)
}
}
/// Convert to a vector of values (for compatibility)
pub fn to_vec(&self) -> Vec<i32> {
self.iter().collect()
}
/// Get the universe size (total possible values)
pub fn universe_size(&self) -> usize {
self.n as usize
}
/// Get the minimum value in the universe
pub fn min_universe_value(&self) -> i32 {
self.off
}
/// Get the maximum value in the universe
pub fn max_universe_value(&self) -> i32 {
self.off + self.n as i32 - 1
}
// ===== COMPLEMENT API (for incremental sum and other optimizations) =====
/// Get an iterator over the **removed** values (complement of current domain)
///
/// This is a key insight from the SparseSet design: removed values are stored
/// in `val[size..n)`, allowing us to iterate over the complement without
/// additional memory overhead.
///
/// # Example
/// ```
/// use selen::variables::domain::sparse_set::SparseSet;
/// let mut domain = SparseSet::new(1, 5); // Domain {1,2,3,4,5}
/// domain.remove(2);
/// domain.remove(4);
/// // complement_iter() yields {2, 4}
/// let complement: Vec<i32> = domain.complement_iter().collect();
/// assert_eq!(complement.len(), 2);
/// ```
pub fn complement_iter(&self) -> impl Iterator<Item = i32> + '_ {
self.val[self.size as usize..self.n as usize]
.iter()
.map(move |&v| v as i32 + self.off)
}
/// Get the size of the complement (number of removed values)
///
/// This is computed as `n - size` and is useful for choosing which set
/// to iterate over when optimizing constraint propagation.
///
/// # Example
/// ```
/// use selen::variables::domain::sparse_set::SparseSet;
/// let mut domain = SparseSet::new(1, 10); // 10 values initially
/// assert_eq!(domain.complement_size(), 0); // No removed values
///
/// domain.remove(1);
/// domain.remove(5);
/// assert_eq!(domain.complement_size(), 2); // 2 removed values
/// ```
pub fn complement_size(&self) -> usize {
(self.n - self.size) as usize
}
/// Check if iterating over complement is more efficient than current domain
///
/// Returns true if `complement_size < size / 2`, indicating that the complement
/// has fewer than half the elements of the current domain. This is useful for
/// optimization decisions like preferring `complement_iter()` when the domain
/// has been heavily pruned.
///
/// # Example
/// ```
/// use selen::variables::domain::sparse_set::SparseSet;
/// let mut domain = SparseSet::new(1, 100);
/// // Initially: size=100, complement_size=0. 0 < 50? Yes, but we check this only matters when complement > 0
///
/// // Remove 10 values: size becomes 90, complement_size becomes 10
/// for i in 1..=10 {
/// domain.remove(i);
/// }
/// // 10 < 90/2 = 10 < 45? Yes, so we SHOULD use complement
/// assert!(domain.should_use_complement());
///
/// // Remove 50 more values: size becomes 40, complement_size becomes 60
/// for i in 11..=60 {
/// domain.remove(i);
/// }
/// // 60 < 40/2 = 60 < 20? No, so we should NOT use complement
/// assert!(!domain.should_use_complement());
/// ```
pub fn should_use_complement(&self) -> bool {
self.complement_size() < (self.size as usize) / 2
}
/// Set intersection - modify this set to contain only elements in both sets
///
/// **Note**: This operates on the **domain** of integer variables, not on set-valued variables.
/// In Selen, `SparseSet` is used as the domain representation for integer variables (including
/// those created with `intset()`). These operations are useful for constraint propagation and
/// domain manipulation, but they do not implement FlatZinc set constraints like `set_union(x,y,z)`
/// which require true set-valued variables where the variable's value is itself a set.
///
/// # Examples
/// ```
/// use selen::variables::domain::sparse_set::SparseSet;
/// let mut domain1 = SparseSet::new(1, 5); // Domain {1,2,3,4,5}
/// let mut domain2 = SparseSet::new(3, 7); // Domain {3,4,5,6,7}
/// domain2.remove(6); // Domain {3,4,5,7}
/// domain1.intersect_with(&domain2); // domain1 becomes {3,4,5}
/// ```
pub fn intersect_with(&mut self, other: &SparseSet) {
// Create a list of values to remove to avoid modifying while iterating
let mut to_remove = Vec::with_capacity(self.size as usize);
for val in self.iter() {
if !other.contains(val) {
to_remove.push(val);
}
}
for val in to_remove {
self.remove(val);
}
}
/// Set union - add all elements from other set to this set
///
/// **Note**: This operates on the **domain** of integer variables, not on set-valued variables.
/// See `intersect_with()` for more details on the distinction.
///
/// Note: This requires that both sets have compatible universes
pub fn union_with(&mut self, other: &SparseSet) {
for val in other.iter() {
if self.contains(val) {
continue; // Already present
}
// Check if value is in our universe
if val >= self.off && val < self.off + self.n as i32 {
// Manually add the value (similar to remove but in reverse)
let val_internal = (val - self.off) as u32;
if !self.contains_intl(val_internal) {
// Add value to the end of the active set
let new_pos = self.size;
let old_val_at_pos = self.val[new_pos as usize];
// Swap the value to the active part
self.exchange(val_internal, old_val_at_pos);
self.size += 1;
// Update bounds if necessary
if self.size == 1 {
self.min = val_internal;
self.max = val_internal;
} else {
if val_internal < self.min {
self.min = val_internal;
}
if val_internal > self.max {
self.max = val_internal;
}
}
}
}
}
}
/// Set difference - remove all elements from this set that are in other set
///
/// This computes `self = self \ other` (set difference).
///
/// **Note**: This operates on the **domain** of integer variables, not on set-valued variables.
/// See `intersect_with()` for more details on the distinction.
///
/// # Examples
/// ```
/// use selen::variables::domain::sparse_set::SparseSet;
/// let mut a = SparseSet::new(1, 5); // Domain {1, 2, 3, 4, 5}
/// let b = SparseSet::new(3, 7); // Domain {3, 4, 5, 6, 7}
/// a.diff_with(&b); // a becomes {1, 2}
/// ```
pub fn diff_with(&mut self, other: &SparseSet) {
// Create a list of values to remove to avoid modifying while iterating
let mut to_remove = Vec::with_capacity(self.size as usize);
for val in self.iter() {
if other.contains(val) {
to_remove.push(val);
}
}
for val in to_remove {
self.remove(val);
}
}
/// Check if this set is a subset of another set
pub fn is_subset_of(&self, other: &Self) -> bool {
// Adjust for different offsets
for i in 0..self.size {
let val = self.val[i as usize];
let external_val = val as i32 + self.off;
if !other.contains(external_val) {
return false;
}
}
true
}
/// Check if two sets are equal
pub fn equals(&self, other: &SparseSet) -> bool {
if self.size != other.size {
return false;
}
self.iter().all(|val| other.contains(val))
}
// ===== BACKTRACKING SUPPORT =====
/// Save the current state for backtracking
#[doc(hidden)]
pub fn save_state(&self) -> SparseSetState {
SparseSetState {
size: self.size,
min: self.min,
max: self.max,
}
}
/// Restore a previously saved state
#[doc(hidden)]
pub fn restore_state(&mut self, state: &SparseSetState) {
self.size = state.size;
self.min = state.min;
self.max = state.max;
}
/// Get current state size (for simple size-only backtracking)
pub fn current_size(&self) -> u32 {
self.size
}
/// Restore to a specific size (assumes min/max are still valid)
/// WARNING: Only use if you're certain min/max haven't changed since the size was recorded
pub fn restore_size(&mut self, size: u32) {
debug_assert!(size <= self.n, "Cannot restore to size larger than universe");
self.size = size;
}
}
impl PartialEq for SparseSet {
fn eq(&self, other: &Self) -> bool {
self.equals(other)
}
}
impl Eq for SparseSet {}
/// Iterator implementation for sparse set
impl IntoIterator for SparseSet {
type Item = i32;
type IntoIter = std::vec::IntoIter<i32>;
fn into_iter(self) -> Self::IntoIter {
self.to_vec().into_iter()
}
}
impl<'a> IntoIterator for &'a SparseSet {
type Item = i32;
type IntoIter = Box<dyn Iterator<Item = i32> + 'a>;
fn into_iter(self) -> Self::IntoIter {
Box::new(self.iter())
}
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn debug() {
let mut v = SparseSet::new(1, 2);
v.remove_all();
assert_eq!(
format!("{:?}", v),
"SparseSet { off: 1, n: 2, min: 0, max: 1, size: 0, ind: [0, 1], val: [0, 1] }"
);
}
#[test]
fn display() {
let mut v = SparseSet::new(1, 2);
v.remove_all();
assert_eq!(format!("{}", v), "[|1,2]");
}
#[test]
fn display2() {
let mut v = SparseSet::new(1, 2);
v.remove(2);
assert_eq!(format!("{}", v), "[1|2]");
}
#[test]
fn display3() {
let v = SparseSet::new(1, 2);
assert_eq!(format!("{}", v), "[1,2|]");
}
#[test]
fn new() {
let v = SparseSet::new(1, 2);
assert_eq!(v.off, 1);
assert_eq!(v.min, 0);
assert_eq!(v.max, 1);
assert_eq!(format!("{}", v), "[1,2|]");
}
#[test]
fn remove() {
let mut v = SparseSet::new(1, 5);
v.remove(3);
assert_eq!(v.size(), 4);
assert_eq!(format!("{}", v), "[1,2,5,4|3]");
v.remove(5);
assert_eq!(format!("{}", v), "[1,2,4|5,3]");
v.remove(1);
assert_eq!(format!("{}", v), "[4,2|1,5,3]");
}
#[test]
fn remove2() {
let mut v = SparseSet::new(1, 5);
v.remove(5);
v.remove(4);
v.remove(3);
v.remove(2);
v.remove(1);
assert_eq!(v.size(), 0);
assert_eq!(format!("{}", v), "[|1,2,3,4,5]");
assert!(v.is_empty())
}
#[test]
fn remove3() {
let mut v = SparseSet::new(1, 5);
v.remove(2);
v.remove(2); // remove non existent
assert_eq!(format!("{}", v), "[1,5,3,4|2]");
}
#[test]
fn remove_all_but0() {
let mut v = SparseSet::new(1, 5);
v.remove_all_but(0);
assert_eq!(format!("{}", v), "[|1,2,3,4,5]");
}
#[test]
fn remove_all_but1() {
let mut v = SparseSet::new(1, 5);
v.remove_all_but(7);
assert_eq!(format!("{}", v), "[|1,2,3,4,5]");
}
#[test]
fn remove_all_but2() {
let mut v = SparseSet::new(1, 5);
v.remove_all_but(2);
assert_eq!(format!("{}", v), "[2|1,3,4,5]");
v.remove_all_but(3);
assert_eq!(format!("{}", v), "[|2,1,3,4,5]");
v.remove_all_but(0);
assert_eq!(format!("{}", v), "[|2,1,3,4,5]");
}
#[test]
fn remove_all_but3() {
let mut v = SparseSet::new(1, 5);
v.remove_all_but(2);
assert_eq!(format!("{}", v), "[2|1,3,4,5]");
v.remove_all_but(0);
assert_eq!(format!("{}", v), "[|2,1,3,4,5]");
}
#[test]
fn remove_below() {
let mut v = SparseSet::new(1, 5);
v.remove_below(3);
assert_eq!(format!("{}", v), "[5,4,3|2,1]");
v.remove_below(6);
assert_eq!(v.size(), 0);
}
#[test]
fn remove_below2() {
let mut v = SparseSet::new(1, 5);
v.remove_all();
v.remove_below(0);
assert_eq!(format!("{}", v), "[|1,2,3,4,5]");
}
#[test]
fn remove_above() {
let mut v = SparseSet::new(3, 7);
v.remove_above(5);
assert_eq!(format!("{}", v), "[3,4,5|7,6]");
v.remove_above(2);
assert_eq!(v.size(), 0);
assert_eq!(format!("{}", v), "[|3,4,5,7,6]");
}
#[test]
fn remove_above2() {
let mut v = SparseSet::new(1, 5);
v.remove_all();
v.remove_above(6);
assert_eq!(format!("{}", v), "[|1,2,3,4,5]");
}
#[test]
fn min() {
let mut v = SparseSet::new(1, 5);
v.remove(1);
assert_eq!(v.size(), 4);
assert_eq!(v.min(), 2);
assert_eq!(format!("{}", v), "[5,2,3,4|1]");
}
#[test]
fn max() {
let mut v = SparseSet::new(1, 5);
v.remove(5);
assert_eq!(v.size(), 4);
assert_eq!(v.max(), 4);
assert_eq!(format!("{}", v), "[1,2,3,4|5]");
}
#[test]
fn when_empty() {
let mut v = SparseSet::new(1, 2);
v.remove(1);
v.remove(2);
assert_eq!(v.size(), 0);
assert!(v.is_empty());
assert_eq!(format!("{}", v), "[|2,1]");
}
#[test]
fn is_fixed() {
let mut v = SparseSet::new(1, 2);
v.remove(1);
assert!(v.is_fixed());
}
#[test]
fn contains() {
let v = SparseSet::new(1, 2);
assert!(!v.contains(3));
assert!(v.contains(2));
assert!(!v.contains_intl(2));
assert!(v.contains_intl(1));
}
// New tests for enhanced functionality
#[test]
fn test_iterator() {
let mut v = SparseSet::new(1, 5);
v.remove(3);
let values: Vec<i32> = v.iter().collect();
assert_eq!(values.len(), 4);
assert!(values.contains(&1));
assert!(values.contains(&2));
assert!(!values.contains(&3));
assert!(values.contains(&4));
assert!(values.contains(&5));
}
#[test]
fn test_into_iterator() {
let mut v = SparseSet::new(1, 3);
v.remove(2);
let values: Vec<i32> = (&v).into_iter().collect();
assert_eq!(values.len(), 2);
assert!(values.contains(&1));
assert!(values.contains(&3));
// Test owned iterator
let values2: Vec<i32> = v.into_iter().collect();
assert_eq!(values2.len(), 2);
assert!(values2.contains(&1));
assert!(values2.contains(&3));
}
#[test]
fn test_first_last() {
let mut v = SparseSet::new(1, 5);
// Test with full set
assert!(v.first().is_some());
assert!(v.last().is_some());
// Test with partial set
v.remove(3);
assert!(v.first().is_some());
assert!(v.last().is_some());
// Test with empty set
v.remove_all();
assert_eq!(v.first(), None);
assert_eq!(v.last(), None);
}
#[test]
fn test_to_vec() {
let mut v = SparseSet::new(1, 3);
v.remove(2);
let vec = v.to_vec();
assert_eq!(vec.len(), 2);
assert!(vec.contains(&1));
assert!(vec.contains(&3));
}
#[test]
fn test_universe_info() {
let v = SparseSet::new(5, 10);
assert_eq!(v.universe_size(), 6);
assert_eq!(v.min_universe_value(), 5);
assert_eq!(v.max_universe_value(), 10);
}
// Tests for new_from_values method
#[test]
fn test_new_from_values_basic() {
let v = SparseSet::new_from_values(vec![2, 4, 6, 8]);
assert_eq!(v.size(), 4);
assert_eq!(v.min(), 2);
assert_eq!(v.max(), 8);
assert!(v.contains(2));
assert!(v.contains(4));
assert!(v.contains(6));
assert!(v.contains(8));
assert!(!v.contains(1));
assert!(!v.contains(3));
assert!(!v.contains(5));
assert!(!v.contains(7));
assert!(!v.contains(9));
// Check that all values are in the iterator
let values: Vec<i32> = v.iter().collect();
assert_eq!(values.len(), 4);
for val in [2, 4, 6, 8] {
assert!(values.contains(&val));
}
}
#[test]
fn test_new_from_values_empty() {
let v = SparseSet::new_from_values(vec![]);
assert!(v.is_empty());
assert_eq!(v.size(), 0);
assert_eq!(v.universe_size(), 0);
}
#[test]
fn test_new_from_values_single() {
let v = SparseSet::new_from_values(vec![42]);
assert_eq!(v.size(), 1);
assert_eq!(v.min(), 42);
assert_eq!(v.max(), 42);
assert!(v.is_fixed());
assert!(v.contains(42));
assert!(!v.contains(41));
assert!(!v.contains(43));
}
#[test]
fn test_new_from_values_contiguous() {
let v = SparseSet::new_from_values(vec![3, 4, 5, 6]);
assert_eq!(v.size(), 4);
assert_eq!(v.min(), 3);
assert_eq!(v.max(), 6);
for i in 3..=6 {
assert!(v.contains(i));
}
assert!(!v.contains(2));
assert!(!v.contains(7));
}
#[test]
fn test_new_from_values_duplicates() {
let v = SparseSet::new_from_values(vec![1, 3, 1, 5, 3, 5]);
assert_eq!(v.size(), 3); // Should deduplicate
assert!(v.contains(1));
assert!(v.contains(3));
assert!(v.contains(5));
assert!(!v.contains(2));
assert!(!v.contains(4));
}
#[test]
fn test_new_from_values_unsorted() {
let v = SparseSet::new_from_values(vec![5, 1, 3, 7, 2]);
assert_eq!(v.size(), 5);
assert_eq!(v.min(), 1);
assert_eq!(v.max(), 7);
for i in [1, 2, 3, 5, 7] {
assert!(v.contains(i));
}
assert!(!v.contains(4));
assert!(!v.contains(6));
}
#[test]
fn test_new_from_values_negative() {
let v = SparseSet::new_from_values(vec![-3, -1, 1, 3]);
assert_eq!(v.size(), 4);
assert_eq!(v.min(), -3);
assert_eq!(v.max(), 3);
assert!(v.contains(-3));
assert!(v.contains(-1));
assert!(v.contains(1));
assert!(v.contains(3));
assert!(!v.contains(-2));
assert!(!v.contains(0));
assert!(!v.contains(2));
}
#[test]
fn test_new_from_values_operations() {
let mut v = SparseSet::new_from_values(vec![2, 4, 6, 8, 10]);
// Test removal
assert!(v.remove(4));
assert_eq!(v.size(), 4);
assert!(!v.contains(4));
assert!(v.contains(2));
assert!(v.contains(6));
// Test remove_all_but
v.remove_all_but(8);
assert_eq!(v.size(), 1);
assert!(v.is_fixed());
assert!(v.contains(8));
assert!(!v.contains(2));
assert!(!v.contains(6));
assert!(!v.contains(10));
}
#[test]
fn test_new_from_values_bounds_operations() {
let mut v = SparseSet::new_from_values(vec![1, 3, 5, 7, 9]);
// Test remove_below
v.remove_below(5);
assert_eq!(v.size(), 3);
assert!(v.contains(5));
assert!(v.contains(7));
assert!(v.contains(9));
assert!(!v.contains(1));
assert!(!v.contains(3));
// Test remove_above
v.remove_above(7);
assert_eq!(v.size(), 2);
assert!(v.contains(5));
assert!(v.contains(7));
assert!(!v.contains(9));
}
#[test]
fn test_new_from_values_vs_new_equivalence() {
// Test that new_from_values with contiguous range is equivalent to new
let v1 = SparseSet::new(5, 8);
let v2 = SparseSet::new_from_values(vec![5, 6, 7, 8]);
assert_eq!(v1.size(), v2.size());
assert_eq!(v1.min(), v2.min());
assert_eq!(v1.max(), v2.max());
for i in 5..=8 {
assert_eq!(v1.contains(i), v2.contains(i));
}
// Test that iterators produce same values
let mut vals1: Vec<i32> = v1.iter().collect();
let mut vals2: Vec<i32> = v2.iter().collect();
vals1.sort();
vals2.sort();
assert_eq!(vals1, vals2);
}
#[test]
fn test_new_from_values_memory_efficiency() {
// Test sparse domain - should be more memory efficient than full range
let v = SparseSet::new_from_values(vec![1, 1000]);
assert_eq!(v.size(), 2);
assert_eq!(v.universe_size(), 1000); // Range is 1000
assert!(v.contains(1));
assert!(v.contains(1000));
assert!(!v.contains(500));
// val array should only contain 2 elements, not 1000
let values: Vec<i32> = v.iter().collect();
assert_eq!(values.len(), 2);
}
#[test]
fn test_new_from_values_with_set_operations() {
// Test union with new_from_values
let mut v1 = SparseSet::new_from_values(vec![1, 3, 5]);
let v2 = SparseSet::new_from_values(vec![2, 4, 5]); // 5 is common
v1.union_with(&v2);
// v1 should now contain {1, 2, 3, 4, 5}
assert_eq!(v1.size(), 5);
for i in 1..=5 {
assert!(v1.contains(i));
}
}
#[test]
fn test_new_from_values_subset_operations() {
let v1 = SparseSet::new_from_values(vec![2, 4]);
let v2 = SparseSet::new_from_values(vec![1, 2, 3, 4, 5]);
let v3 = SparseSet::new_from_values(vec![2, 4, 6]);
assert!(v1.is_subset_of(&v2)); // {2, 4} ⊆ {1, 2, 3, 4, 5}
assert!(v1.is_subset_of(&v3)); // {2, 4} ⊆ {2, 4, 6}
assert!(v1.is_subset_of(&v1)); // Set is subset of itself
// Test empty set is subset of any set
let empty = SparseSet::new_from_values(vec![]);
assert!(empty.is_subset_of(&v1));
assert!(empty.is_subset_of(&v2));
}
#[test]
fn test_new_from_values_equality() {
let v1 = SparseSet::new_from_values(vec![1, 3, 5]);
let v2 = SparseSet::new_from_values(vec![5, 1, 3]); // Same values, different order
let v3 = SparseSet::new_from_values(vec![1, 3]);
assert!(v1.equals(&v2));
assert!(!v1.equals(&v3));
assert!(v1 == v2); // Test PartialEq implementation
assert!(v1 != v3);
}
#[test]
fn test_new_from_values_backtracking() {
let mut set = SparseSet::new_from_values(vec![2, 4, 6, 8, 10]);
// Save initial state
let initial_state = set.save_state();
assert_eq!(initial_state.size, 5);
// Make some changes
set.remove(2);
set.remove(10);
assert_eq!(set.size(), 3);
assert!(!set.contains(2));
assert!(!set.contains(10));
assert!(set.contains(4));
assert!(set.contains(6));
assert!(set.contains(8));
// Restore to initial state
set.restore_state(&initial_state);
assert_eq!(set.size(), 5);
for val in [2, 4, 6, 8, 10] {
assert!(set.contains(val));
}
}
#[test]
fn test_intersect_with() {
let mut v1 = SparseSet::new(1, 5);
let mut v2 = SparseSet::new(1, 5);
// v1 = {1, 2, 3, 4, 5}
// v2 = {2, 4} after removing 1, 3, 5
v2.remove(1);
v2.remove(3);
v2.remove(5);
v1.intersect_with(&v2);
// v1 should now be {2, 4}
assert_eq!(v1.size(), 2);
assert!(v1.contains(2));
assert!(v1.contains(4));
assert!(!v1.contains(1));
assert!(!v1.contains(3));
assert!(!v1.contains(5));
}
#[test]
fn test_diff_with_basic() {
let mut a = SparseSet::new(1, 5); // {1, 2, 3, 4, 5}
let b = SparseSet::new(3, 7); // {3, 4, 5, 6, 7}
a.diff_with(&b);
// a should now be {1, 2} (elements in a but not in b)
assert_eq!(a.size(), 2);
assert!(a.contains(1));
assert!(a.contains(2));
assert!(!a.contains(3));
assert!(!a.contains(4));
assert!(!a.contains(5));
}
#[test]
fn test_diff_with_disjoint() {
let mut a = SparseSet::new(1, 3); // {1, 2, 3}
let b = SparseSet::new(4, 6); // {4, 5, 6}
a.diff_with(&b);
// a should be unchanged (disjoint sets)
assert_eq!(a.size(), 3);
assert!(a.contains(1));
assert!(a.contains(2));
assert!(a.contains(3));
}
#[test]
fn test_diff_with_subset() {
let mut a = SparseSet::new(1, 5); // {1, 2, 3, 4, 5}
let mut b = SparseSet::new(1, 5); // {1, 2, 3, 4, 5}
// Make b a subset: {2, 4}
b.remove(1);
b.remove(3);
b.remove(5);
a.diff_with(&b);
// a should now be {1, 3, 5}
assert_eq!(a.size(), 3);
assert!(a.contains(1));
assert!(a.contains(3));
assert!(a.contains(5));
assert!(!a.contains(2));
assert!(!a.contains(4));
}
#[test]
fn test_diff_with_empty() {
let mut a = SparseSet::new(1, 3); // {1, 2, 3}
let mut b = SparseSet::new(1, 3); // {1, 2, 3}
b.remove_all(); // Make it empty
a.diff_with(&b);
// a should be unchanged
assert_eq!(a.size(), 3);
assert!(a.contains(1));
assert!(a.contains(2));
assert!(a.contains(3));
}
#[test]
fn test_diff_with_becomes_empty() {
let mut a = SparseSet::new(1, 3); // {1, 2, 3}
let b = SparseSet::new(1, 5); // {1, 2, 3, 4, 5} (superset)
a.diff_with(&b);
// a should now be empty
assert_eq!(a.size(), 0);
assert!(a.is_empty());
}
#[test]
fn test_diff_with_sparse_domains() {
let a_values = vec![1, 3, 5, 7, 9];
let b_values = vec![2, 3, 5, 8];
let mut a = SparseSet::new_from_values(a_values);
let b = SparseSet::new_from_values(b_values);
a.diff_with(&b);
// a should now be {1, 7, 9} (removed 3 and 5)
assert_eq!(a.size(), 3);
assert!(a.contains(1));
assert!(a.contains(7));
assert!(a.contains(9));
assert!(!a.contains(3));
assert!(!a.contains(5));
}
#[test]
fn test_set_operations_combination() {
// Test combining union, intersect, and diff
let mut a = SparseSet::new(1, 5); // {1, 2, 3, 4, 5}
let b = SparseSet::new(3, 7); // {3, 4, 5, 6, 7}
let c = SparseSet::new(4, 8); // {4, 5, 6, 7, 8}
// a ∩ b = {3, 4, 5}
a.intersect_with(&b);
assert_eq!(a.size(), 3);
assert!(a.contains(3));
assert!(a.contains(4));
assert!(a.contains(5));
// (a ∩ b) \ c = {3} (remove 4 and 5)
a.diff_with(&c);
assert_eq!(a.size(), 1);
assert!(a.contains(3));
assert!(!a.contains(4));
assert!(!a.contains(5));
}
#[test]
fn test_performance_large_domain() {
// Test with a larger domain to ensure operations remain efficient
let mut v = SparseSet::new(0, 1000);
// Remove odd numbers
for i in 1..1000 {
if i % 2 == 1 {
v.remove(i);
}
}
assert_eq!(v.size(), 501); // Should have 501 even numbers: 0, 2, 4, ..., 1000
// Test contains for all values
for i in 0..1000 {
if i % 2 == 0 {
assert!(v.contains(i));
} else {
assert!(!v.contains(i));
}
}
// Test iteration
let even_values: Vec<i32> = v.iter().filter(|&x| x % 2 == 0).collect();
assert_eq!(even_values.len(), 501);
}
#[test]
fn test_csp_specific_operations() {
let mut v = SparseSet::new(1, 9); // Sudoku domain
// Test remove_below (useful for constraint propagation)
v.remove_below(5);
assert_eq!(v.size(), 5); // Should have {5, 6, 7, 8, 9}
assert!(!v.contains(4));
assert!(v.contains(5));
assert!(v.contains(9));
// Test remove_above
v.remove_above(7);
assert_eq!(v.size(), 3); // Should have {5, 6, 7}
assert!(v.contains(5));
assert!(v.contains(7));
assert!(!v.contains(8));
// Test remove_all_but (useful for variable assignment)
v.remove_all_but(6);
assert_eq!(v.size(), 1);
assert!(v.is_fixed());
assert!(v.contains(6));
assert!(!v.contains(5));
assert!(!v.contains(7));
}
#[test]
fn test_bounds_maintenance() {
let mut v = SparseSet::new(1, 10);
// Test that bounds are correctly maintained after removals
v.remove(1); // Remove minimum
assert_eq!(v.min(), 2);
v.remove(10); // Remove maximum
assert_eq!(v.max(), 9);
v.remove(5); // Remove middle value
assert_eq!(v.min(), 2); // Should still be 2
assert_eq!(v.max(), 9); // Should still be 9
// Test bounds after removing all but one
v.remove_all_but(7);
assert_eq!(v.min(), 7);
assert_eq!(v.max(), 7);
}
#[test]
fn test_backtracking_save_restore() {
let mut set = SparseSet::new(1, 10);
// Save initial state
let initial_state = set.save_state();
assert_eq!(initial_state.size, 10);
assert_eq!(initial_state.min, 0); // Internal representation: 1-1=0
assert_eq!(initial_state.max, 9); // Internal representation: 10-1=9
// Make some changes
set.remove(1);
set.remove(10);
set.remove(5);
assert_eq!(set.size(), 7);
assert_eq!(set.min(), 2);
assert_eq!(set.max(), 9);
// Save intermediate state
let intermediate_state = set.save_state();
// Make more changes
set.remove_all_but(6);
assert_eq!(set.size(), 1);
assert_eq!(set.min(), 6);
assert_eq!(set.max(), 6);
// Restore to intermediate state
set.restore_state(&intermediate_state);
assert_eq!(set.size(), 7);
assert_eq!(set.min(), 2);
assert_eq!(set.max(), 9);
assert!(!set.contains(1));
assert!(!set.contains(10));
assert!(!set.contains(5));
assert!(set.contains(2));
assert!(set.contains(6));
assert!(set.contains(9));
// Restore to initial state
set.restore_state(&initial_state);
assert_eq!(set.size(), 10);
assert_eq!(set.min(), 1);
assert_eq!(set.max(), 10);
for i in 1..=10 {
assert!(set.contains(i));
}
}
#[test]
fn test_size_only_backtracking() {
let mut set = SparseSet::new(5, 8);
let original_size = set.current_size();
assert_eq!(original_size, 4);
// Remove some elements (but not min/max)
set.remove(6);
set.remove(7);
assert_eq!(set.size(), 2);
assert_eq!(set.min(), 5); // Min unchanged
assert_eq!(set.max(), 8); // Max unchanged
// Restore size (safe because min/max didn't change)
set.restore_size(original_size);
assert_eq!(set.size(), 4);
assert_eq!(set.min(), 5);
assert_eq!(set.max(), 8);
// All original elements should be back
assert!(set.contains(5));
assert!(set.contains(6));
assert!(set.contains(7));
assert!(set.contains(8));
}
#[test]
fn test_backtracking_with_bounds_changes() {
let mut set = SparseSet::new(1, 5);
// Save state before removing min/max
let before_bounds_change = set.save_state();
// Remove min and max (this will update bounds)
set.remove(1); // Remove min
set.remove(5); // Remove max
assert_eq!(set.min(), 2);
assert_eq!(set.max(), 4);
assert_eq!(set.size(), 3);
// Save state after bounds change
let after_bounds_change = set.save_state();
// Remove more elements
set.remove(3);
assert_eq!(set.size(), 2);
// Restore to after bounds change
set.restore_state(&after_bounds_change);
assert_eq!(set.size(), 3);
assert_eq!(set.min(), 2);
assert_eq!(set.max(), 4);
assert!(set.contains(2));
assert!(set.contains(3));
assert!(set.contains(4));
// Restore to before bounds change
set.restore_state(&before_bounds_change);
assert_eq!(set.size(), 5);
assert_eq!(set.min(), 1);
assert_eq!(set.max(), 5);
for i in 1..=5 {
assert!(set.contains(i));
}
}
#[test]
fn test_multiple_backtrack_levels() {
let mut set = SparseSet::new(1, 6);
// Level 0: Full set
let level0 = set.save_state();
// Level 1: Remove one element
set.remove(3);
let level1 = set.save_state();
// Level 2: Remove more elements
set.remove(1);
set.remove(6);
let level2 = set.save_state();
// Level 3: Remove to single element
set.remove_all_but(4);
assert_eq!(set.size(), 1);
assert!(set.contains(4));
// Backtrack to level 2
set.restore_state(&level2);
assert_eq!(set.size(), 3);
assert!(set.contains(2));
assert!(set.contains(4));
assert!(set.contains(5));
// Backtrack to level 1
set.restore_state(&level1);
assert_eq!(set.size(), 5);
assert!(!set.contains(3));
for i in [1, 2, 4, 5, 6] {
assert!(set.contains(i));
}
// Backtrack to level 0
set.restore_state(&level0);
assert_eq!(set.size(), 6);
for i in 1..=6 {
assert!(set.contains(i));
}
}
// ===== TESTS FOR COMPLEMENT API =====
#[test]
fn test_complement_iter_empty() {
let set = SparseSet::new(1, 5); // No removals
let complement: Vec<i32> = set.complement_iter().collect();
assert_eq!(complement.len(), 0);
assert_eq!(set.complement_size(), 0);
// With complement_size = 0 and size = 5, should_use_complement = (0 < 5/2) = (0 < 2) = true!
assert!(set.should_use_complement());
}
#[test]
fn test_complement_iter_single_removal() {
let mut set = SparseSet::new(1, 5);
set.remove(3);
let complement: Vec<i32> = set.complement_iter().collect();
assert_eq!(complement.len(), 1);
assert!(complement.contains(&3));
assert_eq!(set.complement_size(), 1);
}
#[test]
fn test_complement_iter_multiple_removals() {
let mut set = SparseSet::new(1, 10);
set.remove(2);
set.remove(5);
set.remove(8);
let complement: Vec<i32> = set.complement_iter().collect();
assert_eq!(complement.len(), 3);
assert!(complement.contains(&2));
assert!(complement.contains(&5));
assert!(complement.contains(&8));
assert_eq!(set.complement_size(), 3);
}
#[test]
fn test_complement_iter_matches_removed_values() {
let mut set = SparseSet::new(1, 8);
// Track what we remove
let removed = vec![1, 3, 5, 7];
for &val in &removed {
set.remove(val);
}
// Verify complement matches removed values
let complement: Vec<i32> = set.complement_iter().collect();
assert_eq!(complement.len(), removed.len());
for &val in &removed {
assert!(complement.contains(&val));
}
// Verify no active values are in complement
for val in set.iter() {
assert!(!complement.contains(&val));
}
}
#[test]
fn test_complement_size_calculation() {
let mut set = SparseSet::new(1, 20);
assert_eq!(set.size(), 20);
assert_eq!(set.complement_size(), 0);
// Remove 5 elements
for i in 1..=5 {
set.remove(i);
}
assert_eq!(set.size(), 15);
assert_eq!(set.complement_size(), 5);
// Remove 5 more
for i in 6..=10 {
set.remove(i);
}
assert_eq!(set.size(), 10);
assert_eq!(set.complement_size(), 10);
// Remove all but one (remove 11-20, leaving only one element at index somewhere)
for i in 11..=19 {
set.remove(i);
}
assert_eq!(set.size(), 1);
assert_eq!(set.complement_size(), 19);
}
#[test]
fn test_should_use_complement_basic() {
let mut set = SparseSet::new(1, 100);
// Start with full set: complement size = 0, size = 100
// should_use_complement = (0 < 100/2) = (0 < 50) = true
assert!(set.should_use_complement());
// Remove 40 elements: complement size = 40, size = 60
// should_use_complement = (40 < 60/2) = (40 < 30) = false
for i in 1..=40 {
set.remove(i);
}
assert!(!set.should_use_complement());
// Remove 21 more (total 61): complement size = 61, size = 39
// should_use_complement = (61 < 39/2) = (61 < 19) = false
for i in 41..=61 {
set.remove(i);
}
assert!(!set.should_use_complement());
// Remove until only 10 remain: complement size = 90, size = 10
// should_use_complement = (90 < 10/2) = (90 < 5) = false
for i in 62..=90 {
set.remove(i);
}
assert_eq!(set.size(), 10);
assert_eq!(set.complement_size(), 90);
assert!(!set.should_use_complement());
}
#[test]
fn test_should_use_complement_when_heavily_pruned() {
let mut set = SparseSet::new(1, 100);
// Remove 98 elements, keep only 2
for i in 1..=98 {
set.remove(i);
}
assert_eq!(set.size(), 2);
assert_eq!(set.complement_size(), 98);
// should_use_complement = (98 < 2/2) = (98 < 1) = false
assert!(!set.should_use_complement());
}
#[test]
fn test_should_use_complement_exact_boundary() {
let mut set = SparseSet::new(1, 10);
// Initial: size = 10, complement = 0
// should_use_complement = (0 < 10/2) = (0 < 5) = true
assert!(set.should_use_complement());
// Remove 8, leaving 2: size = 2, complement = 8
// should_use_complement = (8 < 2/2) = (8 < 1) = false
for i in 1..=8 {
set.remove(i);
}
assert_eq!(set.size(), 2);
assert_eq!(set.complement_size(), 8);
assert!(!set.should_use_complement());
}
#[test]
fn test_complement_iter_after_remove_all() {
let mut set = SparseSet::new(1, 5);
set.remove_all();
let complement: Vec<i32> = set.complement_iter().collect();
assert_eq!(complement.len(), 5);
assert_eq!(set.complement_size(), 5);
// All values should be in complement
for i in 1..=5 {
assert!(complement.contains(&i));
}
}
#[test]
fn test_complement_with_new_from_values() {
let mut set = SparseSet::new_from_values(vec![1, 3, 5, 7, 9]);
// Initial complement is {2, 4, 6, 8}
let complement: Vec<i32> = set.complement_iter().collect();
assert_eq!(complement.len(), 4);
// After removing 3 and 7
set.remove(3);
set.remove(7);
let complement: Vec<i32> = set.complement_iter().collect();
assert_eq!(complement.len(), 6); // {2, 3, 4, 6, 7, 8}
assert!(complement.contains(&2));
assert!(complement.contains(&3));
assert!(complement.contains(&4));
assert!(complement.contains(&6));
assert!(complement.contains(&7));
assert!(complement.contains(&8));
}
#[test]
fn test_complement_complement_is_original() {
let mut set = SparseSet::new(1, 10);
set.remove(2);
set.remove(5);
set.remove(8);
let active: Vec<i32> = set.iter().collect();
let removed: Vec<i32> = set.complement_iter().collect();
// Union should give us all values
let mut combined = active.clone();
combined.extend(removed.clone());
combined.sort();
assert_eq!(combined.len(), 10);
for i in 1..=10 {
assert!(combined.contains(&i));
}
// Intersection should be empty
for val in &active {
assert!(!removed.contains(val));
}
}
#[test]
fn test_complement_consistency_after_operations() {
let mut set = SparseSet::new(1, 20);
// Series of operations
set.remove(5);
set.remove(10);
set.remove(15);
let state1 = set.save_state();
let complement1: Vec<i32> = set.complement_iter().collect();
// More removals
set.remove(3);
set.remove(7);
let complement2: Vec<i32> = set.complement_iter().collect();
assert!(complement2.len() > complement1.len());
// Restore to state1
set.restore_state(&state1);
let complement1_restored: Vec<i32> = set.complement_iter().collect();
// Should match original complement
assert_eq!(complement1, complement1_restored);
}
#[test]
fn test_complement_negative_domain() {
let mut set = SparseSet::new(-5, 5);
set.remove(-2);
set.remove(0);
set.remove(3);
let complement: Vec<i32> = set.complement_iter().collect();
assert_eq!(complement.len(), 3);
assert!(complement.contains(&-2));
assert!(complement.contains(&0));
assert!(complement.contains(&3));
assert_eq!(set.complement_size(), 3);
}
#[test]
fn test_complement_single_value_domain() {
let set = SparseSet::new(5, 5);
assert_eq!(set.size(), 1);
assert_eq!(set.complement_size(), 0);
let complement: Vec<i32> = set.complement_iter().collect();
assert_eq!(complement.len(), 0);
assert!(!set.should_use_complement());
}
#[test]
fn test_complement_performance_check() {
// Verify that complement_iter is efficient by checking it doesn't allocate
// more than necessary (single vec internally)
let mut set = SparseSet::new(1, 1000);
// Remove most elements
for i in 1..=950 {
set.remove(i);
}
// Complement has 950 elements, active has 50
assert_eq!(set.complement_size(), 950);
assert_eq!(set.size(), 50);
// should_use_complement should return false (950 < 50/2 = 25? No)
assert!(!set.should_use_complement());
// But if we had even heavier pruning
for i in 951..=990 {
set.remove(i);
}
// Complement has 990, active has 10
assert_eq!(set.complement_size(), 990);
assert_eq!(set.size(), 10);
// 990 < 10/2 = 5? No
assert!(!set.should_use_complement());
}
}