grid-math 0.1.0

This crate contains the Cell type, representing basic unit of Grid, the Grid type, representing two-dimentional field of Cells, the Cells type, representing iterator over every Cell on the Grid, and the Rows and Columns types, representing iterators over subgrids of Grid One of the best usecases of this crate is for developing CLI based games: Cell has two fields representing position on the Grid, which are both u8, and the Grid consists of the start and the end Cells, making the largest possible Grid to be 255x255, which is enough for most terminal games.

use grid_math::{Cell, Grid};

let grid = Grid::new(5, 5);
let grid_string = grid
    .rows()
    .map(|row| {
        row.cells().map(|_| " [#]")
            .chain(std::iter::once("\n\n"))
            .collect::<String>()
    })
    .collect::<String>();

assert_eq!(grid_string,
" \
 [#] [#] [#] [#] [#]

 [#] [#] [#] [#] [#]

 [#] [#] [#] [#] [#]

 [#] [#] [#] [#] [#]

 [#] [#] [#] [#] [#]

 "
);

This will create, and print out new Grid, which has start at (0, 0) and end at (0, 0).

Note:
`Grid` has two axis: `width`, and `depth`.When creating `Grid`, `width` and `depth` arguments represent it's length,
but when accessing member (`Cell`) of `Grid`, `width` and `depth` arguments represent relative position (index) of `Cell` on the `Grid`.

Grid's structure has 2 fields: start: Cell, and end: Cell. Here is a simple diagram, showing 5x5 Grid structure:

Grid's start is (0, 0), and end is (4, 4), but an actual value of width is 5, and depth is also 5:

To perform some actual operations on some Cells, relative to the Grid, we can do this:

use grid_math::{Cell, Grid};

let grid = Grid::new(5, 5);
let start = grid.start();
let next = start.saturating_right(grid, 1).wrapping_down(grid, 8);

assert!(next.within(grid));
assert_eq!(next, Cell::new(1, 3));

Here is a simple diagram, showing position of next cell with color yellow:

For more examples, visit grid-math documentation on crates.io, Crab Crab! 🦀🦀