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
use core::fmt;
use core::fmt::{ Formatter, Debug };
use core::ops::{Index, IndexMut};
use core::iter::IntoIterator;
use core::ptr::{self, NonNull};
use core::mem;
use core::slice;
extern crate alloc;
use alloc::boxed::Box;
use alloc::vec;
use alloc::vec::Vec;
use alloc::vec::Drain;
use alloc::vec::IntoIter;
use crate::iter::*;
use crate::view::*;
use crate::ops::*;
/// DrainRow type alias for future-proofing.
pub type DrainRow<'a, T> = Drain<'a, T>;
/// IntoIter type alias for future-proofing.
pub type IntoIterTooDee<T> = IntoIter<T>;
/// Represents a two-dimensional array.
///
/// Empty arrays will always have dimensions of zero.
#[derive(Clone, Hash, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
pub struct TooDee<T> {
data: Vec<T>,
num_rows: usize,
num_cols: usize,
}
/// Custom `Default` implementation because `T` does not need to implement `Default`.
/// See rust issue [#26925](https://github.com/rust-lang/rust/issues/26925)
impl<T> Default for TooDee<T> {
/// # Examples
///
/// ```
/// use toodee::TooDee;
/// struct Abc { }
/// let toodee : TooDee<Abc> = TooDee::default();
/// ```
fn default() -> Self {
TooDee {
data : Vec::default(),
num_rows : 0,
num_cols : 0,
}
}
}
impl<T> Index<usize> for TooDee<T> {
type Output = [T];
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let toodee : TooDee<u32> = TooDee::new(10, 5);
/// let row = &toodee[3];
/// assert_eq!(row.len(), 10);
/// ```
fn index(&self, row: usize) -> &Self::Output {
assert!(row < self.num_rows);
let start = row * self.num_cols;
// can access the element unchecked because the above assertion holds
unsafe {
self.data.get_unchecked(start..start + self.num_cols)
}
}
}
impl<T> Index<Coordinate> for TooDee<T> {
type Output = T;
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let toodee : TooDee<u32> = TooDee::new(10, 5);
/// assert_eq!(toodee[(1,3)], 0);
/// ```
fn index(&self, coord: Coordinate) -> &Self::Output {
assert!(coord.1 < self.num_rows);
assert!(coord.0 < self.num_cols);
// can access the element unchecked because the above assertions hold
unsafe {
self.data.get_unchecked(coord.1 * self.num_cols + coord.0)
}
}
}
impl<T> IndexMut<usize> for TooDee<T> {
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let mut toodee : TooDee<u32> = TooDee::new(10, 5);
/// let mut row = &mut toodee[3];
/// row[0] = 42;
/// ```
fn index_mut(&mut self, row: usize) -> &mut Self::Output {
assert!(row < self.num_rows);
let start = row * self.num_cols;
// can access the element unchecked because the above assertion holds
unsafe {
self.data.get_unchecked_mut(start..start + self.num_cols)
}
}
}
impl<T> IndexMut<Coordinate> for TooDee<T> {
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let toodee : TooDee<u32> = TooDee::new(10, 5);
/// assert_eq!(toodee[(1,3)], 0);
/// ```
fn index_mut(&mut self, coord: Coordinate) -> &mut Self::Output {
assert!(coord.1 < self.num_rows);
assert!(coord.0 < self.num_cols);
// can access the element unchecked because the above assertions hold
unsafe {
self.data.get_unchecked_mut(coord.1 * self.num_cols + coord.0)
}
}
}
impl<T> TooDeeOps<T> for TooDee<T> {
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let toodee : TooDee<u32> = TooDee::new(10, 5);
/// assert_eq!(toodee.num_cols(), 10);
///
fn num_cols(&self) -> usize {
self.num_cols
}
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let toodee : TooDee<u32> = TooDee::new(10, 5);
/// assert_eq!(toodee.num_rows(), 5);
///
fn num_rows(&self) -> usize {
self.num_rows
}
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps};
/// let toodee : TooDee<u32> = TooDee::new(10, 5);
/// let view = toodee.view((1,2), (8,4));
/// assert_eq!(view.num_cols(), 7);
/// assert_eq!(view.num_rows(), 2);
/// ```
fn view(&self, start: Coordinate, end: Coordinate) -> TooDeeView<'_, T> {
TooDeeView::from_toodee(start, end, self)
}
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let mut toodee : TooDee<u32> = TooDee::new(10, 5);
/// let mut rows = toodee.rows();
/// assert_eq!(rows.len(), 5);
/// let r0 = rows.next().unwrap();
/// assert_eq!(r0.len(), 10);
/// ```
fn rows(&self) -> Rows<'_, T> {
Rows {
v : &self.data,
cols : self.num_cols,
skip_cols : 0,
}
}
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let mut toodee : TooDee<u32> = TooDee::new(10, 5);
/// let mut col = toodee.col(8);
/// assert_eq!(col.len(), 5);
/// ```
fn col(&self, col: usize) -> Col<'_, T> {
assert!(col < self.num_cols);
unsafe {
Col {
v : self.data.get_unchecked(col..self.data.len() - self.num_cols + col + 1),
skip : self.num_cols - 1,
}
}
}
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// unsafe {
/// let toodee : TooDee<u32> = TooDee::new(10, 5);
/// let row = toodee.get_unchecked_row(3);
/// assert_eq!(row.len(), 10);
/// }
/// ```
unsafe fn get_unchecked_row(&self, row: usize) -> &[T] {
let start = row * self.num_cols;
self.data.get_unchecked(start..start + self.num_cols)
}
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let toodee : TooDee<u32> = TooDee::new(10, 5);
/// unsafe {
/// assert_eq!(*toodee.get_unchecked((1,3)), 0);
/// }
/// ```
unsafe fn get_unchecked(&self, coord: Coordinate) -> &T {
self.data.get_unchecked(coord.1 * self.num_cols + coord.0)
}
}
impl<T> TooDeeOpsMut<T> for TooDee<T> {
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let mut toodee : TooDee<u32> = TooDee::new(10, 5);
/// let view = toodee.view_mut((1,2), (8,4));
/// assert_eq!(view.num_cols(), 7);
/// assert_eq!(view.num_rows(), 2);
/// ```
fn view_mut(&mut self, start: Coordinate, end: Coordinate) -> TooDeeViewMut<'_, T> {
TooDeeViewMut::from_toodee(start, end, self)
}
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let mut toodee : TooDee<u32> = TooDee::new(10, 5);
/// let mut rows = toodee.rows_mut();
/// assert_eq!(rows.len(), 5);
/// let r0 = rows.next().unwrap();
/// assert_eq!(r0.len(), 10);
/// ```
fn rows_mut(&mut self) -> RowsMut<'_, T> {
RowsMut {
v : &mut self.data,
cols : self.num_cols,
skip_cols : 0,
}
}
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let mut toodee : TooDee<u32> = TooDee::new(10, 5);
/// let mut col = toodee.col_mut(8);
/// assert_eq!(col.len(), 5);
/// ```
fn col_mut(&mut self, col: usize) -> ColMut<'_, T> {
assert!(col < self.num_cols);
let dlen = self.data.len();
unsafe {
ColMut {
v : self.data.get_unchecked_mut(col..dlen - self.num_cols + col + 1),
skip : self.num_cols - 1,
}
}
}
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let mut toodee : TooDee<u32> = TooDee::new(10, 5);
/// toodee.fill(42);
/// assert_eq!(toodee[1][1], 42);
/// ```
fn fill(&mut self, fill: T)
where T: Clone {
self.data.fill(fill);
}
/// Swap/exchange the data between two rows.
///
/// # Panics
///
/// Panics if either row index is out of bounds.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let mut toodee : TooDee<u32> = TooDee::init(10, 5, 42u32);
/// toodee[0].iter_mut().for_each(|v| *v = 1);
/// assert_eq!(toodee[(0, 2)], 42);
/// toodee.swap_rows(0, 2);
/// assert_eq!(toodee[(0, 2)], 1);
/// ```
fn swap_rows(&mut self, mut r1: usize, mut r2: usize) {
if r1 == r2 {
return;
}
if r2 < r1 {
mem::swap(&mut r1, &mut r2);
}
assert!(r2 < self.num_rows);
let num_cols = self.num_cols;
unsafe {
let (first, rest) = self.data.get_unchecked_mut(r1 * num_cols..).split_at_mut(num_cols);
let snd_idx = (r2 - r1 - 1) * num_cols;
let second = rest.get_unchecked_mut(snd_idx..snd_idx + num_cols);
// Both slices are guaranteed to have the same length
debug_assert_eq!(first.len(), num_cols);
debug_assert_eq!(second.len(), num_cols);
// We know that the two slices will not overlap because r1 != r2, and we used split_at_mut()
ptr::swap_nonoverlapping(first.as_mut_ptr(), second.as_mut_ptr(), num_cols);
}
}
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// unsafe {
/// let mut toodee : TooDee<u32> = TooDee::new(10, 5);
/// let row = toodee.get_unchecked_row_mut(3);
/// assert_eq!(row.len(), 10);
/// }
/// ```
unsafe fn get_unchecked_row_mut(&mut self, row: usize) -> &mut [T] {
let start = row * self.num_cols;
self.data.get_unchecked_mut(start..start + self.num_cols)
}
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let mut toodee : TooDee<u32> = TooDee::new(10, 5);
/// unsafe {
/// assert_eq!(*toodee.get_unchecked_mut((1,3)), 0);
/// }
/// ```
unsafe fn get_unchecked_mut(&mut self, coord: Coordinate) -> &mut T {
self.data.get_unchecked_mut(coord.1 * self.num_cols + coord.0)
}
/// Swap/exchange two cells in the array.
///
/// # Panics
///
/// Panics if either cell coordinate is out of bounds.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let mut toodee = TooDee::from_vec(3, 3, (0u32..9).collect());
/// toodee.swap((0,0),(2, 2));
/// assert_eq!(toodee.data(), &[8, 1, 2, 3, 4, 5, 6, 7, 0]);
/// ```
fn swap(&mut self, (col1, row1): Coordinate, (col2, row2): Coordinate) {
let num_cols = self.num_cols;
let num_rows = self.num_rows;
assert!(col1 < num_cols && col2 < num_cols);
assert!(row1 < num_rows && row2 < num_rows);
unsafe {
let pa: *mut T = self.data.get_unchecked_mut(row1 * num_cols + col1);
let pb: *mut T = self.data.get_unchecked_mut(row2 * num_cols + col2);
ptr::swap(pa, pb);
}
}
}
impl<T> TooDee<T> {
/// Create a new `TooDee` array of the specified dimensions, and fill it with
/// the type's default value.
///
/// # Panics
///
/// Panics if one of the dimensions is zero but the other is non-zero. This
/// is to enforce the rule that empty arrays have no dimensions.
///
/// Panics if `num_rows * num_cols` overflows.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps};
/// let toodee : TooDee<u32> = TooDee::new(10, 5);
/// assert_eq!(toodee.num_cols(), 10);
/// assert_eq!(toodee.num_rows(), 5);
/// assert_eq!(toodee[0][0], 0);
/// ```
pub fn new(num_cols: usize, num_rows: usize) -> TooDee<T>
where T: Default {
let mut data = Vec::new();
data.resize_with(num_cols.checked_mul(num_rows).unwrap(), T::default);
TooDee { data, num_cols, num_rows }
}
/// Create a new `TooDee` array of the specified dimensions, and fill it with
/// an initial value.
///
/// # Panics
///
/// Panics if one of the dimensions is zero but the other is non-zero. This
/// is to enforce the rule that empty arrays have no dimensions.
///
/// Panics if `num_rows * num_cols` overflows.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps};
/// let toodee = TooDee::init(10, 5, 42u32);
/// assert_eq!(toodee.num_cols(), 10);
/// assert_eq!(toodee.num_rows(), 5);
/// assert_eq!(toodee[0][0], 42);
/// ```
pub fn init(num_cols: usize, num_rows: usize, init_value: T) -> TooDee<T>
where T: Clone {
if num_cols == 0 || num_rows == 0 {
assert_eq!(num_rows, num_cols);
}
let len = num_rows.checked_mul(num_cols).unwrap();
let v = vec![init_value; len];
TooDee {
data : v,
num_cols,
num_rows,
}
}
/// Returns the element capacity of the underlying `Vec`.
///
/// # Examples
///
/// ```
/// use toodee::TooDee;
/// let v = vec![42u32; 10];
/// let toodee : TooDee<u32> = TooDee::from_vec(5, 2, v);
/// assert!(toodee.capacity() >= 10);
/// ```
pub fn capacity(&self) -> usize {
self.data.capacity()
}
/// Constructs a new, empty `TooDee<T>` with the specified element capacity.
///
/// # Examples
///
/// ```
/// use toodee::TooDee;
/// let toodee : TooDee<u32> = TooDee::with_capacity(50);
/// assert!(toodee.capacity() >= 50);
/// ```
pub fn with_capacity(capacity: usize) -> TooDee<T> {
TooDee {
data : Vec::with_capacity(capacity),
num_cols : 0,
num_rows : 0,
}
}
/// Reserves the minimum capacity for at least `additional` more elements to be inserted
/// into the `TooDee<T>`.
///
/// # Examples
///
/// ```
/// use toodee::TooDee;
/// let mut toodee : TooDee<u32> = TooDee::default();
/// toodee.reserve_exact(50);
/// assert_eq!(toodee.capacity(), 50);
/// ```
pub fn reserve_exact(&mut self, capacity: usize) {
self.data.reserve_exact(capacity);
}
/// Reserves capacity for at least `additional` more elements to be inserted
/// in the given `TooDee<T>`.
///
/// # Examples
///
/// ```
/// use toodee::TooDee;
/// let mut toodee : TooDee<u32> = TooDee::default();
/// toodee.reserve(50);
/// assert!(toodee.capacity() >= 50);
/// ```
pub fn reserve(&mut self, capacity: usize) {
self.data.reserve(capacity);
}
/// Shrinks the capacity of the underlying vector as much as possible.
///
/// # Examples
///
/// ```
/// use toodee::TooDee;
/// let mut toodee : TooDee<u32> = TooDee::with_capacity(50);
/// toodee.shrink_to_fit();
/// assert_eq!(toodee.capacity(), 0);
/// ```
pub fn shrink_to_fit(&mut self) {
self.data.shrink_to_fit();
}
/// Create a new `TooDee` array using the provided vector. The vector's length
/// must match the dimensions of the array.
///
/// # Panics
///
/// Panics if one of the dimensions is zero but the other is non-zero. This
/// is to enforce the rule that empty arrays have no dimensions.
///
/// Panics if `num_cols * num_rows` overflows.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps};
/// let v = vec![42u32; 10];
/// let mut toodee : TooDee<u32> = TooDee::from_vec(5, 2, v);
/// assert_eq!(toodee.num_cols(), 5);
/// assert_eq!(toodee.num_rows(), 2);
/// assert_eq!(toodee[0][0], 42);
/// ```
pub fn from_vec(num_cols: usize, num_rows: usize, v: Vec<T>) -> TooDee<T> {
if num_cols == 0 || num_rows == 0 {
assert_eq!(num_rows, num_cols);
}
assert_eq!(num_cols.checked_mul(num_rows).unwrap(), v.len());
TooDee {
data : v,
num_cols,
num_rows,
}
}
/// Create a new `TooDee` array using the provided boxed slice. The slice's length
/// must match the dimensions of the array.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps};
/// let v = vec![42u32; 10];
/// let mut toodee : TooDee<u32> = TooDee::from_box(5, 2, v.into_boxed_slice());
/// assert_eq!(toodee.num_cols(), 5);
/// assert_eq!(toodee.num_rows(), 2);
/// assert_eq!(toodee[0][0], 42);
/// ```
pub fn from_box(num_cols: usize, num_rows: usize, b: Box<[T]>) -> TooDee<T> {
TooDee::from_vec(num_cols, num_rows, b.into_vec())
}
/// Returns a reference to the raw array data
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps};
/// let v = vec![42u32; 10];
/// let mut toodee : TooDee<u32> = TooDee::from_vec(5, 2, v);
/// assert_eq!(toodee.data()[0], 42);
/// ```
pub fn data(&self) -> &[T] {
&self.data
}
/// Returns a mutable reference to the raw array data
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps};
/// let v = vec![42u32; 10];
/// let mut toodee : TooDee<u32> = TooDee::from_vec(5, 2, v);
/// assert_eq!(toodee.data_mut()[0], 42);
/// ```
pub fn data_mut(&mut self) -> &mut [T] {
&mut self.data
}
/// Clears the array, removing all values and zeroing the number of columns and rows.
///
/// Note that this method has no effect on the allocated capacity of the array.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps};
/// let v = vec![42u32; 10];
/// let mut toodee : TooDee<u32> = TooDee::from_vec(5, 2, v);
/// toodee.clear();
/// assert_eq!(toodee.num_cols(), 0);
/// assert_eq!(toodee.num_rows(), 0);
/// assert!(toodee.capacity() >= 10);
/// ```
pub fn clear(&mut self) {
self.num_cols = 0;
self.num_rows = 0;
self.data.clear();
}
/// Removes the last row from the array and returns it as a `Drain`, or `None` if it is empty.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps};
/// let v = vec![42u32; 15];
/// let mut toodee : TooDee<u32> = TooDee::from_vec(5, 3, v);
/// {
/// let drain = toodee.pop_row().unwrap();
/// assert_eq!(drain.len(), 5);
/// }
/// assert_eq!(toodee.num_cols(), 5);
/// assert_eq!(toodee.num_rows(), 2);
/// ```
pub fn pop_row(&mut self) -> Option<DrainRow<'_, T>> {
(self.num_rows != 0).then(move || self.remove_row(self.num_rows - 1))
}
/// Appends a new row to the array.
///
/// # Panics
///
/// Panics if the data's length doesn't match the length of existing rows (if any).
pub fn push_row<I>(&mut self, data: impl IntoIterator<Item=T, IntoIter=I>)
where I : Iterator<Item=T> + ExactSizeIterator
{
self.insert_row(self.num_rows, data);
}
/// Inserts new `data` into the array at the specified `row`
///
/// # Panics
///
/// Panics if the data's length doesn't match the length of existing rows (if any).
pub fn insert_row<I>(&mut self, index: usize, data: impl IntoIterator<Item=T, IntoIter=I>)
where I : Iterator<Item=T> + ExactSizeIterator
{
assert!(index <= self.num_rows);
let mut iter = data.into_iter();
if self.num_rows == 0 {
self.num_cols = iter.len();
} else {
assert_eq!(self.num_cols, iter.len());
}
self.reserve(self.num_cols);
let start = index * self.num_cols;
let len = self.data.len();
unsafe {
// Prevent duplicate (or any) drops on the portion of the array we are modifying.
// This is to safe-guard against a panic potentially caused by `iter.next()`.
// Alternative (less performant) approaches would be:
// - append the new row to the array and use `slice.rotate...()` to shuffle everything into place.
// - store the new row data in a temporary location before shifting the memory and inserting the row.
self.data.set_len(start);
let mut p = self.data.as_mut_ptr().add(start);
// shift everything to make space for the new row
let suffix = p.add(self.num_cols);
ptr::copy(p, suffix, len - start);
// Only iterates a maximum of `self.num_cols` times.
while p < suffix {
if let Some(e) = iter.next() {
ptr::write(p, e);
p = p.add(1);
} else {
// panic if the iterator length is less than expected
assert_eq!(p, suffix, "unexpected iterator length");
}
}
debug_assert!(iter.next().is_none(), "iterator not exhausted");
self.data.set_len(len + self.num_cols);
}
// update the number of rows
if self.num_cols > 0 {
self.num_rows += 1;
}
}
/// Removes the specified row from the array and returns it as a `Drain`
///
/// # Panics
///
/// Panics if the specified row index is out of bounds.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps};
/// let v = vec![42u32; 15];
/// let mut toodee : TooDee<u32> = TooDee::from_vec(5, 3, v);
/// {
/// let drain = toodee.remove_row(1);
/// assert_eq!(drain.len(), 5);
/// }
/// assert_eq!(toodee.num_cols(), 5);
/// assert_eq!(toodee.num_rows(), 2);
/// ```
pub fn remove_row(&mut self, index : usize) -> DrainRow<'_, T>
{
assert!(index < self.num_rows);
let start = index * self.num_cols;
let drain = self.data.drain(start..start + self.num_cols);
self.num_rows -= 1;
if self.num_rows == 0 {
self.num_cols = 0;
}
drain
}
/// Removes the last column from the array and returns it as a `Drain`, or `None` if it is empty.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps};
/// let v = vec![42u32; 15];
/// let mut toodee : TooDee<u32> = TooDee::from_vec(5, 3, v);
/// {
/// let drain = toodee.pop_col().unwrap();
/// assert_eq!(drain.len(), 3);
/// }
/// assert_eq!(toodee.num_cols(), 4);
/// assert_eq!(toodee.num_rows(), 3);
/// ```
pub fn pop_col(&mut self) -> Option<DrainCol<'_, T>> {
(self.num_cols != 0).then(move || self.remove_col(self.num_cols - 1))
}
/// Appends a new column to the array.
///
/// # Panics
///
/// Panics if the data's length doesn't match the length of existing rows (if any).
pub fn push_col<I>(&mut self, data: impl IntoIterator<Item=T, IntoIter=I>)
where I : Iterator<Item=T> + ExactSizeIterator + DoubleEndedIterator
{
self.insert_col(self.num_cols, data);
}
/// Removes the specified column from the array and returns it as a `Drain`
///
/// # Panics
///
/// Panics if the specified column index is out of bounds.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps};
/// let v = vec![42u32; 15];
/// let mut toodee : TooDee<u32> = TooDee::from_vec(5, 3, v);
/// {
/// let drain = toodee.remove_col(1);
/// assert_eq!(drain.len(), 3);
/// }
/// assert_eq!(toodee.num_cols(), 4);
/// assert_eq!(toodee.num_rows(), 3);
/// ```
pub fn remove_col(&mut self, index: usize) -> DrainCol<'_, T>
{
assert!(index < self.num_cols);
let v = &mut self.data;
let num_cols = self.num_cols;
let slice_len = v.len() - num_cols + 1;
unsafe {
// set the vec length to 0 to amplify any leaks
v.set_len(0);
DrainCol {
iter : Col {
skip : num_cols - 1,
v : slice::from_raw_parts_mut(v.as_mut_ptr().add(index), slice_len),
},
col : index,
toodee : NonNull::from(self),
}
}
}
/// Inserts new `data` into the array at the specified `col`.
///
/// # Panics
///
/// Panics if the data's length doesn't match the length of existing columns (if any).
pub fn insert_col<I>(&mut self, index: usize, data: impl IntoIterator<Item=T, IntoIter=I>)
where I : Iterator<Item=T> + ExactSizeIterator + DoubleEndedIterator
{
assert!(index <= self.num_cols);
// Use the reverse iterator
let mut rev_iter = data.into_iter().rev();
if self.num_cols == 0 {
self.num_rows = rev_iter.len();
} else {
assert_eq!(self.num_rows, rev_iter.len());
}
self.reserve(self.num_rows);
let old_len = self.data.len();
let new_len = old_len + self.num_rows;
let suffix_len = self.num_cols - index;
unsafe {
// Prevent duplicate (or any) drops on the array we are modifying.
// This is to safe-guard against a panic potentially caused by `rev_iter.next()`.
// Alternative (less performant) approaches would be:
// - append the new column to the array and use swapping to shuffle everything into place.
// - store the new column data in a temporary location before shifting the memory and inserting values.
self.data.set_len(0);
let p = self.data.as_mut_ptr();
let mut read_p = p.add(old_len);
let mut write_p = p.add(new_len);
let next_or_panic = |iter : &mut core::iter::Rev<I>| -> T {
if let Some(e) = iter.next() {
e
} else {
panic!("unexpected iterator length");
}
};
if self.num_rows > 0 {
// start with suffix copy
read_p = read_p.sub(suffix_len);
write_p = write_p.sub(suffix_len);
ptr::copy(read_p, write_p, suffix_len);
write_p = write_p.sub(1);
ptr::write(write_p, next_or_panic(&mut rev_iter));
for _ in 0..(self.num_rows - 1) {
// copy suffix and prefix as a single block until we are on the final element
read_p = read_p.sub(self.num_cols);
write_p = write_p.sub(self.num_cols);
ptr::copy(read_p, write_p, self.num_cols);
write_p = write_p.sub(1);
ptr::write(write_p, next_or_panic(&mut rev_iter));
}
read_p = read_p.sub(index);
write_p = write_p.sub(index);
ptr::copy(read_p, write_p, index);
}
debug_assert!(rev_iter.next().is_none(), "iterator not exhausted");
self.data.set_len(new_len);
}
// update the number of columns
if self.num_rows > 0 {
self.num_cols += 1;
}
}
/// Switches the values for `num_cols` and `num_rows` _without_ transposing the underlying data.
pub fn swap_dimensions(&mut self) {
mem::swap(&mut self.num_cols, &mut self.num_rows);
}
}
/// Use `Vec`'s `IntoIter` for performance reasons.
///
/// TODO: return type that implements `TooDeeIterator`
impl<T> IntoIterator for TooDee<T> {
type Item = T;
type IntoIter = IntoIterTooDee<T>;
fn into_iter(self) -> Self::IntoIter {
self.data.into_iter()
}
}
impl<'a, T> IntoIterator for &'a TooDee<T> {
type Item = &'a T;
type IntoIter = Cells<'a, T>;
/// `Cells` is the preferred iterator type here, because it implements `TooDeeIterator`
fn into_iter(self) -> Self::IntoIter {
self.cells()
}
}
impl<'a, T> IntoIterator for &'a mut TooDee<T> {
type Item = &'a mut T;
/// `CellsMut` is the preferred iterator type here, because it implements `TooDeeIterator`
type IntoIter = CellsMut<'a, T>;
fn into_iter(self) -> Self::IntoIter {
self.cells_mut()
}
}
/// Support conversion into a `Vec`.
impl<T> From<TooDee<T>> for Vec<T> {
fn from(toodee: TooDee<T>) -> Vec<T> {
toodee.data
}
}
/// Support conversion into a boxed slice.
impl<T> From<TooDee<T>> for Box<[T]> {
fn from(toodee: TooDee<T>) -> Box<[T]> {
toodee.data.into_boxed_slice()
}
}
impl<T> AsRef<[T]> for TooDee<T> {
fn as_ref(&self) -> &[T] {
&self.data
}
}
impl<T> AsMut<[T]> for TooDee<T> {
fn as_mut(&mut self) -> &mut [T] {
&mut self.data
}
}
/// We can allow immutable access to the underlying `Vec`,
/// but not mutable access because that could lead to changes
/// in the `Vec`'s length.
impl<T> AsRef<Vec<T>> for TooDee<T> {
fn as_ref(&self) -> &Vec<T> {
&self.data
}
}
impl<T> Debug for TooDee<T> where T : Debug {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
f.debug_list().entries(self.rows()).finish()
}
}
impl<T> From<TooDeeView<'_, T>> for TooDee<T> where T : Clone {
fn from(view: TooDeeView<'_, T>) -> Self {
let num_cols = view.num_cols();
let num_rows = view.num_rows();
let mut v = Vec::with_capacity(num_cols * num_rows);
for r in view.rows() {
v.extend_from_slice(r);
}
TooDee {
data : v,
num_cols,
num_rows,
}
}
}
impl<T> From<TooDeeViewMut<'_, T>> for TooDee<T> where T : Clone {
fn from(view: TooDeeViewMut<'_, T>) -> Self {
let num_cols = view.num_cols();
let num_rows = view.num_rows();
let mut v = Vec::with_capacity(num_cols * num_rows);
for r in view.rows() {
v.extend_from_slice(r);
}
TooDee {
data : v,
num_cols,
num_rows,
}
}
}
/// Drains a column.
#[derive(Debug)]
pub struct DrainCol<'a, T> {
/// Current remaining elements to remove
iter: Col<'a, T>,
col: usize,
toodee: NonNull<TooDee<T>>,
}
// NonNull is !Sync, so we need to implement Sync manually
unsafe impl<T: Sync> Sync for DrainCol<'_, T> {}
// NonNull is !Send, so we need to implement Send manually
unsafe impl<T: Send> Send for DrainCol<'_, T> {}
impl<T> Iterator for DrainCol<'_, T> {
type Item = T;
#[inline]
fn next(&mut self) -> Option<T> {
self.iter.next().map(|elt| unsafe { ptr::read(elt as *const _) })
}
fn size_hint(&self) -> (usize, Option<usize>) {
self.iter.size_hint()
}
}
impl<T> DoubleEndedIterator for DrainCol<'_, T> {
#[inline]
fn next_back(&mut self) -> Option<T> {
self.iter.next_back().map(|elt| unsafe { ptr::read(elt as *const _) })
}
}
impl<T> ExactSizeIterator for DrainCol<'_, T> { }
impl<T> Drop for DrainCol<'_, T> {
fn drop(&mut self) {
/// Continues dropping the remaining elements in the `DrainCol`, then repositions the
/// un-`Drain`ed elements to restore the original `TooDee`.
struct DropGuard<'r, 'a, T>(&'r mut DrainCol<'a, T>);
impl<'r, 'a, T> Drop for DropGuard<'r, 'a, T> {
fn drop(&mut self) {
self.0.for_each(drop);
let col = self.0.col;
unsafe {
let toodee = self.0.toodee.as_mut();
let vec = &mut toodee.data;
let mut dest = vec.as_mut_ptr().add(col);
let mut src = dest.add(1);
let orig_cols = toodee.num_cols;
let new_cols = orig_cols - 1;
let num_rows = toodee.num_rows;
for _ in 1..num_rows {
ptr::copy(src, dest, new_cols);
src = src.add(orig_cols);
dest = dest.add(new_cols);
}
ptr::copy(src, dest, orig_cols - col);
toodee.num_cols -= 1;
if toodee.num_cols == 0 {
toodee.num_rows = 0;
}
// Set the new length based on the col/row counts
vec.set_len(toodee.num_cols * toodee.num_rows);
}
}
}
// exhaust self first
while let Some(item) = self.next() {
let guard = DropGuard(self);
drop(item);
mem::forget(guard);
}
// Drop a `DropGuard` to move back the non-drained tail of `self`.
DropGuard(self);
}
}