innr 0.2.1

SIMD-accelerated vector similarity primitives with binary, ternary, and scalar quantization
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
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
//! Integration tests for batch vector operations.
//!
//! Tests the PDX-style columnar layout and batch distance computations.

use innr::batch::{
    batch_cosine, batch_dot, batch_knn, batch_knn_adaptive, batch_knn_cosine, batch_knn_dot,
    batch_knn_filtered, batch_knn_reordered, batch_l2_squared, batch_l2_squared_pruning,
    batch_norms, VerticalBatch,
};

// =============================================================================
// VerticalBatch construction tests
// =============================================================================

#[test]
fn empty_batch() {
    let vectors: Vec<Vec<f32>> = vec![];
    let batch = VerticalBatch::from_rows(&vectors);

    assert_eq!(batch.num_vectors(), 0);
    assert_eq!(batch.dimension(), 0);
}

#[test]
fn single_vector_batch() {
    let vectors = vec![vec![1.0, 2.0, 3.0, 4.0]];
    let batch = VerticalBatch::from_rows(&vectors);

    assert_eq!(batch.num_vectors(), 1);
    assert_eq!(batch.dimension(), 4);

    for d in 0..4 {
        assert_eq!(batch.get(d, 0), (d + 1) as f32);
    }
}

#[test]
fn from_flat_matches_from_rows() {
    let vectors = vec![
        vec![1.0, 2.0, 3.0],
        vec![4.0, 5.0, 6.0],
        vec![7.0, 8.0, 9.0],
    ];

    let flat: Vec<f32> = vectors.iter().flat_map(|v| v.iter().copied()).collect();

    let batch_rows = VerticalBatch::from_rows(&vectors);
    let batch_flat = VerticalBatch::from_flat(&flat, 3, 3);

    for d in 0..3 {
        for i in 0..3 {
            assert_eq!(
                batch_rows.get(d, i),
                batch_flat.get(d, i),
                "Mismatch at ({}, {})",
                d,
                i
            );
        }
    }
}

#[test]
fn dimension_slice_correct() {
    let vectors = vec![vec![1.0, 2.0], vec![3.0, 4.0], vec![5.0, 6.0]];
    let batch = VerticalBatch::from_rows(&vectors);

    // dimension 0: [1.0, 3.0, 5.0]
    let dim0 = batch.dimension_slice(0);
    assert_eq!(dim0, &[1.0, 3.0, 5.0]);

    // dimension 1: [2.0, 4.0, 6.0]
    let dim1 = batch.dimension_slice(1);
    assert_eq!(dim1, &[2.0, 4.0, 6.0]);
}

#[test]
fn extract_vector_roundtrip() {
    let vectors = vec![
        vec![1.5, 2.5, 3.5],
        vec![4.5, 5.5, 6.5],
        vec![7.5, 8.5, 9.5],
    ];
    let batch = VerticalBatch::from_rows(&vectors);

    for (i, original) in vectors.iter().enumerate() {
        let extracted = batch.extract_vector(i);
        assert_eq!(original, &extracted, "Vector {} mismatch", i);
    }
}

// =============================================================================
// Distance computation tests
// =============================================================================

#[test]
fn l2_squared_identity() {
    let vectors = vec![vec![1.0, 2.0, 3.0], vec![4.0, 5.0, 6.0]];
    let batch = VerticalBatch::from_rows(&vectors);

    // Distance from v0 to itself should be 0
    let distances = batch_l2_squared(&vectors[0], &batch);
    assert!(distances[0].abs() < 1e-6, "Self-distance should be 0");
}

#[test]
fn l2_squared_symmetric() {
    let v1 = vec![1.0, 2.0, 3.0];
    let v2 = vec![4.0, 5.0, 6.0];

    let batch1 = VerticalBatch::from_rows(std::slice::from_ref(&v1));
    let batch2 = VerticalBatch::from_rows(std::slice::from_ref(&v2));

    let d12 = batch_l2_squared(&v1, &batch2)[0];
    let d21 = batch_l2_squared(&v2, &batch1)[0];

    assert!(
        (d12 - d21).abs() < 1e-6,
        "L2 squared should be symmetric: {} vs {}",
        d12,
        d21
    );
}

#[test]
fn l2_squared_known_value() {
    let vectors = vec![vec![0.0, 0.0, 0.0]];
    let batch = VerticalBatch::from_rows(&vectors);
    let query = vec![3.0, 4.0, 0.0];

    let distances = batch_l2_squared(&query, &batch);
    // Distance should be 5^2 = 25
    assert!(
        (distances[0] - 25.0).abs() < 1e-6,
        "Expected 25, got {}",
        distances[0]
    );
}

#[test]
fn dot_product_orthogonal() {
    let vectors = vec![
        vec![1.0, 0.0, 0.0],
        vec![0.0, 1.0, 0.0],
        vec![0.0, 0.0, 1.0],
    ];
    let batch = VerticalBatch::from_rows(&vectors);

    // Query along x-axis
    let query = vec![1.0, 0.0, 0.0];
    let dots = batch_dot(&query, &batch);

    assert!((dots[0] - 1.0).abs() < 1e-6, "Parallel should be 1");
    assert!(dots[1].abs() < 1e-6, "Orthogonal should be 0");
    assert!(dots[2].abs() < 1e-6, "Orthogonal should be 0");
}

#[test]
fn cosine_normalized() {
    let vectors = vec![
        vec![1.0, 0.0],
        vec![0.0, 1.0],
        vec![1.0, 1.0],
        vec![-1.0, 0.0],
    ];
    let batch = VerticalBatch::from_rows(&vectors);
    let norms = batch_norms(&batch);
    let query = vec![1.0, 0.0];

    let cosines = batch_cosine(&query, &batch, &norms);

    assert!((cosines[0] - 1.0).abs() < 1e-6, "Parallel: {}", cosines[0]);
    assert!(cosines[1].abs() < 1e-6, "Orthogonal: {}", cosines[1]);
    let sqrt2_inv = 1.0 / 2.0_f32.sqrt();
    assert!(
        (cosines[2] - sqrt2_inv).abs() < 1e-5,
        "45 deg: expected {}, got {}",
        sqrt2_inv,
        cosines[2]
    );
    assert!(
        (cosines[3] - (-1.0)).abs() < 1e-6,
        "Opposite: {}",
        cosines[3]
    );
}

// =============================================================================
// kNN tests
// =============================================================================

#[test]
fn knn_returns_k_results() {
    let vectors: Vec<Vec<f32>> = (0..100).map(|i| vec![i as f32, 0.0]).collect();
    let batch = VerticalBatch::from_rows(&vectors);
    let query = vec![50.0, 0.0];

    for k in [1, 5, 10, 50, 100] {
        let result = batch_knn(&query, &batch, k);
        assert_eq!(result.indices.len(), k, "Should return {} results", k);
        assert_eq!(result.scores.len(), k);
    }
}

#[test]
fn knn_results_sorted() {
    let vectors: Vec<Vec<f32>> = (0..50).map(|i| vec![i as f32, (i as f32).sin()]).collect();
    let batch = VerticalBatch::from_rows(&vectors);
    let query = vec![25.0, 0.0];

    let result = batch_knn(&query, &batch, 20);

    for i in 1..result.scores.len() {
        assert!(
            result.scores[i] >= result.scores[i - 1],
            "Results not sorted: {} > {} at position {}",
            result.scores[i - 1],
            result.scores[i],
            i
        );
    }
}

#[test]
fn knn_finds_exact_match() {
    let vectors = vec![
        vec![0.0, 0.0],
        vec![1.0, 0.0],
        vec![0.0, 1.0],
        vec![1.0, 1.0],
    ];
    let batch = VerticalBatch::from_rows(&vectors);

    // Query exactly matches vector 2
    let query = vec![0.0, 1.0];
    let result = batch_knn(&query, &batch, 1);

    assert_eq!(result.indices[0], 2);
    assert!(result.scores[0] < 1e-6);
}

#[test]
fn knn_adaptive_matches_basic() {
    let vectors: Vec<Vec<f32>> = (0..100)
        .map(|i| vec![i as f32, (i as f32 * 0.1).sin(), (i as f32 * 0.1).cos()])
        .collect();
    let batch = VerticalBatch::from_rows(&vectors);
    let query = vec![50.0, 0.0, 1.0];

    let basic = batch_knn(&query, &batch, 10);
    let adaptive = batch_knn_adaptive(&query, &batch, 10, 1);

    // Adaptive must find the same top-10 results as basic knn.
    // batch_knn_adaptive with threshold=1 (very conservative pruning) should not
    // prune any candidate that could end up in the top-k.
    for idx in &basic.indices {
        assert!(
            adaptive.indices.contains(idx),
            "Adaptive missing index {} from basic top-10",
            idx
        );
    }
}

// =============================================================================
// Pruning tests
// =============================================================================

#[test]
fn pruning_filters_far_vectors() {
    let vectors = vec![
        vec![0.0, 0.0],
        vec![1.0, 0.0],
        vec![100.0, 100.0], // Very far
        vec![2.0, 0.0],
    ];
    let batch = VerticalBatch::from_rows(&vectors);
    let query = vec![0.0, 0.0];

    let survivors = batch_l2_squared_pruning(&query, &batch, 5.0);

    let indices: Vec<usize> = survivors.iter().map(|(i, _)| *i).collect();
    assert!(indices.contains(&0), "Origin should survive");
    assert!(indices.contains(&1), "Close vector should survive");
    assert!(!indices.contains(&2), "Far vector should be pruned");
    assert!(indices.contains(&3), "Close vector should survive");
}

#[test]
fn pruning_returns_correct_distances() {
    let vectors = vec![vec![0.0, 0.0], vec![1.0, 0.0], vec![0.0, 2.0]];
    let batch = VerticalBatch::from_rows(&vectors);
    let query = vec![0.0, 0.0];

    let survivors = batch_l2_squared_pruning(&query, &batch, 5.0);

    for (idx, dist) in &survivors {
        let expected = batch_l2_squared(&query, &batch)[*idx];
        assert!(
            (dist - expected).abs() < 1e-6,
            "Distance mismatch for idx {}: {} vs {}",
            idx,
            dist,
            expected
        );
    }
}

#[test]
fn pruning_tight_threshold() {
    let vectors: Vec<Vec<f32>> = (0..100).map(|i| vec![i as f32, 0.0]).collect();
    let batch = VerticalBatch::from_rows(&vectors);
    let query = vec![50.0, 0.0];

    // Only vectors within distance 2 (squared: 4)
    let survivors = batch_l2_squared_pruning(&query, &batch, 4.0);

    // Should only include 48, 49, 50, 51, 52
    let indices: Vec<usize> = survivors.iter().map(|(i, _)| *i).collect();
    assert!(indices.len() <= 5, "Should only have ~5 survivors");
    assert!(indices.contains(&50), "Exact match should survive");
}

// =============================================================================
// Edge cases
// =============================================================================

#[test]
fn knn_k_larger_than_batch() {
    let vectors = vec![vec![1.0, 2.0], vec![3.0, 4.0]];
    let batch = VerticalBatch::from_rows(&vectors);
    let query = vec![0.0, 0.0];

    let result = batch_knn(&query, &batch, 100);

    assert_eq!(result.indices.len(), 2, "Should return all vectors");
}

#[test]
fn knn_k_zero() {
    let vectors = vec![vec![1.0, 2.0]];
    let batch = VerticalBatch::from_rows(&vectors);
    let query = vec![0.0, 0.0];

    let result = batch_knn(&query, &batch, 0);

    assert!(result.indices.is_empty());
    assert!(result.scores.is_empty());
}

#[test]
fn batch_norms_correct() {
    let vectors = vec![
        vec![3.0, 4.0], // norm = 5
        vec![1.0, 0.0], // norm = 1
        vec![0.0, 0.0], // norm = 0
    ];
    let batch = VerticalBatch::from_rows(&vectors);
    let norms = batch_norms(&batch);

    assert!((norms[0] - 5.0).abs() < 1e-6);
    assert!((norms[1] - 1.0).abs() < 1e-6);
    assert!(norms[2].abs() < 1e-6);
}

#[test]
fn cosine_with_zero_norm() {
    let vectors = vec![
        vec![1.0, 0.0],
        vec![0.0, 0.0], // Zero vector
    ];
    let batch = VerticalBatch::from_rows(&vectors);
    let norms = batch_norms(&batch);
    let query = vec![1.0, 0.0];

    let cosines = batch_cosine(&query, &batch, &norms);

    assert!((cosines[0] - 1.0).abs() < 1e-6);
    assert!(cosines[1].abs() < 1e-6, "Zero vector should give 0 cosine");
}

// =============================================================================
// New batch kNN variant tests
// =============================================================================

#[test]
fn reordered_knn_matches_exact_large() {
    // Larger test: 200 vectors, 64 dims -- reordered must match exact
    let vectors: Vec<Vec<f32>> = (0..200)
        .map(|i| (0..64).map(|d| ((i * 7 + d * 3) as f32).sin()).collect())
        .collect();
    let batch = VerticalBatch::from_rows(&vectors);
    let query: Vec<f32> = (0..64).map(|i| (i as f32 * 0.1).cos()).collect();

    let exact = batch_knn(&query, &batch, 10);
    let reordered = batch_knn_reordered(&query, &batch, 10);

    assert_eq!(exact.indices, reordered.indices);
}

#[test]
fn cosine_knn_normalized_matches_dot_knn() {
    // For unit-normalized vectors, cosine ranking == dot ranking
    let raw_vectors: Vec<Vec<f32>> = (0..50)
        .map(|i| (0..8).map(|d| ((i * 7 + d * 3) as f32).sin()).collect())
        .collect();

    // Normalize
    let vectors: Vec<Vec<f32>> = raw_vectors
        .iter()
        .map(|v| {
            let n: f32 = v.iter().map(|x| x * x).sum::<f32>().sqrt();
            v.iter().map(|x| x / n).collect()
        })
        .collect();

    let batch = VerticalBatch::from_rows(&vectors);
    let query = {
        let q: Vec<f32> = (0..8).map(|i| (i as f32 * 0.3).cos()).collect();
        let n: f32 = q.iter().map(|x| x * x).sum::<f32>().sqrt();
        q.iter().map(|x| x / n).collect::<Vec<f32>>()
    };

    let cosine_result = batch_knn_cosine(&query, &batch, 5);
    let dot_result = batch_knn_dot(&query, &batch, 5);

    assert_eq!(
        cosine_result.indices, dot_result.indices,
        "Cosine and dot rankings should match for normalized vectors"
    );
}

#[test]
fn filtered_knn_integration() {
    let vectors: Vec<Vec<f32>> = (0..100).map(|i| vec![i as f32, 0.0]).collect();
    let batch = VerticalBatch::from_rows(&vectors);
    let query = vec![50.0, 0.0];

    // Filter to only even-indexed vectors
    let result = batch_knn_filtered(&query, &batch, 5, |i| i % 2 == 0);

    assert_eq!(result.indices.len(), 5);
    assert_eq!(result.indices[0], 50); // exact match, even index
    for &idx in &result.indices {
        assert_eq!(idx % 2, 0, "All results should have even indices");
    }
}

#[test]
fn cosine_with_zero_query() {
    let vectors = vec![vec![1.0, 2.0], vec![3.0, 4.0]];
    let batch = VerticalBatch::from_rows(&vectors);
    let norms = batch_norms(&batch);
    let query = vec![0.0, 0.0]; // Zero query

    let cosines = batch_cosine(&query, &batch, &norms);

    for &c in &cosines {
        assert!(c.abs() < 1e-6, "Zero query should give 0 cosine");
    }
}