Struct PointCloud

pub struct PointCloud<'a, T> { /* private fields */ }

The core datastructure of the package. Stores the points and the distance function.

Implementations

impl<'a, T> PointCloud<'a, T>

pub fn new(dist_fn: fn(&T, &T) -> f64) -> Self

Constructs a new PointCloud<T>.

It accepts a function to compute distance between any 2 objects.

Examples

extern crate knn;
use knn::PointCloud;
let manhattan_dist = |p: &[f64;2], q: &[f64;2]| -> f64 {(p[0] - q[0]).abs() + (p[1] - q[1]).abs()};
let pc = PointCloud::new(manhattan_dist);

pub fn add_point(&mut self, p: &'a T)

Adds a point to the PointCloud.

It accepts a reference to an object.

Examples

extern crate knn;
use knn::PointCloud;
let dummy_dist = |p: &[f64;2], q: &[f64;2]| -> f64 {0.0};
let mut pc = PointCloud::new(dummy_dist);
let p = [1.89, 5.63];
pc.add_point(&p);

pub fn get_nearest_k(&self, p: &T, k: usize) -> Vec<(f64, &T)>

Gets the k nearest neighbours of an object.

It accepts a reference to the object and how many neighbours to return.

Example

extern crate knn;
use knn::PointCloud;
let manhattan_dist = |p: &[f64;2], q: &[f64;2]| -> f64 {(p[0] - q[0]).abs() + (p[1] - q[1]).abs()};
let mut pc = PointCloud::new(manhattan_dist);
let points = vec![[1.0, 1.0], [2.0, 2.0], [3.0, 2.0]];
for p in &points {
    pc.add_point(&p);
}
let q = [0.5, 0.5];
pc.get_nearest_k(&q, 2);

pub fn len(&self) -> usize

Get the len / number of objects in PointCloud Example:

extern crate knn;
use knn::PointCloud;
let manhattan_dist = |p: &[f64;2], q: &[f64;2]| -> f64 {(p[0] - q[0]).abs() + (p[1] - q[1]).abs()};
let mut pc = PointCloud::new(manhattan_dist);
let points = vec![[1.0, 1.0], [2.0, 2.0], [3.0, 2.0]];
for p in &points {
    pc.add_point(&p);
}
pc.len();

Trait Implementations

impl<'a, T: Clone> Clone for PointCloud<'a, T>

fn clone(&self) -> PointCloud<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.