Adding `beach_map` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add beach_map

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

beach_map = "0.3.1"

The beach_map library will be automatically available globally. Read the beach_map library documentation.

Back to the crate overview.

Readme

BeachMap

A BeachMap is a SlotMap, a data structure used to store elements and access them with an id.

Example:

use beach_map::BeachMap;

let mut beach = BeachMap::new();
let id1 = beach.insert(1);
let id2 = beach.insert(2);

assert_eq!(beach.len(), 2);
assert_eq!(beach[id1], 1);

assert_eq!(beach.remove(id2), Some(2));
assert_eq!(beach.get(id2), None);
assert_eq!(beach.len(), 1);

beach[id1] = 7;
assert_eq!(beach[id1], 7);

beach.extend(0..4);

assert_eq!(beach.data(), [7, 1, 2, 3]);

Rayon

To use rayon with beach_map, you need rayon in your dependencies and add the parallel feature to beach_map.

Example:

use beach_map::BeachMap;
use rayon::prelude::*;

let mut beach = BeachMap::new();
let ids = beach.extend(0..500);

beach.par_iter_mut().for_each(|x| {
    *x *= 2;
});

for i in 0..ids.len() {
    assert_eq!(beach[ids[i]], i * 2);
}

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.

Adding beach_map library as a dependency

Adding `beach_map` library as a dependency