bisector 1.0.0

Flexible bisect implementatation which allows the use the bisection method on arbitrary data types
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

use super::{super::*, *};

#[test]
fn try_bisect_on_view_with_many_elements_converge_to_left_ok() {
    let values = input_1_to_10();
    let bisector = Bisector::new(&values);

    let start_from = Indices::from_bisector(&bisector);

    // In this test case, we'll manually step through the bisection (i.e. without a loop)

    // (1) We use the default starting indices (i.e. left = 0, right = |values| = 10;
    let step: Result<Step<u32, u32>, ()> =
        bisector.try_bisect(|&value| Ok(ConvergeTo::Left(value)), start_from);
    let step = step.unwrap();

    // We converge to the left, so our view of values will be halved to the left half.
    assert_eq!(step.indices, Indices::new(0, 5));
    assert_eq!(step.result.unwrap().unwrap_converge_left(), 6);

    // (2) Now we use the next indices produced by step, to progress our bisection: step.indices
    let step: Result<Step<u32, u32>, ()> =
        bisector.try_bisect(|&value| Ok(ConvergeTo::Left(value)), step.indices);
    let step = step.unwrap();

    // We converge to the left, so our view of values will be halved further to the left half.
    assert_eq!(step.indices, Indices::new(0, 2));
    assert_eq!(step.result.unwrap().unwrap_converge_left(), 3);

    // (3) Step further
    let step: Result<Step<u32, u32>, ()> =
        bisector.try_bisect(|&value| Ok(ConvergeTo::Left(value)), step.indices);
    let step = step.unwrap();

    assert_eq!(step.indices, Indices::new(0, 1));
    assert_eq!(step.result.unwrap().unwrap_converge_left(), 2);

    // (4) Step further
    let step: Result<Step<u32, u32>, ()> =
        bisector.try_bisect(|&value| Ok(ConvergeTo::Left(value)), step.indices);
    let step = step.unwrap();

    assert_eq!(step.indices, Indices::new(0, 0));
    assert_eq!(step.result.unwrap().unwrap_converge_left(), 1);

    // (5) Step a one more time to check we are at the end
    let step: Result<Step<u32, u32>, ()> =
        bisector.try_bisect(|&value| Ok(ConvergeTo::Left(value)), step.indices);
    let step = step.unwrap();

    assert_eq!(step.indices, Indices::new(0, 0));
    assert!(step.result.is_none());
}

#[test]
fn try_bisect_on_view_with_many_elements_converge_to_right_ok() {
    let values = input_1_to_10();
    let bisector = Bisector::new(&values);

    let start_from = Indices::from_bisector(&bisector);

    // In this test case, we'll manually step through the bisection (i.e. without a loop)

    // (1) We use the default starting indices (i.e. left = 0, right = |values| = 10;
    let step: Result<Step<u32, u32>, ()> =
        bisector.try_bisect(|&value| Ok(ConvergeTo::Right(value)), start_from);
    let step = step.unwrap();

    // We converge to the right, so our view of values will be halved to the right half.
    assert_eq!(step.indices, Indices::new(6, 10));
    assert_eq!(step.result.unwrap().unwrap_converge_right(), 6);

    // (2) Now we use the next indices produced by step, to progress our bisection: step.indices
    let step: Result<Step<u32, u32>, ()> =
        bisector.try_bisect(|&value| Ok(ConvergeTo::Right(value)), step.indices);
    let step = step.unwrap();

    // We converge to the right, so our view of values will be halved further to the right half.
    assert_eq!(step.indices, Indices::new(9, 10));
    assert_eq!(step.result.unwrap().unwrap_converge_right(), 9);

    // (3) Step further: the last element is part of the view as well, so it is evaluated too
    let step: Result<Step<u32, u32>, ()> =
        bisector.try_bisect(|&value| Ok(ConvergeTo::Right(value)), step.indices);
    let step = step.unwrap();

    assert_eq!(step.indices, Indices::new(10, 10));
    assert_eq!(step.result.unwrap().unwrap_converge_right(), 10);

    // (4) Step a one more time to check we are at the end
    let step: Result<Step<u32, u32>, ()> =
        bisector.try_bisect(|&value| Ok(ConvergeTo::Right(value)), step.indices);
    let step = step.unwrap();

    assert_eq!(step.indices, Indices::new(10, 10));
    assert!(step.result.is_none());
}

#[test]
fn try_bisect_on_view_with_many_elements_converge_zig_zag_ok() {
    let values = input_1_to_10();
    let bisector = Bisector::new(&values);

    let start_from = Indices::from_bisector(&bisector);

    // In this test case, we'll manually step through the bisection (i.e. without a loop)

    // (1) We use the default starting indices (i.e. left = 0, right = |values| = 10;
    let step: Result<Step<u32, u32>, ()> =
        bisector.try_bisect(|&value| Ok(ConvergeTo::Left(value)), start_from);
    let step = step.unwrap();

    // We converge to the left, so our view of values will be halved to the left half.
    assert_eq!(step.indices, Indices::new(0, 5));
    assert_eq!(step.result.unwrap().unwrap_converge_left(), 6);

    // (2) Now we use the next indices produced by step, to progress our bisection: step.indices
    //      Because we zig-zag, we'll now converge to the right
    let step: Result<Step<u32, u32>, ()> =
        bisector.try_bisect(|&value| Ok(ConvergeTo::Right(value)), step.indices);
    let step = step.unwrap();

    // We converge to the right, so our view of values will be halved to the right half of our previous
    // view.
    assert_eq!(step.indices, Indices::new(3, 5));
    assert_eq!(step.result.unwrap().unwrap_converge_right(), 3);

    // (3) Step further: zig-zag left
    let step: Result<Step<u32, u32>, ()> =
        bisector.try_bisect(|&value| Ok(ConvergeTo::Left(value)), step.indices);
    let step = step.unwrap();

    assert_eq!(step.indices, Indices::new(3, 4));
    assert_eq!(step.result.unwrap().unwrap_converge_left(), 5);

    // (4) Step further: left again, now only one element is left in the view
    let final_step: Result<Step<u32, u32>, ()> =
        bisector.try_bisect(|&value| Ok(ConvergeTo::Left(value)), step.indices);
    let final_step = final_step.unwrap();

    assert_eq!(final_step.indices, Indices::new(3, 3));
    assert_eq!(final_step.result.unwrap().unwrap_converge_left(), 4);

    // (5a) Step a one more time to check we are at the end: left
    let step: Result<Step<u32, u32>, ()> =
        bisector.try_bisect(|&value| Ok(ConvergeTo::Left(value)), final_step.indices);
    let step = step.unwrap();

    assert_eq!(step.indices, Indices::new(3, 3));
    assert!(step.result.is_none());

    // (5b) Step a one more time to check we are at the end: right
    let step: Result<Step<u32, u32>, ()> =
        bisector.try_bisect(|&value| Ok(ConvergeTo::Right(value)), final_step.indices);
    let step = step.unwrap();

    assert_eq!(step.indices, Indices::new(3, 3));
    assert!(step.result.is_none());
}

#[test]
fn try_bisect_on_view_with_many_elements_re_use_same_indices_means_no_progress_with_ok() {
    let values = input_1_to_10();
    let bisector = Bisector::new(&values);

    let start_from = Indices::from_bisector(&bisector);

    let expected_next_indices = Indices::new(0, 5);
    let expected_output_value = 6;

    // In this test case, we'll manually step through the bisection (i.e. without a loop)
    // We'll show no progress is made when the same input indices are used (i.e. the bisector
    //  does not store the progress as internal state).

    // (1) We use the default starting indices (i.e. left = 0, right = |values| = 10;
    let step: Result<Step<u32, u32>, ()> =
        bisector.try_bisect(|&value| Ok(ConvergeTo::Left(value)), start_from);
    let step = step.unwrap();

    // We converge to the left, so our view of values will be halved to the left half.
    assert_eq!(step.indices, expected_next_indices);
    assert_eq!(
        step.result.unwrap().unwrap_converge_left(),
        expected_output_value
    );

    // (2) Now we use the the same starting indices, instead of the progressed indices from the previous
    //  step (`start_from` instead of `step.indices`)
    let step: Result<Step<u32, u32>, ()> =
        bisector.try_bisect(|&value| Ok(ConvergeTo::Left(value)), start_from);
    let step = step.unwrap();

    assert_eq!(step.indices, expected_next_indices);
    assert_eq!(
        step.result.unwrap().unwrap_converge_left(),
        expected_output_value
    );
}

#[test]
fn try_bisect_with_err() {
    let values = input_1_to_10();
    let bisector = Bisector::new(&values);

    let start_from = Indices::from_bisector(&bisector);

    // In this test case, we'll manually step through the bisection (i.e. without a loop)

    // (1) We use the default starting indices (i.e. left = 0, right = |values| = 10;
    let step: Result<Step<u32, u32>, ()> = bisector.try_bisect(|_| Err(()), start_from);

    assert!(step.is_err());
}

#[test]
fn try_bisect_already_converged() {
    let values = input_1();
    let bisector = Bisector::new(&values);

    let start_from = Indices::new(0, 0);

    // This test case is already converged, so we get an Ok result, even though our convergence function
    // always produces an error

    let step: Result<Step<u32, u32>, ()> = bisector.try_bisect(|_| Err(()), start_from);

    assert!(step.is_ok());
}