Struct SQuaJLConfig 

pub struct SQuaJLConfig {
    pub input_dim: usize,
    pub sketch_dim: usize,
    pub bits: u8,
    pub hashes_per_input: u8,
    pub clip: f32,
    pub seed: u64,
    pub metric: SimilarityMetric,
    pub norm_log2_min: f32,
    pub norm_log2_max: f32,
}

Configuration for the stateless sparse-JL quantizer.

The defaults are chosen to be a practical starting point for 384-dimensional sentence embeddings such as all-MiniLM-L6-v2.

Fields

input_dim: usize

Input embedding dimension.

sketch_dim: usize

Output sketch dimension.

Larger values usually improve recall at the cost of more memory.

bits: u8

Number of bits per quantized coordinate.

Supported range: 1..=8.

hashes_per_input: u8

Number of non-zero sketch updates per input coordinate.

Larger values reduce projection noise but cost more CPU at encode time.

clip: f32

Symmetric clip range for the scaled sketch.

Coordinates are clipped to [-clip, clip] before scalar quantization.

seed: u64

Global seed used to derive sparse bucket locations and signs.

metric: SimilarityMetric

Similarity objective for scoring.

norm_log2_min: f32

Lower bound for log2(norm) when the norm channel is enabled.

norm_log2_max: f32

Upper bound for log2(norm) when the norm channel is enabled.

Implementations

impl SQuaJLConfig

pub fn new(input_dim: usize) -> Self

Creates a configuration with the provided input dimension and sensible defaults for the remaining fields.

pub fn with_sketch_dim(self, sketch_dim: usize) -> Self

Sets the output sketch dimension.

pub fn with_bits(self, bits: u8) -> Self

Sets the number of bits per quantized coordinate.

pub fn with_hashes_per_input(self, hashes_per_input: u8) -> Self

Sets the number of sparse hash updates performed for each input dimension.

pub fn with_clip(self, clip: f32) -> Self

Sets the symmetric clip range used by the scalar quantizer.

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

Sets the deterministic seed used by the sparse signed projection.

pub fn with_metric(self, metric: SimilarityMetric) -> Self

Sets the similarity objective.

pub fn with_norm_log2_range(self, min: f32, max: f32) -> Self

Sets the log2(norm) range for the optional norm channel.

pub fn validate(&self) -> Result<()>

Validates the configuration.

Trait Implementations

impl Clone for SQuaJLConfig

fn clone(&self) -> SQuaJLConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SQuaJLConfig

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

Formats the value using the given formatter.

impl Default for SQuaJLConfig

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for SQuaJLConfig

fn eq(&self, other: &SQuaJLConfig) -> 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 SQuaJLConfig