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
/*! # Das Grid **Das Grid** is a 2D grid library which serves as fundamental building block for any 2D game built on the concept of grid Famous games built on 2d grid concept: * Draughts/Checkers * Chess * Scrabble * Tetris * Bejeweled * Shinning Force (while battle) Das Grid offers: * Generic grid type, you can use any type you want to be the grid cell * Helpers to make easy the move of values inside the grid * Based on 2D top/left to bottom/right concept (which can be updated in the future) ## Using **Das Grid** ### Creating the grid ```rust // Creates a 10x10 grid with 0 as default value for each cell let mut g = das_grid::Grid::new(10, 10, 0); // Set the the value 1 at position x: 5 and y: 5 g.set((5, 5), &1); ``` ### Bring your own type ```rust // Using &str instead of i32 let mut g: das_grid::Grid<&str> = das_grid::Grid::new(10, 10, "a"); g.get((0, 0)).unwrap(); // ouputs: "a" ``` ```rust use std::fmt::Display; // Your own enum, much better to track grid values #[derive(Clone, Copy, PartialEq, Eq)] enum Pawn { None, Player, Enemy, } impl std::fmt::Display for Pawn { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { match *self { Pawn::None => write!(f, "None"), Pawn::Player => write!(f, "Player"), Pawn::Enemy => write!(f, "Enemy"), } } } // Initialize empty grid let mut g: das_grid::Grid<Pawn> = das_grid::Grid::new(10, 10, Pawn::None); // Set the Player on position 5,5 g.set((5, 5), &Pawn::Player); // Move the player to right if let Ok(()) = g.mov_to((5, 5), das_grid::MoveDirection::Right) { // "The pawn on 6,5 is Player" println!("The pawn on 6,5 is {}", g.get((6, 5)).unwrap()); } ``` > The `mov_to` function can returns `Result<(), Err>` if the attept of move is out of the bounds of the grid ### Moving cells Each tile of the grid is called cell and each cell is the type that you want, because it is a 2D structure each cell has an address which consists of X and Y ```rust // Creates a 5x5 grid with 0 as default value for each cell let mut g = das_grid::Grid::new(5, 5, 0); // Print with special {:?} to see the contents of the grid println!("{:?}", g); // outputs: // Grid { rows: 5, cols: 5, cells: [ // 0 (x: 0 y: 0) 0 (x: 1 y: 0) 0 (x: 2 y: 0) 0 (x: 3 y: 0) 0 (x: 4 y: 0) // 0 (x: 0 y: 1) 0 (x: 1 y: 1) 0 (x: 2 y: 1) 0 (x: 3 y: 1) 0 (x: 4 y: 1) // 0 (x: 0 y: 2) 0 (x: 1 y: 2) 0 (x: 2 y: 2) 0 (x: 3 y: 2) 0 (x: 4 y: 2) // 0 (x: 0 y: 3) 0 (x: 1 y: 3) 0 (x: 2 y: 3) 0 (x: 3 y: 3) 0 (x: 4 y: 3) // 0 (x: 0 y: 4) 0 (x: 1 y: 4) 0 (x: 2 y: 4) 0 (x: 3 y: 4) 0 (x: 4 y: 4) // ] } ``` ## License ```text MIT License Copyright (c) 2021 Eduardo Pereira Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ``` */ use std::{ fmt::{self, Display}, ops::{Index, IndexMut}, }; /// Err represents the errors that can happen on the Das Grid module /// /// GridErr::OutOfGrid when the attempt of move or set a value /// is beyond the bounds of grid /// /// GridErr::RuleFailed when some rule failed to applied /// /// GridErr::SubgridOverflow when the subgrid 0x0 is greater than the parent grid #[derive(Debug, Clone, PartialEq, Eq)] pub enum GridErr { OutOfGrid, RuleFailed, SubgridOverflow, } impl fmt::Display for GridErr { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { GridErr::OutOfGrid => write!(f, "value is out of the grid rows and cols"), GridErr::RuleFailed => write!(f, "failed to meet the rule requirements"), GridErr::SubgridOverflow => write!( f, "the subgrid cols or rows is greater than the parent grid" ), } } } /// Represents the possible direction to move /// /// MoveDirection::Right /// MoveDirection::Left /// MoveDirection::Up /// MoveDirection::Down #[derive(Debug, PartialEq, Eq)] pub enum MoveDirection { Right, Left, Up, Down, } /// Represent move to right position on Das Grid (0, 1) pub const MOVE_RIGHT: (i32, i32) = (0, 1); /// Represent move to left position on Das Grid (0, -1) pub const MOVE_LEFT: (i32, i32) = (0, -1); /// Represent move to up position on Das Grid (-1, 0) pub const MOVE_UP: (i32, i32) = (-1, 0); /// Represent move to down position on Das Grid (1, 0) pub const MOVE_DOWN: (i32, i32) = (1, 0); /// Stores the grid values and the cells /// The grid itself representation is a flatten vector which is transformed /// for 2D representation when called by the user /// /// The cells are internally manage by a `Vec<T>` /// /// So to create a grid with 4x4 (collums and rows) /// /// ```.rust /// let grid = das_grid::Grid::new(4, 4, 0); /// assert_eq!(grid.size(), 16); /// ``` /// /// Or if you like let's say a Tetris style grid /// /// ```.rust /// let grid = das_grid::Grid::new(10, 20, 0); /// /// // And it will have 200 cells! /// assert_eq!(grid.size(), 200); /// ``` pub struct Grid<T: Copy + Clone> { pub(crate) rows: i32, pub(crate) cols: i32, pub(crate) initial_value: T, pub(crate) cells: Vec<T>, } impl<T: Copy + Clone> Grid<T> { /// Creates a grid of size rows x columns with default value passed on the third parameter /// For example this will generate a 2x2 grid of value 1: /// ```.rust /// let grid = das_grid::Grid::new(2, 2, 1); /// assert_eq!(grid.size(), 4); /// ``` pub fn new(rows: i32, cols: i32, value: T) -> Self where T: Clone + Copy, { if (rows * cols) == 0 { panic!("0x0 grid is forbidden") } let initial_value = value; let cells = vec![value; (rows * cols) as usize]; Self { rows, cols, initial_value, cells, } } /// Creates a grid from a given vector with quadratic size /// For example this will generate a 2x2 grid /// ```.rust /// let mut grid = das_grid::Grid::new_from_vector(2, 2, vec![1, 2, 3, 4]); /// assert_eq!(grid.size(), 4); /// ``` pub fn new_from_vector(rows: i32, cols: i32, vec: Vec<T>) -> Self { if vec.len() % 2 != 0 { panic!("The vector isn't multiple of 2"); } if vec.len() == 0 { panic!("0x0 grid is forbidden") } if rows * cols != vec.len() as i32 { panic!("cols and rows should be same vector size") } let initial_value = vec.first().unwrap().clone(); let cells = vec.to_vec(); Self { rows, cols, initial_value, cells, } } /// Stamps the subgrid into the destiny grid, merging both /// /// If the sub grid is greater than the main grid it return an error of GridErr::SubgridOverflow /// Or if the dest x, y grid is out of bounds it return error GridErr::OutOfGrid /// /// ```.rust /// let mut grid: das_grid::Grid<i32> = das_grid::Grid::new(10, 10, 0); /// let sub_grid: das_grid::Grid<i32> = das_grid::Grid::new(2, 2, 1); /// assert!(grid.stamp_subgrid((5, 5), sub_grid).is_ok()); /// assert_eq!(grid.get((5, 5)).unwrap(), &1); /// assert_eq!(grid.get((5, 6)).unwrap(), &1); /// assert_eq!(grid.get((6, 5)).unwrap(), &1); /// assert_eq!(grid.get((6, 6)).unwrap(), &1); /// ``` pub fn stamp_subgrid(&mut self, index: (i32, i32), sub_grid: Grid<T>) -> Result<(), GridErr> { self.check_grid_overflow(&sub_grid)?; self.check_grid_bounds(index)?; for sub_index in sub_grid.enumerate() { if let Ok(subv) = sub_grid.get(sub_index) { // Sum origin of subgrid and dest cells let dest = (index.0 + sub_index.0, index.1 + sub_index.1); // Ok if the subgrid bleeds match self.set(dest, &subv) { Ok(_) => (), _ => (), } } } Ok(()) } /// Creates the a new grid which is a snapshot of the main grid on the given position and size /// /// If the sub grid is greater than the main grid it return an error of GridErr::SubgridOverflow /// /// Or if the dest x, y grid is out of bounds it return error GridErr::OutOfGrid /// /// ```.rust /// let mut grid = das_grid::Grid::new_from_vector(4, 4, (1..=16).collect()); /// let sub_grid = grid.get_subgrid((2, 2), 2, 2).unwrap(); /// assert_eq!(sub_grid.get_flatten_grid(), vec![11, 12, 15, 16]); /// ``` pub fn get_subgrid(&self, index: (i32, i32), rows: i32, cols: i32) -> Result<Grid<T>, GridErr> { self.check_grid_bounds(index)?; let mut sub_grid = Grid::new(rows, cols, self.initial_value); self.check_grid_overflow(&sub_grid)?; for sub_index in sub_grid.enumerate() { let dest = (index.0 + sub_index.0, index.1 + sub_index.1); if let Ok(subv) = self.get(dest) { match sub_grid.set(sub_index, &subv) { Ok(_) => (), _ => (), } } } Ok(sub_grid) } /// Stamps the subgrid into the destiny grid, merging both /// Only if no rule return error /// /// If the sub grid is greater than the main grid it return an error of GridErr::SubgridOverflow /// /// Or if the dest x, y grid is out of bounds it return error GridErr::OutOfGrid /// /// And if a rule some rule failed it will return GridErr::RuleFailed /// /// ```.rust /// let mut grid: das_grid::Grid<i32> = das_grid::Grid::new(10, 10, 1); /// let sub_grid: das_grid::Grid<i32> = das_grid::Grid::new(2, 2, 1); /// /// let rule_not_1 = |_: (i32, i32), value: &i32| -> Result<(), das_grid::GridErr> { /// if *value == 1 { /// return Err(das_grid::GridErr::RuleFailed); /// } /// Ok(()) /// }; /// /// assert!(grid /// .stamp_subgrid_with_rules((5, 5), sub_grid, vec![rule_not_1]) /// .is_err()); /// ``` pub fn stamp_subgrid_with_rules<R>( &mut self, index: (i32, i32), sub_grid: Grid<T>, rules: Vec<R>, ) -> Result<(), GridErr> where R: Fn((i32, i32), &T) -> Result<(), GridErr>, { self.check_grid_overflow(&sub_grid)?; self.check_grid_bounds(index)?; for sub_index in sub_grid.enumerate() { if let Ok(subv) = sub_grid.get(sub_index) { // Sum origin of subgrid and dest cells let dest = (index.0 + sub_index.0, index.1 + sub_index.1); // Get the destiny let destv = self.get(dest)?; // Test rules on dest pos and value for rule in rules.iter() { rule(dest, destv)?; } // Ok if the subgrid bleeds match self.set(dest, &subv) { Ok(_) => (), _ => (), } } } Ok(()) } // Check if subgrid isn't bigger than the destiny grid fn check_grid_overflow(&self, sub_grid: &Grid<T>) -> Result<(), GridErr> { if sub_grid.cols > self.cols { return Err(GridErr::SubgridOverflow); } if sub_grid.rows > self.rows { return Err(GridErr::SubgridOverflow); } Ok(()) } /// Internally checks if the index (x, y) is inside of the bounds of the grid fn check_grid_bounds(&self, index: (i32, i32)) -> Result<(), GridErr> { let (x, y) = index; if x < 0 || x >= self.rows { return Err(GridErr::OutOfGrid); } if y < 0 || y >= self.cols { return Err(GridErr::OutOfGrid); } Ok(()) } /// Sets a given value to the position (x, y) /// /// Be careful if the value is out of the bounds of grid it will return an error /// with the type of GridErr::OutOfGrid /// /// ```.rust /// let mut grid = das_grid::Grid::new(2, 2, 1); /// assert!(grid.set((0, 0), &1).is_ok()); /// ``` pub fn set(&mut self, index: (i32, i32), value: &T) -> Result<(), GridErr> where T: Copy, { let (x, y) = index; self.check_grid_bounds(index)?; if let Some(cell) = self.cells.get_mut((x * self.rows + y) as usize) { *cell = *value; } Ok(()) } /// Sets a given value to the position (x, y) /// Only if no rule return error /// /// ```.rust /// let mut grid = das_grid::Grid::new(2, 2, 0); /// assert!(grid.set((0, 1), &1).is_ok()); /// /// let rule_not_1 = |_: (i32, i32), value: &i32| -> Result<(), das_grid::GridErr> { /// if *value == 1 { /// return Err(das_grid::GridErr::RuleFailed); /// } /// Ok(()) /// }; /// /// assert!( /// grid.set_with_rules((0, 1), &1, vec![rule_not_1]) /// .err() /// .unwrap() /// == das_grid::GridErr::RuleFailed /// ); /// ``` pub fn set_with_rules<R>( &mut self, index: (i32, i32), value: &T, rules: Vec<R>, ) -> Result<(), GridErr> where R: Fn((i32, i32), &T) -> Result<(), GridErr>, { for rule in rules.iter() { rule(index, value)?; } self.set(index, value)?; Ok(()) } /// Gets a give value to the position (x, y) as mutable /// /// Be careful if the value is out of the bounds of grid it will return an error /// with the type of GridErr::OutOfGrid /// /// ```.rust /// let mut grid = das_grid::Grid::new(2, 2, 1); /// let mut v = grid.get_mut((0, 0)).expect("cannnot get pos at (0, 0)"); /// *v = 50; /// assert_eq!(grid.get((0, 0)).unwrap_or(&0), &50); /// ``` pub fn get_mut(&mut self, index: (i32, i32)) -> Result<&mut T, GridErr> { let (x, y) = index; self.check_grid_bounds(index)?; Ok(self.cells.get_mut((x * self.rows + y) as usize).unwrap()) } /// Gets a give value to the position (x, y) /// /// Be careful if the value is out of the bounds of grid it will return an error /// with the type of GridErr::OutOfGrid /// /// ```.rust /// let grid = das_grid::Grid::new(2, 2, 1); /// let v = grid.get((0, 0)); /// assert_eq!(v, Ok(&1)); /// ``` pub fn get(&self, index: (i32, i32)) -> Result<&T, GridErr> { let (x, y) = index; self.check_grid_bounds(index)?; Ok(self.cells.get((x * self.rows + y) as usize).unwrap()) } /// Moves a given value from position (x, y) to destiny position (x, y) /// /// Be careful if the value is out of the bounds of grid it will return an error /// with the type of GridErr::OutOfGrid /// /// ```.rust /// let mut grid = das_grid::Grid::new(2, 2, 1); /// assert_eq!(grid.mov((0, 0), (1, 1)), Ok(())); /// ``` pub fn mov(&mut self, index: (i32, i32), dest: (i32, i32)) -> Result<(), GridErr> { self.check_grid_bounds(index)?; self.check_grid_bounds(dest)?; let prev = *self.get_mut(index).unwrap(); self.set(index, &self.initial_value.clone())?; self.set(dest, &prev)?; Ok(()) } /// Moves a given value from position (x, y) to destiny position (x, y) /// Only if no rule return error /// /// Be careful if the value is out of the bounds of grid it will return an error /// with the type of GridErr::OutOfGrid /// /// And if a rule some rule failed it will return GridErr::RuleFailed /// /// ```.rust /// let mut grid = das_grid::Grid::new(2, 2, 0); /// assert!(grid.set((0, 1), &1).is_ok()); /// /// let rule_not_1 = |_: (i32, i32), value: &i32| -> Result<(), das_grid::GridErr> { /// if *value == 1 { /// return Err(das_grid::GridErr::RuleFailed); /// } /// Ok(()) /// }; /// /// assert!( /// grid.mov_with_rules((0, 0), (0, 1), vec![rule_not_1]) /// .err() /// .unwrap() /// == das_grid::GridErr::RuleFailed /// ); /// ``` pub fn mov_with_rules<R>( &mut self, index: (i32, i32), dest: (i32, i32), rules: Vec<R>, ) -> Result<(), GridErr> where R: Fn((i32, i32), &T) -> Result<(), GridErr>, { self.check_grid_bounds(index)?; self.check_grid_bounds(dest)?; let prev = *self.get_mut(index).unwrap(); let destv = self.get(dest)?; for rule in rules { rule(dest, destv)?; } self.set(index, &self.initial_value.clone())?; self.set(dest, &prev)?; Ok(()) } /// Moves a given value from position (x, y) to another position based on the direction /// /// The directions can be Left, Right, Top, Down: /// * DasGrid::MoveDirection::Left, translates to (0, -1) /// * DasGrid::MoveDirection::Right, translates to (0, 1) /// * DasGrid::MoveDirection::Top, translates to (-1, 0) /// * DasGrid::MoveDirection::Down, translates to (1, 0) /// /// Be careful if the value is out of the bounds of grid it will return an error /// with the type of GridErr::OutOfGrid /// /// ```.rust /// let mut grid = das_grid::Grid::new(2, 2, 1); /// assert_eq!(grid.mov_to((0, 0), das_grid::MoveDirection::Right), Ok(())); /// ``` pub fn mov_to(&mut self, index: (i32, i32), direction: MoveDirection) -> Result<(), GridErr> { let (x, y) = index; self.check_grid_bounds(index)?; let (xx, yy) = match direction { MoveDirection::Up => MOVE_UP, MoveDirection::Down => MOVE_DOWN, MoveDirection::Left => MOVE_LEFT, MoveDirection::Right => MOVE_RIGHT, }; let dest = (x + xx, y + yy); self.check_grid_bounds(dest)?; let prev = *self.get_mut(index).unwrap(); self.set(index, &self.initial_value.clone())?; self.set(dest, &prev)?; Ok(()) } /// Moves a given value from position (x, y) to another position based on the direction /// Only if no rule return error /// /// if the dest x, y grid is out of bounds it return error GridErr::OutOfGrid /// /// And if a rule some rule failed it will return GridErr::RuleFailed /// /// The directions can be Left, Right, Top, Down: /// * DasGrid::MoveDirection::Left, translates to (0, -1) /// * DasGrid::MoveDirection::Right, translates to (0, 1) /// * DasGrid::MoveDirection::Top, translates to (-1, 0) /// * DasGrid::MoveDirection::Down, translates to (1, 0) /// /// Be careful if the value is out of the bounds of grid it will return an error /// with the type of GridErr::OutOfGrid /// /// ```.rust /// let mut g = das_grid::Grid::new(2, 2, 0); /// g.set((0, 1), &1); /// let rule_not_1 = |_: (i32, i32), value: &i32| -> Result<(), das_grid::GridErr> { /// if *value == 1 { /// return Err(das_grid::GridErr::RuleFailed); /// } /// Ok(()) /// }; /// let ret = g.mov_to_with_rules((0, 0), das_grid::MoveDirection::Right, vec![rule_not_1]); /// assert!(ret.is_err()); /// ``` pub fn mov_to_with_rules<R>( &mut self, index: (i32, i32), direction: MoveDirection, rules: Vec<R>, ) -> Result<(), GridErr> where R: Fn((i32, i32), &T) -> Result<(), GridErr>, { let (x, y) = index; self.check_grid_bounds(index)?; let (xx, yy) = match direction { MoveDirection::Up => MOVE_UP, MoveDirection::Down => MOVE_DOWN, MoveDirection::Left => MOVE_LEFT, MoveDirection::Right => MOVE_RIGHT, }; let dest = (x + xx, y + yy); self.check_grid_bounds(dest)?; let destv = self.get(dest)?; for rule in rules { rule(dest, destv)?; } let prev = *self.get_mut(index).unwrap(); self.set(index, &self.initial_value.clone())?; self.set(dest, &prev)?; Ok(()) } /// Get the size of grid based on cells length /// /// For instance a 10x10 grid will return the size of 100 /// /// ```.rust /// let mut grid = das_grid::Grid::new(2, 2, 1); /// assert_eq!(grid.size(), 4); /// ``` pub fn size(&self) -> usize { self.cells.len() } /// The rows of the grid /// ```.rust /// let mut grid = das_grid::Grid::new(3, 2, 1); /// assert_eq!(grid.rows(), 3); /// ``` pub fn rows(&self) -> i32 { self.rows } /// The cols of the grid /// ```.rust /// let mut grid = das_grid::Grid::new(3, 2, 1); /// assert_eq!(grid.cols(), 2); /// ``` pub fn cols(&self) -> i32 { self.cols } /// Returns the grid as a tuple of (x, y) /// /// ```.rust /// let mut grid = das_grid::Grid::new(3, 2, 1); /// for (x, y) in grid.enumerate() { /// println!("x {} y {}", x, y); /// } /// ``` pub fn enumerate(&self) -> Vec<(i32, i32)> { let mut x = 0; let mut y = 0; self.cells .iter() .enumerate() .map(|(idx, _)| { if idx as i32 % self.rows() == 0 && idx > 1 { x = 0; y += 1; } let res = (x, y); x += 1; res }) .collect::<Vec<_>>() } /// Returns the type vector with the values from the col /// /// If the col idx is wrong it can return the error GridErr::OutOfGrid /// /// ```.rust /// let mut g = das_grid::Grid::new_from_vector(2, 2, vec![1, 2, 3, 4]); /// let col = g.get_col(1).unwrap(); /// assert_eq!(col, vec![2, 4]); /// ``` pub fn get_col(&self, col_idx: i32) -> Result<Vec<T>, GridErr> { let mut vec_result: Vec<T> = vec![]; for idx in (0..self.cols).into_iter() { let v = self.get((idx, col_idx))?; vec_result.push(*v); } Ok(vec_result) } /// Returns the type vector with the values from the row /// /// If the row idx is wrong it can return the error GridErr::OutOfGrid /// /// ```.rust /// let mut g = das_grid::Grid::new_from_vector(2, 2, vec![1, 2, 3, 4]); /// let row = g.get_row(1).unwrap(); /// assert_eq!(row, vec![3, 4]); /// ``` pub fn get_row(&self, row_idx: i32) -> Result<Vec<T>, GridErr> { let mut vec_result: Vec<T> = vec![]; for idx in (0..self.rows).into_iter() { let v = self.get((row_idx, idx))?; vec_result.push(*v); } Ok(vec_result) } /// Returns a clone of the internal representation of the grid /// /// ```.rust /// let mut g = das_grid::Grid::new_from_vector(2, 2, vec![1, 2, 3, 4]); /// assert_eq!(g.get_flatten_grid(), vec![1,2,3,4]); /// ``` pub fn get_flatten_grid(&self) -> Vec<T> { self.cells.clone() } /// Fill the grid with the given value /// /// ```.rust /// /// ``` pub fn fill_grid(&mut self, value: T) { self.cells.fill(value); } #[allow(dead_code)] pub(crate) fn debug(&self) where T: std::fmt::Display, { println!("{:?}", self) } /// Fills the certain area of the grid with a given value /// /// If the area is greater than the main grid it return an error of GridErr::SubgridOverflow /// /// ```.rust /// let mut grid = das_grid::Grid::new_from_vector(4, 4, (1..=16).collect()); /// grid.fill_subgrid((1, 1), 2, 2, &0); /// assert!(grid.get((1, 1)).unwrap() == &0); /// assert!(grid.get((1, 2)).unwrap() == &0); /// assert!(grid.get((2, 1)).unwrap() == &0); /// assert!(grid.get((2, 2)).unwrap() == &0); /// ``` pub fn fill_subgrid( &mut self, index: (i32, i32), rows: i32, cols: i32, value: &T, ) -> Result<Grid<T>, GridErr> { self.check_grid_bounds(index)?; let sub_grid = Grid::new(rows, cols, self.initial_value); self.check_grid_overflow(&sub_grid)?; for sub_index in sub_grid.enumerate() { let dest = (index.0 + sub_index.0, index.1 + sub_index.1); match self.set(dest, value) { Ok(_) => (), _ => (), } } Ok(sub_grid) } } impl<'a, T: Copy + Clone> IntoIterator for &'a Grid<T> { type Item = &'a T; type IntoIter = std::slice::Iter<'a, T>; fn into_iter(self) -> Self::IntoIter { self.cells.iter() } } impl<'a, T: Copy + Clone> IntoIterator for &'a mut Grid<T> { type Item = &'a mut T; type IntoIter = std::slice::IterMut<'a, T>; fn into_iter(self) -> Self::IntoIter { self.cells.iter_mut() } } impl<T: Copy + Clone> fmt::Display for Grid<T> { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!( f, "Grid {{ rows: {}, cols: {}, cells: [...] }}", self.rows, self.cols ) } } impl<T: Copy + Clone + Display> fmt::Debug for Grid<T> { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { let mut cell_str = String::new(); let mut pos = (0, 0); for (idx, cell) in self.cells.iter().enumerate() { if idx as i32 % self.cols == 0 && idx > 0 { pos.1 = 0; pos.0 += 1; cell_str += "\n"; } cell_str.push_str(&format!("\t{:3} (x: {} y: {})", cell, pos.0, pos.1)); pos.1 += 1 } write!( f, "Grid {{ rows: {}, cols: {}, cells: [\n{}\n] }}", self.rows, self.cols, cell_str, ) } } impl<T: Copy + Clone> Index<(i32, i32)> for Grid<T> { type Output = T; fn index(&self, index: (i32, i32)) -> &T { self.get(index).unwrap() } } impl<T: Copy + Clone> IndexMut<(i32, i32)> for Grid<T> { fn index_mut(&mut self, index: (i32, i32)) -> &mut T { self.get_mut(index).unwrap() } } #[cfg(test)] mod lib_test;