Struct BinaryScannModel 

pub struct BinaryScannModel { /* private fields */ }

Index-generation-scoped packed Hamming routing model.

Implementations

impl BinaryScannModel

pub fn to_artifact( &self, generation: u64, trained_vectors: u64, ) -> ScannResult<ScannTrainedArtifact>

pub fn from_artifact(artifact: &ScannTrainedArtifact) -> ScannResult<Self>

pub fn train( training: &BinaryScannTraining, codes: &[u8], num_vectors: usize, index_label: &str, ) -> ScannResult<Self>

pub fn train_with_stats( training: &BinaryScannTraining, codes: &[u8], num_vectors: usize, index_label: &str, ) -> ScannResult<(Self, BinaryScannTrainingStats)>

pub fn dim_bits(&self) -> u32

pub fn num_leaves(&self) -> u32

pub fn fingerprint(&self) -> u64

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

pub fn probe( &self, query: &[u8], nprobe: usize, beam_width: usize, scratch: &mut BinaryScannSearchScratch, ) -> ScannResult<BinaryScannProbePlan>

Route once against the global tree. The resulting plan can be reused across every immutable segment in the active generation.

pub fn assign( &self, code: &[u8], scratch: &mut BinaryScannSearchScratch, ) -> ScannResult<u32>

pub fn spill_assignment( &self, code: &[u8], scratch: &mut BinaryScannSearchScratch, ) -> ScannResult<BinaryScannSpillAssignment>

Choose the normal primary leaf and the best alternate leaf reachable by a small widened tree probe. Packed bits do not have a meaningful float residual projection, so binary spilling uses exact centroid Hamming distance while retaining SOAR’s one-secondary storage policy.

pub fn search_segments( &self, query: &[u8], k: usize, nprobe: usize, beam_width: usize, segments: &[(&BinaryScannSegment, u32)], scratch: &mut BinaryScannSearchScratch, ) -> ScannResult<Vec<BinaryScannHit>>

Search any number of compatible segments with one shared routing plan. doc_base rebases segment-local IDs without touching their payload.

Trait Implementations

impl Clone for BinaryScannModel

fn clone(&self) -> BinaryScannModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinaryScannModel

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

Formats the value using the given formatter.