Struct RTreed 

pub struct RTreed<K, V: RTreeObject, C> { /* private fields */ }

Implementations

impl<K, V: RTreeObject, C> RTreed<K, V, C>

pub fn new(collection: C) -> Self

Examples found in repository

examples/basic_usage.rs (lines 15-17)

fn main() {
    // A hashmap of 2D rectangles will be the underlying collection.
    let rect_hashmap: HashMap<i32, Rectangle<(i32, i32)>> = HashMap::new();

    // Wrap `RTreed` around the hashmap.
    let mut rtreed = RTreed::<i32, Rectangle<(i32, i32)>, HashMap<i32, Rectangle<(i32, i32)>>>::new(
        rect_hashmap,
    );

    // Insert two rectangles, recording them in the R-tree.
    rtreed.insert(1, Rectangle::from_corners((0, 0), (1, 1)));
    rtreed.insert(2, Rectangle::from_corners((1, 1), (2, 2)));

    // Locate the two rectangles in the R-tree.
    assert_eq!(
        rtreed
            .rtree()
            .locate_in_envelope(&AABB::from_corners((0, 0), (2, 2)))
            .count(),
        2
    );

    // Now remove one of the rectangles, recording this in the R-tree.
    rtreed.remove(&1);

    // Make the same query to the R-tree as before.
    // Only one rectangle is now present.
    assert_eq!(
        rtreed
            .rtree()
            .locate_in_envelope(&AABB::from_corners((0, 0), (2, 2)))
            .count(),
        1
    );
}

impl<K, V: RTreeObject, C> RTreed<K, V, C>

pub fn collection(&self) -> &C

pub fn rtree(&self) -> &RTree<GeomWithData<V, K>>

Examples found in repository

examples/basic_usage.rs (line 26)

fn main() {
    // A hashmap of 2D rectangles will be the underlying collection.
    let rect_hashmap: HashMap<i32, Rectangle<(i32, i32)>> = HashMap::new();

    // Wrap `RTreed` around the hashmap.
    let mut rtreed = RTreed::<i32, Rectangle<(i32, i32)>, HashMap<i32, Rectangle<(i32, i32)>>>::new(
        rect_hashmap,
    );

    // Insert two rectangles, recording them in the R-tree.
    rtreed.insert(1, Rectangle::from_corners((0, 0), (1, 1)));
    rtreed.insert(2, Rectangle::from_corners((1, 1), (2, 2)));

    // Locate the two rectangles in the R-tree.
    assert_eq!(
        rtreed
            .rtree()
            .locate_in_envelope(&AABB::from_corners((0, 0), (2, 2)))
            .count(),
        2
    );

    // Now remove one of the rectangles, recording this in the R-tree.
    rtreed.remove(&1);

    // Make the same query to the R-tree as before.
    // Only one rectangle is now present.
    assert_eq!(
        rtreed
            .rtree()
            .locate_in_envelope(&AABB::from_corners((0, 0), (2, 2)))
            .count(),
        1
    );
}

Trait Implementations

impl<K: Clone, V: Clone + RTreeObject, C: Clone> Clone for RTreed<K, V, C>

fn clone(&self) -> RTreed<K, V, C>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<K: Debug, V: Debug + RTreeObject, C: Debug> Debug for RTreed<K, V, C>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<K, V: RTreeObject, C: Default> Default for RTreed<K, V, C>

fn default() -> Self

Returns the “default value” for a type.

impl<K, V: RTreeObject, C: Get<K, Item = V>> Get<K> for RTreed<K, V, C>

fn get(&self, key: &K) -> Option<&V>

Returns a reference to the value corresponding to the key.

impl<K: Clone, V: Clone + RTreeObject, C: Get<K, Item = V> + Insert<K>> Insert<K> for RTreed<K, V, C>

fn insert(&mut self, key: K, value: V)

Insert a key-value pair into the collection.

impl<K, V: RTreeObject, C: IntoIter<K, Item = V>> IntoIter<K> for RTreed<K, V, C>

type IntoIter = <C as IntoIter<K>>::IntoIter

Iterator that consumes the collection.

fn into_iter(self) -> C::IntoIter

Consume the collection and yield owned key-value pairs.

impl<K, V: RTreeObject, C> Keyed for RTreed<K, V, C>

type Key = K

impl<K, V: RTreeObject, C> Map for RTreed<K, V, C>

type Item = V

impl<K: Clone, V: Clone + RTreeObject, C: Push<K, Item = V>> Push<K> for RTreed<K, V, C>

fn push(&mut self, value: V) -> K

Insert a value into the collection without specifying a key, returning the key that was automatically generated.

impl<K: Clone + PartialEq, V: Clone + PartialEq + RTreeObject, C: Remove<K, Item = V>> Remove<K> for RTreed<K, V, C>

fn remove(&mut self, key: &K) -> Option<V>

Remove a key from the collection, returning the value at the key if the key was previously in the map.