Struct smartcore::algorithm::neighbour::linear_search::LinearKNNSearch

pub struct LinearKNNSearch<T, F: RealNumber, D: Distance<T, F>> { /* fields omitted */ }

Implements Linear Search algorithm, see KNN algorithms

Implementations

impl<T, F: RealNumber, D: Distance<T, F>> LinearKNNSearch<T, F, D>

pub fn new(
    data: Vec<T>,
    distance: D
) -> Result<LinearKNNSearch<T, F, D>, Failed>

Initializes algorithm.

• data - vector of data points to search for.
• distance - distance metric to use for searching. This function should extend Distance interface.

pub fn find(&self, from: &T, k: usize) -> Result<Vec<(usize, F, &T)>, Failed>

Find k nearest neighbors

• from - look for k nearest points to from
• k - the number of nearest neighbors to return

pub fn find_radius(
    &self,
    from: &T,
    radius: F
) -> Result<Vec<(usize, F, &T)>, Failed>

Find all nearest neighbors within radius radius from p

• p - look for k nearest points to p
• radius - radius of the search

Trait Implementations

impl<T: Debug, F: Debug + RealNumber, D: Debug + Distance<T, F>> Debug for LinearKNNSearch<T, F, D>

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

Formats the value using the given formatter.

impl<'de, T, F: RealNumber, D: Distance<T, F>> Deserialize<'de> for LinearKNNSearch<T, F, D> where
    T: Deserialize<'de>,
    D: Deserialize<'de>, 

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T, F: RealNumber, D: Distance<T, F>> Serialize for LinearKNNSearch<T, F, D> where
    T: Serialize,
    D: Serialize, 

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.