array-linked-list 0.2.3

A data structure, which combines the advantages of dynamic arrays and linked lists
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
use crate::{ArrayLinkedList, LinkedListNode, id::Id};

impl<T> ArrayLinkedList<T> {
    /// Returns a borrowing iterator over its elements.
    pub fn iter(&self) -> impl DoubleEndedIterator<Item = &T> {
        Values(Indexed::new(self))
    }

    /// Returns a mutable borrowing iterator over its elements.
    pub fn iter_mut(&mut self) -> impl DoubleEndedIterator<Item = &mut T> {
        ValuesMut(IndexedMut::new(self))
    }

    /// Returns a borrowing iterator over its indexed elements.
    pub fn indexed(&self) -> impl DoubleEndedIterator<Item = (usize, &T)> {
        Indexed::new(self)
    }

    /// Returns a mutable borrowing iterator over its indexed elements.
    pub fn indexed_mut(&mut self) -> impl DoubleEndedIterator<Item = (usize, &mut T)> {
        IndexedMut::new(self)
    }

    /// Returns a borrowing iterator over its indices.
    pub fn indices(&self) -> impl DoubleEndedIterator<Item = usize> + '_ {
        Indices(Indexed::new(self))
    }

    /// Returns a borrowing iterator over its elements, starting after the element at the specified index.
    ///
    /// # Panics
    ///
    /// Panics if index >= capacity
    pub fn iter_after(&self, index: usize) -> impl DoubleEndedIterator<Item = &T> {
        Values(Indexed::after(self, index))
    }

    /// Returns a mutable borrowing iterator over its elements, starting after the element at the specified index.
    ///
    /// # Panics
    ///
    /// Panics if index >= capacity
    pub fn iter_mut_after(&mut self, index: usize) -> impl DoubleEndedIterator<Item = &mut T> {
        ValuesMut(IndexedMut::after(self, index))
    }

    /// Returns a borrowing iterator over its indexed elements, starting after the element at the specified index.
    ///
    /// # Panics
    ///
    /// Panics if index >= capacity
    pub fn indexed_after(&self, index: usize) -> impl DoubleEndedIterator<Item = (usize, &T)> {
        Indexed::after(self, index)
    }

    /// Returns a mutable borrowing iterator over its indexed elements, starting after the element at the specified index.
    ///
    /// # Panics
    ///
    /// Panics if index >= capacity
    pub fn indexed_mut_after(
        &mut self,
        index: usize,
    ) -> impl DoubleEndedIterator<Item = (usize, &mut T)> {
        IndexedMut::after(self, index)
    }

    /// Returns a borrowing iterator over its indices, starting after the element at the specified index.
    ///
    /// # Panics
    ///
    /// Panics if index >= capacity
    pub fn indices_after(&self, index: usize) -> impl DoubleEndedIterator<Item = usize> + '_ {
        Indices(Indexed::after(self, index))
    }

    /// Returns a borrowing iterator over its elements, ending before the element at the specified index.
    ///
    /// # Panics
    ///
    /// Panics if index >= capacity
    pub fn iter_before(&self, index: usize) -> impl DoubleEndedIterator<Item = &T> {
        Values(Indexed::before(self, index))
    }

    /// Returns a mutable borrowing iterator over its elements, ending before the element at the specified index.
    ///
    /// # Panics
    ///
    /// Panics if index >= capacity
    pub fn iter_mut_before(&mut self, index: usize) -> impl DoubleEndedIterator<Item = &mut T> {
        ValuesMut(IndexedMut::before(self, index))
    }

    /// Returns a borrowing iterator over its indexed elements, ending before the element at the specified index.
    ///
    /// # Panics
    ///
    /// Panics if index >= capacity
    pub fn indexed_before(&self, index: usize) -> impl DoubleEndedIterator<Item = (usize, &T)> {
        Indexed::before(self, index)
    }

    /// Returns a mutable borrowing iterator over its indexed elements, ending before the element at the specified index.
    ///
    /// # Panics
    ///
    /// Panics if index >= capacity
    pub fn indexed_mut_before(
        &mut self,
        index: usize,
    ) -> impl DoubleEndedIterator<Item = (usize, &mut T)> {
        IndexedMut::before(self, index)
    }

    /// Returns a borrowing iterator over its indices, ending before the element at the specified index.
    ///
    /// # Panics
    ///
    /// Panics if index >= capacity
    pub fn indices_before(&self, index: usize) -> impl DoubleEndedIterator<Item = usize> + '_ {
        Indices(Indexed::before(self, index))
    }

    /// Returns an owning iterator returning its indexed elements.
    pub fn into_indexed(self) -> impl DoubleEndedIterator<Item = (usize, T)> {
        IntoIndexed(self)
    }

    /// Returns an owning iterator returning its indices.
    pub fn into_indices(self) -> impl DoubleEndedIterator<Item = usize> {
        IntoIndices(IntoIndexed(self))
    }
}

struct Indexed<'a, T> {
    front_index: Id,
    back_index: Id,
    array: &'a ArrayLinkedList<T>,
}

impl<'a, T> Indexed<'a, T> {
    fn empty(array: &'a ArrayLinkedList<T>) -> Self {
        Self {
            front_index: Id::default(),
            back_index: Id::default(),
            array,
        }
    }

    fn new(array: &'a ArrayLinkedList<T>) -> Self {
        Self {
            front_index: array.first_index,
            back_index: array.last_index,
            array,
        }
    }

    fn after(array: &'a ArrayLinkedList<T>, prev_index: usize) -> Self {
        let element = &array.elements[prev_index];
        if element.data.is_some() {
            Self {
                front_index: element.next_index,
                back_index: array.last_index,
                array,
            }
        } else {
            Self::empty(array)
        }
    }

    fn before(array: &'a ArrayLinkedList<T>, next_index: usize) -> Self {
        let element = &array.elements[next_index];
        if element.data.is_some() {
            Self {
                front_index: array.first_index,
                back_index: element.prev_index,
                array,
            }
        } else {
            Self::empty(array)
        }
    }
}

struct IndexedMut<'a, T> {
    front_index: Id,
    back_index: Id,
    elements: &'a mut [LinkedListNode<T>],
}

impl<'a, T> IndexedMut<'a, T> {
    fn empty(array: &'a mut ArrayLinkedList<T>) -> Self {
        Self {
            front_index: Id::default(),
            back_index: Id::default(),
            elements: &mut array.elements,
        }
    }

    fn new(array: &'a mut ArrayLinkedList<T>) -> Self {
        Self {
            front_index: array.first_index,
            back_index: array.last_index,
            elements: &mut array.elements,
        }
    }

    fn after(array: &'a mut ArrayLinkedList<T>, prev_index: usize) -> Self {
        let last_index = array.last_index;
        let element = &array.elements[prev_index];
        if element.data.is_some() {
            let front_index = element.next_index;
            Self {
                front_index,
                back_index: last_index,
                elements: &mut array.elements,
            }
        } else {
            Self::empty(array)
        }
    }

    fn before(array: &'a mut ArrayLinkedList<T>, next_index: usize) -> Self {
        let first_index = array.first_index;
        let element = &array.elements[next_index];
        if element.data.is_some() {
            let back_index = element.prev_index;
            Self {
                front_index: first_index,
                back_index,
                elements: &mut array.elements,
            }
        } else {
            Self::empty(array)
        }
    }
}

struct Indices<'a, T>(Indexed<'a, T>);

/// Borrowing iterator over values of the linked array.
pub struct Values<'a, T>(Indexed<'a, T>);

/// Mutable borrowing iterator over values of the linked array.
pub struct ValuesMut<'a, T>(IndexedMut<'a, T>);

impl<'a, T> Iterator for Indexed<'a, T> {
    type Item = (usize, &'a T);
    #[inline]
    fn next(&mut self) -> Option<Self::Item> {
        let index = self.front_index.index()?;

        let element = &self.array.elements[index];
        if self.front_index == self.back_index {
            self.front_index = Id::default();
            self.back_index = Id::default();
        } else {
            self.front_index = element.next_index;
        }
        Some((index, unsafe { element.data.as_ref().unwrap_unchecked() }))
    }
}

impl<T> DoubleEndedIterator for Indexed<'_, T> {
    #[inline]
    fn next_back(&mut self) -> Option<Self::Item> {
        let index = self.back_index.index()?;

        let element = &self.array.elements[index];
        if self.front_index == self.back_index {
            self.front_index = Id::default();
            self.back_index = Id::default();
        } else {
            self.back_index = element.prev_index;
        }
        Some((index, unsafe { element.data.as_ref().unwrap_unchecked() }))
    }
}

impl<'a, T> Iterator for IndexedMut<'a, T> {
    type Item = (usize, &'a mut T);
    #[inline]
    fn next(&mut self) -> Option<Self::Item> {
        let index = self.front_index.index()?;

        let element: *mut LinkedListNode<T> = &raw mut self.elements[index];
        if self.front_index == self.back_index {
            self.front_index = Id::default();
            self.back_index = Id::default();
        } else {
            self.front_index = unsafe { (*element).next_index };
        }
        Some((index, unsafe {
            (*element).data.as_mut().unwrap_unchecked()
        }))
    }
}

impl<T> DoubleEndedIterator for IndexedMut<'_, T> {
    #[inline]
    fn next_back(&mut self) -> Option<Self::Item> {
        let index = self.back_index.index()?;

        let element: *mut LinkedListNode<T> = &raw mut self.elements[index];
        if self.front_index == self.back_index {
            self.front_index = Id::default();
            self.back_index = Id::default();
        } else {
            self.back_index = unsafe { (*element).prev_index };
        }
        Some((index, unsafe {
            (*element).data.as_mut().unwrap_unchecked()
        }))
    }
}

impl<T> Iterator for Indices<'_, T> {
    type Item = usize;
    fn next(&mut self) -> Option<Self::Item> {
        self.0.next().map(|(index, _)| index)
    }
}

impl<T> DoubleEndedIterator for Indices<'_, T> {
    fn next_back(&mut self) -> Option<Self::Item> {
        self.0.next_back().map(|(index, _)| index)
    }
}

impl<'a, T> Iterator for Values<'a, T> {
    type Item = &'a T;
    fn next(&mut self) -> Option<Self::Item> {
        self.0.next().map(|(_, value)| value)
    }
}

impl<T> DoubleEndedIterator for Values<'_, T> {
    fn next_back(&mut self) -> Option<Self::Item> {
        self.0.next_back().map(|(_, value)| value)
    }
}

impl<'a, T> Iterator for ValuesMut<'a, T> {
    type Item = &'a mut T;
    fn next(&mut self) -> Option<Self::Item> {
        self.0.next().map(|(_, value)| value)
    }
}

impl<T> DoubleEndedIterator for ValuesMut<'_, T> {
    fn next_back(&mut self) -> Option<Self::Item> {
        self.0.next_back().map(|(_, value)| value)
    }
}

impl<'a, T> IntoIterator for &'a ArrayLinkedList<T> {
    type Item = &'a T;
    type IntoIter = Values<'a, T>;

    #[inline]
    fn into_iter(self) -> Self::IntoIter {
        Values(Indexed::new(self))
    }
}

impl<'a, T> IntoIterator for &'a mut ArrayLinkedList<T> {
    type Item = &'a mut T;
    type IntoIter = ValuesMut<'a, T>;

    #[inline]
    fn into_iter(self) -> Self::IntoIter {
        ValuesMut(IndexedMut::new(self))
    }
}

struct IntoIndexed<T>(ArrayLinkedList<T>);
struct IntoIndices<T>(IntoIndexed<T>);

/// Owning iterator over values of the linked array.
pub struct IntoValues<T>(IntoIndexed<T>);

impl<T> Iterator for IntoIndexed<T> {
    type Item = (usize, T);
    #[inline]
    fn next(&mut self) -> Option<Self::Item> {
        let index = self.0.first_index.index()?;

        let element = &mut self.0.elements[index];
        if self.0.first_index == self.0.last_index {
            self.0.first_index = Id::default();
            self.0.last_index = Id::default();
        } else {
            self.0.first_index = element.next_index;
        }
        Some((index, unsafe { element.data.take().unwrap_unchecked() }))
    }
}

impl<T> DoubleEndedIterator for IntoIndexed<T> {
    #[inline]
    fn next_back(&mut self) -> Option<Self::Item> {
        let index = self.0.last_index.index()?;

        let element = &mut self.0.elements[index];
        if self.0.first_index == self.0.last_index {
            self.0.first_index = Id::default();
            self.0.last_index = Id::default();
        } else {
            self.0.last_index = element.prev_index;
        }
        Some((index, unsafe { element.data.take().unwrap_unchecked() }))
    }
}

impl<T> Iterator for IntoIndices<T> {
    type Item = usize;
    fn next(&mut self) -> Option<Self::Item> {
        self.0.next().map(|(index, _)| index)
    }
}

impl<T> DoubleEndedIterator for IntoIndices<T> {
    fn next_back(&mut self) -> Option<Self::Item> {
        self.0.next_back().map(|(index, _)| index)
    }
}

impl<T> Iterator for IntoValues<T> {
    type Item = T;
    fn next(&mut self) -> Option<Self::Item> {
        self.0.next().map(|(_, value)| value)
    }
}

impl<T> DoubleEndedIterator for IntoValues<T> {
    fn next_back(&mut self) -> Option<Self::Item> {
        self.0.next_back().map(|(_, value)| value)
    }
}

impl<T> IntoIterator for ArrayLinkedList<T> {
    type Item = T;
    type IntoIter = IntoValues<T>;

    fn into_iter(self) -> Self::IntoIter {
        IntoValues(IntoIndexed(self))
    }
}