frlearn_neighbor 0.1.0

Neighbour search abstractions and brute-force backend for FuzzyRough.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

//! Neighbour-index abstractions and distance computation backends.
#![cfg_attr(doc, warn(missing_docs))]
#![warn(rust_2018_idioms)]
#![warn(clippy::all)]

pub mod bruteforce;
pub mod distance;

use frlearn_core::{FrError, FrResult, Matrix};
use ndarray::Array2;

pub use bruteforce::BruteForceIndex;
pub use distance::{Metric, pairwise_distance};

pub trait NeighborIndex {
    fn query(&self, xq: &Matrix, k: usize) -> FrResult<(Array2<usize>, Matrix)>;
}

fn validate_query_features(x_train: &Matrix, xq: &Matrix) -> FrResult<()> {
    if xq.ncols() != x_train.ncols() {
        return Err(FrError::InvalidInput(format!(
            "query feature mismatch: expected {}, found {}",
            x_train.ncols(),
            xq.ncols()
        )));
    }

    Ok(())
}