dstructs 0.1.0

A collection of high-performance data structures for Rust
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
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
//! 优化的向量实现
//!
//! 提供一个针对嵌入式环境优化的向量实现

use smallvec::SmallVec;
use std::iter::FromIterator;
use std::ops::{Deref, DerefMut, Index, IndexMut, Range, RangeBounds};

/// 针对小数组优化的向量类型
#[derive(Debug, Clone)]
#[repr(C, align(16))] // SIMD 对齐
pub struct Vector<T> {
    inner: SmallVec<[T; 16]>,
}

/// 用于批量移除元素的迭代器
pub struct Drain<'a, T: 'a> {
    vec: &'a mut Vector<T>,
    range: Range<usize>,
}

impl<T> Vector<T> {
    /// 创建新的向量
    #[inline(always)]
    pub fn new() -> Self {
        Self {
            inner: SmallVec::new(),
        }
    }

    /// 创建指定容量的向量
    #[inline(always)]
    pub fn with_capacity(capacity: usize) -> Self {
        Self {
            inner: SmallVec::with_capacity(capacity),
        }
    }

    /// 添加元素到向量末尾
    #[inline(always)]
    pub fn push(&mut self, value: T) {
        // 预分配增长策略优化
        if self.len() == self.capacity() {
            let new_cap = std::cmp::max(self.capacity() * 2, 4);
            self.reserve(new_cap - self.capacity());
        }
        self.inner.push(value);
    }

    /// 从向量末尾移除并返回元素
    #[inline(always)]
    pub fn pop(&mut self) -> Option<T> {
        self.inner.pop()
    }

    /// 返回向量的容量
    #[inline(always)]
    pub fn capacity(&self) -> usize {
        self.inner.capacity()
    }

    /// 清空向量
    #[inline(always)]
    pub fn clear(&mut self) {
        self.inner.clear();
    }

    /// 检查向量是否为空
    #[inline(always)]
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }

    /// 返回向量中的元素数量
    #[inline(always)]
    pub fn len(&self) -> usize {
        self.inner.len()
    }

    /// 预留至少能容纳 `additional` 个元素的空间
    #[inline]
    pub fn reserve(&mut self, additional: usize) {
        let new_cap = self.len() + additional;
        if new_cap > self.capacity() {
            // 使用指数增长策略
            let aligned_cap = (new_cap + 15) & !15; // 16字节对齐
            self.inner.reserve(aligned_cap - self.len());
        }
    }

    /// 将向量缩小到最小所需容量
    #[inline]
    pub fn shrink_to_fit(&mut self) {
        if self.spilled() {
            self.inner.shrink_to_fit();
        }
    }

    /// 获取原始指针
    #[inline(always)]
    pub fn as_ptr(&self) -> *const T {
        self.inner.as_ptr()
    }

    /// 获取可变原始指针
    #[inline(always)]
    pub fn as_mut_ptr(&mut self) -> *mut T {
        self.inner.as_mut_ptr()
    }

    /// 批量插入元素
    #[inline]
    pub fn extend_from_slice(&mut self, other: &[T])
    where
        T: Copy,
    {
        self.inner.extend_from_slice(other);
    }

    /// 追加另一个切片中的所有元素(克隆版本)
    #[inline]
    pub fn extend_from_slice_cloned(&mut self, other: &[T])
    where
        T: Clone,
    {
        self.inner.extend(other.iter().cloned());
    }

    /// 批量移除元素
    #[inline]
    pub fn drain<R>(&mut self, range: R) -> impl Iterator<Item = T> + '_
    where
        R: RangeBounds<usize>,
    {
        self.inner.drain(range)
    }

    /// 检查是否使用堆内存
    #[inline]
    pub fn spilled(&self) -> bool {
        self.inner.spilled()
    }

    /// 获取指定范围的切片
    #[inline]
    pub fn get(&self, index: usize) -> Option<&T> {
        self.inner.get(index)
    }

    /// 获取指定范围的可变切片
    #[inline]
    pub fn get_mut(&mut self, index: usize) -> Option<&mut T> {
        self.inner.get_mut(index)
    }

    /// 获取指定范围的切片
    #[inline]
    pub fn slice(&self, range: Range<usize>) -> Option<&[T]> {
        if range.start <= range.end && range.end <= self.len() {
            Some(&self.inner[range])
        } else {
            None
        }
    }

    /// 获取指定范围的可变切片
    #[inline]
    pub fn slice_mut(&mut self, range: Range<usize>) -> Option<&mut [T]> {
        let len = self.len();
        if range.start <= range.end && range.end <= len {
            Some(&mut self.inner[range])
        } else {
            None
        }
    }

    /// 在指定位置插入元素
    #[inline]
    pub fn insert(&mut self, index: usize, value: T) {
        self.inner.insert(index, value);
    }

    /// 移除指定位置的元素
    #[inline]
    pub fn remove(&mut self, index: usize) -> T {
        self.inner.remove(index)
    }

    /// 保留满足条件的元素
    #[inline]
    pub fn retain<F>(&mut self, mut f: F)
    where
        F: FnMut(&T) -> bool,
    {
        self.inner.retain(|x| f(x));
    }

    /// 将向量截断到指定长度
    #[inline]
    pub fn truncate(&mut self, len: usize) {
        self.inner.truncate(len);
    }

    /// 将所有元素移动到另一个向量中
    #[inline]
    pub fn append(&mut self, other: &mut Self) {
        let other_vec = std::mem::take(&mut other.inner);
        self.inner.extend(other_vec);
    }

    /// 分割向量,返回指定长度的前缀
    #[inline]
    pub fn split_off(&mut self, at: usize) -> Self {
        let mut other = Vector::new();
        if at < self.len() {
            other.extend(self.inner.drain(at..));
        }
        other
    }
}

impl<T> Default for Vector<T> {
    fn default() -> Self {
        Self::new()
    }
}

impl<T> Deref for Vector<T> {
    type Target = [T];

    fn deref(&self) -> &Self::Target {
        self.inner.as_slice()
    }
}

impl<T> DerefMut for Vector<T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        self.inner.as_mut_slice()
    }
}

impl<T> From<Vec<T>> for Vector<T> {
    fn from(vec: Vec<T>) -> Self {
        Self {
            inner: SmallVec::from_vec(vec),
        }
    }
}

impl<T> Extend<T> for Vector<T> {
    fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I) {
        self.inner.extend(iter);
    }
}

impl<T> FromIterator<T> for Vector<T> {
    fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self {
        let iter = iter.into_iter();
        let (lower, _) = iter.size_hint();
        let mut vector = Self::with_capacity(lower);
        vector.extend(iter);
        vector
    }
}

impl<T> IntoIterator for Vector<T> {
    type Item = T;
    type IntoIter = smallvec::IntoIter<[T; 16]>;

    fn into_iter(self) -> Self::IntoIter {
        self.inner.into_iter()
    }
}

impl<'a, T> IntoIterator for &'a Vector<T> {
    type Item = &'a T;
    type IntoIter = std::slice::Iter<'a, T>;

    fn into_iter(self) -> Self::IntoIter {
        self.inner.iter()
    }
}

impl<'a, T> IntoIterator for &'a mut Vector<T> {
    type Item = &'a mut T;
    type IntoIter = std::slice::IterMut<'a, T>;

    fn into_iter(self) -> Self::IntoIter {
        self.inner.iter_mut()
    }
}

impl<T> Index<usize> for Vector<T> {
    type Output = T;

    fn index(&self, index: usize) -> &Self::Output {
        &self.inner[index]
    }
}

impl<T> IndexMut<usize> for Vector<T> {
    fn index_mut(&mut self, index: usize) -> &mut Self::Output {
        &mut self.inner[index]
    }
}

impl<T> AsRef<[T]> for Vector<T> {
    fn as_ref(&self) -> &[T] {
        self.inner.as_ref()
    }
}

impl<T> AsMut<[T]> for Vector<T> {
    fn as_mut(&mut self) -> &mut [T] {
        self.inner.as_mut()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_vector_creation() {
        let vec: Vector<i32> = Vector::new();
        assert_eq!(vec.len(), 0);
        assert!(vec.is_empty());
        assert!(!vec.spilled());

        let vec = Vector::<i32>::with_capacity(10);
        assert_eq!(vec.len(), 0);
        assert!(vec.capacity() >= 10);
    }

    #[test]
    fn test_vector_push() {
        let mut vec: Vector<i32> = Vector::new();
        vec.push(1);
        vec.push(2);
        vec.push(3);

        assert_eq!(vec.len(), 3);
        assert_eq!(vec[0], 1);
        assert_eq!(vec[1], 2);
        assert_eq!(vec[2], 3);
    }

    #[test]
    fn test_vector_pop() {
        let mut vec = Vector::new();
        vec.push(1);
        vec.push(2);

        assert_eq!(vec.pop(), Some(2));
        assert_eq!(vec.len(), 1);
        assert_eq!(vec.pop(), Some(1));
        assert_eq!(vec.pop(), None);
    }

    #[test]
    fn test_vector_clear() {
        let mut vec = Vector::new();
        vec.push(1);
        vec.push(2);
        vec.clear();

        assert!(vec.is_empty());
        assert_eq!(vec.len(), 0);
    }

    #[test]
    fn test_vector_from_vec() {
        let std_vec = vec![1, 2, 3];
        let vec = Vector::from(std_vec);

        assert_eq!(vec.len(), 3);
        assert_eq!(&*vec, &[1, 2, 3]);
    }

    #[test]
    fn test_vector_extend() {
        let mut vec = Vector::new();
        vec.extend(0..3);

        assert_eq!(vec.len(), 3);
        assert_eq!(&*vec, &[0, 1, 2]);
    }

    #[test]
    fn test_vector_spill() {
        let mut vec: Vector<i32> = Vector::new();
        assert!(!vec.spilled());

        // 添加超过内联存储容量的元素
        for i in 0..32 {
            vec.push(i);
        }

        // 验证是否溢出到堆上
        assert!(vec.spilled());
    }

    #[test]
    fn test_from_iterator() {
        let vec: Vector<i32> = (0..5).collect();
        assert_eq!(&*vec, &[0, 1, 2, 3, 4]);
    }

    #[test]
    fn test_into_iterator() {
        let vec: Vector<i32> = (0..5).collect();
        let sum: i32 = vec.into_iter().sum();
        assert_eq!(sum, 10);
    }

    #[test]
    fn test_slice_operations() {
        let mut vec = Vector::new();
        vec.extend(0..5);

        assert_eq!(vec.slice(1..4), Some(&[1, 2, 3][..]));
        assert_eq!(vec.get(5), None);

        if let Some(value) = vec.get_mut(1) {
            *value = 10;
        }
        assert_eq!(&*vec, &[0, 10, 2, 3, 4]);
    }

    #[test]
    fn test_insert_remove() {
        let mut vec = Vector::new();
        vec.extend(0..3);

        vec.insert(1, 10);
        assert_eq!(&*vec, &[0, 10, 1, 2]);

        assert_eq!(vec.remove(1), 10);
        assert_eq!(&*vec, &[0, 1, 2]);
    }

    #[test]
    fn test_retain() {
        let mut vec = Vector::new();
        vec.extend(0..5);

        vec.retain(|&x| x % 2 == 0);
        assert_eq!(&*vec, &[0, 2, 4]);
    }

    #[test]
    fn test_append() {
        let mut vec1 = Vector::new();
        let mut vec2 = Vector::new();

        vec1.extend(0..3);
        vec2.extend(3..6);

        vec1.append(&mut vec2);
        assert_eq!(&*vec1, &[0, 1, 2, 3, 4, 5]);
        assert!(vec2.is_empty());
    }

    #[test]
    fn test_split_off() {
        let mut vec = Vector::new();
        vec.extend(0..5);

        let vec2 = vec.split_off(2);
        assert_eq!(&*vec, &[0, 1]);
        assert_eq!(&*vec2, &[2, 3, 4]);
    }

    #[test]
    fn test_performance_critical_path() {
        let mut vec = Vector::with_capacity(1000);

        // 测试连续 push 的性能
        for i in 0..1000 {
            vec.push(i);
        }
        assert_eq!(vec.len(), 1000);

        // 测试批量操作性能
        let data: Vec<i32> = (0..1000).collect();
        let mut vec = Vector::new();
        vec.extend_from_slice(&data);
        assert_eq!(vec.len(), 1000);

        // 测试内存对齐
        assert_eq!(std::mem::align_of_val(&vec) % 16, 0);
    }
}