[][src]Struct goko::CoverTreeParameters

pub struct CoverTreeParameters<D: PointCloud> {
    pub total_nodes: AtomicUsize,
    pub scale_base: f32,
    pub leaf_cutoff: usize,
    pub min_res_index: i32,
    pub use_singletons: bool,
    pub partition_type: PartitionType,
    pub point_cloud: Arc<D>,
    pub verbosity: u32,
    pub rng_seed: Option<u64>,
    pub plugins: RwLock<TypeMap>,
}

Container for the parameters governing the construction of the covertree

Fields

total_nodes: AtomicUsize

An atomic that tracks all nodes as they are created across all threads. This may not reflect what your current reader can see.

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.

partition_type: PartitionType

The partition type of the tree

point_cloud: Arc<D>

The point cloud this tree references

verbosity: u32

This should be replaced by a logging solution

rng_seed: Option<u64>

The seed to use for deterministic trees. This is xor-ed with the point index to create a seed for rand::rngs::SmallRng.

Pass in None if you want to use the host os's entropy instead.

plugins: RwLock<TypeMap>

This is where the base plugins are are stored.

Implementations

impl<D: PointCloud> CoverTreeParameters<D>[src]

pub fn internal_index(&self, scale_index: i32) -> usize[src]

Gets the index of the layer in the vector.

Trait Implementations

impl<D: Debug + PointCloud> Debug for CoverTreeParameters<D>[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T, U> Cast<U> for T where
    U: FromCast<T>, 

impl<T> From<T> for T[src]

impl<T> FromCast<T> for T

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Pointable for T

type Init = T

The type for initializers.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>, 

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,