pagedvector 0.1.0

A sparse paged vector with lazy page allocation.
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
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
// pagedvector.rs
//! This small crate helps creating a paged vector storage for large arrays of data where most of the vector storage is filled with default values (non-initialized).
//! 
//! The idea closely follows virtual memory allocation mechanism in operating systems.
//! Virtual storage is divided in equal-length chunks (pages) with a page book-keeping mechanism. If the user stores a non-default value, the corresponding page becomes allocated.
//! 
//! # Experimental
//!
//! `PagedVec` is currently experimental.
//!
//! Direct mutable access (`get_mut`, `IndexMut`, mutable slices) bypasses the
//! internal sparse bookkeeping. The sparse representation itself remains valid,
//! but allocation statistics and automatic page deallocation are not guaranteed
//! to remain correct after such modifications.
//!
//! Use [`PagedVec::set`] for bookkeeping-safe updates.

use std::ops::Index;
use std::ops::IndexMut;

use bincode::Encode;
use serde::{Deserialize, Serialize};

/*********************************************************************************************************************************************************/
/*********************************************************************************************************************************************************/

/// Internal representation of an allocated page.
#[derive(Clone,Debug, Serialize, Deserialize, Encode)]
struct Page<T> {
	data : Vec<T>,
	non_default: usize,
}

impl<T: Clone + PartialEq> Page<T> {
	/// new instance
	pub fn new(default: T, len: usize)->Self {
		return Self {
			data : vec![default; len],
			non_default : 0,
		};
	}
	
}


/*********************************************************************************************************************************************************/
/*********************************************************************************************************************************************************/

/// A vector-like structure with the storage split into equal-sized pages which are allocated only if non-default values are stored inside.
#[derive(Clone,Debug, Serialize, Deserialize, Encode)]
pub struct PagedVec<T> {
	psize : usize,
	vlen : usize,
	default : T,
	default_page : Vec<T>,
	pages : Vec<Option<Page<T>>>,
}

impl<T: Clone + PartialEq> PagedVec<T> {
	
	/// Create a new instance.
	/// 
	/// | Argument | Value |
	/// |---|---|
	/// | vlen | virtual length (similar to `.len()` in `Vec<T>`). |
	/// | default | the default value upon which pages are not allocated. |
	/// | psize | page size (preferrable as 2^N). |
	pub fn new(vlen: usize, default: T, psize: usize)-> Self {
		assert!(psize > 0);
		let npages = vlen.div_ceil(psize);
		return Self {
			psize : psize,
			vlen : vlen,
			default : default.clone(),
			default_page : vec![default;psize],
			pages : vec![None; npages],
		};
	}
	
	/// Virtual length of the vector.
	pub fn len(&self)->usize {
		return self.vlen;
	}
	
	/*********************************************************************************************************************************************************/
	/*********************************************************************************************************************************************************/
	
	pub fn is_default(&self, idx: usize)->bool {
		assert!(idx < self.vlen);
		let (vpn, off) = self.split_index(idx);
		match &self.pages[vpn] {
			Some(page) => {
				return page.data[off] == self.default;
			}
			None => {return true;}
		}
	}
	
	/// The total number of pages (allocated and empty).
	pub fn number_pages_total(&self)->usize {
		return self.pages.len();
	}
	
	/// Counts the number of allocated pages.
	pub fn number_pages_alloc(&self)->usize {
		let mut count = 0usize;
		for k in 0..self.pages.len(){
			if self.pages[k].is_some(){
				count += 1;
			}
		}
		return count;
	}
	
	/*********************************************************************************************************************************************************/
	/*********************************************************************************************************************************************************/
	
	#[inline]
	fn split_index(&self, idx: usize) -> (usize,usize) {
		return (idx / self.psize, idx % self.psize);
	}
	
	/// Return an immutable reference to a stored value.
	pub fn get(&self, idx: usize)-> &T {
		assert!(idx < self.vlen);
		let (vpn, off) = self.split_index(idx);
		match &self.pages[vpn] {
			Some(page) => {
				return &page.data[off];
			}
			None => {
				return &self.default;
			}
		}
	}
	
	/// Returns a mutable reference to the element at `idx`.
	///
	/// # Warning
	///
	/// This method bypasses the page bookkeeping mechanism. If the value is
	/// modified through the returned reference, the page's internal
	/// `non_default` counter is **not** updated.
	///
	/// Consequently:
	///
	/// - `number_pages_alloc()` may become incorrect;
	/// - pages containing only default values may not be automatically
	///   deallocated;
	/// - future versions of this crate may change this behavior.
	///
	/// If bookkeeping consistency is required, use [`PagedVec::set`] instead.
	///
	/// After arbitrary mutable modifications, call [`PagedVec::cleanup`] (planned)
	/// before relying on allocation statistics.
	#[deprecated(
    since = "0.1.0",
    note = "get_mut() bypasses sparse bookkeeping; use set() instead"
	)]
	pub fn get_mut(&mut self, idx: usize)-> &mut T {
		assert!(idx < self.vlen);
		let (vpn, off) = self.split_index(idx);
		if self.pages[vpn].is_none() {
			self.pages[vpn] = Some(Page::new(self.default.clone(), self.psize));
		}
		return &mut self.pages[vpn].as_mut().unwrap().data[off];
	}
	
	/// Returns a contiguous slice of vector memory (allocated or not), panics if the slice spans across more than one page.
	pub fn get_page_slice(&self, start: usize, len: usize)->&[T] {
		assert!(start <= self.vlen);
		assert!(len <= self.vlen - start);
		if len == 0 {
			return &self.default_page[0..0];
		}
		let (vpn0, off0) = self.split_index(start);
		let (vpn1, off1) = self.split_index(start + len - 1);
		assert_eq!(vpn0, vpn1);
		match &self.pages[vpn0] {
			Some(page) => {
				return &page.data[off0..=off1];
			}
			None => {
				return &self.default_page[off0..=off1];
			}
		}
	}
	
	/// Returns a contiguous slice of vector memory (preallocates, if necessary), panics if the slice spans across more than one page.
	/// 
	/// # Warning
	///
	/// This method bypasses the page bookkeeping mechanism. If the value is
	/// modified through the returned reference, the page's internal
	/// `non_default` counter is **not** updated.
	///
	/// Consequently:
	///
	/// - `number_pages_alloc()` may become incorrect;
	/// - pages containing only default values may not be automatically
	///   deallocated;
	/// - future versions of this crate may change this behavior.
	#[deprecated(
    since = "0.1.0",
    note = "mutable slice access bypasses sparse bookkeeping; use set() instead"
	)]
	pub fn get_page_slice_mut(&mut self, start: usize, len: usize)->&mut [T] {
		assert!(start <= self.vlen);
		assert!(len <= self.vlen - start);
		if len == 0 {
			return &mut self.default_page[0..0];
		}
		let (vpn0, off0) = self.split_index(start);
		let (vpn1, off1) = self.split_index(start + len - 1);
		assert_eq!(vpn0, vpn1);
		if self.pages[vpn0].is_none() {
			self.pages[vpn0] = Some(Page::new(self.default.clone(), self.psize));
		}
		return &mut self.pages[vpn0].as_mut().unwrap().data[off0..=off1];
	}
	
	/// Set a value at a specific index, default and non-default values are handled separately.
	pub fn set(&mut self, idx: usize, value: T) {
		assert!(idx < self.vlen);
		if value == self.default {
			return self.set_default(idx);
		} else {
			return self.set_nondefault(idx, value);
		}
	}
	
	/// Default case.
	fn set_default(&mut self, idx: usize) {
		let (vpn, off) = self.split_index(idx);
		let mut dealloc = false;
		match &mut self.pages[vpn] {
			Some(page) => {
				if page.data[off] != self.default {
					page.data[off] = self.default.clone();
					page.non_default -= 1;
				}
				if page.non_default == 0 {dealloc = true;}
			}
			None => {/*do nothing*/}
		}
		if dealloc {self.pages[vpn] = None;}
	}
	
	/// Non-default case.
	fn set_nondefault(&mut self, idx: usize, value : T) {
		let (vpn, off) = self.split_index(idx);
		if self.pages[vpn].is_none() {
			self.pages[vpn] = Some(Page::new(self.default.clone(),self.psize));
		}
		match &mut self.pages[vpn] {
			Some(page) => {
				if page.data[off] == self.default {
					page.non_default += 1;
				}
				page.data[off] = value;
			}
			None => {/*do nothing*/}
		}
	}
	
}

/*********************************************************************************************************************************************************/
/*********************************************************************************************************************************************************/


impl<T: Clone + PartialEq> Index<usize> for PagedVec<T> {
	type Output = T;
	
	fn index(&self, index: usize) -> &Self::Output {
		return self.get(index);
	}
	
}

/// Mutable indexing.
///
/// # Warning
///
/// Assignments through indexing
///
/// ```ignore
/// vec[i] = value;
/// ```
///
/// bypass the sparse bookkeeping logic in the current implementation.
/// This means allocation statistics and automatic page deallocation may
/// become inconsistent.
///
/// Prefer [`PagedVec::set`] whenever possible.
#[allow(deprecated)]
impl<T: Clone + PartialEq> IndexMut<usize> for PagedVec<T> {
	
	fn index_mut(&mut self, index: usize)-> &mut Self::Output {
		return self.get_mut(index);
	}
	
}

/*

/*********************************************************************************************************************************************************/
/*********************************************************************************************************************************************************/

impl<T: Clone + PartialEq> Index<Range<usize>> for PagedVec<T> {
	type Output = [T];
	
	fn index(&self, range: Range<usize>)->&Self::Output {
		let start = range.start;
		let end = range.end;
		assert!(start <= end);
		let len = end - start;
		return self.get_page_slice(start,len);
	}
}

impl<T: Clone + PartialEq> IndexMut<Range<usize>> for PagedVec<T> {
	
	fn index_mut(&mut self, range: Range<usize>)->&mut Self::Output {
		let start = range.start;
		let end = range.end;
		assert!(start <= end);
		let len = end - start;
		return self.get_page_slice_mut(start,len);
	}
	
}

/*********************************************************************************************************************************************************/
/*********************************************************************************************************************************************************/

impl<T: Clone + PartialEq> Index<RangeFrom<usize>> for PagedVec<T> {
	type Output = [T];
	
	fn index(&self, range: RangeFrom<usize>)->&Self::Output {
		let start = range.start;
		let end = self.len();
		assert!(start <= end);
		let len = end - start;
		return self.get_page_slice(start, len);
	}
	
}

impl<T: Clone + PartialEq> IndexMut<RangeFrom<usize>> for PagedVec<T> {
	
	fn index_mut(&mut self, range: RangeFrom<usize>)->&mut Self::Output {
		let start = range.start;
		let end = self.len();
		assert!(start <= end);
		let len = end - start;
		return self.get_page_slice_mut(start, len);
	}
	
}

/*********************************************************************************************************************************************************/
/*********************************************************************************************************************************************************/

impl<T: Clone + PartialEq> Index<RangeTo<usize>> for PagedVec<T> {
	type Output = [T];
	
	fn index(&self, range: RangeTo<usize>)->&Self::Output {
		let start = 0;
		let end = range.end;
		assert!(end <= self.len());
		let len = end - start;
		return self.get_page_slice(start, len);
	}
	
}

impl<T: Clone + PartialEq> IndexMut<RangeTo<usize>> for PagedVec<T> {
	
	fn index_mut(&mut self, range: RangeTo<usize>)->&mut Self::Output {
		let start = 0;
		let end = range.end;
		assert!(end <= self.len());
		let len = end - start;
		return self.get_page_slice_mut(start, len);
	}
	
}

/*********************************************************************************************************************************************************/
/*********************************************************************************************************************************************************/

impl<T: Clone + PartialEq> Index<RangeFull> for PagedVec<T> {
	type Output = [T];
	
	fn index(&self, _: RangeFull)->&Self::Output {
		let len = self.len();
		return self.get_page_slice(0, len);
	}
	
}

impl<T: Clone + PartialEq> IndexMut<RangeFull> for PagedVec<T> {
	
	fn index_mut(&mut self, _: RangeFull)->&mut Self::Output {
		let len = self.len();
		return self.get_page_slice_mut(0, len);
	}
	
}

/*********************************************************************************************************************************************************/
/*********************************************************************************************************************************************************/

impl<T: Clone + PartialEq> Index<RangeInclusive<usize>> for PagedVec<T> {
	type Output = [T];
	
	fn index(&self, range: RangeInclusive<usize>)->&Self::Output {
		let start = *range.start();
		let end = *range.end();
		assert!(start <= end);
		assert!(end < self.len());
		let len = end - start + 1;
		return self.get_page_slice(start,len);
	}
	
}

impl<T: Clone + PartialEq> IndexMut<RangeInclusive<usize>> for PagedVec<T> {
	
	fn index_mut(&mut self, range: RangeInclusive<usize>)->&mut Self::Output {
		let start = *range.start();
		let end = *range.end();
		assert!(start <= end);
		assert!(end < self.len());
		let len = end - start + 1;
		return self.get_page_slice_mut(start,len);
	}
	
}

/*********************************************************************************************************************************************************/
/*********************************************************************************************************************************************************/

impl<T: Clone + PartialEq> Index<RangeToInclusive<usize>> for PagedVec<T> {
	type Output = [T];
	
	fn index(&self, range: RangeToInclusive<usize>)->&Self::Output {
		let start = 0;
		let end = range.end;
		assert!(end < self.len());
		let len = end - start + 1;
		return self.get_page_slice(start,len);
	}
	
}

impl<T: Clone + PartialEq> IndexMut<RangeToInclusive<usize>> for PagedVec<T> {
	
	fn index_mut(&mut self, range: RangeToInclusive<usize>)->&mut Self::Output {
		let start = 0;
		let end = range.end;
		assert!(end < self.len());
		let len = end - start + 1;
		return self.get_page_slice_mut(start,len);
	}
	
}

/*********************************************************************************************************************************************************/
/*********************************************************************************************************************************************************/

*/