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
pub mod iter;
use std::fmt::{Debug, Display};
use std::ops::{Add, Index, IndexMut};
use crate::iter::CircularArrayIter;
/// A circular array that allows infinite pushes into a fixed-size array.
#[derive(Debug)]
pub struct CircularArray<const N: usize, T> {
arr: [T;N],
start: usize,
seq: usize,
}
impl<const N: usize, T> CircularArray<N, T> where T: Copy + Default + Debug + Display {
pub fn new() -> Self {
Self {
arr: [T::default(); N],
start: 0,
seq: 0,
}
}
/// # example
/// ```
/// use circular_array::CircularArray;
/// #[test]
/// fn test_push() {
/// let mut arr = CircularArray::<3, u32>::new();
/// arr.push(1);
/// arr.push(2);
/// arr.push(3);
/// assert_eq!(arr.to_array(), [1, 2, 3]);
/// arr.push(4);
/// assert_eq!(arr.to_array(), [2, 3, 4]);
/// }
/// ```
pub fn push(&mut self, item: T) {
if self.seq >= N {
println!("1 {}", item);
self.arr[self.start] = item;
} else {
println!("2");
self.arr[self.seq] = item;
}
self.start = (self.start + 1) % N;
self.seq += 1;
}
/// ## Examples
/// ```
/// use circular_array::CircularArray;
/// #[test]
/// fn test_to_array() {
/// let mut arr = CircularArray::<3, u32>::new();
/// arr.push(1);
/// arr.push(2);
/// arr.push(3);
/// assert_eq!(arr.to_array(), [1, 2, 3]);
/// arr.push(4);
/// assert_eq!(arr.to_array(), [2, 3, 4]);
/// }
/// ```
pub fn to_array(&self) -> [T;N] {
unsafe {
let mut arr = [T::default(); N];
let src_ptr = self.arr.as_ptr();
let dest_ptr = arr.as_mut_ptr();
if self.seq >= N && self.start > 0 {
std::ptr::copy_nonoverlapping(src_ptr.add(self.start), dest_ptr, N - self.start);
std::ptr::copy_nonoverlapping(src_ptr, dest_ptr.add(N - self.start), N - self.start);
} else {
std::ptr::copy_nonoverlapping(src_ptr, dest_ptr, N);
}
arr
}
}
/// # example
/// ```
/// use circular_array::CircularArray;
/// let mut arr = CircularArray::<3, u32>::new();
/// arr.push(1);
/// arr.push(2);
/// arr.push(3);
/// let mut iter: circular_array::iter::CircularArrayIter<3, u32> = arr.iter();
/// assert_eq!(iter.next(), Some(&1));
/// assert_eq!(iter.next(), Some(&2));
/// assert_eq!(iter.next(), Some(&3));
/// assert_eq!(iter.next(), None);
/// ```
pub fn iter(&self) -> CircularArrayIter<N, T> {
CircularArrayIter::new(&self)
}
}
impl<T, const N: usize> Index<usize> for CircularArray<N, T> where [T]: Index<usize>, T: Default + Copy
{
type Output = <[T] as Index<usize>>::Output;
#[inline]
fn index(&self, index: usize) -> &Self::Output {
if self.seq >= N {
&self.arr[(self.start + index) % N]
} else {
&self.arr[index]
}
}
}
impl<T, const N: usize> IndexMut<usize> for CircularArray<N, T>
where [T]: Index<usize>,
T: Default + Copy, usize: Add<usize> {
#[inline]
fn index_mut(&mut self, index: usize) -> &mut Self::Output {
if self.seq >= N {
&mut self.arr[(self.start + index) % N]
} else {
&mut self.arr[index]
}
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_push() {
let mut arr = CircularArray::<3, u32>::new();
arr.push(1);
arr.push(2);
arr.push(3);
assert_eq!(arr.arr, [1, 2, 3]);
arr.push(4);
assert_eq!(arr.arr, [4, 2, 3]);
}
#[test]
#[allow(non_snake_case)]
fn test_Index_and_IndexMut() {
let mut arr = CircularArray::<3, u32>::new();
arr.push(0);
arr.push(0);
arr.push(0);
arr.push(0);
arr.push(0);
arr[0] = 1;
arr[1] = 2;
arr[2] = 3;
assert_eq!(arr[0], 1);
assert_eq!(arr[1], 2);
assert_eq!(arr[2], 3);
}
#[test]
fn test_to_array() {
let mut arr = CircularArray::<3, u32>::new();
arr.push(1);
arr.push(2);
arr.push(3);
assert_eq!(arr.to_array(), [1, 2, 3]);
arr.push(4);
assert_eq!(arr.to_array(), [2, 3, 4]);
}
}