kiddo 6.0.0

A high-performance, flexible, ergonomic k-d tree library. Ideal for geo- and astro- nearest-neighbour and k-nearest-neighbor queries
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

use core::arch::aarch64::{float32x4_t, float64x2_t};

/// NEON f64 leaf-kernel operations contract.
pub trait NeonF64LeafOps {
    /// Calculate distance on 2 f64 lanes for the first dimension.
    unsafe fn dist_k0_f64x2(delta: float64x2_t) -> float64x2_t;

    /// Accumulate distance on 2 f64 lanes for subsequent dimensions.
    unsafe fn dist_kn_f64x2(acc: float64x2_t, delta: float64x2_t) -> float64x2_t;

    /// Calculate scalar f64 distance for the first dimension.
    fn dist_k0_f64x1(delta: f64) -> f64;

    /// Accumulate scalar f64 distance for subsequent dimensions.
    fn dist_kn_f64x1(acc: f64, delta: f64) -> f64;
}

/// Placeholder implementation for metrics without NEON f64 specializations.
pub struct UnsupportedNeonF64LeafOps;

impl NeonF64LeafOps for UnsupportedNeonF64LeafOps {
    #[inline(always)]
    unsafe fn dist_k0_f64x2(_delta: float64x2_t) -> float64x2_t {
        panic!("NEON f64 leaf ops are not implemented for this metric")
    }

    #[inline(always)]
    unsafe fn dist_kn_f64x2(_acc: float64x2_t, _delta: float64x2_t) -> float64x2_t {
        panic!("NEON f64 leaf ops are not implemented for this metric")
    }

    #[inline(always)]
    fn dist_k0_f64x1(_delta: f64) -> f64 {
        panic!("NEON f64 leaf ops are not implemented for this metric")
    }

    #[inline(always)]
    fn dist_kn_f64x1(_acc: f64, _delta: f64) -> f64 {
        panic!("NEON f64 leaf ops are not implemented for this metric")
    }
}

/// NEON f32 leaf-kernel operations contract.
pub trait NeonF32LeafOps {
    /// Calculate distance on 4 f32 lanes for the first dimension.
    unsafe fn dist_k0_f32x4(delta: float32x4_t) -> float32x4_t;

    /// Accumulate distance on 4 f32 lanes for subsequent dimensions.
    unsafe fn dist_kn_f32x4(acc: float32x4_t, delta: float32x4_t) -> float32x4_t;

    /// Calculate scalar f32 distance for the first dimension.
    fn dist_k0_f32x1(delta: f32) -> f32;

    /// Accumulate scalar f32 distance for subsequent dimensions.
    fn dist_kn_f32x1(acc: f32, delta: f32) -> f32;
}

/// Placeholder implementation for metrics without NEON f32 specializations.
pub struct UnsupportedNeonF32LeafOps;

impl NeonF32LeafOps for UnsupportedNeonF32LeafOps {
    #[inline(always)]
    unsafe fn dist_k0_f32x4(_delta: float32x4_t) -> float32x4_t {
        panic!("NEON f32 leaf ops are not implemented for this metric")
    }

    #[inline(always)]
    unsafe fn dist_kn_f32x4(_acc: float32x4_t, _delta: float32x4_t) -> float32x4_t {
        panic!("NEON f32 leaf ops are not implemented for this metric")
    }

    #[inline(always)]
    fn dist_k0_f32x1(_delta: f32) -> f32 {
        panic!("NEON f32 leaf ops are not implemented for this metric")
    }

    #[inline(always)]
    fn dist_kn_f32x1(_acc: f32, _delta: f32) -> f32 {
        panic!("NEON f32 leaf ops are not implemented for this metric")
    }
}