edgevec 0.9.0

High-performance embedded vector database for Browser, Node, and Edge
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
//! NEON SIMD Benchmarks
//!
//! Benchmarks comparing NEON-optimized vs portable implementations for:
//! - Hamming distance (binary vectors)
//! - Dot product (f32 vectors)
//! - Euclidean distance (f32 vectors)
//!
//! ## Running on ARM64
//!
//! **Native ARM64:**
//! ```bash
//! cargo bench --bench simd_neon_bench
//! ```
//!
//! **Cross-compile for ARM64 (from x86):**
//! ```bash
//! cross bench --target aarch64-unknown-linux-gnu --bench simd_neon_bench
//! ```
//!
//! ## Expected Results (ARM64)
//!
//! ### Hamming Distance
//!
//! | Size | Portable | NEON | Speedup |
//! |:-----|:---------|:-----|:--------|
//! | 64B  | ~80ns    | ~20ns| ~4x     |
//! | 256B | ~300ns   | ~50ns| ~6x     |
//! | 1KB  | ~1.2µs   | ~150ns| ~8x    |
//! | 4KB  | ~4.8µs   | ~500ns| ~10x   |
//!
//! ### Similarity Functions (Dot Product, Euclidean)
//!
//! | Dims | Portable | NEON | Speedup |
//! |:-----|:---------|:-----|:--------|
//! | 128  | ~200ns   | ~80ns| ~2.5x   |
//! | 768  | ~1.2µs   | ~300ns| ~4x    |
//! | 1536 | ~2.4µs   | ~600ns| ~4x    |
//!
//! Target: NEON ≥2x faster than portable
//!
//! ## Note on x86
//!
//! On x86 targets, only the portable benchmark runs. NEON benchmarks are
//! compiled out via `#[cfg(target_arch = "aarch64")]`.

use criterion::{criterion_group, criterion_main, BenchmarkId, Criterion, Throughput};
use std::hint::black_box;
use edgevec::quantization::simd::portable::hamming_distance_slice as portable_hamming;
use rand::{Rng, SeedableRng};
use rand_chacha::ChaCha8Rng;

#[cfg(target_arch = "aarch64")]
use edgevec::simd::neon::{
    dot_product as neon_dot_product, dot_product_portable,
    euclidean_distance as neon_euclidean, euclidean_distance_portable,
    hamming_distance_slice as neon_hamming,
};

/// Generate random byte vectors for benchmarking.
fn generate_byte_vectors(size: usize, seed: u64) -> (Vec<u8>, Vec<u8>) {
    let mut rng = ChaCha8Rng::seed_from_u64(seed);
    let a: Vec<u8> = (0..size).map(|_| rng.gen()).collect();
    let b: Vec<u8> = (0..size).map(|_| rng.gen()).collect();
    (a, b)
}

/// Generate random f32 vectors for benchmarking.
fn generate_f32_vectors(size: usize, seed: u64) -> (Vec<f32>, Vec<f32>) {
    let mut rng = ChaCha8Rng::seed_from_u64(seed);
    let a: Vec<f32> = (0..size).map(|_| rng.gen_range(-1.0..1.0)).collect();
    let b: Vec<f32> = (0..size).map(|_| rng.gen_range(-1.0..1.0)).collect();
    (a, b)
}

/// Portable dot product for non-ARM benchmarks
#[cfg(not(target_arch = "aarch64"))]
fn portable_dot_product(a: &[f32], b: &[f32]) -> f32 {
    a.iter().zip(b.iter()).map(|(x, y)| x * y).sum()
}

/// Portable euclidean distance for non-ARM benchmarks
#[cfg(not(target_arch = "aarch64"))]
fn portable_euclidean(a: &[f32], b: &[f32]) -> f32 {
    a.iter()
        .zip(b.iter())
        .map(|(x, y)| {
            let diff = x - y;
            diff * diff
        })
        .sum::<f32>()
        .sqrt()
}

/// Benchmark NEON vs Portable Hamming distance.
///
/// Tests various input sizes to understand performance characteristics.
fn bench_neon_vs_portable(c: &mut Criterion) {
    let mut group = c.benchmark_group("hamming_neon_vs_portable");

    // Test sizes: 64, 256, 1024, 4096 bytes
    // These cover:
    // - 64B: Small vectors (4 NEON chunks)
    // - 256B: Medium vectors (16 NEON chunks)
    // - 1024B: Large vectors (64 NEON chunks)
    // - 4096B: Very large vectors (256 NEON chunks)
    let sizes = [64, 256, 1024, 4096];

    for size in sizes {
        let (a, b) = generate_byte_vectors(size, 42 + size as u64);

        group.throughput(Throughput::Bytes((size * 2) as u64)); // 2 input vectors

        // Portable baseline (runs on all platforms)
        group.bench_with_input(BenchmarkId::new("portable", size), &size, |bench, _| {
            bench.iter(|| portable_hamming(black_box(&a), black_box(&b)));
        });

        // NEON optimized (ARM64 only)
        #[cfg(target_arch = "aarch64")]
        group.bench_with_input(BenchmarkId::new("neon", size), &size, |bench, _| {
            bench.iter(|| neon_hamming(black_box(&a), black_box(&b)));
        });
    }

    group.finish();
}

/// Benchmark NEON Hamming with realistic embedding sizes.
///
/// Common embedding dimensions that map to binary vectors:
/// - 768 bits = 96 bytes (standard BERT)
/// - 1536 bits = 192 bytes (OpenAI ada-002)
/// - 3072 bits = 384 bytes (large models)
fn bench_neon_embedding_sizes(c: &mut Criterion) {
    let mut group = c.benchmark_group("hamming_embedding_sizes");

    let sizes = [96, 192, 384]; // Common binary embedding sizes in bytes

    for size in sizes {
        let (a, b) = generate_byte_vectors(size, 100 + size as u64);

        group.throughput(Throughput::Bytes((size * 2) as u64));

        group.bench_with_input(BenchmarkId::new("portable", size), &size, |bench, _| {
            bench.iter(|| portable_hamming(black_box(&a), black_box(&b)));
        });

        #[cfg(target_arch = "aarch64")]
        group.bench_with_input(BenchmarkId::new("neon", size), &size, |bench, _| {
            bench.iter(|| neon_hamming(black_box(&a), black_box(&b)));
        });
    }

    group.finish();
}

/// Benchmark batch Hamming distance operations.
///
/// Measures throughput when computing many distances (realistic search use case).
fn bench_neon_batch(c: &mut Criterion) {
    let mut group = c.benchmark_group("hamming_batch");

    let batch_size = 1000;
    let vector_size = 96; // Standard 768-bit binary embedding

    // Generate batch of vectors
    let vectors: Vec<Vec<u8>> = (0..batch_size)
        .map(|i| {
            let (v, _) = generate_byte_vectors(vector_size, i as u64);
            v
        })
        .collect();
    let (query, _) = generate_byte_vectors(vector_size, 9999);

    group.throughput(Throughput::Elements(batch_size as u64));

    // Portable batch
    group.bench_function("portable_batch_1000", |bench| {
        bench.iter(|| {
            for v in &vectors {
                black_box(portable_hamming(black_box(&query), black_box(v)));
            }
        });
    });

    // NEON batch (ARM64 only)
    #[cfg(target_arch = "aarch64")]
    group.bench_function("neon_batch_1000", |bench| {
        bench.iter(|| {
            for v in &vectors {
                black_box(neon_hamming(black_box(&query), black_box(v)));
            }
        });
    });

    group.finish();
}

/// Benchmark edge cases: tail handling.
///
/// Tests sizes that exercise the tail path (len % 16 != 0).
fn bench_neon_tail_handling(c: &mut Criterion) {
    let mut group = c.benchmark_group("hamming_tail_handling");

    // Sizes that test different tail lengths
    let sizes = [
        15,  // 0 chunks + 15 tail
        17,  // 1 chunk + 1 tail
        31,  // 1 chunk + 15 tail
        33,  // 2 chunks + 1 tail
        100, // 6 chunks + 4 tail
    ];

    for size in sizes {
        let (a, b) = generate_byte_vectors(size, 200 + size as u64);

        group.bench_with_input(BenchmarkId::new("portable", size), &size, |bench, _| {
            bench.iter(|| portable_hamming(black_box(&a), black_box(&b)));
        });

        #[cfg(target_arch = "aarch64")]
        group.bench_with_input(BenchmarkId::new("neon", size), &size, |bench, _| {
            bench.iter(|| neon_hamming(black_box(&a), black_box(&b)));
        });
    }

    group.finish();
}

// =============================================================================
// Similarity Benchmarks (Dot Product & Euclidean Distance)
// =============================================================================

/// Benchmark NEON vs Portable dot product.
///
/// Tests at common embedding dimensions: 128, 768, 1536
fn bench_dot_product(c: &mut Criterion) {
    let mut group = c.benchmark_group("dot_product_neon_vs_portable");

    // Common embedding dimensions
    let dims = [128, 768, 1536];

    for dim in dims {
        let (a, b) = generate_f32_vectors(dim, 300 + dim as u64);

        group.throughput(Throughput::Elements(dim as u64));

        // Portable baseline
        #[cfg(not(target_arch = "aarch64"))]
        group.bench_with_input(BenchmarkId::new("portable", dim), &dim, |bench, _| {
            bench.iter(|| portable_dot_product(black_box(&a), black_box(&b)));
        });

        #[cfg(target_arch = "aarch64")]
        {
            group.bench_with_input(BenchmarkId::new("portable", dim), &dim, |bench, _| {
                bench.iter(|| dot_product_portable(black_box(&a), black_box(&b)));
            });

            group.bench_with_input(BenchmarkId::new("neon", dim), &dim, |bench, _| {
                bench.iter(|| neon_dot_product(black_box(&a), black_box(&b)));
            });
        }
    }

    group.finish();
}

/// Benchmark NEON vs Portable euclidean distance.
///
/// Tests at common embedding dimensions: 128, 768, 1536
fn bench_euclidean_distance(c: &mut Criterion) {
    let mut group = c.benchmark_group("euclidean_neon_vs_portable");

    let dims = [128, 768, 1536];

    for dim in dims {
        let (a, b) = generate_f32_vectors(dim, 400 + dim as u64);

        group.throughput(Throughput::Elements(dim as u64));

        #[cfg(not(target_arch = "aarch64"))]
        group.bench_with_input(BenchmarkId::new("portable", dim), &dim, |bench, _| {
            bench.iter(|| portable_euclidean(black_box(&a), black_box(&b)));
        });

        #[cfg(target_arch = "aarch64")]
        {
            group.bench_with_input(BenchmarkId::new("portable", dim), &dim, |bench, _| {
                bench.iter(|| euclidean_distance_portable(black_box(&a), black_box(&b)));
            });

            group.bench_with_input(BenchmarkId::new("neon", dim), &dim, |bench, _| {
                bench.iter(|| neon_euclidean(black_box(&a), black_box(&b)));
            });
        }
    }

    group.finish();
}

/// Benchmark batch similarity operations.
///
/// Simulates realistic search scenario: 1 query vs 1000 vectors.
fn bench_similarity_batch(c: &mut Criterion) {
    let mut group = c.benchmark_group("similarity_batch");

    let batch_size = 1000;
    let dim = 768; // OpenAI embedding dimension

    let vectors: Vec<Vec<f32>> = (0..batch_size)
        .map(|i| {
            let (v, _) = generate_f32_vectors(dim, i as u64);
            v
        })
        .collect();
    let (query, _) = generate_f32_vectors(dim, 9999);

    group.throughput(Throughput::Elements(batch_size as u64));

    // Dot product batch
    #[cfg(not(target_arch = "aarch64"))]
    group.bench_function("dot_portable_batch_1000", |bench| {
        bench.iter(|| {
            for v in &vectors {
                black_box(portable_dot_product(black_box(&query), black_box(v)));
            }
        });
    });

    #[cfg(target_arch = "aarch64")]
    {
        group.bench_function("dot_portable_batch_1000", |bench| {
            bench.iter(|| {
                for v in &vectors {
                    black_box(dot_product_portable(black_box(&query), black_box(v)));
                }
            });
        });

        group.bench_function("dot_neon_batch_1000", |bench| {
            bench.iter(|| {
                for v in &vectors {
                    black_box(neon_dot_product(black_box(&query), black_box(v)));
                }
            });
        });

        group.bench_function("euclidean_portable_batch_1000", |bench| {
            bench.iter(|| {
                for v in &vectors {
                    black_box(euclidean_distance_portable(black_box(&query), black_box(v)));
                }
            });
        });

        group.bench_function("euclidean_neon_batch_1000", |bench| {
            bench.iter(|| {
                for v in &vectors {
                    black_box(neon_euclidean(black_box(&query), black_box(v)));
                }
            });
        });
    }

    #[cfg(not(target_arch = "aarch64"))]
    group.bench_function("euclidean_portable_batch_1000", |bench| {
        bench.iter(|| {
            for v in &vectors {
                black_box(portable_euclidean(black_box(&query), black_box(v)));
            }
        });
    });

    group.finish();
}

/// Benchmark tail handling for similarity functions.
///
/// Tests sizes that exercise scalar tail path (len % 4 != 0).
fn bench_similarity_tail_handling(c: &mut Criterion) {
    let mut group = c.benchmark_group("similarity_tail_handling");

    // Sizes that exercise different tail lengths for f32 (4 floats per NEON vector)
    let sizes = [
        1,   // 0 chunks + 1 tail
        3,   // 0 chunks + 3 tail
        5,   // 1 chunk + 1 tail
        7,   // 1 chunk + 3 tail
        100, // 25 chunks + 0 tail
        103, // 25 chunks + 3 tail
    ];

    for size in sizes {
        let (a, b) = generate_f32_vectors(size, 500 + size as u64);

        // Dot product
        #[cfg(not(target_arch = "aarch64"))]
        group.bench_with_input(BenchmarkId::new("dot_portable", size), &size, |bench, _| {
            bench.iter(|| portable_dot_product(black_box(&a), black_box(&b)));
        });

        #[cfg(target_arch = "aarch64")]
        {
            group.bench_with_input(BenchmarkId::new("dot_portable", size), &size, |bench, _| {
                bench.iter(|| dot_product_portable(black_box(&a), black_box(&b)));
            });

            group.bench_with_input(BenchmarkId::new("dot_neon", size), &size, |bench, _| {
                bench.iter(|| neon_dot_product(black_box(&a), black_box(&b)));
            });
        }
    }

    group.finish();
}

criterion_group!(
    benches,
    // Hamming benchmarks
    bench_neon_vs_portable,
    bench_neon_embedding_sizes,
    bench_neon_batch,
    bench_neon_tail_handling,
    // Similarity benchmarks
    bench_dot_product,
    bench_euclidean_distance,
    bench_similarity_batch,
    bench_similarity_tail_handling,
);
criterion_main!(benches);