scirs2-interpolate 0.4.1

Interpolation module for SciRS2 (scirs2-interpolate)
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
//! Auto-generated module
//!
//! 🤖 Generated with [SplitRS](https://github.com/cool-japan/splitrs)

use crate::error::{InterpolateError, InterpolateResult};
use scirs2_core::ndarray::{Array2, ArrayView1, ArrayView2, Axis};
use scirs2_core::numeric::{Float, FromPrimitive};
use scirs2_core::parallel_ops::*;
use std::fmt::Debug;

use super::types::{EnhancedNearestNeighborSearcher, IndexType, SearchConfig};

/// Create an enhanced nearest neighbor searcher with automatic index selection
///
/// This function automatically chooses the best spatial index based on the
/// characteristics of the input data.
///
/// # Arguments
///
/// * `points` - Training data points with shape (n_points, n_dims)
/// * `config` - Optional search configuration (uses defaults if None)
///
/// # Returns
///
/// A configured enhanced nearest neighbor searcher
///
/// # Examples
///
/// ```rust
/// use scirs2_core::ndarray::Array2;
/// use scirs2_interpolate::spatial::enhanced_search::{
///     make_enhanced_searcher, SearchConfig
/// };
///
/// let points = Array2::from_shape_vec((100, 3), (0..300).map(|x| x as f64).collect()).expect("Operation failed");
/// let searcher = make_enhanced_searcher(points, None).expect("Operation failed");
/// ```
#[allow(dead_code)]
pub fn make_enhanced_searcher<F>(
    points: Array2<F>,
    config: Option<SearchConfig>,
) -> InterpolateResult<EnhancedNearestNeighborSearcher<F>>
where
    F: Float + FromPrimitive + Debug + Send + Sync + 'static,
{
    let config = config.unwrap_or_default();
    EnhancedNearestNeighborSearcher::new(points, IndexType::Adaptive, config)
}
/// Create a high-performance searcher optimized for large datasets
///
/// This function creates a searcher specifically optimized for large datasets
/// with features like parallel processing and approximate search.
///
/// # Arguments
///
/// * `points` - Training data points with shape (n_points, n_dims)
/// * `approximation_factor` - Approximation factor (1.0 = exact, >1.0 = approximate)
/// * `num_threads` - Number of threads for parallel processing (None = auto)
///
/// # Returns
///
/// A high-performance nearest neighbor searcher
#[allow(dead_code)]
pub fn make_high_performance_searcher<F>(
    points: Array2<F>,
    approximation_factor: f64,
    num_threads: Option<usize>,
) -> InterpolateResult<EnhancedNearestNeighborSearcher<F>>
where
    F: Float + FromPrimitive + Debug + Send + Sync + 'static,
{
    let config = SearchConfig {
        approximation_factor,
        parallel_search: true,
        num_threads,
        cache_results: true,
        adaptive_indexing: true,
        ..Default::default()
    };
    let index_type = if approximation_factor > 1.0 {
        IndexType::LSH
    } else {
        IndexType::Adaptive
    };
    EnhancedNearestNeighborSearcher::new(points, index_type, config)
}
#[cfg(test)]
mod tests {
    use super::*;
    use scirs2_core::ndarray::array;
    #[test]
    fn test_enhanced_searcher_creation() {
        let points = array![[0.0, 0.0], [1.0, 0.0], [0.0, 1.0], [1.0, 1.0]];
        let config = SearchConfig::default();
        let searcher = EnhancedNearestNeighborSearcher::new(points, IndexType::BruteForce, config);
        assert!(searcher.is_ok());
    }
    #[test]
    fn test_brute_force_knn() {
        let points = array![[0.0, 0.0], [1.0, 0.0], [0.0, 1.0], [1.0, 1.0]];
        let config = SearchConfig::default();
        let mut searcher =
            EnhancedNearestNeighborSearcher::new(points, IndexType::BruteForce, config)
                .expect("Operation failed");
        let query = array![0.5, 0.5];
        let neighbors = searcher
            .k_nearest_neighbors(&query.view(), 2)
            .expect("Operation failed");
        assert_eq!(neighbors.len(), 2);
        assert!((neighbors[0].1 - neighbors[1].1).abs() < 1e-10);
    }
    #[test]
    fn test_radius_search() {
        let points = array![[0.0, 0.0], [1.0, 0.0], [0.0, 1.0], [1.0, 1.0], [2.0, 2.0]];
        let config = SearchConfig::default();
        let mut searcher =
            EnhancedNearestNeighborSearcher::new(points, IndexType::BruteForce, config)
                .expect("Operation failed");
        let query = array![0.5, 0.5];
        let neighbors = searcher
            .radius_neighbors(&query.view(), 1.0)
            .expect("Operation failed");
        assert_eq!(neighbors.len(), 4);
    }
    #[test]
    fn test_batch_search() {
        let points = array![[0.0, 0.0], [1.0, 0.0], [0.0, 1.0], [1.0, 1.0]];
        let config = SearchConfig::default();
        let mut searcher =
            EnhancedNearestNeighborSearcher::new(points, IndexType::BruteForce, config)
                .expect("Operation failed");
        let queries = array![[0.1, 0.1], [0.9, 0.9]];
        let results = searcher
            .batch_k_nearest_neighbors(&queries.view(), 2)
            .expect("Operation failed");
        assert_eq!(results.len(), 2);
        assert_eq!(results[0].len(), 2);
        assert_eq!(results[1].len(), 2);
    }
    #[test]
    fn test_cache_functionality() {
        let points = array![[0.0, 0.0], [1.0, 0.0], [0.0, 1.0], [1.0, 1.0]];
        let config = SearchConfig {
            cache_results: true,
            ..Default::default()
        };
        let mut searcher =
            EnhancedNearestNeighborSearcher::new(points, IndexType::BruteForce, config)
                .expect("Operation failed");
        let query = array![0.5, 0.5];
        let _neighbors1 = searcher
            .k_nearest_neighbors(&query.view(), 2)
            .expect("Operation failed");
        assert_eq!(searcher.stats().cache_hits, 0);
        let _neighbors2 = searcher
            .k_nearest_neighbors(&query.view(), 2)
            .expect("Operation failed");
        assert_eq!(searcher.stats().cache_hits, 1);
        assert!(searcher.cache_hit_ratio() > 0.0);
    }
    #[test]
    fn test_make_enhanced_searcher() {
        let points = array![[0.0, 0.0], [1.0, 0.0], [0.0, 1.0], [1.0, 1.0]];
        let searcher = make_enhanced_searcher(points, None);
        assert!(searcher.is_ok());
    }
    #[test]
    fn test_kdtree_basic_functionality() {
        let points = array![[0.0, 0.0], [1.0, 0.0], [0.0, 1.0], [1.0, 1.0], [0.5, 0.5]];
        let config = SearchConfig::default();
        let mut searcher =
            EnhancedNearestNeighborSearcher::new(points.clone(), IndexType::KdTree, config)
                .expect("Operation failed");
        let query = array![0.6, 0.6];
        let neighbors = searcher
            .k_nearest_neighbors(&query.view(), 3)
            .expect("Operation failed");
        for i in 1..neighbors.len() {
            assert!(neighbors[i].1 >= neighbors[i - 1].1);
        }
        assert_eq!(neighbors.len(), 3);
        assert_eq!(neighbors[0].0, 4);
        assert!(neighbors[0].1 < 0.2);
        assert!(neighbors[1].1 < 1.0);
        assert!(neighbors[2].1 < 1.0);
    }
    #[test]
    fn test_kdtree_radius_search() {
        let points = array![
            [0.0, 0.0],
            [1.0, 0.0],
            [0.0, 1.0],
            [1.0, 1.0],
            [3.0, 3.0],
            [0.1, 0.1]
        ];
        let config = SearchConfig::default();
        let mut searcher =
            EnhancedNearestNeighborSearcher::new(points.clone(), IndexType::KdTree, config)
                .expect("Operation failed");
        let query = array![0.0, 0.0];
        let neighbors = searcher
            .radius_neighbors(&query.view(), 1.5)
            .expect("Operation failed");
        assert_eq!(neighbors.len(), 5);
        for (_, dist) in &neighbors {
            assert!(*dist <= 1.5);
        }
        for i in 1..neighbors.len() {
            assert!(neighbors[i].1 >= neighbors[i - 1].1);
        }
    }
    #[test]
    fn test_kdtree_single_point() {
        let points = array![[1.0, 2.0]];
        let config = SearchConfig::default();
        let mut searcher = EnhancedNearestNeighborSearcher::new(points, IndexType::KdTree, config)
            .expect("Operation failed");
        let query = array![0.0, 0.0];
        let neighbors = searcher
            .k_nearest_neighbors(&query.view(), 1)
            .expect("Operation failed");
        assert_eq!(neighbors.len(), 1);
        assert_eq!(neighbors[0].0, 0);
        assert!((neighbors[0].1 - 5.0_f64.sqrt()).abs() < 1e-10);
    }
    #[test]
    fn test_kdtree_high_dimensional() {
        let points = array![
            [0.0, 0.0, 0.0, 0.0, 0.0],
            [1.0, 0.0, 0.0, 0.0, 0.0],
            [0.0, 1.0, 0.0, 0.0, 0.0],
            [0.0, 0.0, 1.0, 0.0, 0.0],
            [0.0, 0.0, 0.0, 1.0, 0.0],
            [0.0, 0.0, 0.0, 0.0, 1.0],
            [0.2, 0.2, 0.2, 0.2, 0.2]
        ];
        let config = SearchConfig::default();
        let mut searcher =
            EnhancedNearestNeighborSearcher::new(points.clone(), IndexType::KdTree, config)
                .expect("Operation failed");
        let query = array![0.1, 0.1, 0.1, 0.1, 0.1];
        let neighbors = searcher
            .k_nearest_neighbors(&query.view(), 2)
            .expect("Operation failed");
        assert_eq!(neighbors.len(), 2);
        assert!(neighbors[0].0 == 0 || neighbors[0].0 == 6);
        assert!(neighbors[0].1 < 0.3);
        assert!(neighbors[1].1 < 1.0);
    }
    #[test]
    fn test_balltree_basic_functionality() {
        let points = array![
            [0.0, 0.0],
            [1.0, 0.0],
            [0.0, 1.0],
            [1.0, 1.0],
            [0.5, 0.5],
            [2.0, 1.0],
            [1.0, 2.0]
        ];
        let config = SearchConfig::default();
        let mut searcher =
            EnhancedNearestNeighborSearcher::new(points.clone(), IndexType::BallTree, config)
                .expect("Operation failed");
        let query = array![0.6, 0.6];
        let neighbors = searcher
            .k_nearest_neighbors(&query.view(), 3)
            .expect("Operation failed");
        assert_eq!(neighbors.len(), 3);
        assert_eq!(neighbors[0].0, 4);
        for i in 1..neighbors.len() {
            assert!(neighbors[i].1 >= neighbors[i - 1].1);
        }
    }
    #[test]
    fn test_balltree_radius_search() {
        let points = array![
            [0.0, 0.0],
            [1.0, 0.0],
            [0.0, 1.0],
            [1.0, 1.0],
            [5.0, 5.0],
            [0.2, 0.2]
        ];
        let config = SearchConfig::default();
        let mut searcher =
            EnhancedNearestNeighborSearcher::new(points.clone(), IndexType::BallTree, config)
                .expect("Operation failed");
        let query = array![0.0, 0.0];
        let neighbors = searcher
            .radius_neighbors(&query.view(), 2.0)
            .expect("Operation failed");
        assert_eq!(neighbors.len(), 5);
        for (_, dist) in &neighbors {
            assert!(*dist <= 2.0);
        }
        for i in 1..neighbors.len() {
            assert!(neighbors[i].1 >= neighbors[i - 1].1);
        }
    }
    #[test]
    fn test_balltree_empty_results() {
        let points = array![[10.0, 10.0], [11.0, 10.0], [10.0, 11.0], [11.0, 11.0]];
        let config = SearchConfig::default();
        let mut searcher =
            EnhancedNearestNeighborSearcher::new(points, IndexType::BallTree, config)
                .expect("Operation failed");
        let query = array![0.0, 0.0];
        let neighbors = searcher
            .radius_neighbors(&query.view(), 1.0)
            .expect("Operation failed");
        assert_eq!(neighbors.len(), 0);
    }
    #[test]
    fn test_balltree_high_dimensional() {
        let points = array![
            [1.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
            [0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
            [0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 0.0],
            [0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0],
            [0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0],
            [0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0],
            [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0],
            [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0],
            [0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1]
        ];
        let config = SearchConfig::default();
        let mut searcher =
            EnhancedNearestNeighborSearcher::new(points, IndexType::BallTree, config)
                .expect("Operation failed");
        let query = array![0.05, 0.05, 0.05, 0.05, 0.05, 0.05, 0.05, 0.05];
        let neighbors = searcher
            .k_nearest_neighbors(&query.view(), 3)
            .expect("Operation failed");
        assert_eq!(neighbors.len(), 3);
        assert_eq!(neighbors[0].0, 8);
    }
    #[test]
    fn test_balltree_single_point() {
        let points = array![[3.0, 4.0]];
        let config = SearchConfig::default();
        let mut searcher =
            EnhancedNearestNeighborSearcher::new(points, IndexType::BallTree, config)
                .expect("Operation failed");
        let query = array![0.0, 0.0];
        let neighbors = searcher
            .k_nearest_neighbors(&query.view(), 1)
            .expect("Operation failed");
        assert_eq!(neighbors.len(), 1);
        assert_eq!(neighbors[0].0, 0);
        assert!((neighbors[0].1 - 5.0).abs() < 1e-10);
    }
    #[test]
    fn test_kdtree_vs_balltree_consistency() {
        let points = array![
            [0.0, 0.0],
            [1.0, 0.0],
            [0.0, 1.0],
            [1.0, 1.0],
            [0.5, 0.5],
            [2.0, 2.0],
            [0.2, 0.8],
            [0.8, 0.2]
        ];
        let config = SearchConfig::default();
        let mut kdtree_searcher =
            EnhancedNearestNeighborSearcher::new(points.clone(), IndexType::KdTree, config.clone())
                .expect("Operation failed");
        let mut balltree_searcher =
            EnhancedNearestNeighborSearcher::new(points.clone(), IndexType::BallTree, config)
                .expect("Operation failed");
        let query = array![0.3, 0.7];
        let k = 4;
        let kdtree_neighbors = kdtree_searcher
            .k_nearest_neighbors(&query.view(), k)
            .expect("Operation failed");
        let balltree_neighbors = balltree_searcher
            .k_nearest_neighbors(&query.view(), k)
            .expect("Operation failed");
        assert_eq!(kdtree_neighbors.len(), balltree_neighbors.len());
        let mut kdtree_sorted = kdtree_neighbors.clone();
        let mut balltree_sorted = balltree_neighbors.clone();
        kdtree_sorted.sort_by_key(|&(idx, _)| idx);
        balltree_sorted.sort_by_key(|&(idx, _)| idx);
        for i in 0..k {
            assert_eq!(kdtree_sorted[i].0, balltree_sorted[i].0);
            assert!((kdtree_sorted[i].1 - balltree_sorted[i].1).abs() < 1e-10);
        }
    }
    #[test]
    fn test_performance_statistics() {
        let points = array![
            [0.0, 0.0],
            [1.0, 0.0],
            [0.0, 1.0],
            [1.0, 1.0],
            [2.0, 0.0],
            [0.0, 2.0],
            [2.0, 2.0],
            [1.0, 0.5],
            [0.5, 1.0],
            [1.5, 1.5]
        ];
        let config = SearchConfig::default();
        let mut searcher = EnhancedNearestNeighborSearcher::new(points, IndexType::KdTree, config)
            .expect("Operation failed");
        let query = array![0.5, 0.5];
        let _neighbors = searcher
            .k_nearest_neighbors(&query.view(), 3)
            .expect("Operation failed");
        let stats = searcher.stats();
        assert!(stats.total_queries > 0);
        assert!(stats.nodes_visited > 0);
    }
}