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
use super::growth_trait::SplitVecGrowth;
use crate::{Fragment, SplitVec};
/// Stategy which allows the split vector to grow linearly.
///
/// In other words, each new fragment will have equal capacity,
/// which is equal to the capacity of the first fragment.
///
/// # Examples
///
/// ```
/// use orx_split_vec::prelude::*;
///
/// // SplitVec<usize, LinearGrowth>
/// let mut vec = SplitVec::with_linear_growth(16);
///
/// assert_eq!(1, vec.fragments().len());
/// assert_eq!(Some(16), vec.fragments().first().map(|f| f.capacity()));
/// assert_eq!(Some(0), vec.fragments().first().map(|f| f.len()));
///
/// // push 160 elements
/// for i in 0..10 * 16 {
/// vec.push(i);
/// }
///
/// assert_eq!(10, vec.fragments().len());
/// for fragment in vec.fragments() {
/// assert_eq!(16, fragment.len());
/// assert_eq!(16, fragment.capacity());
/// }
///
/// // push the 161-st element
/// vec.push(42);
/// assert_eq!(11, vec.fragments().len());
/// assert_eq!(Some(16), vec.fragments().last().map(|f| f.capacity()));
/// assert_eq!(Some(1), vec.fragments().last().map(|f| f.len()));
/// ```
#[derive(Debug, Default, Clone, PartialEq)]
pub struct LinearGrowth;
const DEFAULT_FRAGMENT_CAPACITY: usize = 32;
impl<T> SplitVecGrowth<T> for LinearGrowth {
fn new_fragment_capacity(&self, fragments: &[Fragment<T>]) -> usize {
fragments
.last()
.map(|f| f.capacity())
.unwrap_or(DEFAULT_FRAGMENT_CAPACITY)
}
fn get_fragment_and_inner_indices(
&self,
fragments: &[Fragment<T>],
element_index: usize,
) -> Option<(usize, usize)> {
let cap = fragments[fragments.len() - 1].capacity();
let mut div = 0;
let mut rem = element_index;
while rem >= cap {
div += 1;
rem -= cap;
}
if div < fragments.len() && rem < fragments[div].len() {
Some((div, rem))
} else {
None
}
}
}
impl<T> SplitVec<T, LinearGrowth> {
/// Creates a split vector with linear growth and given `constant_fragment_capacity`.
///
/// Assuming it is the common case compared to empty vector scenarios,
/// it immediately allocates the first fragment to keep the `SplitVec` struct smaller.
///
/// # Panics
/// Panics if `constant_fragment_capacity` is zero.
///
/// # Examples
///
/// ```
/// use orx_split_vec::prelude::*;
///
/// // SplitVec<usize, LinearGrowth>
/// let mut vec = SplitVec::with_linear_growth(16);
///
/// assert_eq!(1, vec.fragments().len());
/// assert_eq!(Some(16), vec.fragments().first().map(|f| f.capacity()));
/// assert_eq!(Some(0), vec.fragments().first().map(|f| f.len()));
///
/// // push 160 elements
/// for i in 0..10 * 16 {
/// vec.push(i);
/// }
///
/// assert_eq!(10, vec.fragments().len());
/// for fragment in vec.fragments() {
/// assert_eq!(16, fragment.len());
/// assert_eq!(16, fragment.capacity());
/// }
///
/// // push the 161-st element
/// vec.push(42);
/// assert_eq!(11, vec.fragments().len());
/// assert_eq!(Some(16), vec.fragments().last().map(|f| f.capacity()));
/// assert_eq!(Some(1), vec.fragments().last().map(|f| f.len()));
/// ```
pub fn with_linear_growth(constant_fragment_capacity: usize) -> Self {
assert!(constant_fragment_capacity > 0);
Self {
fragments: vec![Fragment::new(constant_fragment_capacity)],
growth: LinearGrowth,
}
}
}
#[cfg(test)]
mod tests {
use crate::{Fragment, LinearGrowth, SplitVecGrowth};
#[test]
fn new_cap() {
fn new_fra() -> Fragment<usize> {
Vec::<usize>::with_capacity(10).into()
}
let growth = LinearGrowth;
assert_eq!(10, growth.new_fragment_capacity(&[new_fra()]));
assert_eq!(10, growth.new_fragment_capacity(&[new_fra(), new_fra()]));
assert_eq!(
10,
growth.new_fragment_capacity(&[new_fra(), new_fra(), new_fra()])
);
}
#[test]
#[should_panic]
fn indices_panics_when_fragments_is_empty() {
assert_eq!(
None,
<LinearGrowth as SplitVecGrowth<usize>>::get_fragment_and_inner_indices(
&LinearGrowth,
&[],
0
)
);
}
#[test]
fn indices() {
fn new_full() -> Fragment<usize> {
(0..10).collect::<Vec<_>>().into()
}
fn new_half() -> Fragment<usize> {
let mut vec = Vec::with_capacity(10);
for i in 0..5 {
vec.push(10 + i);
}
vec.into()
}
let growth = LinearGrowth;
for i in 0..10 {
assert_eq!(
Some((0, i)),
growth.get_fragment_and_inner_indices(&[new_full()], i)
);
}
assert_eq!(
None,
growth.get_fragment_and_inner_indices(&[new_full()], 10)
);
for i in 0..10 {
assert_eq!(
Some((0, i)),
growth.get_fragment_and_inner_indices(&[new_full(), new_half()], i)
);
}
for i in 10..15 {
assert_eq!(
Some((1, i - 10)),
growth.get_fragment_and_inner_indices(&[new_full(), new_half()], i)
);
}
assert_eq!(
None,
growth.get_fragment_and_inner_indices(&[new_full(), new_half()], 15)
);
}
}