Enum Algorithm 

#[non_exhaustive]
pub enum Algorithm {
    Auto,
    BruteForce,
    KDTree,
}

Algorithm used for nearest-neighbor search.

Example

use scry_learn::neighbors::{KnnClassifier, Algorithm};

let knn = KnnClassifier::new()
    .k(5)
    .algorithm(Algorithm::KDTree);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Auto

Automatically choose the best algorithm based on data and metric.

Uses KD-tree for Euclidean distance with < 20 features, brute-force otherwise.

BruteForce

Brute-force O(n) search. Works with all distance metrics.

KDTree

KD-tree O(log n) average-case search. Euclidean distance only.

Falls back to brute-force if a non-Euclidean metric is selected.

Trait Implementations

impl Clone for Algorithm

fn clone(&self) -> Algorithm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Algorithm

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

Formats the value using the given formatter.

impl Default for Algorithm

fn default() -> Algorithm

Returns the “default value” for a type.

impl Copy for Algorithm