-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathflat_index_search_test.go
More file actions
751 lines (642 loc) · 17.2 KB
/
flat_index_search_test.go
File metadata and controls
751 lines (642 loc) · 17.2 KB
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
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
package comet
import (
"math"
"sync"
"testing"
)
// TestFlatIndexSearchSimple tests basic search functionality
func TestFlatIndexSearchSimple(t *testing.T) {
idx, err := NewFlatIndex(3, Euclidean)
if err != nil {
t.Fatalf("NewFlatIndex() error: %v", err)
}
// Add vectors
vectors := [][]float32{
{1, 0, 0},
{0, 1, 0},
{0, 0, 1},
{1, 1, 0},
}
for _, v := range vectors {
node := NewVectorNode(v)
idx.Add(*node)
}
// Search for nearest to [1, 0, 0]
query := []float32{1, 0, 0}
results, err := idx.NewSearch().
WithQuery(query).
WithK(2).
Execute()
if err != nil {
t.Fatalf("Search() error: %v", err)
}
if len(results) != 2 {
t.Errorf("Expected 2 results, got %d", len(results))
}
// First result should be [1, 0, 0] (exact match)
if !vectorsEqual(results[0].Node.Vector(), []float32{1, 0, 0}) {
t.Errorf("Expected first result to be [1, 0, 0], got %v", results[0].Node.Vector())
}
}
// TestFlatIndexSearchWithThreshold tests search with distance threshold
func TestFlatIndexSearchWithThreshold(t *testing.T) {
idx, err := NewFlatIndex(3, Euclidean)
if err != nil {
t.Fatalf("NewFlatIndex() error: %v", err)
}
// Add vectors with known distances
vectors := [][]float32{
{1, 0, 0}, // distance 0 from query
{2, 0, 0}, // distance 1 from query
{4, 0, 0}, // distance 3 from query
{10, 0, 0}, // distance 9 from query
}
for _, v := range vectors {
node := NewVectorNode(v)
idx.Add(*node)
}
// Search with threshold of 2.0
query := []float32{1, 0, 0}
results, err := idx.NewSearch().
WithQuery(query).
WithK(10).
WithThreshold(2.0).
Execute()
if err != nil {
t.Fatalf("Search() error: %v", err)
}
// Should only get vectors within distance 2.0
if len(results) != 2 {
t.Errorf("Expected 2 results with threshold, got %d", len(results))
}
}
// TestFlatIndexSearchCosine tests search with cosine distance
func TestFlatIndexSearchCosine(t *testing.T) {
idx, err := NewFlatIndex(3, Cosine)
if err != nil {
t.Fatalf("NewFlatIndex() error: %v", err)
}
// Add vectors
vectors := [][]float32{
{1, 0, 0},
{1, 1, 0},
{0, 1, 0},
}
for _, v := range vectors {
node := NewVectorNode(v)
idx.Add(*node)
}
// Search for nearest to [1, 0, 0]
query := []float32{2, 0, 0} // Parallel to [1, 0, 0]
results, err := idx.NewSearch().
WithQuery(query).
WithK(1).
Execute()
if err != nil {
t.Fatalf("Search() error: %v", err)
}
if len(results) != 1 {
t.Errorf("Expected 1 result, got %d", len(results))
}
// Should find [1, 0, 0] as it's parallel (cosine distance = 0)
expected := []float32{1, 0, 0}
if !vectorsAlmostEqual(results[0].Node.Vector(), expected, 0.001) {
t.Errorf("Expected result %v, got %v", expected, results[0].Node.Vector())
}
}
// TestFlatIndexSearchByNode tests searching using node IDs
func TestFlatIndexSearchByNode(t *testing.T) {
idx, err := NewFlatIndex(3, Euclidean)
if err != nil {
t.Fatalf("NewFlatIndex() error: %v", err)
}
// Add vectors and remember their IDs
node1 := NewVectorNode([]float32{1, 0, 0})
node2 := NewVectorNode([]float32{0, 1, 0})
node3 := NewVectorNode([]float32{0, 0, 1})
idx.Add(*node1)
idx.Add(*node2)
idx.Add(*node3)
// Search using node1's ID
results, err := idx.NewSearch().
WithNode(node1.ID()).
WithK(2).
Execute()
if err != nil {
t.Fatalf("Search() error: %v", err)
}
if len(results) != 2 {
t.Errorf("Expected 2 results, got %d", len(results))
}
// First result should be the query node itself
if results[0].Node.ID() != node1.ID() {
t.Errorf("Expected first result to be query node %d, got %d", node1.ID(), results[0].Node.ID())
}
}
// TestFlatIndexSearchByMultipleNodes tests batch search using multiple node IDs
func TestFlatIndexSearchByMultipleNodes(t *testing.T) {
idx, err := NewFlatIndex(3, Euclidean)
if err != nil {
t.Fatalf("NewFlatIndex() error: %v", err)
}
// Add vectors
node1 := NewVectorNode([]float32{1, 0, 0})
node2 := NewVectorNode([]float32{0, 1, 0})
node3 := NewVectorNode([]float32{0, 0, 1})
idx.Add(*node1)
idx.Add(*node2)
idx.Add(*node3)
// Search using multiple nodes
results, err := idx.NewSearch().
WithNode(node1.ID(), node2.ID()).
WithK(2).
Execute()
if err != nil {
t.Fatalf("Search() error: %v", err)
}
// With aggregation enabled (default), results are deduplicated by node ID
// Each query returns k=2 neighbors, but duplicates are aggregated
// In this case, we expect 2 unique nodes (node2 and node3 appear in both queries)
if len(results) != 2 {
t.Errorf("Expected 2 deduplicated results, got %d", len(results))
}
// Verify we got unique node IDs
seenIDs := make(map[uint32]bool)
for _, res := range results {
if seenIDs[res.Node.ID()] {
t.Errorf("Found duplicate node ID %d in results", res.Node.ID())
}
seenIDs[res.Node.ID()] = true
}
}
// TestFlatIndexSearchByNonExistentNode tests error handling for non-existent node ID
func TestFlatIndexSearchByNonExistentNode(t *testing.T) {
idx, err := NewFlatIndex(3, Euclidean)
if err != nil {
t.Fatalf("NewFlatIndex() error: %v", err)
}
node := NewVectorNode([]float32{1, 0, 0})
idx.Add(*node)
// Try to search with non-existent node ID
_, err = idx.NewSearch().
WithNode(9999).
WithK(1).
Execute()
if err == nil {
t.Error("Expected error when searching with non-existent node ID")
}
}
// TestFlatIndexSearchBatchQueries tests batch query search
func TestFlatIndexSearchBatchQueries(t *testing.T) {
idx, err := NewFlatIndex(3, Euclidean)
if err != nil {
t.Fatalf("NewFlatIndex() error: %v", err)
}
// Add vectors
vectors := [][]float32{
{1, 0, 0},
{0, 1, 0},
{0, 0, 1},
}
for _, v := range vectors {
node := NewVectorNode(v)
idx.Add(*node)
}
// Search with multiple queries
queries := [][]float32{
{1, 0, 0}, // Will find {1,0,0}
{0, 1, 0}, // Will find {0,1,0}
}
results, err := idx.NewSearch().
WithQuery(queries...).
WithK(1).
Execute()
if err != nil {
t.Fatalf("Search() error: %v", err)
}
// With aggregation, results are deduplicated by node ID
// These two queries should find nodes, with possible overlap
// So we expect at least 1 unique result
if len(results) < 1 {
t.Errorf("Expected at least 1 deduplicated result, got %d", len(results))
}
// Verify we got unique node IDs
seenIDs := make(map[uint32]bool)
for _, res := range results {
if seenIDs[res.Node.ID()] {
t.Errorf("Found duplicate node ID %d in results", res.Node.ID())
}
seenIDs[res.Node.ID()] = true
}
}
// TestFlatIndexSearchValidation tests search parameter validation
func TestFlatIndexSearchValidation(t *testing.T) {
idx, err := NewFlatIndex(3, Euclidean)
if err != nil {
t.Fatalf("NewFlatIndex() error: %v", err)
}
node := NewVectorNode([]float32{1, 0, 0})
idx.Add(*node)
tests := []struct {
name string
setup func() VectorSearch
wantErr bool
}{
{
name: "no query or node",
setup: func() VectorSearch {
return idx.NewSearch().WithK(1)
},
wantErr: true,
},
{
name: "valid node search",
setup: func() VectorSearch {
return idx.NewSearch().
WithNode(node.ID()).
WithK(1)
},
wantErr: false,
},
{
name: "query dimension mismatch",
setup: func() VectorSearch {
return idx.NewSearch().
WithQuery([]float32{1, 0, 0, 0}). // 4D instead of 3D
WithK(1)
},
wantErr: true,
},
{
name: "zero query with cosine",
setup: func() VectorSearch {
cosineIdx, _ := NewFlatIndex(3, Cosine)
node := NewVectorNode([]float32{1, 0, 0})
cosineIdx.Add(*node)
return cosineIdx.NewSearch().
WithQuery([]float32{0, 0, 0}).
WithK(1)
},
wantErr: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
_, err := tt.setup().Execute()
if tt.wantErr && err == nil {
t.Error("Expected error but got none")
}
if !tt.wantErr && err != nil {
t.Errorf("Unexpected error: %v", err)
}
})
}
}
// TestFlatIndexSearchKBounds tests k parameter edge cases
func TestFlatIndexSearchKBounds(t *testing.T) {
idx, err := NewFlatIndex(3, Euclidean)
if err != nil {
t.Fatalf("NewFlatIndex() error: %v", err)
}
// Add 5 vectors
for i := 0; i < 5; i++ {
node := NewVectorNode([]float32{float32(i), 0, 0})
idx.Add(*node)
}
tests := []struct {
name string
k int
expectedLen int
}{
{"k = 0", 0, 5}, // Should return all
{"k = -1", -1, 5}, // Should return all
{"k = 3", 3, 3}, // Normal case
{"k = 5", 5, 5}, // Exact match
{"k = 100", 100, 5}, // More than available
{"k = 1", 1, 1}, // Minimum
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
results, err := idx.NewSearch().
WithQuery([]float32{0, 0, 0}).
WithK(tt.k).
Execute()
if err != nil {
t.Fatalf("Search() error: %v", err)
}
if len(results) != tt.expectedLen {
t.Errorf("Expected %d results, got %d", tt.expectedLen, len(results))
}
})
}
}
// TestFlatIndexConcurrentSearch tests thread-safety of Search operations
func TestFlatIndexConcurrentSearch(t *testing.T) {
idx, err := NewFlatIndex(3, Euclidean)
if err != nil {
t.Fatalf("NewFlatIndex() error: %v", err)
}
// Add some vectors
for i := 0; i < 100; i++ {
node := NewVectorNode([]float32{float32(i), 0, 0})
idx.Add(*node)
}
const numSearches = 50
var wg sync.WaitGroup
wg.Add(numSearches)
for i := 0; i < numSearches; i++ {
go func(i int) {
defer wg.Done()
query := []float32{float32(i % 10), 0, 0}
_, err := idx.NewSearch().
WithQuery(query).
WithK(10).
Execute()
if err != nil {
t.Errorf("Search() error: %v", err)
}
}(i)
}
wg.Wait()
}
// TestFlatIndexConcurrentAddAndSearch tests concurrent adds and searches
func TestFlatIndexConcurrentAddAndSearch(t *testing.T) {
idx, err := NewFlatIndex(3, Euclidean)
if err != nil {
t.Fatalf("NewFlatIndex() error: %v", err)
}
// Pre-populate with some vectors
for i := 0; i < 50; i++ {
node := NewVectorNode([]float32{float32(i), 0, 0})
idx.Add(*node)
}
var wg sync.WaitGroup
const numOps = 100
// Concurrent adds
wg.Add(numOps)
for i := 0; i < numOps; i++ {
go func(i int) {
defer wg.Done()
node := NewVectorNode([]float32{float32(i + 50), 0, 0})
idx.Add(*node)
}(i)
}
// Concurrent searches
wg.Add(numOps)
for i := 0; i < numOps; i++ {
go func(i int) {
defer wg.Done()
query := []float32{float32(i % 10), 0, 0}
idx.NewSearch().
WithQuery(query).
WithK(5).
Execute()
}(i)
}
wg.Wait()
}
// TestFlatIndexEmptySearch tests searching an empty index
func TestFlatIndexEmptySearch(t *testing.T) {
idx, err := NewFlatIndex(3, Euclidean)
if err != nil {
t.Fatalf("NewFlatIndex() error: %v", err)
}
query := []float32{1, 0, 0}
results, err := idx.NewSearch().
WithQuery(query).
WithK(10).
Execute()
if err != nil {
t.Fatalf("Search() error: %v", err)
}
if len(results) != 0 {
t.Errorf("Expected 0 results from empty index, got %d", len(results))
}
}
// TestFlatIndexSearchResultsOrdered tests that results are properly ordered by distance
func TestFlatIndexSearchResultsOrdered(t *testing.T) {
idx, err := NewFlatIndex(3, Euclidean)
if err != nil {
t.Fatalf("NewFlatIndex() error: %v", err)
}
// Add vectors at different distances from origin
vectors := [][]float32{
{5, 0, 0}, // distance 5
{1, 0, 0}, // distance 1
{10, 0, 0}, // distance 10
{3, 0, 0}, // distance 3
}
for _, v := range vectors {
node := NewVectorNode(v)
idx.Add(*node)
}
query := []float32{0, 0, 0}
results, err := idx.NewSearch().
WithQuery(query).
WithK(4).
Execute()
if err != nil {
t.Fatalf("Search() error: %v", err)
}
// Check that results are ordered by distance
expectedOrder := []float32{1, 3, 5, 10}
for i, expected := range expectedOrder {
if results[i].Node.Vector()[0] != expected {
t.Errorf("Result %d: expected distance %f, got %f", i, expected, results[i].Node.Vector()[0])
}
}
// Verify distances are in ascending order
distance, _ := NewDistance(Euclidean)
for i := 1; i < len(results); i++ {
d1 := distance.Calculate(query, results[i-1].Node.Vector())
d2 := distance.Calculate(query, results[i].Node.Vector())
if d1 > d2 {
t.Errorf("Results not properly ordered: distance[%d]=%f > distance[%d]=%f", i-1, d1, i, d2)
}
}
}
// TestFlatIndexSearchDifferentDistanceMetrics tests all distance metrics
func TestFlatIndexSearchDifferentDistanceMetrics(t *testing.T) {
vectors := [][]float32{
{1, 0, 0},
{0, 1, 0},
{1, 1, 0},
}
metrics := []DistanceKind{Euclidean, Cosine}
for _, metric := range metrics {
t.Run(string(metric), func(t *testing.T) {
idx, err := NewFlatIndex(3, metric)
if err != nil {
t.Fatalf("NewFlatIndex() error: %v", err)
}
for _, v := range vectors {
node := NewVectorNode(v)
err := idx.Add(*node)
if err != nil {
t.Fatalf("Add() error: %v", err)
}
}
query := []float32{1, 0, 0}
results, err := idx.NewSearch().
WithQuery(query).
WithK(2).
Execute()
if err != nil {
t.Fatalf("Search() error: %v", err)
}
if len(results) != 2 {
t.Errorf("Expected 2 results, got %d", len(results))
}
})
}
}
// TestFlatIndexSearchCombinedQueryAndNode tests searching with both queries and node IDs
func TestFlatIndexSearchCombinedQueryAndNode(t *testing.T) {
idx, err := NewFlatIndex(3, Euclidean)
if err != nil {
t.Fatalf("NewFlatIndex() error: %v", err)
}
// Add vectors
vectors := [][]float32{
{1, 0, 0},
{0, 1, 0},
{0, 0, 1},
{2, 0, 0},
}
nodes := make([]*VectorNode, len(vectors))
for i, v := range vectors {
nodes[i] = NewVectorNode(v)
idx.Add(*nodes[i])
}
// Search using both a direct query and a node ID
// Node 0 has vector [1, 0, 0]
// Direct query is [0, 1, 0]
results, err := idx.NewSearch().
WithQuery([]float32{0, 1, 0}).
WithNode(nodes[0].ID()).
WithK(2).
Execute()
if err != nil {
t.Fatalf("Search() error: %v", err)
}
// With aggregation enabled (default), results are deduplicated by node ID
// Query 1: [0, 1, 0] → finds 2 nearest nodes
// Query 2 (node 0): [1, 0, 0] → finds 2 nearest nodes
// These queries may have overlapping results, which are deduplicated
// We expect 2-3 unique results depending on overlap
if len(results) < 2 || len(results) > 3 {
t.Errorf("Expected 2-3 deduplicated results, got %d", len(results))
}
// Verify we got unique node IDs
seenIDs := make(map[uint32]bool)
for _, res := range results {
if seenIDs[res.Node.ID()] {
t.Errorf("Found duplicate node ID %d in results", res.Node.ID())
}
seenIDs[res.Node.ID()] = true
}
}
// TestFlatIndexSearchMultipleQueriesAndNodes tests batch search with mixed queries and nodes
func TestFlatIndexSearchMultipleQueriesAndNodes(t *testing.T) {
idx, err := NewFlatIndex(3, Euclidean)
if err != nil {
t.Fatalf("NewFlatIndex() error: %v", err)
}
// Add vectors
vectors := [][]float32{
{1, 0, 0},
{0, 1, 0},
{0, 0, 1},
{2, 0, 0},
{0, 2, 0},
}
nodes := make([]*VectorNode, len(vectors))
for i, v := range vectors {
nodes[i] = NewVectorNode(v)
idx.Add(*nodes[i])
}
// Search with 2 direct queries and 2 node IDs
results, err := idx.NewSearch().
WithQuery([]float32{1.1, 0, 0}, []float32{0, 1.1, 0}).
WithNode(nodes[2].ID(), nodes[3].ID()).
WithK(2).
Execute()
if err != nil {
t.Fatalf("Search() error: %v", err)
}
// With aggregation enabled (default), results are deduplicated by node ID
// 4 queries (2 direct + 2 from nodes) each returning k=2 results
// Due to overlapping results across queries, we expect fewer than 8 unique results
// We should have at least 2 unique results (the k value)
if len(results) < 2 {
t.Errorf("Expected at least 2 deduplicated results, got %d", len(results))
}
// Verify we got unique node IDs
seenIDs := make(map[uint32]bool)
for _, res := range results {
if seenIDs[res.Node.ID()] {
t.Errorf("Found duplicate node ID %d in results", res.Node.ID())
}
seenIDs[res.Node.ID()] = true
}
}
// TestFlatIndexSearchCombinedWithThreshold tests combined search with threshold
func TestFlatIndexSearchCombinedWithThreshold(t *testing.T) {
idx, err := NewFlatIndex(3, Euclidean)
if err != nil {
t.Fatalf("NewFlatIndex() error: %v", err)
}
// Add vectors
vectors := [][]float32{
{1, 0, 0},
{0, 1, 0},
{0, 0, 1},
{5, 0, 0},
{0, 5, 0},
}
nodes := make([]*VectorNode, len(vectors))
for i, v := range vectors {
nodes[i] = NewVectorNode(v)
idx.Add(*nodes[i])
}
// Search with query and node, but with threshold
results, err := idx.NewSearch().
WithQuery([]float32{1, 0, 0}).
WithNode(nodes[1].ID()). // [0, 1, 0]
WithK(10).
WithThreshold(2.0).
Execute()
if err != nil {
t.Fatalf("Search() error: %v", err)
}
// Both queries should only return vectors within distance 2.0
// Query [1,0,0]: gets [1,0,0] (dist 0), [0,1,0] (dist ~1.41), [0,0,1] (dist ~1.41)
// Query [0,1,0]: gets [0,1,0] (dist 0), [1,0,0] (dist ~1.41), [0,0,1] (dist ~1.41)
// So we should get at most 6 results (with some duplicates being counted separately)
if len(results) == 0 {
t.Error("Expected some results within threshold, got none")
}
}
// Helper functions
func vectorsEqual(v1, v2 []float32) bool {
if len(v1) != len(v2) {
return false
}
for i := range v1 {
if v1[i] != v2[i] {
return false
}
}
return true
}
func vectorsAlmostEqual(v1, v2 []float32, epsilon float32) bool {
if len(v1) != len(v2) {
return false
}
for i := range v1 {
if math.Abs(float64(v1[i]-v2[i])) > float64(epsilon) {
return false
}
}
return true
}