toodee

TooDee is a lightweight and high performance two-dimensional wrapper around a Vec.

Core features

Raw access to the underlying vector's slice via data() and data_mut().
Creation of performant two-dimensional subsets using view() and view_mut().
Get/set specific cells using indexing, e.g., toodee[row][col] = val.
Index with a Coordinate if you prefer, e.g., toodee[(col, row)] = val.
Index by row index (i.e., row major) to access row slices, e.g., &toodee[row].
Iteration, any which way - rows(), rows_mut(), col(), col_mut(), cells(), cells_mut().
#[no_std] compliant.
Can create a new TooDeeView from a &[T], or a TooDeeViewMut from a &mut [T].
insert_col(), remove_col(), insert_row(), and remove_row() implementations with good performance.

Extras

The TranslateOps trait provides translate_with_wrap() (efficient vertical and/or horizontal scrolling), flip_rows(), and flip_cols() operations.
The SortOps trait provides sort_by_row(), sort_by_col() and other related operations.

TODO

More documentation, with examples.
tiles(..) and tiles_mut()?
Pathfinding algorithms?

Motivation

Similar libraries do exist, but they lacked either performance, flexibility, or functionality.

Here's a small feature comparison chart:

	Storage order	Structs supported	Growable?	Mutable views?	Raw data access?	Iterate over row slices?	Safe/checked access?	Notes
`toodee::TooDee`	Row-major	Anything	Yes	Yes	Yes	Yes	No
`image::ImageBuffer`	Row-major	`image::Pixel`	No	No	Yes	No	No	Good for image processing - see the `imageproc` crate.
`image::SubImage`	Row-major	`image::Pixel`	No	Yes	No	No	No
`grid::Grid`	Row-major	`Clone`	Yes	No	Yes	No	Yes	Similar to `TooDee`, but not as functionally rich.
`array2d::Array2D`	Row-major	`Clone`	No	No	No	No	Yes
`imgref::Img`	Row-major	Anything	No	Yes	Yes	No	No
`nalgebra::Matrix`	Column-major	`Scalar`	Yes	Yes	Yes	No	No	Use this for vector/matrix math.

Goals

High performance and good flexibility, with the constraint of using a 1-D vector.
Suitable for use in image processing, but not restricted to this problem domain.
Provide solid implementations of non-trivial 2D operations.

Non-goals

GPU integration

Limitations

Views are not nested for the time being, The only impact is that the bounds() of a view are always relative to the underlying TooDee array.

License

Licensed under either of

Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.