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
use crate::ImpVec;
use orx_pinned_vec::PinnedVec;
impl<T, P> ImpVec<T, P>
where
P: PinnedVec<T>,
{
/// Appends an element to the back of a collection.
///
/// Unlike `std::vec::Vec` or `orx_split_vec::SplitVec`;
/// push operation for `ImpVec` does **not** require a mutable reference.
///
/// # Examples
///
/// ```
/// use orx_imp_vec::prelude::*;
///
/// let vec: ImpVec<_, _> = FixedVec::new(10).into();
/// vec.push(1);
/// vec.push(2);
///
/// // since push does not require a mut reference,
/// // it is legal to hold on to other immutable references
/// // while pushing elements.
/// let ref_elem = &vec[1];
/// let ref_elem_addr = ref_elem as *const i32;
/// assert_eq!(2, *ref_elem);
///
/// vec.push(3);
/// vec.push(4);
/// vec.push(5);
///
/// assert_eq!(2, *ref_elem);
/// assert_eq!(vec, [1, 2, 3, 4, 5]);
///
/// let ref_elem_addr_after_growth = &vec[1] as *const i32;
/// assert_eq!(ref_elem_addr, ref_elem_addr_after_growth);
/// ```
pub fn push(&self, value: T) {
let data = self.as_mut_ptr();
unsafe {
let pinned_vec = &mut *data;
pinned_vec.push(value);
}
}
}
impl<'a, T, P> ImpVec<T, P>
where
P: PinnedVec<T> + 'a,
{
/// Appends an element to the back of a collection and returns a reference to it.
///
/// The reference will always be valid unless the collection is mutated;
/// note that methods that grows the vector do **not** require a mutable reference,
/// such as, `push`, `push_get_ref`, `extend` or `extend_from_slice` methods.
///
/// # Examples
///
/// Hold on to valid references while pushing new items,
/// as long as the collection is not mutated with methods such as `insert`, `remove` or `pop`.
///
/// ```
/// use orx_imp_vec::prelude::*;
///
/// let vec: ImpVec<_, _> = FixedVec::new(10).into();
/// let ref1 = vec.push_get_ref(1);
/// let ref_elem_addr = ref1 as *const i32;
///
/// vec.push(2);
/// vec.push(3);
/// let ref4 = vec.push_get_ref(4);
///
/// // capacity is expaneded here from 4 to 8; however, in chunks;
/// // therefore, data is not moved around and the references remain valid.
/// let ref5 = vec.push_get_ref(5);
///
///
/// assert_eq!(ref1, &1);
/// assert_eq!(ref4, &4);
/// assert_eq!(ref5, &5);
/// assert_eq!(vec, [1, 2, 3, 4, 5]);
///
/// let ref_elem_addr_after_growth = &vec[0] as *const i32;
/// assert_eq!(ref_elem_addr, ref_elem_addr_after_growth);
/// ```
///
/// As you may see below, any mutable method that can possibly invalidate the references
/// are not allowed.
///
/// ```
/// use orx_imp_vec::prelude::*;
///
/// let mut vec: ImpVec<_, _> = SplitVec::with_linear_growth(10).into(); // mut required for the `insert`
/// let ref1 = vec.push_get_ref(1);
/// vec.push(2);
/// vec.push(3);
///
/// assert_eq!(ref1, &1);
/// assert_eq!(vec, [1, 2, 3]);
///
/// vec.insert(0, 42);
/// assert_eq!(vec, [42, 1, 2, 3]);
///
/// // below line does not compile as the 'insert' call breaks reference 'ref1'
/// // let value1 = *ref1;
/// ```
pub fn push_get_ref<'b>(&'b self, value: T) -> &'a T
where
'a: 'b,
{
let data = self.as_mut_ptr();
unsafe {
let pinned_vec = &mut *data;
pinned_vec.push(value);
pinned_vec.get_unchecked(pinned_vec.len() - 1)
}
}
}
#[cfg(test)]
mod tests {
use crate::prelude::*;
use crate::test_all_growth_types;
use crate::test_all_pinned_types;
use std::fmt::Debug;
#[test]
fn push() {
fn test<P: PinnedVec<usize>>(pinned_vec: P) {
let imp: ImpVec<_, _> = pinned_vec.into();
let mut initial_refs = vec![];
for i in 0..1000 {
imp.push(i * 10);
initial_refs.push(&imp[i] as *const usize);
}
let expected_vals: Vec<_> = (0..1000).map(|i| i * 10).collect();
assert_eq!(expected_vals, imp);
let mut final_refs = vec![];
for i in 0..1000 {
final_refs.push(&imp[i] as *const usize);
}
assert_eq!(initial_refs, final_refs);
}
test_all_pinned_types!(test);
}
#[test]
fn push_get_ref() {
fn test<P: PinnedVec<usize>>(pinned_vec: P) {
let imp: ImpVec<_, _> = pinned_vec.into();
let mut initial_refs = vec![];
let first_ref = imp.push_get_ref(0);
initial_refs.push(first_ref as *const usize);
for i in 1..1000 {
initial_refs.push(imp.push_get_ref(i * 10) as *const usize);
}
let expected_vals: Vec<_> = (0..1000).map(|i| i * 10).collect();
assert_eq!(expected_vals, imp);
let mut final_refs = vec![];
for i in 0..1000 {
final_refs.push(&imp[i] as *const usize);
}
assert_eq!(initial_refs, final_refs);
assert_eq!(0, *first_ref);
}
test_all_pinned_types!(test);
}
// cons-list
#[derive(Debug)]
enum List<'a, T> {
Cons(T, &'a List<'a, T>),
Nil,
}
impl<'a, T> List<'a, T> {
fn cons(&self) -> Option<&'a List<'a, T>> {
match self {
List::Nil => None,
List::Cons(_, x) => Some(*x),
}
}
}
impl<'a, T: PartialEq> PartialEq for List<'a, T> {
fn eq(&self, other: &Self) -> bool {
match (self, other) {
(Self::Cons(l0, l1), Self::Cons(r0, r1)) => {
l0 == r0
&& std::ptr::eq(l1 as *const &'a List<'a, T>, r1 as *const &'a List<'a, T>)
}
_ => core::mem::discriminant(self) == core::mem::discriminant(other),
}
}
}
type MyList<'a> = List<'a, usize>;
#[test]
fn make_cons_list() {
fn test<'a, P>(pinned_vec: P)
where
P: PinnedVec<MyList<'a>> + 'a,
{
fn lists_maker<'a, P>(pinned_vec: P) -> ImpVec<MyList<'a>, P>
where
P: PinnedVec<MyList<'a>> + 'a,
{
let lists: ImpVec<MyList<'a>, P> = pinned_vec.into();
let r0 = lists.push_get_ref(List::Nil);
let r1 = lists.push_get_ref(List::Cons(1, r0));
let r2 = lists.push_get_ref(List::Cons(2, r1));
lists.push(List::Cons(3, r2));
lists
}
// data
let lists = lists_maker(pinned_vec);
assert!(matches!(lists[0], List::Nil));
assert!(matches!(lists[1], List::Cons(1, _)));
assert!(matches!(lists[2], List::Cons(2, _)));
assert!(matches!(lists[3], List::Cons(3, _)));
// references
assert_eq!(lists[0].cons(), None);
assert_eq!(lists[1].cons(), Some(&lists[0]));
assert_eq!(lists[2].cons(), Some(&lists[1]));
assert_eq!(lists[3].cons(), Some(&lists[2]));
// ptr-eq
let cons_ptrs: Vec<_> = lists
.iter()
.map(|x| x.cons().map(|x| x as *const MyList<'a>))
.collect();
assert!(std::ptr::eq(
cons_ptrs[1].expect("-"),
&lists[0] as *const MyList<'a>
));
assert!(std::ptr::eq(
cons_ptrs[2].expect("-"),
&lists[1] as *const MyList<'a>
));
assert!(std::ptr::eq(
cons_ptrs[3].expect("-"),
&lists[2] as *const MyList<'a>
));
}
test_all_pinned_types!(test);
}
#[test]
fn make_cons_list_as_pinned() {
fn test<'a, G>(pinned_vec: SplitVec<MyList<'a>, G>)
where
G: SplitVecGrowth<MyList<'a>> + 'a,
{
fn lists_maker<'a, G>(pinned_vec: SplitVec<MyList<'a>, G>) -> SplitVec<MyList<'a>, G>
where
G: SplitVecGrowth<MyList<'a>> + 'a,
{
let lists: ImpVec<_, _> = pinned_vec.into();
let r0 = lists.push_get_ref(List::Nil);
let r1 = lists.push_get_ref(List::Cons(1, r0));
let r2 = lists.push_get_ref(List::Cons(2, r1));
lists.push(List::Cons(3, r2));
lists.into()
}
// data
let lists = lists_maker(pinned_vec);
assert!(matches!(lists[0], List::Nil));
assert!(matches!(lists[1], List::Cons(1, _)));
assert!(matches!(lists[2], List::Cons(2, _)));
assert!(matches!(lists[3], List::Cons(3, _)));
// references
assert_eq!(lists[0].cons(), None);
assert_eq!(lists[1].cons(), Some(&lists[0]));
assert_eq!(lists[2].cons(), Some(&lists[1]));
assert_eq!(lists[3].cons(), Some(&lists[2]));
// ptr-eq
let cons_ptrs: Vec<_> = lists
.into_iter()
.map(|x| x.cons().map(|x| x as *const MyList<'a>))
.collect();
assert!(std::ptr::eq(
cons_ptrs[1].expect("-"),
&lists[0] as *const MyList<'a>
));
assert!(std::ptr::eq(
cons_ptrs[2].expect("-"),
&lists[1] as *const MyList<'a>
));
assert!(std::ptr::eq(
cons_ptrs[3].expect("-"),
&lists[2] as *const MyList<'a>
));
}
test_all_growth_types!(test);
}
#[test]
fn make_cons_list_as_pinned_long() {
fn test<'a, G>(pinned_vec: SplitVec<MyList<'a>, G>)
where
G: SplitVecGrowth<MyList<'a>> + 'a,
{
fn lists_maker<'a, G>(pinned_vec: SplitVec<MyList<'a>, G>) -> SplitVec<MyList<'a>, G>
where
G: SplitVecGrowth<MyList<'a>> + 'a,
{
let lists: ImpVec<_, _> = pinned_vec.into();
let mut last = lists.push_get_ref(List::Nil);
for i in 1..10000 {
last = lists.push_get_ref(List::Cons(i, last));
}
lists.into()
}
let lists = lists_maker(pinned_vec);
assert_eq!(10000, lists.len());
// data
assert!(matches!(lists[0], List::Nil));
for i in 1..10000 {
assert!(matches!(lists[i], List::Cons(_, _)));
}
// references
assert_eq!(lists[0].cons(), None);
for i in 1..10000 {
assert_eq!(lists[i].cons(), Some(&lists[i - 1]));
}
// ptr-eq
let cons_ptrs: Vec<_> = lists
.into_iter()
.map(|x| x.cons().map(|x| x as *const MyList<'a>))
.collect();
for i in 1..10000 {
assert!(std::ptr::eq(
cons_ptrs[i].expect("-"),
&lists[i - 1] as *const MyList<'a>
));
}
}
test_all_growth_types!(test);
}
}