Struct IvfPqParams 

pub struct IvfPqParams {
    pub n_cells: usize,
    pub pq_m: usize,
    pub pq_k: usize,
    pub nprobe: usize,
    pub metric: DistanceMetric,
}

IVF-PQ index configuration.

Fields

n_cells: usize

Number of Voronoi cells (partitions). Typical: sqrt(N).

pq_m: usize

Number of PQ subvectors. Must divide dimension evenly.

pq_k: usize

Centroids per PQ subvector (at most 256 for u8 codes).

nprobe: usize

Number of cells to probe at query time. Higher = better recall.

metric: DistanceMetric

Distance metric.

Implementations

impl IvfPqParams

pub fn training_threshold(&self) -> usize

Vectors an index needs before it can train: one per coarse cell and one per PQ centroid, since both k-means runs need at least k points.

Trait Implementations

impl Clone for IvfPqParams

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IvfPqParams

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

Formats the value using the given formatter.

impl Default for IvfPqParams

fn default() -> Self

Returns the “default value” for a type.

impl<'__msgpack_de> FromMessagePack<'__msgpack_de> for IvfPqParams

fn read<R: Read<'__msgpack_de>>(reader: &mut R) -> Result<Self, Error>

where Self: Sized,

Reads the MessagePack representation of this value from the provided reader.

impl ToMessagePack for IvfPqParams

fn write<W: Write>(&self, writer: &mut W) -> Result<(), Error>

Writes the MessagePack representation of this value into the provided writer.

fn size_hint(&self) -> Option<TrustedSizeHint>

Returns a trusted upper bound for the number of bytes written by the next call to Self::write, or None when it cannot be determined cheaply.

fn max_size() -> Option<TrustedSizeHint>

Returns a trusted upper bound valid for every value of this type.

fn write_slice<W>(values: &[Self], writer: &mut W) -> Result<(), Error>

where W: Write, Self: Sized,

Writes the MessagePack representation of a slice of values into the provided writer.