lather 0.0.0

A Rust crate and Python extension for modeling starspot effects on radial velocity and photometric observations, inspired by complaints about the SOAP project of similar goals.
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

extern crate std;

pub struct Linspace {
    index: usize,
    len: usize,
    start: f64,
    step: f64,
}

impl Iterator for Linspace {
    type Item = f64;
    fn next(&mut self) -> Option<f64> {
        if self.index >= self.len {
            None
        } else {
            let output = Some(self.start + self.step * (self.index as f64));
            self.index += 1;
            output
        }
    }
}

/// Creates an iterator of `len` floats between `start`
/// and `stop`, inclusive.
pub fn linspace(start: f64, stop: f64, len: usize) -> Linspace {
    Linspace {
        start: start,
        len: len,
        step: (stop - start) / (len as f64 - 1.0),
        index: 0,
    }
}

pub struct Floatrange {
    index: usize,
    len: usize,
    start: f64,
    step: f64,
}

impl Iterator for Floatrange {
    type Item = f64;
    fn next(&mut self) -> Option<f64> {
        if self.index > self.len {
            None
        } else {
            let output = Some(self.start + self.step * (self.index as f64));
            self.index += 1;
            output
        }
    }
}

/// Creates an iterator of floats that begin at `start` and
/// increase by `step` until they would exceed `stop`.
pub fn floatrange(start: f64, stop: f64, step: f64) -> Floatrange {
    let len = if start == stop {
        0
    } else {
        ((stop - start) / step) as usize
    };
    Floatrange {
        index: 0,
        len: len,
        start: start,
        step: step,
    }
}

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

    #[test]
    fn linspace_len() {
        assert_eq!(linspace(0.0, 10.0, 10).count(), 10);
    }

    #[test]
    fn floatrange_len() {
        assert_eq!(floatrange(0.0, 10.0, 1.0).count(), 11);
    }

    #[test]
    fn linspace_empty() {
        assert!(linspace(0.0, 10.0, 0).next().is_none());
        assert_eq!(linspace(0.0, 0.0, 100).count(), 100);
    }

    #[test]
    fn floatrange_empty() {
        assert_eq!(floatrange(0.0, 10.0, 11.0).count(), 1);
        assert_eq!(floatrange(0.0, 0.0, 10.0).count(), 1);
    }

    #[test]
    fn linspace_bounds() {
        assert_eq!(linspace(0.0, 10.0, 10).next().unwrap(), 0.0);
        assert_eq!(linspace(0.0, 10.0, 10).last().unwrap(), 10.0);
    }

    #[test]
    fn floatrange_bounds() {
        assert_eq!(floatrange(0.0, 10.0, 1.0).next().unwrap(), 0.0);
        assert_eq!(floatrange(0.0, 10.0, 1.0).last().unwrap(), 10.0);
    }

    #[test]
    fn basic_floatrange() {
        let mut frange = floatrange(0.0, 2.0, 1.0);
        assert_eq!(frange.next().unwrap(), 0.0);
        assert_eq!(frange.next().unwrap(), 1.0);
        assert_eq!(frange.next().unwrap(), 2.0);
        assert!(frange.next().is_none());
    }

    #[test]
    fn basic_linspace() {
        let mut lspace = linspace(0.0, 2.0, 3);
        assert_eq!(lspace.next().unwrap(), 0.0);
        assert_eq!(lspace.next().unwrap(), 1.0);
        assert_eq!(lspace.next().unwrap(), 2.0);
        assert!(lspace.next().is_none());
    }
}