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
use core::borrow::Borrow;
use core::fmt::{self, Debug};
use core::iter::FromIterator;
use core::ops::{Index, RangeBounds};
use crate::map_types::{
Entry, IntoIter, IntoKeys, IntoValues, Iter, IterMut, Keys, OccupiedEntry, OccupiedError,
Range, RangeMut, VacantEntry, Values, ValuesMut,
};
use crate::tree::{node::NodeGetHelper, Idx, SgError, SgTree};
/// Safe, fallible, embedded-friendly ordered map.
///
/// ### Fallible APIs
///
/// * [`try_insert`][crate::map::SgMap::try_insert]
/// * [`try_append`][crate::map::SgMap::try_append]
/// * [`try_extend`][crate::map::SgMap::try_extend]
/// * [`try_from_iter`][crate::map::SgMap::try_from_iter]
///
/// [`TryFrom`](https://doc.rust-lang.org/stable/std/convert/trait.TryFrom.html) isn't implemented because it would collide with the blanket implementation.
/// See [this open GitHub issue](https://github.com/rust-lang/rust/issues/50133#issuecomment-64690839) from 2018,
/// this is a known Rust limitation that should be fixed via specialization in the future.
///
/// ### Attribution Note
///
/// The majority of API examples and descriptions are adapted or directly copied from the standard library's [`BTreeMap`](https://doc.rust-lang.org/std/collections/struct.BTreeMap.html).
/// The goal is to offer embedded developers familiar, ergonomic APIs on resource constrained systems that otherwise don't get the luxury of dynamic collections.
#[derive(Default, Clone, Hash, PartialEq, Eq, Ord, PartialOrd)]
pub struct SgMap<K: Ord + Default, V: Default, const N: usize> {
pub(crate) bst: SgTree<K, V, N>,
}
impl<K: Ord + Default, V: Default, const N: usize> SgMap<K, V, N> {
/// Makes a new, empty `SgMap`.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map = SgMap::<_, _, 10>::new();
///
/// map.insert(1, "a");
/// ```
pub fn new() -> Self {
SgMap { bst: SgTree::new() }
}
/// The [original scapegoat tree paper's](https://people.csail.mit.edu/rivest/pubs/GR93.pdf) alpha, `a`, can be chosen in the range `0.5 <= a < 1.0`.
/// `a` tunes how "aggressively" the data structure self-balances.
/// It controls the trade-off between total rebuild time and maximum height guarantees.
///
/// * As `a` approaches `0.5`, the tree will rebalance more often. Ths means slower insertions, but faster lookups and deletions.
/// * An `a` equal to `0.5` means a tree that always maintains a perfect balance (e.g."complete" binary tree, at all times).
///
/// * As `a` approaches `1.0`, the tree will rebalance less often. This means quicker insertions, but slower lookups and deletions.
/// * If `a` reached `1.0`, it'd mean a tree that never rebalances.
///
/// Returns `Err` if `0.5 <= alpha_num / alpha_denom < 1.0` isn't `true` (invalid `a`, out of range).
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map: SgMap<isize, isize, 10> = SgMap::new();
///
/// // Set 2/3, e.g. `a = 0.666...` (it's default value).
/// assert!(map.set_rebal_param(2.0, 3.0).is_ok());
/// ```
#[doc(alias = "rebalance")]
#[doc(alias = "alpha")]
pub fn set_rebal_param(&mut self, alpha_num: f32, alpha_denom: f32) -> Result<(), SgError> {
self.bst.set_rebal_param(alpha_num, alpha_denom)
}
/// Get the current rebalance parameter, alpha, as a tuple of `(alpha_numerator, alpha_denominator)`.
/// See [the corresponding setter method][SgMap::set_rebal_param] for more details.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map: SgMap<isize, isize, 10> = SgMap::new();
///
/// // Set 2/3, e.g. `a = 0.666...` (it's default value).
/// assert!(map.set_rebal_param(2.0, 3.0).is_ok());
///
/// // Get the currently set value
/// assert_eq!(map.rebal_param(), (2.0, 3.0));
/// ```
#[doc(alias = "rebalance")]
#[doc(alias = "alpha")]
pub fn rebal_param(&self) -> (f32, f32) {
self.bst.rebal_param()
}
/// Total capacity, e.g. maximum number of map pairs.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map = SgMap::<usize, &str, 10>::new();
///
/// assert!(map.capacity() == 10);
/// ```
pub fn capacity(&self) -> usize {
self.bst.capacity()
}
/// Gets an iterator over the keys of the map, in sorted order.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut a = SgMap::<_, _, 10>::new();
/// a.insert(2, "b");
/// a.insert(1, "a");
///
/// let keys: Vec<_> = a.keys().cloned().collect();
/// assert_eq!(keys, [1, 2]);
/// ```
pub fn keys(&self) -> Keys<'_, K, V, N> {
Keys { inner: self.iter() }
}
/// Creates a consuming iterator visiting all the keys, in sorted order.
/// The map cannot be used after calling this.
/// The iterator element type is `K`.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut a = SgMap::<_, _, 10>::new();
/// a.insert(2, "b");
/// a.insert(1, "a");
///
/// let keys: Vec<i32> = a.into_keys().collect();
/// assert_eq!(keys, [1, 2]);
/// ```
pub fn into_keys(self) -> IntoKeys<K, V, N> {
IntoKeys {
inner: self.into_iter(),
}
}
/// Gets an iterator over the values of the map, in order by key.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut a = SgMap::<_, _, 10>::new();
/// a.insert(1, "hello");
/// a.insert(2, "goodbye");
///
/// let values: Vec<&str> = a.values().cloned().collect();
/// assert_eq!(values, ["hello", "goodbye"]);
/// ```
pub fn values(&self) -> Values<'_, K, V, N> {
Values { inner: self.iter() }
}
/// Creates a consuming iterator visiting all the values, in order by key.
/// The map cannot be used after calling this.
/// The iterator element type is `V`.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut a = SgMap::<_, _, 10>::new();
/// a.insert(1, "hello");
/// a.insert(2, "goodbye");
///
/// let values: Vec<&str> = a.into_values().collect();
/// assert_eq!(values, ["hello", "goodbye"]);
/// ```
pub fn into_values(self) -> IntoValues<K, V, N> {
IntoValues {
inner: self.into_iter(),
}
}
/// Gets a mutable iterator over the values of the map, in order by key.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut a = SgMap::<_, _, 10>::new();
/// a.insert(1, String::from("hello"));
/// a.insert(2, String::from("goodbye"));
///
/// for value in a.values_mut() {
/// value.push_str("!");
/// }
///
/// let values: Vec<String> = a.values().cloned().collect();
/// assert_eq!(values, [String::from("hello!"),
/// String::from("goodbye!")]);
/// ```
pub fn values_mut(&mut self) -> ValuesMut<'_, K, V, N> {
ValuesMut {
inner: self.iter_mut(),
}
}
/// Moves all elements from `other` into `self`, leaving `other` empty.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut a = SgMap::<_, _, 10>::new();
/// a.insert(1, "a");
/// a.insert(2, "b");
/// a.insert(3, "c");
///
/// let mut b = SgMap::<_, _, 10>::new();
/// b.insert(3, "d");
/// b.insert(4, "e");
/// b.insert(5, "f");
///
/// a.append(&mut b);
///
/// assert_eq!(a.len(), 5);
/// assert_eq!(b.len(), 0);
///
/// assert_eq!(a[&1], "a");
/// assert_eq!(a[&2], "b");
/// assert_eq!(a[&3], "d");
/// assert_eq!(a[&4], "e");
/// assert_eq!(a[&5], "f");
/// ```
pub fn append(&mut self, other: &mut SgMap<K, V, N>) {
self.bst.append(&mut other.bst);
}
/// Attempts to move all elements from `other` into `self`, leaving `other` empty.
///
/// # Examples
///
/// ```
/// use core::iter::FromIterator;
/// use scapegoat::{SgMap, SgError};
///
/// let mut a = SgMap::<_, _, 10>::new();
/// a.try_insert(1, "a").is_ok();
/// a.try_insert(2, "b").is_ok();
/// a.try_insert(3, "c").is_ok();
///
/// let mut b = SgMap::<_, _, 10>::new();
/// b.try_insert(3, "d").is_ok(); // Overwrite previous
/// b.try_insert(4, "e").is_ok();
/// b.try_insert(5, "f").is_ok();
///
/// // Successful append
/// assert!(a.try_append(&mut b).is_ok());
///
/// // Elements moved
/// assert_eq!(a.len(), 5);
/// assert_eq!(b.len(), 0);
///
/// assert_eq!(a[&1], "a");
/// assert_eq!(a[&2], "b");
/// assert_eq!(a[&3], "d");
/// assert_eq!(a[&4], "e");
/// assert_eq!(a[&5], "f");
///
/// // Fill remaining capacity
/// let mut key = 6;
/// while a.len() < a.capacity() {
/// assert!(a.try_insert(key, "filler").is_ok());
/// key += 1;
/// }
///
/// // Full
/// assert!(a.is_full());
///
/// // More data
/// let mut c = SgMap::<_, _, 10>::from_iter([(11, "k"), (12, "l")]);
/// let mut d = SgMap::<_, _, 10>::from_iter([(1, "a2"), (2, "b2")]);
///
/// // Cannot append new pairs
/// assert_eq!(a.try_append(&mut c), Err(SgError::StackCapacityExceeded));
///
/// // Can still replace existing pairs
/// assert!(a.try_append(&mut d).is_ok());
/// ```
pub fn try_append(&mut self, other: &mut SgMap<K, V, N>) -> Result<(), SgError> {
self.bst.try_append(&mut other.bst)
}
/// Insert a key-value pair into the map.
/// If the map did not have this key present, `None` is returned.
/// If the map did have this key present, the value is updated, the old value is returned,
/// and the key is updated. This accommodates types that can be `==` without being identical.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map = SgMap::<_, _, 10>::new();
/// assert_eq!(map.insert(37, "a"), None);
/// assert_eq!(map.is_empty(), false);
///
/// map.insert(37, "b");
/// assert_eq!(map.insert(37, "c"), Some("b"));
/// assert_eq!(map[&37], "c");
/// ```
pub fn insert(&mut self, key: K, val: V) -> Option<V>
where
K: Ord,
{
self.bst.insert(key, val)
}
/// Insert a key-value pair into the map.
/// Returns `Err` if the operation can't be completed, else the `Ok` contains:
/// * `None` if the map did not have this key present.
/// * The old value if the map did have this key present (both the value and key are updated,
/// this accommodates types that can be `==` without being identical).
///
/// ### Warning
///
/// Unlike other APIs in this crate, the semantics and return type of this API are *NOT* the same as `BTreeMap`'s nightly [`try_insert`](https://doc.rust-lang.org/std/collections/struct.BTreeMap.html#method.try_insert).
/// For an equivalent, use [`try_insert_std`][`SgMap::try_insert_std`].
///
/// # Examples
///
/// ```
/// use scapegoat::{SgMap, SgError};
///
/// let mut map = SgMap::<_, _, 10>::new();
///
/// // Add a new pair
/// assert_eq!(map.try_insert(37, "a"), Ok(None));
/// assert_eq!(map.is_empty(), false);
///
/// // Replace existing pair
/// map.insert(37, "b");
/// assert_eq!(map.try_insert(37, "c"), Ok(Some("b")));
/// assert_eq!(map[&37], "c");
///
/// // Fill remaining capacity
/// let mut key = 38;
/// while map.len() < map.capacity() {
/// assert!(map.try_insert(key, "filler").is_ok());
/// key += 1;
/// }
///
/// // Full
/// assert!(map.is_full());
///
/// // Cannot insert new pair
/// assert_eq!(map.try_insert(key, "out of bounds"), Err(SgError::StackCapacityExceeded));
///
/// // Can still replace existing pair
/// assert_eq!(map.try_insert(key - 1, "overwrite filler"), Ok(Some("filler")));
/// ```
///
pub fn try_insert(&mut self, key: K, val: V) -> Result<Option<V>, SgError>
where
K: Ord,
{
self.bst.try_insert(key, val)
}
/// Tries to insert a key-value pair into the map, and returns
/// a mutable reference to the value in the entry.
///
/// If the map already had this key present, nothing is updated, and
/// an error containing the occupied entry and the value is returned.
///
/// ### Warning
///
/// The semantics and return type of this API match `BTreeMap`'s nightly [`try_insert`](https://doc.rust-lang.org/std/collections/struct.BTreeMap.html#method.try_insert), *NOT* the other `try_*` APIs in this crate.
/// For a fallible insert, use [`try_insert`][`SgMap::try_insert`].
///
/// # Examples
///
/// Basic usage:
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map = SgMap::<_, _, 10>::new();
/// assert_eq!(map.try_insert_std(37, "a").unwrap(), &"a");
///
/// let err = map.try_insert_std(37, "b").unwrap_err();
/// assert_eq!(err.entry.key(), &37);
/// assert_eq!(err.entry.get(), &"a");
/// assert_eq!(err.value, "b");
/// ```
pub fn try_insert_std(&mut self, key: K, value: V) -> Result<&mut V, OccupiedError<'_, K, V, N>>
where
K: Ord,
{
match self.entry(key) {
Entry::Occupied(entry) => Err(OccupiedError { entry, value }),
Entry::Vacant(entry) => Ok(entry.insert(value)),
}
}
/// Attempt to extend a collection with the contents of an iterator.
///
/// # Examples
///
/// ```
/// use core::iter::FromIterator;
/// use scapegoat::{SgMap, SgError};
///
/// let mut a = SgMap::<_, _, 2>::new();
/// let mut b = SgMap::<_, _, 3>::from_iter([(1, "a"), (2, "b"), (3, "c")]);
/// let mut c = SgMap::<_, _, 2>::from_iter([(1, "a"), (2, "b")]);
///
/// // Too big
/// assert_eq!(a.try_extend(b.into_iter()), Err(SgError::StackCapacityExceeded));
///
/// // Fits
/// assert!(a.try_extend(c.into_iter()).is_ok());
/// ```
///
/// ### Note
///
/// There is no `TryExtend` trait in `core`/`std`.
pub fn try_extend<I: ExactSizeIterator + IntoIterator<Item = (K, V)>>(
&mut self,
iter: I,
) -> Result<(), SgError> {
self.bst.try_extend(iter)
}
/// Attempt conversion from an iterator.
/// Will fail if iterator length exceeds `u16::MAX`.
///
/// # Examples
///
/// ```
/// use scapegoat::{SgMap, SgError};
///
/// const CAPACITY_1: usize = 1_000;
/// let vec: Vec<(usize, usize)> = (0..CAPACITY_1).map(|n|(n, n)).collect();
/// assert!(SgMap::<usize, usize, CAPACITY_1>::try_from_iter(vec.into_iter()).is_ok());
///
/// const CAPACITY_2: usize = (u16::MAX as usize) + 1;
/// let vec: Vec<(usize, usize)> = (0..CAPACITY_2).map(|n|(n, n)).collect();
/// assert_eq!(
/// SgMap::<usize, usize, CAPACITY_2>::try_from_iter(vec.into_iter()),
/// Err(SgError::MaximumCapacityExceeded)
/// );
/// ```
///
/// ### Note
///
/// There is no `TryFromIterator` trait in `core`/`std`.
pub fn try_from_iter<I: ExactSizeIterator + IntoIterator<Item = (K, V)>>(
iter: I,
) -> Result<Self, SgError> {
match iter.len() <= SgTree::<K, V, N>::max_capacity() {
true => Ok(SgMap::from_iter(iter)),
false => Err(SgError::MaximumCapacityExceeded),
}
}
/// Gets an iterator over the entries of the map, sorted by key.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map = SgMap::<_, _, 10>::new();
/// map.insert(3, "c");
/// map.insert(2, "b");
/// map.insert(1, "a");
///
/// for (key, value) in map.iter() {
/// println!("{}: {}", key, value);
/// }
///
/// let (first_key, first_value) = map.iter().next().unwrap();
/// assert_eq!((*first_key, *first_value), (1, "a"));
/// ```
pub fn iter(&self) -> Iter<'_, K, V, N> {
Iter::new(self)
}
/// Gets a mutable iterator over the entries of the map, sorted by key.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map = SgMap::<_, _, 10>::new();
/// map.insert("a", 1);
/// map.insert("b", 2);
/// map.insert("c", 3);
///
/// // Add 10 to the value if the key isn't "a"
/// for (key, value) in map.iter_mut() {
/// if key != &"a" {
/// *value += 10;
/// }
/// }
///
/// let (second_key, second_value) = map.iter().skip(1).next().unwrap();
/// assert_eq!((*second_key, *second_value), ("b", 12));
/// ```
pub fn iter_mut(&mut self) -> IterMut<'_, K, V, N> {
IterMut::new(self)
}
/// Removes a key from the map, returning the stored key and value if the key
/// was previously in the map.
///
/// The key may be any borrowed form of the map's key type, but the ordering
/// on the borrowed form *must* match the ordering on the key type.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map = SgMap::<_, _, 10>::new();
/// map.insert(1, "a");
/// assert_eq!(map.remove_entry(&1), Some((1, "a")));
/// assert_eq!(map.remove_entry(&1), None);
/// ```
pub fn remove_entry<Q>(&mut self, key: &Q) -> Option<(K, V)>
where
K: Borrow<Q> + Ord,
Q: Ord + ?Sized,
{
self.bst.remove_entry(key)
}
/// Retains only the elements specified by the predicate.
///
/// In other words, remove all pairs `(k, v)` such that `f(&k, &mut v)` returns `false`.
/// The elements are visited in ascending key order.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map: SgMap<i32, i32, 10> = (0..8).map(|x| (x, x*10)).collect();
/// // Keep only the elements with even-numbered keys.
/// map.retain(|&k, _| k % 2 == 0);
/// assert!(map.into_iter().eq(vec![(0, 0), (2, 20), (4, 40), (6, 60)]));
/// ```
pub fn retain<F>(&mut self, mut f: F)
where
K: Ord,
F: FnMut(&K, &mut V) -> bool,
{
self.bst.retain(|k, v| f(k, v));
}
/// Splits the collection into two at the given key. Returns everything after the given key,
/// including the key.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut a = SgMap::<_, _, 10>::new();
/// a.insert(1, "a");
/// a.insert(2, "b");
/// a.insert(3, "c");
/// a.insert(17, "d");
/// a.insert(41, "e");
///
/// let b = a.split_off(&3);
///
/// assert_eq!(a.len(), 2);
/// assert_eq!(b.len(), 3);
///
/// assert_eq!(a[&1], "a");
/// assert_eq!(a[&2], "b");
///
/// assert_eq!(b[&3], "c");
/// assert_eq!(b[&17], "d");
/// assert_eq!(b[&41], "e");
/// ```
pub fn split_off<Q>(&mut self, key: &Q) -> SgMap<K, V, N>
where
K: Borrow<Q> + Ord,
Q: Ord + ?Sized,
{
SgMap {
bst: self.bst.split_off(key),
}
}
/// Removes a key from the map, returning the value at the key if the key
/// was previously in the map.
///
/// The key may be any borrowed form of the map's key type, but the ordering
/// on the borrowed form *must* match the ordering on the key type.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map = SgMap::<_, _, 10>::new();
/// map.insert(1, "a");
/// assert_eq!(map.remove(&1), Some("a"));
/// assert_eq!(map.remove(&1), None);
/// ```
pub fn remove<Q>(&mut self, key: &Q) -> Option<V>
where
K: Borrow<Q> + Ord,
Q: Ord + ?Sized,
{
self.bst.remove(key)
}
/// Returns the key-value pair corresponding to the supplied key.
///
/// The supplied key may be any borrowed form of the map's key type, but the ordering
/// on the borrowed form *must* match the ordering on the key type.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map = SgMap::<_, _, 10>::new();
/// map.insert(1, "a");
/// assert_eq!(map.get_key_value(&1), Some((&1, &"a")));
/// assert_eq!(map.get_key_value(&2), None);
/// ```
pub fn get_key_value<Q>(&self, key: &Q) -> Option<(&K, &V)>
where
K: Borrow<Q> + Ord,
Q: Ord + ?Sized,
{
self.bst.get_key_value(key)
}
/// Returns a reference to the value corresponding to the key.
///
/// The key may be any borrowed form of the map's key type, but the ordering
/// on the borrowed form *must* match the ordering on the key type.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map = SgMap::<_, _, 10>::new();
/// map.insert(1, "a");
/// assert_eq!(map.get(&1), Some(&"a"));
/// assert_eq!(map.get(&2), None);
/// ```
pub fn get<Q>(&self, key: &Q) -> Option<&V>
where
K: Borrow<Q> + Ord,
Q: Ord + ?Sized,
{
self.bst.get(key)
}
// Returns a mutable reference to the value corresponding to the key.
///
/// The key may be any borrowed form of the map's key type, but the ordering
/// on the borrowed form *must* match the ordering on the key type.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map = SgMap::<_, _, 10>::new();
/// map.insert(1, "a");
/// if let Some(x) = map.get_mut(&1) {
/// *x = "b";
/// }
/// assert_eq!(map[&1], "b");
/// ```
pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut V>
where
K: Borrow<Q> + Ord,
Q: Ord + ?Sized,
{
self.bst.get_mut(key)
}
/// Clears the map, removing all elements.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut a = SgMap::<_, _, 10>::new();
/// a.insert(1, "a");
/// a.clear();
/// assert!(a.is_empty());
/// ```
pub fn clear(&mut self) {
self.bst.clear()
}
/// Returns `true` if the map contains a value for the specified key.
///
/// The key may be any borrowed form of the map's key type, but the ordering
/// on the borrowed form *must* match the ordering on the key type.
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map = SgMap::<_, _, 10>::new();
/// map.insert(1, "a");
/// assert_eq!(map.contains_key(&1), true);
/// assert_eq!(map.contains_key(&2), false);
/// ```
pub fn contains_key<Q>(&self, key: &Q) -> bool
where
K: Borrow<Q> + Ord,
Q: Ord + ?Sized,
{
self.bst.contains_key(key)
}
/// Returns `true` if the map contains no elements.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut a = SgMap::<_, _, 10>::new();
/// assert!(a.is_empty());
/// a.insert(1, "a");
/// assert!(!a.is_empty());
/// ```
pub fn is_empty(&self) -> bool {
self.bst.is_empty()
}
/// Returns `true` if the map's capacity is filled.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut a = SgMap::<_, _, 2>::new();
/// a.insert(1, "a");
/// assert!(!a.is_full());
/// a.insert(2, "b");
/// assert!(a.is_full());
/// ```
pub fn is_full(&self) -> bool {
self.bst.is_full()
}
/// Returns a reference to the first key-value pair in the map.
/// The key in this pair is the minimum key in the map.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map = SgMap::<_, _, 10>::new();
/// assert_eq!(map.first_key_value(), None);
/// map.insert(1, "b");
/// map.insert(2, "a");
/// assert_eq!(map.first_key_value(), Some((&1, &"b")));
/// ```
pub fn first_key_value(&self) -> Option<(&K, &V)>
where
K: Ord,
{
self.bst.first_key_value()
}
/// Returns a reference to the first/minium key in the map, if any.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map = SgMap::<_, _, 10>::new();
/// assert_eq!(map.first_key_value(), None);
/// map.insert(1, "b");
/// map.insert(2, "a");
/// assert_eq!(map.first_key(), Some(&1));
/// ```
pub fn first_key(&self) -> Option<&K>
where
K: Ord,
{
self.bst.first_key()
}
/// Removes and returns the first element in the map.
/// The key of this element is the minimum key that was in the map.
///
/// # Examples
///
/// Draining elements in ascending order, while keeping a usable map each iteration.
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map = SgMap::<_, _, 10>::new();
/// map.insert(1, "a");
/// map.insert(2, "b");
/// while let Some((key, _val)) = map.pop_first() {
/// assert!((&map).into_iter().all(|(k, _v)| *k > key));
/// }
/// assert!(map.is_empty());
/// ```
pub fn pop_first(&mut self) -> Option<(K, V)>
where
K: Ord,
{
self.bst.pop_first()
}
/// Returns a reference to the last key-value pair in the map.
/// The key in this pair is the maximum key in the map.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map = SgMap::<_, _, 10>::new();
/// map.insert(1, "b");
/// map.insert(2, "a");
/// assert_eq!(map.last_key_value(), Some((&2, &"a")));
/// ```
pub fn last_key_value(&self) -> Option<(&K, &V)>
where
K: Ord,
{
self.bst.last_key_value()
}
/// Returns a reference to the last/maximum key in the map, if any.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map = SgMap::<_, _, 10>::new();
/// map.insert(1, "b");
/// map.insert(2, "a");
/// assert_eq!(map.last_key(), Some(&2));
/// ```
pub fn last_key(&self) -> Option<&K>
where
K: Ord,
{
self.bst.last_key()
}
/// Removes and returns the last element in the map.
/// The key of this element is the maximum key that was in the map.
///
/// # Examples
///
/// Draining elements in descending order, while keeping a usable map each iteration.
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map = SgMap::<_, _, 10>::new();
/// map.insert(1, "a");
/// map.insert(2, "b");
/// while let Some((key, _val)) = map.pop_last() {
/// assert!((&map).into_iter().all(|(k, _v)| *k < key));
/// }
/// assert!(map.is_empty());
/// ```
pub fn pop_last(&mut self) -> Option<(K, V)>
where
K: Ord,
{
self.bst.pop_last()
}
/// Returns the number of elements in the map.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut a = SgMap::<_, _, 10>::new();
/// assert_eq!(a.len(), 0);
/// a.insert(1, "a");
/// assert_eq!(a.len(), 1);
/// ```
pub fn len(&self) -> usize {
self.bst.len()
}
/// Gets the given key's corresponding entry in the map for in-place manipulation.
///
/// # Examples
///
/// Basic usage:
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut count = SgMap::<&str, usize, 10>::new();
///
/// // count the number of occurrences of letters in the vec
/// for x in vec!["a", "b", "a", "c", "a", "b"] {
/// *count.entry(x).or_insert(0) += 1;
/// }
///
/// assert_eq!(count["a"], 3);
/// ```
pub fn entry(&mut self, key: K) -> Entry<'_, K, V, N> {
let ngh: NodeGetHelper<Idx> = self.bst.internal_get(None, &key);
match ngh.node_idx() {
Some(node_idx) => Entry::Occupied(OccupiedEntry {
node_idx,
table: self,
}),
None => Entry::Vacant(VacantEntry { key, table: self }),
}
}
/// Returns the first entry in the map for in-place manipulation.
/// The key of this entry is the minimum key in the map.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map = SgMap::<_, _, 10>::new();
/// map.insert(1, "a");
/// map.insert(2, "b");
/// if let Some(mut entry) = map.first_entry() {
/// if *entry.key() > 0 {
/// entry.insert("first");
/// }
/// }
/// assert_eq!(*map.get(&1).unwrap(), "first");
/// assert_eq!(*map.get(&2).unwrap(), "b");
/// ```
pub fn first_entry(&mut self) -> Option<OccupiedEntry<'_, K, V, N>> {
if self.is_empty() {
return None;
}
let node_idx = self.bst.min_idx;
Some(OccupiedEntry {
node_idx,
table: self,
})
}
/// Returns the last entry in the map for in-place manipulation.
/// The key of this entry is the maximum key in the map.
///
/// # Examples
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map = SgMap::<_, _, 10>::new();
/// map.insert(1, "a");
/// map.insert(2, "b");
/// if let Some(mut entry) = map.last_entry() {
/// if *entry.key() > 0 {
/// entry.insert("last");
/// }
/// }
/// assert_eq!(*map.get(&1).unwrap(), "a");
/// assert_eq!(*map.get(&2).unwrap(), "last");
/// ```
pub fn last_entry(&mut self) -> Option<OccupiedEntry<'_, K, V, N>> {
if self.is_empty() {
return None;
}
let node_idx = self.bst.max_idx;
Some(OccupiedEntry {
node_idx,
table: self,
})
}
/// Constructs a double-ended iterator over a sub-range of elements in the map.
/// The simplest way is to use the range syntax `min..max`, thus `range(min..max)` will
/// yield elements from min (inclusive) to max (exclusive).
/// The range may also be entered as `(Bound<T>, Bound<T>)`, so for example
/// `range((Excluded(4), Included(10)))` will yield a left-exclusive, right-inclusive
/// range from 4 to 10.
///
/// # Panics
///
/// Panics if range `start > end`.
/// Panics if range `start == end` and both bounds are `Excluded`.
///
/// # Examples
///
/// Basic usage:
///
/// ```
/// use scapegoat::SgMap;
/// use core::ops::Bound::Included;
///
/// let mut map = SgMap::<_, _, 10>::new();
/// map.insert(3, "a");
/// map.insert(5, "b");
/// map.insert(8, "c");
/// for (&key, &value) in map.range((Included(&4), Included(&8))) {
/// println!("{}: {}", key, value);
/// }
/// assert_eq!(Some((&5, &"b")), map.range(4..).next());
/// ```
pub fn range<T, R>(&self, range: R) -> Range<'_, K, V, N>
where
T: Ord + ?Sized,
K: Borrow<T> + Ord,
R: RangeBounds<T>,
{
SgTree::<K, V, N>::assert_valid_range(&range);
Range {
table: self,
node_idx_iter: self.bst.range_search(&range).into_iter(),
}
}
/// Constructs a mutable single-ended iterator over a sub-range of elements in the map.
/// The simplest way is to use the range syntax `min..max`, thus `range(min..max)` will
/// yield elements from min (inclusive) to max (exclusive).
/// The range may also be entered as `(Bound<T>, Bound<T>)`, so for example
/// `range((Excluded(4), Included(10)))` will yield a left-exclusive, right-inclusive
/// range from 4 to 10.
///
/// # Panics
///
/// Panics if range `start > end`.
/// Panics if range `start == end` and both bounds are `Excluded`.
///
/// # Examples
///
/// Basic usage:
///
/// ```
/// use scapegoat::SgMap;
///
/// let mut map: SgMap<_, _, 10> = ["Alice", "Bob", "Carol", "Cheryl"]
/// .iter()
/// .map(|&s| (s, 0))
/// .collect();
/// for (_, balance) in map.range_mut("B".."Cheryl") {
/// *balance += 100;
/// }
/// for (name, balance) in &map {
/// println!("{} => {}", name, balance);
/// }
///
/// assert_eq!(map["Alice"], 0);
/// assert_eq!(map["Bob"], 100);
/// ```
pub fn range_mut<T, R>(&mut self, range: R) -> RangeMut<'_, K, V, N>
where
T: Ord + ?Sized,
K: Borrow<T> + Ord,
R: RangeBounds<T>,
{
SgTree::<K, V, N>::assert_valid_range(&range);
RangeMut::new(self, &range)
}
}
// Convenience Traits --------------------------------------------------------------------------------------------------
// Debug
impl<K: Default, V: Default, const N: usize> Debug for SgMap<K, V, N>
where
K: Ord + Debug,
V: Debug,
{
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_map().entries(self.bst.iter()).finish()
}
}
// From array.
impl<K: Default, V: Default, const N: usize> From<[(K, V); N]> for SgMap<K, V, N>
where
K: Ord,
{
/// ```
/// use scapegoat::SgMap;
///
/// let map1 = SgMap::from([(1, 2), (3, 4)]);
/// let map2: SgMap<_, _, 2> = [(1, 2), (3, 4)].into();
/// assert_eq!(map1, map2);
/// ```
///
/// ### Warning
///
/// [`TryFrom`](https://doc.rust-lang.org/stable/std/convert/trait.TryFrom.html) isn't implemented because it would collide with the blanket implementation.
/// See [this open GitHub issue](https://github.com/rust-lang/rust/issues/50133#issuecomment-64690839) from 2018,
/// this is a known Rust limitation that should be fixed via specialization in the future.
#[doc(alias = "tryfrom")]
#[doc(alias = "try_from")]
#[doc(alias = "TryFrom")]
fn from(arr: [(K, V); N]) -> Self {
IntoIterator::into_iter(arr).collect()
}
}
// Indexing
impl<K: Default, V: Default, Q, const N: usize> Index<&Q> for SgMap<K, V, N>
where
K: Borrow<Q> + Ord,
Q: Ord + ?Sized,
{
type Output = V;
/// Returns a reference to the value corresponding to the supplied key.
///
/// # Panics
///
/// Panics if the key is not present in the `SgMap`.
fn index(&self, key: &Q) -> &Self::Output {
&self.bst[key]
}
}
// Construct from iterator.
impl<K: Default, V: Default, const N: usize> FromIterator<(K, V)> for SgMap<K, V, N>
where
K: Ord,
{
fn from_iter<I: IntoIterator<Item = (K, V)>>(iter: I) -> Self {
let mut sgm = SgMap::new();
sgm.bst = SgTree::from_iter(iter);
sgm
}
}
// Extension from iterator.
impl<K: Default, V: Default, const N: usize> Extend<(K, V)> for SgMap<K, V, N>
where
K: Ord,
{
fn extend<T: IntoIterator<Item = (K, V)>>(&mut self, iter: T) {
self.bst.extend(iter);
}
}
// Extension from reference iterator.
impl<'a, K: Default, V: Default, const N: usize> Extend<(&'a K, &'a V)> for SgMap<K, V, N>
where
K: Ord + Copy,
V: Copy,
{
fn extend<I: IntoIterator<Item = (&'a K, &'a V)>>(&mut self, iter: I) {
self.extend(iter.into_iter().map(|(&key, &value)| (key, value)));
}
}
// General Iterators ---------------------------------------------------------------------------------------------------
// Reference iterator
impl<'a, K: Ord + Default, V: Default, const N: usize> IntoIterator for &'a SgMap<K, V, N> {
type Item = (&'a K, &'a V);
type IntoIter = Iter<'a, K, V, N>;
fn into_iter(self) -> Self::IntoIter {
self.iter()
}
}
// Consuming iterator
impl<K: Ord + Default, V: Default, const N: usize> IntoIterator for SgMap<K, V, N> {
type Item = (K, V);
type IntoIter = IntoIter<K, V, N>;
fn into_iter(self) -> Self::IntoIter {
IntoIter::new(self)
}
}