primal-barracuda 0.4.0

barraCuda — BARrier-free Rust Abstracted Cross-platform Unified Dimensional Algebra. Vendor-agnostic GPU compute via WGSL.
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
// SPDX-License-Identifier: AGPL-3.0-or-later
//! Spatial Interpolation (Ordinary Kriging) at f64 precision
//!
//! UNIFIED PATTERN (Feb 16 2026) — Serves multiple springs:
//! - airSpring: Soil moisture mapping from sparse sensors to field grid
//! - wetSpring: Sample interpolation across sampling sites
//! - General: Any spatial data interpolation with uncertainty estimation
//!
//! # Architecture
//!
//! Kriging provides the Best Linear Unbiased Predictor (BLUP) for spatial data:
//! 1. Build covariance matrix K from variogram model
//! 2. Solve kriging system Kw = k for weights
//! 3. Interpolate: z* = Σ `w_i` * `z_i` with variance estimate
//!
//! # Variogram Models
//!
//! - Spherical: Most common, bounded
//! - Exponential: Unbounded, reaches sill asymptotically
//! - Gaussian: Very smooth, for continuous phenomena
//! - Linear: Simple, bounded
//!
//! # Example
//!
//! ```rust,ignore
//! use barracuda::ops::kriging_f64::{KrigingF64, VariogramModel};
//!
//! // Known sensor locations with soil moisture readings
//! let known_points = vec![
//!     (0.0, 0.0, 0.35),  // (x, y, moisture)
//!     (10.0, 0.0, 0.28),
//!     (0.0, 10.0, 0.32),
//!     (10.0, 10.0, 0.30),
//! ];
//!
//! // Target grid points to interpolate
//! let target_points = vec![(5.0, 5.0), (2.5, 2.5), (7.5, 7.5)];
//!
//! let kriging = KrigingF64::new(device.clone())?;
//! let (interpolated, variances) = kriging.interpolate(
//!     &known_points,
//!     &target_points,
//!     VariogramModel::Spherical { nugget: 0.0, sill: 0.01, range: 15.0 },
//! )?;
//! ```

use crate::device::WgpuDevice;
use crate::error::Result;
use std::sync::Arc;

/// Variogram models for spatial correlation
#[derive(Debug, Clone, Copy)]
pub enum VariogramModel {
    /// Spherical variogram: most common, bounded
    /// γ(h) = c0 + c * (1.5*h/a - 0.5*(h/a)³) for h ≤ a
    Spherical {
        /// Nugget effect (variance at zero distance)
        nugget: f64,
        /// Sill (total variance at range)
        sill: f64,
        /// Range (distance at which sill is reached)
        range: f64,
    },

    /// Exponential variogram: unbounded, reaches sill asymptotically
    /// γ(h) = c0 + c * (1 - exp(-3h/a))
    Exponential {
        /// Nugget effect (variance at zero distance)
        nugget: f64,
        /// Sill (total variance at range)
        sill: f64,
        /// Range (practical range ≈ a/3)
        range: f64,
    },

    /// Gaussian variogram: very smooth, continuous phenomena
    /// γ(h) = c0 + c * (1 - exp(-3(h/a)²))
    Gaussian {
        /// Nugget effect (variance at zero distance)
        nugget: f64,
        /// Sill (total variance at range)
        sill: f64,
        /// Range (practical range ≈ a/√3)
        range: f64,
    },

    /// Linear variogram: simple, bounded
    /// γ(h) = c0 + c * h/a for h ≤ a
    Linear {
        /// Nugget effect (variance at zero distance)
        nugget: f64,
        /// Sill (total variance at range)
        sill: f64,
        /// Range (distance at which sill is reached)
        range: f64,
    },
}

impl VariogramModel {
    /// Get variogram parameters (nugget, sill, range, `model_id`).
    #[must_use]
    pub fn params(&self) -> (f64, f64, f64, u32) {
        match self {
            Self::Spherical {
                nugget,
                sill,
                range,
            } => (*nugget, *sill, *range, 0),
            Self::Exponential {
                nugget,
                sill,
                range,
            } => (*nugget, *sill, *range, 1),
            Self::Gaussian {
                nugget,
                sill,
                range,
            } => (*nugget, *sill, *range, 2),
            Self::Linear {
                nugget,
                sill,
                range,
            } => (*nugget, *sill, *range, 3),
        }
    }

    /// Compute variogram value γ(h) for distance h.
    #[must_use]
    pub fn gamma(&self, h: f64) -> f64 {
        if h <= 0.0 {
            return 0.0;
        }

        let (nugget, sill, range, model) = self.params();
        let c = sill - nugget; // Partial sill

        match model {
            0 => {
                // Spherical
                if h >= range {
                    nugget + c
                } else {
                    let ratio = h / range;
                    c.mul_add(1.5f64.mul_add(ratio, -(0.5 * ratio.powi(3))), nugget)
                }
            }
            1 => {
                // Exponential
                c.mul_add(1.0 - (-3.0 * h / range).exp(), nugget)
            }
            2 => {
                // Gaussian
                let ratio = h / range;
                c.mul_add(1.0 - (-3.0 * ratio * ratio).exp(), nugget)
            }
            3 => {
                // Linear
                if h >= range {
                    nugget + c
                } else {
                    nugget + c * h / range
                }
            }
            _ => nugget + c,
        }
    }

    /// Compute covariance C(h) = sill - γ(h).
    #[must_use]
    pub fn covariance(&self, h: f64) -> f64 {
        let (_, sill, _, _) = self.params();
        sill - self.gamma(h)
    }
}

/// Result of kriging interpolation.
#[derive(Debug, Clone)]
pub struct KrigingResult {
    /// Interpolated values at target points
    pub values: Vec<f64>,
    /// Kriging variance (uncertainty) at each target point
    pub variances: Vec<f64>,
    /// Kriging weights used (`n_known` per target)
    pub weights: Vec<Vec<f64>>,
}

/// Ordinary Kriging interpolator.
pub struct KrigingF64 {
    device: Arc<WgpuDevice>,
}

impl KrigingF64 {
    /// Create a new kriging interpolator
    /// # Errors
    /// Returns [`Err`] if the device is invalid or unavailable.
    pub fn new(device: Arc<WgpuDevice>) -> Result<Self> {
        Ok(Self { device })
    }

    /// GPU device handle (for future GPU-accelerated kriging).
    #[must_use]
    pub fn device(&self) -> &Arc<WgpuDevice> {
        &self.device
    }

    /// Perform ordinary kriging interpolation
    /// # Arguments
    /// * `known_points` - Known data points as (x, y, z) tuples
    /// * `target_points` - Target points as (x, y) tuples
    /// * `variogram` - Variogram model with parameters
    /// # Returns
    /// `KrigingResult` with interpolated values, variances, and weights
    /// # Errors
    /// Returns [`Err`] if the covariance matrix is singular or ill-conditioned
    /// (LU solve fails).
    pub fn interpolate(
        &self,
        known_points: &[(f64, f64, f64)],
        target_points: &[(f64, f64)],
        variogram: VariogramModel,
    ) -> Result<KrigingResult> {
        let n = known_points.len();
        let m = target_points.len();

        if n == 0 {
            return Ok(KrigingResult {
                values: vec![],
                variances: vec![],
                weights: vec![],
            });
        }

        // Build covariance matrix K (n+1 x n+1) for ordinary kriging
        // Last row/col is for Lagrange multiplier
        let n1 = n + 1;
        let mut k_matrix = vec![0.0; n1 * n1];

        for i in 0..n {
            for j in 0..n {
                let h = Self::distance(
                    known_points[i].0,
                    known_points[i].1,
                    known_points[j].0,
                    known_points[j].1,
                );
                k_matrix[i * n1 + j] = variogram.covariance(h);
            }
            // Lagrange row/col
            k_matrix[i * n1 + n] = 1.0;
            k_matrix[n * n1 + i] = 1.0;
        }
        k_matrix[n * n1 + n] = 0.0;

        // Solve for each target point
        let mut values = Vec::with_capacity(m);
        let mut variances = Vec::with_capacity(m);
        let mut all_weights = Vec::with_capacity(m);

        for target in target_points {
            // Build RHS vector k
            let mut k_vec = vec![0.0; n1];
            for i in 0..n {
                let h = Self::distance(known_points[i].0, known_points[i].1, target.0, target.1);
                k_vec[i] = variogram.covariance(h);
            }
            k_vec[n] = 1.0; // Lagrange constraint

            // CPU LU solve — kriging systems are typically small (N < 1000
            // observation points); GPU LU is beneficial at N > ~2048
            let weights = Self::solve_lu(&k_matrix, &k_vec, n1)?;

            // Interpolate: z* = Σ w_i * z_i
            let mut z_interp = 0.0;
            for i in 0..n {
                z_interp = weights[i].mul_add(known_points[i].2, z_interp);
            }

            // Kriging variance: σ² = sill - Σ w_i * k_i - λ
            let (_, sill, _, _) = variogram.params();
            let mut variance_sum = 0.0;
            for i in 0..n {
                variance_sum = weights[i].mul_add(k_vec[i], variance_sum);
            }
            variance_sum += weights[n]; // Lagrange multiplier
            let variance = sill - variance_sum;

            values.push(z_interp);
            variances.push(variance.max(0.0)); // Ensure non-negative
            all_weights.push(weights[..n].to_vec());
        }

        Ok(KrigingResult {
            values,
            variances,
            weights: all_weights,
        })
    }

    /// Simple kriging (known mean)
    ///
    /// # Errors
    ///
    /// Returns [`Err`] if buffer allocation, GPU dispatch, or buffer
    /// readback fails (e.g. device lost or out of memory).
    pub fn interpolate_simple(
        &self,
        known_points: &[(f64, f64, f64)],
        target_points: &[(f64, f64)],
        variogram: VariogramModel,
        mean: f64,
    ) -> Result<KrigingResult> {
        let n = known_points.len();
        let m = target_points.len();

        if n == 0 {
            return Ok(KrigingResult {
                values: vec![mean; m],
                variances: vec![variogram.params().1; m], // sill
                weights: vec![vec![]; m],
            });
        }

        // Build covariance matrix K (n x n) - no Lagrange constraint
        let mut k_matrix = vec![0.0; n * n];

        for i in 0..n {
            for j in 0..n {
                let h = Self::distance(
                    known_points[i].0,
                    known_points[i].1,
                    known_points[j].0,
                    known_points[j].1,
                );
                k_matrix[i * n + j] = variogram.covariance(h);
            }
        }

        // Solve for each target point
        let mut values = Vec::with_capacity(m);
        let mut variances = Vec::with_capacity(m);
        let mut all_weights = Vec::with_capacity(m);

        for target in target_points {
            // Build RHS vector k
            let mut k_vec = vec![0.0; n];
            for i in 0..n {
                let h = Self::distance(known_points[i].0, known_points[i].1, target.0, target.1);
                k_vec[i] = variogram.covariance(h);
            }

            // Solve Kw = k
            let weights = Self::solve_lu(&k_matrix, &k_vec, n)?;

            // Interpolate: z* = μ + Σ w_i * (z_i - μ)
            let mut z_interp = mean;
            for i in 0..n {
                z_interp = weights[i].mul_add(known_points[i].2 - mean, z_interp);
            }

            // Simple kriging variance
            let (_, sill, _, _) = variogram.params();
            let mut variance_sum = 0.0;
            for i in 0..n {
                variance_sum = weights[i].mul_add(k_vec[i], variance_sum);
            }
            let variance = sill - variance_sum;

            values.push(z_interp);
            variances.push(variance.max(0.0));
            all_weights.push(weights);
        }

        Ok(KrigingResult {
            values,
            variances,
            weights: all_weights,
        })
    }

    /// Euclidean distance between two 2D points
    fn distance(x1: f64, y1: f64, x2: f64, y2: f64) -> f64 {
        let dx = x2 - x1;
        let dy = y2 - y1;
        dx.hypot(dy)
    }

    /// Solve linear system Ax = b using LU decomposition
    fn solve_lu(a: &[f64], b: &[f64], n: usize) -> Result<Vec<f64>> {
        // Simple LU decomposition with partial pivoting
        let mut lu = a.to_vec();
        let mut perm: Vec<usize> = (0..n).collect();

        // LU decomposition
        for k in 0..n {
            // Find pivot
            let mut max_val = lu[k * n + k].abs();
            let mut max_row = k;
            for i in (k + 1)..n {
                let val = lu[i * n + k].abs();
                if val > max_val {
                    max_val = val;
                    max_row = i;
                }
            }

            // Swap rows
            if max_row != k {
                perm.swap(k, max_row);
                for j in 0..n {
                    lu.swap(k * n + j, max_row * n + j);
                }
            }

            // Check for singularity
            if lu[k * n + k].abs() < 1e-14 {
                // Add small regularization
                lu[k * n + k] = 1e-10;
            }

            // Elimination
            for i in (k + 1)..n {
                lu[i * n + k] /= lu[k * n + k];
                for j in (k + 1)..n {
                    lu[i * n + j] = lu[i * n + k].mul_add(-lu[k * n + j], lu[i * n + j]);
                }
            }
        }

        // Forward substitution (Ly = Pb)
        let mut y = vec![0.0; n];
        for i in 0..n {
            y[i] = b[perm[i]];
            for j in 0..i {
                y[i] = lu[i * n + j].mul_add(-y[j], y[i]);
            }
        }

        // Back substitution (Ux = y)
        let mut x = vec![0.0; n];
        for i in (0..n).rev() {
            x[i] = y[i];
            for j in (i + 1)..n {
                x[i] = lu[i * n + j].mul_add(-x[j], x[i]);
            }
            x[i] /= lu[i * n + i];
        }

        Ok(x)
    }

    /// Estimate variogram parameters from data using method of moments
    /// # Errors
    /// Returns [`Err`] if allocation fails (unlikely for typical inputs).
    pub fn fit_variogram(
        known_points: &[(f64, f64, f64)],
        n_lags: usize,
        max_distance: f64,
    ) -> Result<(Vec<f64>, Vec<f64>)> {
        let n = known_points.len();
        let lag_width = max_distance / n_lags as f64;

        let mut lag_distances = vec![0.0; n_lags];
        let mut lag_semivariances = vec![0.0; n_lags];
        let mut lag_counts = vec![0usize; n_lags];

        // Compute empirical variogram
        for i in 0..n {
            for j in (i + 1)..n {
                let h = Self::distance(
                    known_points[i].0,
                    known_points[i].1,
                    known_points[j].0,
                    known_points[j].1,
                );

                let lag_idx = (h / lag_width).floor() as usize;
                if lag_idx < n_lags {
                    let diff = known_points[i].2 - known_points[j].2;
                    lag_semivariances[lag_idx] = diff.mul_add(diff, lag_semivariances[lag_idx]);
                    lag_distances[lag_idx] += h;
                    lag_counts[lag_idx] += 1;
                }
            }
        }

        // Average
        for k in 0..n_lags {
            if lag_counts[k] > 0 {
                lag_semivariances[k] /= 2.0 * lag_counts[k] as f64;
                lag_distances[k] /= lag_counts[k] as f64;
            }
        }

        Ok((lag_distances, lag_semivariances))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn create_test_device() -> Option<Arc<crate::device::WgpuDevice>> {
        crate::device::test_pool::get_test_device_if_f64_gpu_available_sync()
    }

    #[test]
    fn test_variogram_spherical() {
        let model = VariogramModel::Spherical {
            nugget: 0.0,
            sill: 1.0,
            range: 10.0,
        };

        // γ(0) = 0
        assert!((model.gamma(0.0) - 0.0).abs() < 1e-10);

        // γ(a) = sill
        assert!((model.gamma(10.0) - 1.0).abs() < 1e-10);

        // γ(h > a) = sill
        assert!((model.gamma(20.0) - 1.0).abs() < 1e-10);

        // γ(a/2) should be ~0.688
        let mid = model.gamma(5.0);
        assert!(mid > 0.5 && mid < 0.8);
    }

    #[test]
    fn test_kriging_simple_case() -> Result<()> {
        let Some(device) = create_test_device() else {
            return Ok(());
        };
        let kriging = KrigingF64::new(device)?;

        // Simple 4-point case
        let known = vec![
            (0.0, 0.0, 1.0),
            (10.0, 0.0, 2.0),
            (0.0, 10.0, 2.0),
            (10.0, 10.0, 3.0),
        ];

        let targets = vec![(5.0, 5.0)]; // Center point

        let model = VariogramModel::Spherical {
            nugget: 0.0,
            sill: 0.5,
            range: 15.0,
        };

        let result = kriging.interpolate(&known, &targets, model)?;

        // Center should interpolate to mean of corners: (1+2+2+3)/4 = 2.0
        assert!(
            (result.values[0] - 2.0).abs() < 0.1,
            "Expected ~2.0, got {}",
            result.values[0]
        );

        // Variance should be positive
        assert!(result.variances[0] >= 0.0);

        Ok(())
    }

    #[test]
    fn test_kriging_at_known_point() -> Result<()> {
        let Some(device) = create_test_device() else {
            return Ok(());
        };
        let kriging = KrigingF64::new(device)?;

        let known = vec![(0.0, 0.0, 1.0), (10.0, 0.0, 2.0), (0.0, 10.0, 3.0)];

        // Interpolate at a known point
        let targets = vec![(0.0, 0.0)];

        let model = VariogramModel::Exponential {
            nugget: 0.0,
            sill: 1.0,
            range: 10.0,
        };

        let result = kriging.interpolate(&known, &targets, model)?;

        // Should exactly reproduce known value
        assert!(
            (result.values[0] - 1.0).abs() < 1e-6,
            "Expected 1.0, got {}",
            result.values[0]
        );

        // Variance at known point should be ~0 (or very small due to numerics)
        assert!(
            result.variances[0] < 0.01,
            "Variance at known point should be ~0, got {}",
            result.variances[0]
        );

        Ok(())
    }
}