djkato/grid
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

#17 Doc grid size limit

Browse source
This commit is contained in:
becheran 2022-08-16 09:15:43 +02:00
parent 4aa88f4a65
commit d3942d37ff
1 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/lib.rs
View file

@ -116,6 +116,8 @@ macro_rules! grid {
/// ///
/// Uses a rust `Vec<T>` type to reference the grid data on the heap. /// Uses a rust `Vec<T>` type to reference the grid data on the heap.
/// Also the number of rows and columns are stored in the grid data structure. /// Also the number of rows and columns are stored in the grid data structure.
///
/// The size limit of a grid is `rows * cols < usize`.
/// ///
/// The grid data is stored in a row-major memory layout. /// The grid data is stored in a row-major memory layout.
pub struct Grid<T> { pub struct Grid<T> {