Struct instant_distance::Builder

pub struct Builder { /* fields omitted */ }

Parameters for building the Hnsw

Implementations

impl Builder

pub fn ef_construction(self, ef_construction: usize) -> Self

Set the efConstruction parameter from the paper

pub fn ef_search(self, ef: usize) -> Self

Set the ef parameter from the paper

If the efConstruction parameter is not already set, it will be set to the same value as ef by default.

pub fn select_heuristic(self, params: Option<Heuristic>) -> Self

pub fn ml(self, ml: f32) -> Self

Set the mL parameter from the paper

If the mL parameter is not already set, it defaults to 1.0 / ln(M).

pub fn seed(self, seed: u64) -> Self

Set the seed value for the random number generator used to generate a layer for each point

If this value is left unset, a seed is generated from entropy (via getrandom()).

pub fn build<P: Point, V: Clone>(
    self,
    points: Vec<P>,
    values: Vec<V>
) -> HnswMap<P, V>

Build an HnswMap with the given sets of points and values

pub fn build_hnsw<P: Point>(self, points: Vec<P>) -> (Hnsw<P>, Vec<PointId>)

Build the Hnsw with the given set of points

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.