oxihuman-core 0.1.2

Core data structures, algorithms, and asset management for OxiHuman
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

#![allow(dead_code)]

#[allow(dead_code)]
#[derive(Debug, Clone)]
pub struct DoubleBuffer<T> {
    front: Vec<T>,
    back: Vec<T>,
}

#[allow(dead_code)]
pub fn new_double_buffer<T>() -> DoubleBuffer<T> {
    DoubleBuffer {
        front: Vec::new(),
        back: Vec::new(),
    }
}

#[allow(dead_code)]
pub fn write_buffer<T>(db: &mut DoubleBuffer<T>, val: T) {
    db.back.push(val);
}

#[allow(dead_code)]
pub fn read_buffer<T>(db: &DoubleBuffer<T>) -> &[T] {
    &db.front
}

#[allow(dead_code)]
pub fn swap_buffers<T>(db: &mut DoubleBuffer<T>) {
    std::mem::swap(&mut db.front, &mut db.back);
    db.back.clear();
}

#[allow(dead_code)]
pub fn buffer_len<T>(db: &DoubleBuffer<T>) -> usize {
    db.front.len()
}

#[allow(dead_code)]
pub fn buffer_is_empty<T>(db: &DoubleBuffer<T>) -> bool {
    db.front.is_empty()
}

#[allow(dead_code)]
pub fn front_buffer<T>(db: &DoubleBuffer<T>) -> &[T] {
    &db.front
}

#[allow(dead_code)]
pub fn back_buffer<T>(db: &DoubleBuffer<T>) -> &[T] {
    &db.back
}

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

    #[test]
    fn test_new() {
        let db: DoubleBuffer<i32> = new_double_buffer();
        assert!(buffer_is_empty(&db));
    }

    #[test]
    fn test_write_and_swap() {
        let mut db = new_double_buffer();
        write_buffer(&mut db, 1);
        write_buffer(&mut db, 2);
        swap_buffers(&mut db);
        assert_eq!(read_buffer(&db), &[1, 2]);
    }

    #[test]
    fn test_back_clears_on_swap() {
        let mut db = new_double_buffer();
        write_buffer(&mut db, 10);
        swap_buffers(&mut db);
        assert!(back_buffer(&db).is_empty());
    }

    #[test]
    fn test_buffer_len() {
        let mut db = new_double_buffer();
        write_buffer(&mut db, 'a');
        write_buffer(&mut db, 'b');
        swap_buffers(&mut db);
        assert_eq!(buffer_len(&db), 2);
    }

    #[test]
    fn test_front_buffer() {
        let mut db = new_double_buffer();
        write_buffer(&mut db, 5);
        swap_buffers(&mut db);
        assert_eq!(front_buffer(&db), &[5]);
    }

    #[test]
    fn test_back_buffer_before_swap() {
        let mut db = new_double_buffer();
        write_buffer(&mut db, 7);
        assert_eq!(back_buffer(&db), &[7]);
    }

    #[test]
    fn test_double_swap() {
        let mut db = new_double_buffer();
        write_buffer(&mut db, 1);
        swap_buffers(&mut db);
        write_buffer(&mut db, 2);
        swap_buffers(&mut db);
        assert_eq!(read_buffer(&db), &[2]);
    }

    #[test]
    fn test_empty_after_creation() {
        let db: DoubleBuffer<f32> = new_double_buffer();
        assert_eq!(buffer_len(&db), 0);
    }

    #[test]
    fn test_read_before_swap() {
        let db: DoubleBuffer<i32> = new_double_buffer();
        assert!(read_buffer(&db).is_empty());
    }

    #[test]
    fn test_multiple_writes() {
        let mut db = new_double_buffer();
        for i in 0..5 {
            write_buffer(&mut db, i);
        }
        swap_buffers(&mut db);
        assert_eq!(buffer_len(&db), 5);
    }
}