generic-btree 0.10.7

Generic BTree for versatile purposes
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

use core::ops::RangeBounds;
use std::ops::Range;

/// For better performance, it's advised to impl split
pub trait Sliceable: HasLength + Sized {
    #[must_use]
    fn _slice(&self, range: Range<usize>) -> Self;

    #[must_use]
    #[inline(always)]
    fn slice(&self, range: impl RangeBounds<usize>) -> Self {
        let start = match range.start_bound() {
            std::ops::Bound::Included(x) => *x,
            std::ops::Bound::Excluded(x) => x + 1,
            std::ops::Bound::Unbounded => 0,
        };

        let end = match range.end_bound() {
            std::ops::Bound::Included(x) => x + 1,
            std::ops::Bound::Excluded(x) => *x,
            std::ops::Bound::Unbounded => self.rle_len(),
        };

        self._slice(start..end)
    }

    /// slice in-place
    #[inline(always)]
    fn slice_(&mut self, range: impl RangeBounds<usize>) {
        *self = self.slice(range);
    }

    #[must_use]
    fn split(&mut self, pos: usize) -> Self {
        let right = self.slice(pos..);
        self.slice_(..pos);
        right
    }

    /// Update the slice in the given range.
    /// This method may split `self` into two or three parts.
    /// If so, it will make `self` the leftmost part and return the next split parts.
    ///
    /// # Example
    ///
    /// If `self.rle_len() == 10`, `self.update(1..5)` will split self into three parts and update the middle part.
    /// It returns the middle and the right part.
    fn update_with_split(
        &mut self,
        range: impl RangeBounds<usize>,
        f: impl FnOnce(&mut Self),
    ) -> (Option<Self>, Option<Self>) {
        let start = match range.start_bound() {
            std::ops::Bound::Included(x) => *x,
            std::ops::Bound::Excluded(x) => x + 1,
            std::ops::Bound::Unbounded => 0,
        };

        let end = match range.end_bound() {
            std::ops::Bound::Included(x) => x + 1,
            std::ops::Bound::Excluded(x) => *x,
            std::ops::Bound::Unbounded => self.rle_len(),
        };

        if start >= end {
            return (None, None);
        }

        match (start == 0, end == self.rle_len()) {
            (true, true) => {
                f(self);
                (None, None)
            }
            (true, false) => {
                let right = self.split(end);
                f(self);
                (Some(right), None)
            }
            (false, true) => {
                let mut right = self.split(start);
                f(&mut right);
                (Some(right), None)
            }
            (false, false) => {
                let right = self.split(end);
                let mut middle = self.split(start);
                f(&mut middle);
                (Some(middle), Some(right))
            }
        }
    }
}

pub trait Mergeable {
    /// Whether self can merge rhs with self on the left.
    ///
    /// Note: This is not symmetric.
    fn can_merge(&self, rhs: &Self) -> bool;
    fn merge_right(&mut self, rhs: &Self);
    fn merge_left(&mut self, left: &Self);
}

pub trait HasLength {
    fn rle_len(&self) -> usize;
}

pub trait TryInsert {
    fn try_insert(&mut self, pos: usize, elem: Self) -> Result<(), Self>
    where
        Self: Sized;
}

pub trait CanRemove {
    fn can_remove(&self) -> bool;
}

impl CanRemove for () {
    fn can_remove(&self) -> bool {
        true
    }
}
impl CanRemove for usize {
    fn can_remove(&self) -> bool {
        *self == 0
    }
}
impl CanRemove for isize {
    fn can_remove(&self) -> bool {
        *self == 0
    }
}
impl CanRemove for u32 {
    fn can_remove(&self) -> bool {
        *self == 0
    }
}
impl CanRemove for i32 {
    fn can_remove(&self) -> bool {
        *self == 0
    }
}