Struct NearestNeighbours 

pub struct NearestNeighbours { /* private fields */ }

Implementations

impl NearestNeighbours

pub fn new(metric: String) -> Result<NearestNeighbours>

Create a new, empty NearestNeighbours struct

use nn_rs::NearestNeighbours;

let metric = String::from("cosine");
let mut index = NearestNeighbours::new(metric);

Parameters

• metric: distance metric to use. One of “cosine”, “euclidean” or “manhattan”

Return Values

• NearestNeighbours struct

pub fn from_json( metric: String, vectors_file: PathBuf, ) -> Result<NearestNeighbours>

Create a new NearestNeighbours struct from a json

This constructor should be useful for loading vectors from python matrix libraries such as torch, tensorflow, jax, numpy etc.

Parameters

• metric: distance metric. One of “cosine”, “euclidean” or “manhattan”
• vector_file: a json of {“id_1”: [1.0, 2.0, … ], “id_2”: [1.0, 2.0, … ], … } format

Return Values

• NearestNeighbours struct

Example json format

{
    "id_1": [1.0, 2.0, ... ],
    "id_2": [1.0, 2.0, ... ],
    .
    .
    .
    "id_n": [1.0, 2.0, ... ],
}

pub fn load(nn_file: PathBuf) -> Result<NearestNeighbours>

Load a NearestNeighbours struct from a .nn file

Parameters

• nn_file: .nn file to load

Return Values

• NearestNeighbours struct

pub fn add_vector(&mut self, id: String, vector: DVector<f64>) -> Result<()>

Add a new vector to the NearestNeighbour struct

Note: the id should be unique. If it isn’t, only the vector associated with the id that was most recently added will be kept

Parameters

• id: the id of the vector, this can be any string but it must be unique
• vector: the vector to add

Return Values

• nothing

pub fn save(&mut self, output_path: PathBuf) -> Result<()>

Save the NearestNeighbour struct to a .nn file

Parameters

• output_path: path to save the struct to

Return Values

• nothing

pub fn query_by_vector( &mut self, query_vector: DVector<f64>, no_neighbours: usize, ) -> Result<Vec<String>>

Find the nearest neighbour for a query vector

Parameters

• query_vector: vector to find the nearest neighbour to
• no_neighbours: the number of nearest neighbours to find

Return Values

• ids of the nearest neighbours

Trait Implementations

impl Clone for NearestNeighbours

fn clone(&self) -> NearestNeighbours

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NearestNeighbours

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NearestNeighbours

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for NearestNeighbours

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

where __S: Serializer,

Serialize this value into the given Serde serializer.