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
/// With `LinearSearch`, one can iterate over a slice of `Releases` in a linear ordering.
#[derive(Clone, Debug)]
pub struct LinearSearch<'r, T> {
    // All known releases, sorted by their version from high to low
    releases: &'r [T],
    // The current release
    current: usize,
}

impl<'r, T> LinearSearch<'r, T> {
    pub fn new(releases: &'r [T]) -> Self {
        Self {
            releases,
            current: 0,
        }
    }

    pub fn next_release(&mut self) -> Option<&'r T> {
        let ret = self.releases.get(self.current);
        self.current += 1;
        ret
    }
}

/// With `Bisect`, one can perform a binary search over a slice of `Releases`.
/// This can for example be used to more quickly find a `MSRV` or the latest working `nightly` build.
#[derive(Clone, Debug)]
pub struct Bisect<'r, T> {
    // All known releases, sorted by their version from high to low
    releases: &'r [T],

    // The lowest index still in search range.
    lower_bound: usize,

    // The highest index still in search range.
    upper_bound: usize,

    // The halfway point of our current search range.
    pivot: usize,

    // Whether the search is complete, and can not go further
    done: bool,
}

impl<'r, T> Bisect<'r, T> {
    /// Iterate over the element by performing a binary search.
    ///
    /// # Panics
    ///
    /// Panics if the given `Releases` slice has length `0`.
    pub fn new(releases: &'r [T]) -> Self {
        let half = releases.len() / 2 - 1;

        Self {
            releases,
            lower_bound: 0,
            upper_bound: releases.len() - 1,
            pivot: half,
            done: false,
        }
    }

    pub fn search_left(&mut self) -> Option<&'r T> {
        if self.done {
            return None;
        }

        let ret = &self.releases[self.pivot];

        #[cfg(debug_assertions)]
        let min = self.lower_bound;

        if self.pivot - self.lower_bound == 1 {
            self.upper_bound = self.lower_bound;
            self.pivot = self.lower_bound;
        } else if self.upper_bound == self.pivot && self.lower_bound == self.pivot {
            self.done = true;
        } else {
            self.upper_bound = self.pivot;
            self.pivot = self.lower_bound + (self.upper_bound - self.lower_bound) / 2;
        }

        #[cfg(debug_assertions)]
        assert!(self.lower_bound >= min);

        Some(ret)
    }

    pub fn search_right(&mut self) -> Option<&'r T> {
        if self.done {
            return None;
        }

        #[cfg(debug_assertions)]
        let max = self.upper_bound;

        let ret = &self.releases[self.pivot];

        if self.upper_bound - self.pivot == 1 {
            self.lower_bound = self.upper_bound;
            self.pivot = self.upper_bound;
        } else if self.upper_bound == self.pivot && self.lower_bound == self.pivot {
            self.done = true;
        } else {
            self.lower_bound = self.pivot;
            self.pivot = (self.lower_bound + self.upper_bound) / 2;
        }

        #[cfg(debug_assertions)]
        assert!(self.upper_bound <= max);

        Some(ret)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::source::{Document, RustChangelog};
    use crate::{Release, ReleaseIndex};

    #[test]
    fn linear_search() {
        let path = [
            env!("CARGO_MANIFEST_DIR"),
            "/resources/rust_changelog/RELEASES.md",
        ]
        .join("");
        let strategy = RustChangelog::from_document(Document::LocalPath(path.into()));
        let index = ReleaseIndex::from_source(strategy).unwrap();
        let releases = index.releases();

        let mut search = LinearSearch::new(&releases);
        let first = search.next_release().unwrap();
        let second = search.next_release().unwrap();
        let third = search.next_release().unwrap();

        assert_eq!(first, &&Release::new(semver::Version::from((1, 50, 0))));
        assert_eq!(second, &&Release::new(semver::Version::from((1, 49, 0))));
        assert_eq!(third, &&Release::new(semver::Version::from((1, 48, 0))));
    }

    #[test]
    fn bisection_search_only_left() {
        let releases = (0usize..10).into_iter().collect::<Vec<_>>();

        let mut search = Bisect::new(&releases);

        let check = search.search_left();
        assert_eq!(*check.unwrap(), 4);

        let check = search.search_left();
        assert_eq!(*check.unwrap(), 2);

        let check = search.search_left();
        assert_eq!(*check.unwrap(), 1);

        let check = search.search_left();
        assert_eq!(*check.unwrap(), 0);

        assert!(search.search_left().is_none());
    }

    #[test]
    fn bisection_search_only_right() {
        let releases = (0usize..10).into_iter().collect::<Vec<_>>();

        let mut search = Bisect::new(&releases);

        let check = search.search_right();
        assert_eq!(*check.unwrap(), 4);

        let check = search.search_right();
        assert_eq!(*check.unwrap(), 6);

        let check = search.search_right();
        assert_eq!(*check.unwrap(), 7);

        let check = search.search_right();
        assert_eq!(*check.unwrap(), 8);

        let check = search.search_right();
        assert_eq!(*check.unwrap(), 9);

        assert!(search.search_right().is_none());
    }

    #[test]
    fn bisection_search_zig_zag() {
        println!();

        let releases = (0usize..100).into_iter().collect::<Vec<_>>();

        let mut search = Bisect::new(&releases);

        let check = search.search_right();
        assert_eq!(*check.unwrap(), 49);

        let check = search.search_left();
        assert_eq!(*check.unwrap(), 74);

        let check = search.search_right();
        assert_eq!(*check.unwrap(), 61);

        let check = search.search_left();
        assert_eq!(*check.unwrap(), 67);

        let check = search.search_right();
        assert_eq!(*check.unwrap(), 64);

        let check = search.search_left();
        assert_eq!(*check.unwrap(), 65);

        let check = search.search_right();
        assert_eq!(*check.unwrap(), 64);

        assert!(search.clone().search_right().is_none());
        assert!(search.search_left().is_none());
    }
}