terrustrial 0.1.1

A Rust library for geospatial statistics, variograms, and kriging.
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

use ultraviolet::{DRotor3, DVec3, DVec3x4};
use wide::f64x4;

use super::{nugget::Nugget, spherical::SphericalVariogram, VariogramModel};

#[derive(Clone, Debug)]
pub enum VariogramType {
    Nugget(Nugget),
    Spherical(SphericalVariogram),
    //TODO
    // Exponential,
    // Gaussian,
    // Linear,
    // Power,
    // HoleEffect,
    // Custom,
}

impl VariogramModel for VariogramType {
    fn c_0(&self) -> f64 {
        match self {
            VariogramType::Spherical(v) => v.c_0(),
            &VariogramType::Nugget(v) => v.c_0(),
        }
    }

    fn variogram(&self, h: DVec3) -> f64 {
        match self {
            VariogramType::Spherical(v) => v.variogram(h),
            VariogramType::Nugget(v) => v.variogram(h),
        }
    }

    fn covariogram(&self, h: DVec3) -> f64 {
        match self {
            VariogramType::Spherical(v) => v.covariogram(h),
            VariogramType::Nugget(v) => v.covariogram(h),
        }
    }

    fn variogram_simd(&self, h: DVec3x4) -> f64x4 {
        match self {
            VariogramType::Spherical(v) => v.variogram_simd(h),
            VariogramType::Nugget(v) => v.variogram_simd(h),
        }
    }

    fn covariogram_simd(&self, h: DVec3x4) -> f64x4 {
        match self {
            VariogramType::Spherical(v) => v.covariogram_simd(h),
            VariogramType::Nugget(v) => v.covariogram_simd(h),
        }
    }

    fn set_orientation(&mut self, orientation: DRotor3) {
        match self {
            VariogramType::Spherical(v) => v.set_orientation(orientation),
            VariogramType::Nugget(_) => {}
        }
    }
}

#[derive(Clone, Debug, Default)]
pub struct CompositeVariogram {
    pub variograms: Vec<VariogramType>,
}

impl CompositeVariogram {
    pub fn new(variograms: Vec<VariogramType>) -> Self {
        Self { variograms }
    }

    pub fn set_orientation(&mut self, orientation: DRotor3) {
        for v in self.variograms.iter_mut() {
            v.set_orientation(orientation);
        }
    }
}

impl VariogramModel for CompositeVariogram {
    fn c_0(&self) -> f64 {
        self.variograms.iter().map(VariogramModel::c_0).sum()
    }

    fn variogram(&self, h: DVec3) -> f64 {
        self.variograms
            .iter()
            .fold(0.0, |acc, v| acc + v.variogram(h))
    }

    fn covariogram(&self, h: DVec3) -> f64 {
        self.variograms
            .iter()
            .fold(0.0, |acc, v| acc + v.covariogram(h))
    }

    fn variogram_simd(&self, h: DVec3x4) -> f64x4 {
        self.variograms
            .iter()
            .fold(f64x4::splat(0.0), |acc, v| acc + v.variogram_simd(h))
    }

    fn covariogram_simd(&self, h: DVec3x4) -> f64x4 {
        self.variograms
            .iter()
            .fold(f64x4::splat(0.0), |acc, v| acc + v.covariogram_simd(h))
    }

    fn set_orientation(&mut self, orientation: DRotor3) {
        for v in self.variograms.iter_mut() {
            v.set_orientation(orientation);
        }
    }
}

#[cfg(test)]
mod test {

    use super::*;

    #[test]
    fn composite_variogram() {
        let spherical = VariogramType::Spherical(SphericalVariogram::new(
            DVec3::new(1.0, 1.0, 1.0),
            1.0,
            DRotor3::identity(),
        ));

        let composite = CompositeVariogram::new(vec![spherical.clone()]);

        //check if composite variogram is equal to spherical variogram
        assert!(composite.c_0() == spherical.c_0());

        assert!(
            composite.covariogram(DVec3::new(0.5, 0.5, 0.5))
                == spherical.covariogram(DVec3::new(0.5, 0.5, 0.5))
        );

        assert!(
            composite.variogram(DVec3::new(1.0, 1.0, 1.0))
                == spherical.variogram(DVec3::new(1.0, 1.0, 1.0))
        );
        assert!(
            composite.covariogram(DVec3::new(1.0, 1.0, 1.0))
                == spherical.covariogram(DVec3::new(1.0, 1.0, 1.0))
        );
    }
}