sochdb-vector 2.0.8

Streaming elimination vector search engine for SochDB - CPU-first ANN with RDF + BPS
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
//! Query engine implementation.

use std::collections::HashSet;
use std::sync::Arc;
use std::time::Instant;

use crate::config::EngineConfig;
use crate::error::{Error, Result};
use crate::filter::BitsetFilter;
use crate::rotation::Rotator;
use crate::segment::Segment;
use crate::segment::bps::{BpsBuilder, BpsScanner};
use crate::segment::rdf::RdfScorer;
use crate::segment::rerank::{Reranker, quantize_query};
use crate::types::*;

/// Query engine for executing vector searches
pub struct QueryEngine {
    config: EngineConfig,
    segments: Vec<Arc<Segment>>,
    rotator: Rotator,
}

impl QueryEngine {
    /// Create a new query engine
    pub fn new(config: EngineConfig) -> Result<Self> {
        config.validate()?;
        let rotator = Rotator::new(config.dim);

        Ok(Self {
            config,
            segments: Vec::new(),
            rotator,
        })
    }

    /// Add a segment to the engine
    pub fn add_segment(&mut self, segment: Arc<Segment>) -> Result<()> {
        if segment.dim() != self.config.dim {
            return Err(Error::DimensionMismatch {
                expected: self.config.dim,
                got: segment.dim(),
            });
        }
        self.segments.push(segment);
        Ok(())
    }

    /// Load a segment from file
    pub fn load_segment(&mut self, path: &str) -> Result<()> {
        let segment = Segment::open(path)?;
        self.add_segment(Arc::new(segment))
    }

    /// Execute a query
    pub fn search(&self, query: &[f32], params: &QueryParams) -> Result<QueryResult> {
        if query.len() != self.config.dim as usize {
            return Err(Error::DimensionMismatch {
                expected: self.config.dim,
                got: query.len() as u32,
            });
        }

        if self.segments.is_empty() {
            return Err(Error::EmptyIndex);
        }

        let total_start = Instant::now();
        let mut stats = QueryStats::default();

        // Step 0: Rotate query
        let rotate_start = Instant::now();
        let rotated_query = self.rotator.rotate(query);
        stats.time_rotate_ns = rotate_start.elapsed().as_nanos() as u64;

        // Prepare filter
        let filter = params.filter.as_ref().map(|bits| {
            BitsetFilter::from_ids(
                self.total_vectors(),
                &bits.iter().map(|&id| id as VectorId).collect::<Vec<_>>(),
            )
        });

        // Search each segment
        let mut all_candidates: Vec<ScoredCandidate> = Vec::new();

        for segment in &self.segments {
            let segment_result = self.search_segment(
                segment,
                &rotated_query,
                query,
                params,
                filter.as_ref(),
                &mut stats,
            )?;
            all_candidates.extend(segment_result);
        }

        // Merge and select top k
        all_candidates.sort_by(|a, b| b.score.partial_cmp(&a.score).unwrap());
        all_candidates.truncate(params.k);

        stats.total_time_ns = total_start.elapsed().as_nanos() as u64;

        Ok(QueryResult {
            candidates: all_candidates,
            stats,
        })
    }

    /// Search within a single segment
    fn search_segment(
        &self,
        segment: &Segment,
        rotated_query: &[f32],
        _original_query: &[f32],
        params: &QueryParams,
        filter: Option<&BitsetFilter>,
        stats: &mut QueryStats,
    ) -> Result<Vec<ScoredCandidate>> {
        let header = segment.header();
        let _n_vec = header.n_vec as usize;

        // Compute selectivity for filter-aware widening
        let selectivity = filter
            .map(|f| {
                let mut f = f.clone();
                f.selectivity()
            })
            .unwrap_or(1.0);

        let widening_factor = if selectivity < 1.0 && params.adaptive {
            (1.0 / selectivity).min(4.0)
        } else {
            1.0
        };

        // Step 2: RDF candidate generation
        let rdf_start = Instant::now();
        let rdf_candidates = if header
            .flags
            .has(crate::segment::format::SegmentFlags::HAS_RDF)
        {
            let l_a_widened = ((params.l_a as f32) * widening_factor) as usize;
            self.rdf_search(segment, rotated_query, l_a_widened)
        } else {
            Vec::new()
        };
        stats.time_rdf_ns += rdf_start.elapsed().as_nanos() as u64;
        stats.rdf_candidates += rdf_candidates.len();

        // Step 3: BPS candidate generation
        let bps_start = Instant::now();
        let bps_candidates = if header
            .flags
            .has(crate::segment::format::SegmentFlags::HAS_BPS)
        {
            let l_b_widened = ((params.l_b as f32) * widening_factor) as usize;
            self.bps_search(segment, rotated_query, l_b_widened)
        } else {
            Vec::new()
        };
        stats.time_bps_ns += bps_start.elapsed().as_nanos() as u64;
        stats.bps_candidates += bps_candidates.len();

        // Step 4: Union candidates
        let mut candidate_set: HashSet<VectorId> = HashSet::new();
        for c in &rdf_candidates {
            candidate_set.insert(c.id);
        }
        for (vid, _) in &bps_candidates {
            candidate_set.insert(*vid);
        }
        stats.union_size += candidate_set.len();

        // Apply filter
        let filter_start = Instant::now();
        let filtered_candidates: Vec<VectorId> = if let Some(f) = filter {
            candidate_set
                .into_iter()
                .filter(|&id| f.contains(id) && !segment.is_tombstoned(id))
                .collect()
        } else {
            candidate_set
                .into_iter()
                .filter(|&id| !segment.is_tombstoned(id))
                .collect()
        };
        stats.time_filter_ns += filter_start.elapsed().as_nanos() as u64;
        stats.post_filter_size += filtered_candidates.len();

        // Step 5: Rerank
        let rerank_start = Instant::now();
        let reranked = self.rerank(segment, rotated_query, &filtered_candidates, params.r)?;
        stats.time_rerank_ns += rerank_start.elapsed().as_nanos() as u64;
        stats.rerank_count += reranked.len();

        // Adaptive widening check
        if params.adaptive && reranked.len() < params.k {
            stats.widening_applied = true;
            // Could widen and retry here
        }

        Ok(reranked)
    }

    /// RDF-based candidate generation
    fn rdf_search(
        &self,
        segment: &Segment,
        rotated_query: &[f32],
        l_a: usize,
    ) -> Vec<ScoredCandidate> {
        let directory = segment.rdf_directory();
        if directory.is_empty() {
            return Vec::new();
        }

        let rdf_data = unsafe {
            let ptr = segment.rdf_data_ptr();
            let len = segment.header().file_len as usize - segment.header().off_rdf_data as usize;
            std::slice::from_raw_parts(ptr, len.min(1024 * 1024 * 100)) // Cap at 100MB for safety
        };

        let dim_weights = segment.dim_weights();
        let scorer = RdfScorer::new(
            directory,
            rdf_data,
            dim_weights,
            segment.header().rdf_stripe_shift,
            segment.num_vectors(),
        );

        scorer.score(rotated_query, self.config.rdf.top_t as usize, l_a)
    }

    /// BPS-based candidate generation
    fn bps_search(
        &self,
        segment: &Segment,
        rotated_query: &[f32],
        l_b: usize,
    ) -> Vec<(VectorId, Distance)> {
        let header = segment.header();
        let bps_data = segment.bps_data();

        // Compute query sketch using stored qparams when available (correct
        // asymmetric quantization).  Fall back to legacy symmetric quantization
        // only for segments written before qparams were persisted.
        #[allow(deprecated)]
        let query_sketch = if let Some(qparams) = segment.bps_qparams() {
            BpsBuilder::compute_query_sketch_with_params(&self.config.bps, rotated_query, qparams)
        } else {
            BpsBuilder::compute_query_sketch(&self.config.bps, rotated_query)
        };

        let scanner = BpsScanner::new(
            bps_data,
            header.n_vec as usize,
            header.num_bps_blocks() as usize,
            header.bps_proj as usize,
        );

        scanner.top_k(&query_sketch, l_b)
    }

    /// Rerank candidates using int8 dot product
    fn rerank(
        &self,
        segment: &Segment,
        rotated_query: &[f32],
        candidates: &[VectorId],
        r: usize,
    ) -> Result<Vec<ScoredCandidate>> {
        if candidates.is_empty() {
            return Ok(Vec::new());
        }

        let header = segment.header();
        let i8_data = segment.i8_data();
        let scales = segment.scales_data();

        // Quantize query
        let (query_i8, query_scale) = quantize_query(rotated_query, &self.config.rerank);

        // Get outliers if available
        let outliers = if header
            .flags
            .has(crate::segment::format::SegmentFlags::HAS_OUTLIERS)
        {
            unsafe {
                std::slice::from_raw_parts(
                    segment.outliers_ptr(),
                    header.n_vec as usize * header.num_outliers as usize,
                )
            }
        } else {
            &[]
        };

        let reranker = Reranker::new(
            i8_data,
            &scales[..header.n_vec as usize], // One scale per vector
            outliers,
            header.dim as usize,
            header.num_outliers as usize,
        );

        Ok(reranker.rerank(candidates, &query_i8, query_scale, r))
    }

    /// Optional verification with fp32
    pub fn verify(
        &self,
        segment: &Segment,
        candidates: &[ScoredCandidate],
        query: &[f32],
        k: usize,
    ) -> Vec<ScoredCandidate> {
        if let Some(fp32_data) = segment.fp32_data() {
            let dim = segment.dim() as usize;
            let mut verified: Vec<ScoredCandidate> = candidates
                .iter()
                .map(|c| {
                    let offset = c.id as usize * dim;
                    if offset + dim <= fp32_data.len() {
                        let vec = &fp32_data[offset..offset + dim];
                        let score = query.iter().zip(vec.iter()).map(|(a, b)| a * b).sum();
                        ScoredCandidate { id: c.id, score }
                    } else {
                        *c
                    }
                })
                .collect();

            verified.sort_by(|a, b| b.score.partial_cmp(&a.score).unwrap());
            verified.truncate(k);
            verified
        } else {
            candidates.to_vec()
        }
    }

    /// Get total vector count across all segments
    pub fn total_vectors(&self) -> u32 {
        self.segments.iter().map(|s| s.num_vectors()).sum()
    }

    /// Get config
    pub fn config(&self) -> &EngineConfig {
        &self.config
    }

    /// Get segments
    pub fn segments(&self) -> &[Arc<Segment>] {
        &self.segments
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::segment::SegmentWriter;
    use tempfile::NamedTempFile;

    fn create_test_index() -> (NamedTempFile, EngineConfig) {
        let config = EngineConfig::with_dim(64);
        let mut writer = SegmentWriter::new(config.clone()).unwrap();

        // Add vectors with known patterns
        for i in 0..1000 {
            let mut vec = vec![0.0f32; 64];
            // Create a distinctive pattern
            vec[i % 64] = 1.0;
            vec[(i + 1) % 64] = 0.5;
            writer.add(&vec).unwrap();
        }

        let file = NamedTempFile::new().unwrap();
        writer.build(file.path()).unwrap();

        (file, config)
    }

    #[test]
    fn test_query_engine_basic() {
        let (file, config) = create_test_index();

        let mut engine = QueryEngine::new(config).unwrap();
        engine.load_segment(file.path().to_str().unwrap()).unwrap();

        // Query similar to vector 0
        let mut query = vec![0.0f32; 64];
        query[0] = 1.0;
        query[1] = 0.5;

        let params = QueryParams {
            k: 10,
            l_a: 100,
            l_b: 200,
            r: 50,
            adaptive: false,
            filter: None,
        };

        let result = engine.search(&query, &params).unwrap();

        assert!(!result.candidates.is_empty());
        println!("Query stats: {}", result.stats);
    }

    #[test]
    fn test_query_with_filter() {
        let (file, config) = create_test_index();

        let mut engine = QueryEngine::new(config).unwrap();
        engine.load_segment(file.path().to_str().unwrap()).unwrap();

        let mut query = vec![0.0f32; 64];
        query[0] = 1.0;

        // Filter to only even IDs
        let filter: Vec<u64> = (0..500).map(|i| i * 2).collect();

        let params = QueryParams {
            k: 10,
            l_a: 100,
            l_b: 200,
            r: 50,
            adaptive: false,
            filter: Some(filter),
        };

        let result = engine.search(&query, &params).unwrap();

        // All results should have even IDs
        for c in &result.candidates {
            assert!(c.id % 2 == 0, "Expected even ID, got {}", c.id);
        }
    }
}