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
/*
Copyright 2020 Martin Buck
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall
be included all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
//! DynamicPrecisionIndexVec is a memory efficient container with a usize interface. It uses u8 -> u16 -> u32 -> usize for storage depending on the largest index's size
use crate::{IsIndexContainer, IsIndexContainerIterator};
use std::{u16, u32, u8, usize};
//------------------------------------------------------------------------------
#[derive(Clone, Default)]
/// DynamicPrecisionIndexVec is a memory efficient container with a usize interface. It uses u8 -> u16 -> u32 -> usize for storage depending on the largest index's size
pub struct DynamicPrecisionIndexVec {
mode: Mode,
}
//@todo implement as much of the Vec interface as possible
impl DynamicPrecisionIndexVec {
/// Creates a new DynamicPrecisionIndexVec with u8 precision
pub fn new() -> Self {
Self {
mode: Mode::U8(Vec::new()),
}
}
/// If storage is currently done with u8 precision, returns a reference to the inner Vec
pub fn get_u8(&self) -> Option<&Vec<u8>> {
match self.mode {
Mode::U8(ref vec) => Some(vec),
_ => None,
}
}
/// If storage is currently done with u8 precision, returns a mutable reference to the inner Vec
pub fn get_u8_mut(&mut self) -> Option<&mut Vec<u8>> {
match self.mode {
Mode::U8(ref mut vec) => Some(vec),
_ => None,
}
}
/// If storage is currently done with u16 precision, returns a reference to the inner Vec
pub fn get_u16(&self) -> Option<&Vec<u16>> {
match self.mode {
Mode::U16(ref vec) => Some(vec),
_ => None,
}
}
/// If storage is currently done with u16 precision, returns a mutable reference to the inner Vec
pub fn get_u16_mut(&mut self) -> Option<&mut Vec<u16>> {
match self.mode {
Mode::U16(ref mut vec) => Some(vec),
_ => None,
}
}
/// If storage is currently done with u32 precision, returns a reference to the inner Vec
pub fn get_u32(&self) -> Option<&Vec<u32>> {
match self.mode {
Mode::U32(ref vec) => Some(vec),
_ => None,
}
}
/// If storage is currently done with u32 precision, returns a mutable reference to the inner Vec
pub fn get_u32_mut(&mut self) -> Option<&mut Vec<u32>> {
match self.mode {
Mode::U32(ref mut vec) => Some(vec),
_ => None,
}
}
/// If storage is currently done with usize precision, returns a reference to the inner Vec
pub fn get_usize(&mut self) -> Option<&Vec<usize>> {
match self.mode {
Mode::Usize(ref vec) => Some(vec),
_ => None,
}
}
/// If storage is currently done with usize precision, returns a mutable reference to the inner Vec
pub fn get_usize_mut(&mut self) -> Option<&mut Vec<usize>> {
match self.mode {
Mode::Usize(ref mut vec) => Some(vec),
_ => None,
}
}
/// First promotes the precision to usize, then returns a reference to the Vec<usize>. Calling this might unnecessarily increase memory usage
pub fn get_usize_upgraded(&mut self) -> &Vec<usize> {
self.upgrade_to_usize();
match self.mode {
Mode::Usize(ref vec) => vec,
_ => panic!("Logic error in get_usize_upgraded of DynamicPrecisionIndexVec"),
}
}
/// First promotes the precision to usize, then returns a mutable reference to the Vec<usize>. Calling this might unnecessarily increase memory usage
pub fn get_usize_upgraded_mut(&mut self) -> &mut Vec<usize> {
self.upgrade_to_usize();
match self.mode {
Mode::Usize(ref mut vec) => vec,
_ => panic!("Logic error in get_usize_upgraded_mut of DynamicPrecisionIndexVec"),
}
}
fn upgrade_to_usize(&mut self) {
if let Some(new_mode) = match self.mode {
Mode::U8(ref vec) => {
let new = vec.iter().map(|x| *x as usize).collect();
Some(Mode::Usize(new))
}
Mode::U16(ref vec) => {
let new = vec.iter().map(|x| *x as usize).collect();
Some(Mode::Usize(new))
}
Mode::U32(ref vec) => {
let new = vec.iter().map(|x| *x as usize).collect();
Some(Mode::Usize(new))
}
Mode::Usize(_) => None,
} {
self.mode = new_mode;
}
}
fn upgrade_to_u32(&mut self) {
if let Some(new_mode) = match self.mode {
Mode::U8(ref vec) => {
let new = vec.iter().map(|x| *x as u32).collect();
Some(Mode::U32(new))
}
Mode::U16(ref vec) => {
let new = vec.iter().map(|x| *x as u32).collect();
Some(Mode::U32(new))
}
Mode::U32(_) => None,
Mode::Usize(_) => None,
} {
self.mode = new_mode;
}
}
fn upgrade_to_u16(&mut self) {
if let Some(new_mode) = match self.mode {
Mode::U8(ref vec) => {
let new = vec.iter().map(|x| *x as u16).collect();
Some(Mode::U16(new))
}
Mode::U16(_) => None,
Mode::U32(_) => None,
Mode::Usize(_) => None,
} {
self.mode = new_mode;
}
}
fn allowed_max(&self) -> usize {
match self.mode {
Mode::U8(_) => u8::MAX as usize,
Mode::U16(_) => u16::MAX as usize,
Mode::U32(_) => u32::MAX as usize,
Mode::Usize(_) => usize::MAX,
}
}
}
//------------------------------------------------------------------------------
impl IsIndexContainer for DynamicPrecisionIndexVec {
fn ensure_supported(&mut self, x: usize) {
if x <= self.allowed_max() {
return;
}
if x > u32::MAX as usize {
self.upgrade_to_usize();
} else if x > u16::MAX as usize {
self.upgrade_to_u32();
} else if x > u8::MAX as usize {
self.upgrade_to_u16();
}
}
fn get(&self, i: usize) -> usize {
match self.mode {
Mode::U8(ref vec) => vec[i] as usize,
Mode::U16(ref vec) => vec[i] as usize,
Mode::U32(ref vec) => vec[i] as usize,
Mode::Usize(ref vec) => vec[i] as usize,
}
}
fn set(&mut self, i: usize, x: usize) {
self.ensure_supported(x);
match self.mode {
Mode::U8(ref mut vec) => vec[i] = x as u8,
Mode::U16(ref mut vec) => vec[i] = x as u16,
Mode::U32(ref mut vec) => vec[i] = x as u32,
Mode::Usize(ref mut vec) => vec[i] = x,
}
}
fn push(&mut self, x: usize) {
self.ensure_supported(x);
match self.mode {
Mode::U8(ref mut vec) => vec.push(x as u8),
Mode::U16(ref mut vec) => vec.push(x as u16),
Mode::U32(ref mut vec) => vec.push(x as u32),
Mode::Usize(ref mut vec) => vec.push(x),
}
}
fn len(&self) -> usize {
match self.mode {
Mode::U8(ref vec) => vec.len(),
Mode::U16(ref vec) => vec.len(),
Mode::U32(ref vec) => vec.len(),
Mode::Usize(ref vec) => vec.len(),
}
}
fn reserve(&mut self, n: usize) {
match self.mode {
Mode::U8(ref mut vec) => vec.reserve(n),
Mode::U16(ref mut vec) => vec.reserve(n),
Mode::U32(ref mut vec) => vec.reserve(n),
Mode::Usize(ref mut vec) => vec.reserve(n),
}
}
fn iter(&self) -> IsIndexContainerIterator<Self> {
IsIndexContainerIterator::new(self)
}
}
impl From<&Vec<usize>> for DynamicPrecisionIndexVec {
fn from(vec: &Vec<usize>) -> Self {
let mut result = Self::new();
if let Some(max) = vec.iter().max() {
result.ensure_supported(max);
result.reserve(vec.len());
for x in vec.iter() {
result.push(x)
}
}
result
}
}
impl From<Vec<usize>> for DynamicPrecisionIndexVec {
fn from(vec: Vec<usize>) -> Self {
Self::from(&vec)
}
}
impl From<&Vec<u32>> for DynamicPrecisionIndexVec {
fn from(vec: &Vec<u32>) -> Self {
let mut result = Self::new();
if let Some(max) = vec.iter().max() {
result.ensure_supported(*max as usize);
result.reserve(vec.len());
for x in vec.iter() {
result.push(*x as usize)
}
}
result
}
}
impl From<Vec<u32>> for DynamicPrecisionIndexVec {
fn from(vec: Vec<u32>) -> Self {
Self::from(&vec)
}
}
impl From<&Vec<u16>> for DynamicPrecisionIndexVec {
fn from(vec: &Vec<u16>) -> Self {
let mut result = Self::new();
if let Some(max) = vec.iter().max() {
result.ensure_supported(*max as usize);
result.reserve(vec.len());
for x in vec.iter() {
result.push(*x as usize)
}
}
result
}
}
impl From<Vec<u16>> for DynamicPrecisionIndexVec {
fn from(vec: Vec<u16>) -> Self {
Self::from(&vec)
}
}
impl From<&Vec<u8>> for DynamicPrecisionIndexVec {
fn from(vec: &Vec<u8>) -> Self {
Self::from(vec.clone())
}
}
impl From<Vec<u8>> for DynamicPrecisionIndexVec {
fn from(vec: Vec<u8>) -> Self {
Self {
mode: Mode::U8(vec),
}
}
}
//------------------------------------------------------------------------------
#[derive(Clone)]
enum Mode {
U8(Vec<u8>),
U16(Vec<u16>),
U32(Vec<u32>),
Usize(Vec<usize>),
}
impl Default for Mode {
fn default() -> Self {
Self::U8(Vec::new())
}
}