Struct goko::CoverTreeBuilder

pub struct CoverTreeBuilder {
    pub scale_base: f32,
    pub leaf_cutoff: usize,
    pub min_res_index: i32,
    pub use_singletons: bool,
    pub verbosity: u32,
}

A construction object for a covertree.

Fields

scale_base: f32

See paper or main description, governs the number of children of each node. Higher is more.

leaf_cutoff: usize

If a node covers less than or equal to this number of points, it becomes a leaf.

min_res_index: i32

If a node has scale index less than or equal to this, it becomes a leaf

use_singletons: bool

If you don't want singletons messing with your tree and want everything to be a node or a element of leaf node, make this true.

verbosity: u32

Printing verbosity. 2 is the default and gives a progress bar. Still not fully pulled thru the codebase. This should be replaced by a logging solution

Implementations

impl CoverTreeBuilder

pub fn new() -> CoverTreeBuilder

Creates a new builder with sensible defaults.

pub fn from_yaml<P: AsRef<Path>>(path: P) -> Self

Creates a builder from an open yaml object

pub fn set_scale_base(&mut self, x: f32) -> &mut Self

pub fn set_leaf_cutoff(&mut self, x: usize) -> &mut Self

pub fn set_min_res_index(&mut self, x: i32) -> &mut Self

pub fn set_use_singletons(&mut self, x: bool) -> &mut Self

pub fn set_verbosity(&mut self, x: u32) -> &mut Self

pub fn build<D: PointCloud>(
    &self,
    point_cloud: Arc<D>
) -> GokoResult<CoverTreeWriter<D>>

Pass a point cloud object when ready. To do, make this point cloud an Arc

Trait Implementations

impl Debug for CoverTreeBuilder

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

Formats the value using the given formatter.

impl Default for CoverTreeBuilder

fn default() -> CoverTreeBuilder

Returns the "default value" for a type.