paraxis 0.10.1

A simple to use spatial datastructure crate.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

use crate::common::{errors::ParaxisError, structs::Node};

/*
* P -> Position
* D -> Data
* */

pub trait Grid<P, D> {
    fn new(size: &P) -> Result<Self, ParaxisError>
    where
        Self: Sized;
    fn insert(&mut self, data: D, position: &P) -> Result<(), ParaxisError>;
    fn remove(&mut self, position: &P) -> Result<Node<P, D>, ParaxisError>;
    fn get(&self, position: &P) -> Result<&Node<P, D>, ParaxisError>;
    fn get_mut(&mut self, position: &P) -> Result<&mut Node<P, D>, ParaxisError>;
    fn in_grid_bounds(&self, position: &P) -> bool;
}

pub trait Tree<P, D> {
    fn new(raw_data: Vec<(P, D)>) -> Self;
    fn add(&mut self, position: &P, data: D);
    fn rebalance(&mut self);
    fn k_nearest_neighbours(
        &self,
        position: &P,
        k: usize,
    ) -> Result<Vec<&Node<P, D>>, ParaxisError>;
}