Enum IndexStructure 

pub enum IndexStructure {
    Flat,
    IvfFlat {
        n_clusters: usize,
    },
    PQ {
        m: usize,
        bits: u8,
    },
    HnswLike {
        m: usize,
        ef: usize,
    },
    Lsh {
        n_tables: usize,
        n_bits: u8,
    },
    Tree {
        max_leaf: usize,
    },
}

Supported index structures for approximate nearest-neighbour search.

Variants

Flat

Brute-force exact search — O(n·d) per query.

IvfFlat

Inverted File Index with flat scan inside each cluster.

Fields

n_clusters: usize

Number of Voronoi cells.

PQ

Product Quantization — lossy compression with sub-space codebooks.

Fields

m: usize

Number of sub-spaces.

bits: u8

Bits per sub-space.

HnswLike

HNSW-inspired hierarchical navigable small-world graph.

Fields

m: usize

Max connections per node.

ef: usize

Candidate list size during search.

Lsh

Locality Sensitive Hashing with multiple hash tables.

Fields

n_tables: usize

Number of hash tables.

n_bits: u8

Bits per table projection.

Tree

KD-tree / ball-tree style partition with bounded leaf size.

Fields

max_leaf: usize

Maximum number of vectors in a leaf node.

Implementations

impl IndexStructure

pub fn name(&self) -> &'static str

Human-readable name for this structure.

Trait Implementations

impl Clone for IndexStructure

fn clone(&self) -> IndexStructure

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexStructure

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

Formats the value using the given formatter.

impl PartialEq for IndexStructure

fn eq(&self, other: &IndexStructure) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for IndexStructure