lance-graph 0.5.4

Graph query engine for Lance datasets with Cypher support
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
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
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright The Lance Authors

//! User-Defined Functions (UDFs) for DataFusion
//!
//! This module contains UDF implementations for vector operations used in graph queries.

use crate::ast::DistanceMetric;
use crate::datafusion_planner::vector_ops;
use arrow::array::ArrayRef;
use arrow::datatypes::DataType;
use datafusion::logical_expr::{ScalarUDF, Signature, Volatility};
use datafusion::physical_plan::ColumnarValue;
use std::sync::{Arc, LazyLock};

/// Type alias for UDF function closures
type UdfFunc =
    Arc<dyn Fn(&[ColumnarValue]) -> datafusion::error::Result<ColumnarValue> + Send + Sync>;

/// Vector distance computation function (used by UDF)
///
/// This function handles four cases efficiently:
/// 1. Array vs Array: Pairwise distance computation
/// 2. Array vs Scalar: Broadcast single query vector against all data vectors (memory efficient)
/// 3. Scalar vs Array: Broadcast single query vector against all data vectors (memory efficient)
/// 4. Scalar vs Scalar: Single distance computation
fn vector_distance_func(
    args: &[ColumnarValue],
    metric: &DistanceMetric,
) -> datafusion::error::Result<ColumnarValue> {
    if args.len() != 2 {
        return Err(datafusion::error::DataFusionError::Execution(
            "vector_distance requires exactly 2 arguments".to_string(),
        ));
    }

    match (&args[0], &args[1]) {
        // Case 1: Both are arrays - pairwise or broadcast based on lengths
        (ColumnarValue::Array(left_arr), ColumnarValue::Array(right_arr)) => {
            let left_vectors = vector_ops::extract_vectors(left_arr)
                .map_err(|e| datafusion::error::DataFusionError::Execution(e.to_string()))?;
            let right_vectors = vector_ops::extract_vectors(right_arr)
                .map_err(|e| datafusion::error::DataFusionError::Execution(e.to_string()))?;

            let distances: Vec<f32> = if right_vectors.len() == 1 {
                // Broadcast right against all left vectors
                vector_ops::compute_vector_distances(&left_vectors, &right_vectors[0], metric)
            } else if left_vectors.len() == 1 {
                // Broadcast left against all right vectors
                vector_ops::compute_vector_distances(&right_vectors, &left_vectors[0], metric)
            } else if left_vectors.len() == right_vectors.len() {
                // Pairwise distance computation
                left_vectors
                    .iter()
                    .zip(right_vectors.iter())
                    .map(|(l, r)| match metric {
                        DistanceMetric::L2 => vector_ops::l2_distance(l, r),
                        DistanceMetric::Cosine => vector_ops::cosine_distance(l, r),
                        DistanceMetric::Dot => vector_ops::dot_product_distance(l, r),
                    })
                    .collect()
            } else {
                return Err(datafusion::error::DataFusionError::Execution(format!(
                    "Vector count mismatch: left has {} vectors, right has {}",
                    left_vectors.len(),
                    right_vectors.len()
                )));
            };

            let result = Arc::new(arrow::array::Float32Array::from(distances)) as ArrayRef;
            Ok(ColumnarValue::Array(result))
        }

        // Case 2: Left is array, right is scalar - broadcast scalar against all left vectors
        // This is the common case for similarity search: comparing many vectors to one query
        (ColumnarValue::Array(left_arr), ColumnarValue::Scalar(right_scalar)) => {
            let left_vectors = vector_ops::extract_vectors(left_arr)
                .map_err(|e| datafusion::error::DataFusionError::Execution(e.to_string()))?;

            // Extract single query vector from scalar WITHOUT allocating a full array
            let query_vector = vector_ops::extract_single_vector_from_scalar(right_scalar)
                .map_err(|e| datafusion::error::DataFusionError::Execution(e.to_string()))?;

            let distances =
                vector_ops::compute_vector_distances(&left_vectors, &query_vector, metric);
            let result = Arc::new(arrow::array::Float32Array::from(distances)) as ArrayRef;
            Ok(ColumnarValue::Array(result))
        }

        // Case 3: Left is scalar, right is array - broadcast scalar against all right vectors
        (ColumnarValue::Scalar(left_scalar), ColumnarValue::Array(right_arr)) => {
            let right_vectors = vector_ops::extract_vectors(right_arr)
                .map_err(|e| datafusion::error::DataFusionError::Execution(e.to_string()))?;

            // Extract single query vector from scalar WITHOUT allocating a full array
            let query_vector = vector_ops::extract_single_vector_from_scalar(left_scalar)
                .map_err(|e| datafusion::error::DataFusionError::Execution(e.to_string()))?;

            let distances =
                vector_ops::compute_vector_distances(&right_vectors, &query_vector, metric);
            let result = Arc::new(arrow::array::Float32Array::from(distances)) as ArrayRef;
            Ok(ColumnarValue::Array(result))
        }

        // Case 4: Both are scalars - single distance computation
        (ColumnarValue::Scalar(left_scalar), ColumnarValue::Scalar(right_scalar)) => {
            let left_vec = vector_ops::extract_single_vector_from_scalar(left_scalar)
                .map_err(|e| datafusion::error::DataFusionError::Execution(e.to_string()))?;
            let right_vec = vector_ops::extract_single_vector_from_scalar(right_scalar)
                .map_err(|e| datafusion::error::DataFusionError::Execution(e.to_string()))?;

            let distance = match metric {
                DistanceMetric::L2 => vector_ops::l2_distance(&left_vec, &right_vec),
                DistanceMetric::Cosine => vector_ops::cosine_distance(&left_vec, &right_vec),
                DistanceMetric::Dot => vector_ops::dot_product_distance(&left_vec, &right_vec),
            };

            // Return as scalar since both inputs were scalars
            Ok(ColumnarValue::Scalar(
                datafusion::scalar::ScalarValue::Float32(Some(distance)),
            ))
        }
    }
}

/// Cached vector distance UDFs (one per metric type)
/// These are initialized once and reused across all queries for better performance
static VECTOR_DISTANCE_L2_UDF: LazyLock<Arc<ScalarUDF>> = LazyLock::new(|| {
    let func = move |args: &[ColumnarValue]| -> datafusion::error::Result<ColumnarValue> {
        vector_distance_func(args, &DistanceMetric::L2)
    };

    Arc::new(ScalarUDF::new_from_impl(VectorDistanceUDF {
        name: "vector_distance_l2".to_string(),
        func: Arc::new(func),
        metric: DistanceMetric::L2,
        signature: Signature::any(2, Volatility::Immutable),
    }))
});

static VECTOR_DISTANCE_COSINE_UDF: LazyLock<Arc<ScalarUDF>> = LazyLock::new(|| {
    let func = move |args: &[ColumnarValue]| -> datafusion::error::Result<ColumnarValue> {
        vector_distance_func(args, &DistanceMetric::Cosine)
    };

    Arc::new(ScalarUDF::new_from_impl(VectorDistanceUDF {
        name: "vector_distance_cosine".to_string(),
        func: Arc::new(func),
        metric: DistanceMetric::Cosine,
        signature: Signature::any(2, Volatility::Immutable),
    }))
});

static VECTOR_DISTANCE_DOT_UDF: LazyLock<Arc<ScalarUDF>> = LazyLock::new(|| {
    let func = move |args: &[ColumnarValue]| -> datafusion::error::Result<ColumnarValue> {
        vector_distance_func(args, &DistanceMetric::Dot)
    };

    Arc::new(ScalarUDF::new_from_impl(VectorDistanceUDF {
        name: "vector_distance_dot".to_string(),
        func: Arc::new(func),
        metric: DistanceMetric::Dot,
        signature: Signature::any(2, Volatility::Immutable),
    }))
});

/// Get a cached vector distance UDF for the given distance metric
pub(crate) fn create_vector_distance_udf(metric: &DistanceMetric) -> Arc<ScalarUDF> {
    match metric {
        DistanceMetric::L2 => VECTOR_DISTANCE_L2_UDF.clone(),
        DistanceMetric::Cosine => VECTOR_DISTANCE_COSINE_UDF.clone(),
        DistanceMetric::Dot => VECTOR_DISTANCE_DOT_UDF.clone(),
    }
}

/// Vector similarity computation function (used by UDF)
///
/// This function handles four cases efficiently:
/// 1. Array vs Array: Pairwise similarity computation
/// 2. Array vs Scalar: Broadcast single query vector against all data vectors (memory efficient)
/// 3. Scalar vs Array: Broadcast single query vector against all data vectors (memory efficient)
/// 4. Scalar vs Scalar: Single similarity computation
fn vector_similarity_func(
    args: &[ColumnarValue],
    metric: &DistanceMetric,
) -> datafusion::error::Result<ColumnarValue> {
    if args.len() != 2 {
        return Err(datafusion::error::DataFusionError::Execution(
            "vector_similarity requires exactly 2 arguments".to_string(),
        ));
    }

    // Helper function to compute single similarity value
    let compute_single_similarity = |l: &[f32], r: &[f32]| match metric {
        DistanceMetric::L2 => {
            let dist = vector_ops::l2_distance(l, r);
            if dist == 0.0 {
                1.0
            } else {
                1.0 / (1.0 + dist)
            }
        }
        DistanceMetric::Cosine => vector_ops::cosine_similarity(l, r),
        DistanceMetric::Dot => vector_ops::dot_product_similarity(l, r),
    };

    match (&args[0], &args[1]) {
        // Case 1: Both are arrays - pairwise or broadcast based on lengths
        (ColumnarValue::Array(left_arr), ColumnarValue::Array(right_arr)) => {
            let left_vectors = vector_ops::extract_vectors(left_arr)
                .map_err(|e| datafusion::error::DataFusionError::Execution(e.to_string()))?;
            let right_vectors = vector_ops::extract_vectors(right_arr)
                .map_err(|e| datafusion::error::DataFusionError::Execution(e.to_string()))?;

            let similarities: Vec<f32> = if right_vectors.len() == 1 {
                // Broadcast right against all left vectors
                vector_ops::compute_vector_similarities(&left_vectors, &right_vectors[0], metric)
            } else if left_vectors.len() == 1 {
                // Broadcast left against all right vectors
                vector_ops::compute_vector_similarities(&right_vectors, &left_vectors[0], metric)
            } else if left_vectors.len() == right_vectors.len() {
                // Pairwise similarity computation
                left_vectors
                    .iter()
                    .zip(right_vectors.iter())
                    .map(|(l, r)| compute_single_similarity(l, r))
                    .collect()
            } else {
                return Err(datafusion::error::DataFusionError::Execution(format!(
                    "Vector count mismatch: left has {} vectors, right has {}",
                    left_vectors.len(),
                    right_vectors.len()
                )));
            };

            let result = Arc::new(arrow::array::Float32Array::from(similarities)) as ArrayRef;
            Ok(ColumnarValue::Array(result))
        }

        // Case 2: Left is array, right is scalar - broadcast scalar against all left vectors
        // This is the common case for similarity search: comparing many vectors to one query
        (ColumnarValue::Array(left_arr), ColumnarValue::Scalar(right_scalar)) => {
            let left_vectors = vector_ops::extract_vectors(left_arr)
                .map_err(|e| datafusion::error::DataFusionError::Execution(e.to_string()))?;

            // Extract single query vector from scalar WITHOUT allocating a full array
            let query_vector = vector_ops::extract_single_vector_from_scalar(right_scalar)
                .map_err(|e| datafusion::error::DataFusionError::Execution(e.to_string()))?;

            let similarities =
                vector_ops::compute_vector_similarities(&left_vectors, &query_vector, metric);
            let result = Arc::new(arrow::array::Float32Array::from(similarities)) as ArrayRef;
            Ok(ColumnarValue::Array(result))
        }

        // Case 3: Left is scalar, right is array - broadcast scalar against all right vectors
        (ColumnarValue::Scalar(left_scalar), ColumnarValue::Array(right_arr)) => {
            let right_vectors = vector_ops::extract_vectors(right_arr)
                .map_err(|e| datafusion::error::DataFusionError::Execution(e.to_string()))?;

            // Extract single query vector from scalar WITHOUT allocating a full array
            let query_vector = vector_ops::extract_single_vector_from_scalar(left_scalar)
                .map_err(|e| datafusion::error::DataFusionError::Execution(e.to_string()))?;

            let similarities =
                vector_ops::compute_vector_similarities(&right_vectors, &query_vector, metric);
            let result = Arc::new(arrow::array::Float32Array::from(similarities)) as ArrayRef;
            Ok(ColumnarValue::Array(result))
        }

        // Case 4: Both are scalars - single similarity computation
        (ColumnarValue::Scalar(left_scalar), ColumnarValue::Scalar(right_scalar)) => {
            let left_vec = vector_ops::extract_single_vector_from_scalar(left_scalar)
                .map_err(|e| datafusion::error::DataFusionError::Execution(e.to_string()))?;
            let right_vec = vector_ops::extract_single_vector_from_scalar(right_scalar)
                .map_err(|e| datafusion::error::DataFusionError::Execution(e.to_string()))?;

            let similarity = compute_single_similarity(&left_vec, &right_vec);

            // Return as scalar since both inputs were scalars
            Ok(ColumnarValue::Scalar(
                datafusion::scalar::ScalarValue::Float32(Some(similarity)),
            ))
        }
    }
}

// UDFs are cached using `LazyLock` static variables to avoid recreating them for each query.
// Each distance metric (L2, Cosine, Dot) has its own cached UDF instance for both
// `vector_distance` and `vector_similarity` functions. This provides significant performance
// improvements when executing multiple queries, as UDF initialization only happens once.

static VECTOR_SIMILARITY_L2_UDF: LazyLock<Arc<ScalarUDF>> = LazyLock::new(|| {
    let func = move |args: &[ColumnarValue]| -> datafusion::error::Result<ColumnarValue> {
        vector_similarity_func(args, &DistanceMetric::L2)
    };

    Arc::new(ScalarUDF::new_from_impl(VectorSimilarityUDF {
        name: "vector_similarity_l2".to_string(),
        func: Arc::new(func),
        metric: DistanceMetric::L2,
        signature: Signature::any(2, Volatility::Immutable),
    }))
});

static VECTOR_SIMILARITY_COSINE_UDF: LazyLock<Arc<ScalarUDF>> = LazyLock::new(|| {
    let func = move |args: &[ColumnarValue]| -> datafusion::error::Result<ColumnarValue> {
        vector_similarity_func(args, &DistanceMetric::Cosine)
    };

    Arc::new(ScalarUDF::new_from_impl(VectorSimilarityUDF {
        name: "vector_similarity_cosine".to_string(),
        func: Arc::new(func),
        metric: DistanceMetric::Cosine,
        signature: Signature::any(2, Volatility::Immutable),
    }))
});

static VECTOR_SIMILARITY_DOT_UDF: LazyLock<Arc<ScalarUDF>> = LazyLock::new(|| {
    let func = move |args: &[ColumnarValue]| -> datafusion::error::Result<ColumnarValue> {
        vector_similarity_func(args, &DistanceMetric::Dot)
    };

    Arc::new(ScalarUDF::new_from_impl(VectorSimilarityUDF {
        name: "vector_similarity_dot".to_string(),
        func: Arc::new(func),
        metric: DistanceMetric::Dot,
        signature: Signature::any(2, Volatility::Immutable),
    }))
});

/// Get a cached vector similarity UDF for the given distance metric
pub(crate) fn create_vector_similarity_udf(metric: &DistanceMetric) -> Arc<ScalarUDF> {
    match metric {
        DistanceMetric::L2 => VECTOR_SIMILARITY_L2_UDF.clone(),
        DistanceMetric::Cosine => VECTOR_SIMILARITY_COSINE_UDF.clone(),
        DistanceMetric::Dot => VECTOR_SIMILARITY_DOT_UDF.clone(),
    }
}

/// UDF implementation for vector distance
struct VectorDistanceUDF {
    name: String,
    func: UdfFunc,
    metric: DistanceMetric,
    signature: Signature,
}

impl std::fmt::Debug for VectorDistanceUDF {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("VectorDistanceUDF")
            .field("name", &self.name)
            .field("metric", &self.metric)
            .finish()
    }
}

impl datafusion::logical_expr::ScalarUDFImpl for VectorDistanceUDF {
    fn as_any(&self) -> &dyn std::any::Any {
        self
    }

    fn name(&self) -> &str {
        &self.name
    }

    fn signature(&self) -> &Signature {
        &self.signature
    }

    fn return_type(&self, _arg_types: &[DataType]) -> datafusion::error::Result<DataType> {
        Ok(DataType::Float32)
    }

    fn invoke_with_args(
        &self,
        args: datafusion::logical_expr::ScalarFunctionArgs,
    ) -> datafusion::error::Result<ColumnarValue> {
        (self.func)(&args.args)
    }
}

impl PartialEq for VectorDistanceUDF {
    fn eq(&self, other: &Self) -> bool {
        self.name == other.name && self.metric == other.metric
        // Note: signature is structural so we don't compare it
    }
}

impl Eq for VectorDistanceUDF {}

impl std::hash::Hash for VectorDistanceUDF {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        self.name.hash(state);
    }
}

/// UDF implementation for vector similarity
struct VectorSimilarityUDF {
    name: String,
    func: UdfFunc,
    metric: DistanceMetric,
    signature: Signature,
}

impl std::fmt::Debug for VectorSimilarityUDF {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("VectorSimilarityUDF")
            .field("name", &self.name)
            .field("metric", &self.metric)
            .finish()
    }
}

impl datafusion::logical_expr::ScalarUDFImpl for VectorSimilarityUDF {
    fn as_any(&self) -> &dyn std::any::Any {
        self
    }

    fn name(&self) -> &str {
        &self.name
    }

    fn signature(&self) -> &Signature {
        &self.signature
    }

    fn return_type(&self, _arg_types: &[DataType]) -> datafusion::error::Result<DataType> {
        Ok(DataType::Float32)
    }

    fn invoke_with_args(
        &self,
        args: datafusion::logical_expr::ScalarFunctionArgs,
    ) -> datafusion::error::Result<ColumnarValue> {
        (self.func)(&args.args)
    }
}

impl PartialEq for VectorSimilarityUDF {
    fn eq(&self, other: &Self) -> bool {
        self.name == other.name && self.metric == other.metric
        // Note: signature is structural so we don't compare it
    }
}

impl Eq for VectorSimilarityUDF {}

impl std::hash::Hash for VectorSimilarityUDF {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        self.name.hash(state);
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use arrow::array::{Array, FixedSizeListArray, Float32Array};
    use arrow::datatypes::{DataType, Field};
    use std::sync::Arc;

    /// Helper to create a FixedSizeListArray from vectors
    fn create_vector_array(vectors: Vec<Vec<f32>>) -> ArrayRef {
        let dim = vectors[0].len() as i32;
        let mut values = Vec::new();
        for vec in vectors {
            values.extend(vec);
        }

        let field = Arc::new(Field::new("item", DataType::Float32, true));
        let value_array = Arc::new(Float32Array::from(values));
        Arc::new(FixedSizeListArray::try_new(field, dim, value_array, None).unwrap())
    }

    #[test]
    fn test_vector_distance_l2_udf() {
        // Create test vectors: [1,0,0] and [0,1,0]
        let left = create_vector_array(vec![vec![1.0, 0.0, 0.0]]);
        let right = create_vector_array(vec![vec![0.0, 1.0, 0.0]]);

        let args = vec![ColumnarValue::Array(left), ColumnarValue::Array(right)];

        // Call the distance function directly
        let result = super::vector_distance_func(&args, &DistanceMetric::L2).unwrap();

        if let ColumnarValue::Array(arr) = result {
            let float_arr = arr.as_any().downcast_ref::<Float32Array>().unwrap();
            assert_eq!(float_arr.len(), 1);
            // Distance should be sqrt(2) ≈ 1.414
            assert!((float_arr.value(0) - 1.414).abs() < 0.01);
        } else {
            panic!("Expected array result");
        }
    }

    #[test]
    fn test_vector_distance_cosine_udf() {
        // Create identical vectors: [1,0,0] and [1,0,0]
        let left = create_vector_array(vec![vec![1.0, 0.0, 0.0]]);
        let right = create_vector_array(vec![vec![1.0, 0.0, 0.0]]);

        let args = vec![ColumnarValue::Array(left), ColumnarValue::Array(right)];

        let result = super::vector_distance_func(&args, &DistanceMetric::Cosine).unwrap();

        if let ColumnarValue::Array(arr) = result {
            let float_arr = arr.as_any().downcast_ref::<Float32Array>().unwrap();
            assert_eq!(float_arr.len(), 1);
            // Cosine distance of identical vectors should be 0
            assert_eq!(float_arr.value(0), 0.0);
        } else {
            panic!("Expected array result");
        }
    }

    #[test]
    fn test_vector_similarity_cosine_udf() {
        // Create identical vectors: [1,0,0] and [1,0,0]
        let left = create_vector_array(vec![vec![1.0, 0.0, 0.0]]);
        let right = create_vector_array(vec![vec![1.0, 0.0, 0.0]]);

        let args = vec![ColumnarValue::Array(left), ColumnarValue::Array(right)];

        let result = super::vector_similarity_func(&args, &DistanceMetric::Cosine).unwrap();

        if let ColumnarValue::Array(arr) = result {
            let float_arr = arr.as_any().downcast_ref::<Float32Array>().unwrap();
            assert_eq!(float_arr.len(), 1);
            // Cosine similarity of identical vectors should be 1.0
            assert_eq!(float_arr.value(0), 1.0);
        } else {
            panic!("Expected array result");
        }
    }

    #[test]
    fn test_vector_distance_broadcast() {
        // Multiple left vectors, single right vector (broadcast)
        let left = create_vector_array(vec![
            vec![1.0, 0.0, 0.0],
            vec![0.0, 1.0, 0.0],
            vec![0.0, 0.0, 1.0],
        ]);
        let right = create_vector_array(vec![vec![1.0, 0.0, 0.0]]);

        let args = vec![ColumnarValue::Array(left), ColumnarValue::Array(right)];

        let result = super::vector_distance_func(&args, &DistanceMetric::L2).unwrap();

        if let ColumnarValue::Array(arr) = result {
            let float_arr = arr.as_any().downcast_ref::<Float32Array>().unwrap();
            assert_eq!(float_arr.len(), 3);
            assert_eq!(float_arr.value(0), 0.0); // Identical
            assert!((float_arr.value(1) - 1.414).abs() < 0.01); // Orthogonal
            assert!((float_arr.value(2) - 1.414).abs() < 0.01); // Orthogonal
        } else {
            panic!("Expected array result");
        }
    }

    #[test]
    fn test_vector_distance_wrong_arg_count() {
        let left = create_vector_array(vec![vec![1.0, 0.0, 0.0]]);

        // Only 1 argument (should fail)
        let args = vec![ColumnarValue::Array(left)];

        let result = super::vector_distance_func(&args, &DistanceMetric::L2);
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .to_string()
            .contains("requires exactly 2 arguments"));
    }

    /// Helper to create a scalar from a single vector
    fn create_vector_scalar(vec: Vec<f32>) -> datafusion::scalar::ScalarValue {
        use datafusion::scalar::ScalarValue;

        let dim = vec.len() as i32;
        let field = Arc::new(Field::new("item", DataType::Float32, true));
        let values = Arc::new(Float32Array::from(vec));
        let list_array = FixedSizeListArray::try_new(field, dim, values, None).unwrap();

        ScalarValue::try_from_array(&list_array, 0).unwrap()
    }

    #[test]
    fn test_vector_distance_array_vs_scalar() {
        // Test memory-efficient scalar broadcast: array of vectors vs single scalar query
        let left = create_vector_array(vec![
            vec![1.0, 0.0, 0.0],
            vec![0.0, 1.0, 0.0],
            vec![0.0, 0.0, 1.0],
        ]);
        let right_scalar = create_vector_scalar(vec![1.0, 0.0, 0.0]);

        let args = vec![
            ColumnarValue::Array(left),
            ColumnarValue::Scalar(right_scalar),
        ];

        let result = super::vector_distance_func(&args, &DistanceMetric::L2).unwrap();

        if let ColumnarValue::Array(arr) = result {
            let float_arr = arr.as_any().downcast_ref::<Float32Array>().unwrap();
            assert_eq!(float_arr.len(), 3);
            assert_eq!(float_arr.value(0), 0.0); // Identical to query
            assert!((float_arr.value(1) - 1.414).abs() < 0.01); // Orthogonal
            assert!((float_arr.value(2) - 1.414).abs() < 0.01); // Orthogonal
        } else {
            panic!("Expected array result");
        }
    }

    #[test]
    fn test_vector_distance_scalar_vs_array() {
        // Test the reverse: scalar query vs array of vectors
        let left_scalar = create_vector_scalar(vec![1.0, 0.0, 0.0]);
        let right = create_vector_array(vec![vec![1.0, 0.0, 0.0], vec![0.0, 1.0, 0.0]]);

        let args = vec![
            ColumnarValue::Scalar(left_scalar),
            ColumnarValue::Array(right),
        ];

        let result = super::vector_distance_func(&args, &DistanceMetric::Cosine).unwrap();

        if let ColumnarValue::Array(arr) = result {
            let float_arr = arr.as_any().downcast_ref::<Float32Array>().unwrap();
            assert_eq!(float_arr.len(), 2);
            assert_eq!(float_arr.value(0), 0.0); // Identical to query (cosine distance = 0)
            assert_eq!(float_arr.value(1), 1.0); // Orthogonal (cosine distance = 1)
        } else {
            panic!("Expected array result");
        }
    }

    #[test]
    fn test_vector_distance_scalar_vs_scalar() {
        // Test scalar vs scalar - should return a scalar result
        let left_scalar = create_vector_scalar(vec![1.0, 0.0, 0.0]);
        let right_scalar = create_vector_scalar(vec![0.0, 1.0, 0.0]);

        let args = vec![
            ColumnarValue::Scalar(left_scalar),
            ColumnarValue::Scalar(right_scalar),
        ];

        let result = super::vector_distance_func(&args, &DistanceMetric::L2).unwrap();

        // Should return a scalar, not an array
        if let ColumnarValue::Scalar(scalar) = result {
            if let datafusion::scalar::ScalarValue::Float32(Some(dist)) = scalar {
                assert!((dist - 1.414).abs() < 0.01); // sqrt(2) for orthogonal unit vectors
            } else {
                panic!("Expected Float32 scalar");
            }
        } else {
            panic!("Expected scalar result for scalar vs scalar");
        }
    }

    #[test]
    fn test_vector_similarity_array_vs_scalar() {
        // Test memory-efficient scalar broadcast for similarity
        let left = create_vector_array(vec![
            vec![1.0, 0.0, 0.0],
            vec![0.0, 1.0, 0.0],
            vec![0.707, 0.707, 0.0], // 45 degrees
        ]);
        let right_scalar = create_vector_scalar(vec![1.0, 0.0, 0.0]);

        let args = vec![
            ColumnarValue::Array(left),
            ColumnarValue::Scalar(right_scalar),
        ];

        let result = super::vector_similarity_func(&args, &DistanceMetric::Cosine).unwrap();

        if let ColumnarValue::Array(arr) = result {
            let float_arr = arr.as_any().downcast_ref::<Float32Array>().unwrap();
            assert_eq!(float_arr.len(), 3);
            assert_eq!(float_arr.value(0), 1.0); // Identical to query
            assert_eq!(float_arr.value(1), 0.0); // Orthogonal
            assert!((float_arr.value(2) - 0.707).abs() < 0.01); // cos(45°) ≈ 0.707
        } else {
            panic!("Expected array result");
        }
    }

    #[test]
    fn test_vector_similarity_scalar_vs_scalar() {
        // Test scalar vs scalar for similarity
        let left_scalar = create_vector_scalar(vec![1.0, 0.0, 0.0]);
        let right_scalar = create_vector_scalar(vec![1.0, 0.0, 0.0]);

        let args = vec![
            ColumnarValue::Scalar(left_scalar),
            ColumnarValue::Scalar(right_scalar),
        ];

        let result = super::vector_similarity_func(&args, &DistanceMetric::Cosine).unwrap();

        // Should return a scalar, not an array
        if let ColumnarValue::Scalar(scalar) = result {
            if let datafusion::scalar::ScalarValue::Float32(Some(sim)) = scalar {
                assert_eq!(sim, 1.0); // Identical vectors have similarity 1.0
            } else {
                panic!("Expected Float32 scalar");
            }
        } else {
            panic!("Expected scalar result for scalar vs scalar");
        }
    }

    #[test]
    fn test_vector_distance_dot_product_with_scalar() {
        // Test dot product metric with scalar broadcast
        let left = create_vector_array(vec![vec![1.0, 0.0, 0.0], vec![0.9, 0.1, 0.0]]);
        let right_scalar = create_vector_scalar(vec![1.0, 0.0, 0.0]);

        let args = vec![
            ColumnarValue::Array(left),
            ColumnarValue::Scalar(right_scalar),
        ];

        let result = super::vector_distance_func(&args, &DistanceMetric::Dot).unwrap();

        if let ColumnarValue::Array(arr) = result {
            let float_arr = arr.as_any().downcast_ref::<Float32Array>().unwrap();
            assert_eq!(float_arr.len(), 2);
            // Dot product distance = -dot_product
            assert_eq!(float_arr.value(0), -1.0); // -1.0 * 1.0 = -1.0
            assert!((float_arr.value(1) + 0.9).abs() < 0.01); // -(0.9 * 1.0) = -0.9
        } else {
            panic!("Expected array result");
        }
    }
}