Struct BinaryDenseVectorConfig 

pub struct BinaryDenseVectorConfig {
    pub dim: usize,
    pub index_type: BinaryIndexType,
    pub num_clusters: Option<usize>,
    pub nprobe: usize,
    pub build_threshold: Option<usize>,
}

Configuration for binary dense vector fields

Binary dense vectors store packed bits (1 bit per dimension) and use Hamming distance for scoring. Always uses brute-force flat search (Hamming popcount is ~10ns/vec for 768-bit, ANN indexes don’t help).

Fields

dim: usize

Number of bits (dimensions). Storage is ceil(dim/8) bytes per vector.

index_type: BinaryIndexType

ANN index type: Flat (brute-force SIMD Hamming, default) or Ivf (k-majority Hamming clusters — probe nprobe clusters at query time). IVF pays off for segments past a few million vectors.

num_clusters: Option<usize>

Number of IVF clusters (default: sqrt(n) capped at 4096)

nprobe: usize

Clusters to probe during search (default: 32)

build_threshold: Option<usize>

Minimum vectors before building the IVF index (default: 100_000 — below that brute-force SIMD Hamming is faster than probing).

Implementations

impl BinaryDenseVectorConfig

pub fn new(dim: usize) -> Self

pub fn with_ivf(self, num_clusters: Option<usize>, nprobe: usize) -> Self

Enable the IVF index (builder pattern)

pub fn with_build_threshold(self, threshold: usize) -> Self

Set the build threshold (builder pattern)

pub fn default_build_threshold(&self) -> usize

Default build threshold: brute-force wins below ~100K vectors.

pub fn optimal_num_clusters(&self, num_vectors: usize) -> usize

Optimal cluster count for a given vector count (sqrt(n), capped)

pub fn byte_len(&self) -> usize

Number of bytes needed to store one vector

Trait Implementations

impl Clone for BinaryDenseVectorConfig

fn clone(&self) -> BinaryDenseVectorConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinaryDenseVectorConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BinaryDenseVectorConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BinaryDenseVectorConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.