andrey/kdtree-rust
1
0
Fork 0
mirror of https://github.com/andreytkachenko/kdtree-rust.git synced 2024-11-25 02:46:22 +04:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
fulara 2016-12-29 01:38:17 +01:00 committed by GitHub
parent 450f20b109
commit 70b69392ce
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -6,7 +6,7 @@ Implementation uses sliding midpoint variation of the tree. [More Info here](htt
###Usage ###Usage
Tree can only be used with types implementing trait: Tree can only be used with types implementing trait:
``` ```
pub trait KdtreePointTrait : Clone { pub trait KdtreePointTrait : Copy {
fn dims(&self) -> &[f64]; fn dims(&self) -> &[f64];
} }
``` ```
@ -26,6 +26,17 @@ impl KdtreePointTrait for Point3WithId {
} }
``` ```
Where id is just a example of the way in which I carry the data. Where id is just a example of the way in which I carry the data.
With that trait implemented you are good to go to use the tree. Keep in mind that the kdtree is not a self balancing tree, so it should not support continous add. right now the tree just handles the build up from Vec. Basic usage can be found in the integration test, fragment copied below:
```
let tree = kdtree::kdtree::Kdtree::new(&mut points.clone());
//test points pushed into the tree, id should be equal.
for i in 0 .. point_count {
let p = &points[i];
assert_eq!(p.id, tree.nearest_search(p).id );
}
```
##Benchmark ##Benchmark