uwheel 0.4.0

Embeddable Aggregate Management System for Streams and Queries
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

use crate::aggregator::Aggregator;
use core::{fmt::Debug, marker::PhantomData};

mod entry;
mod key;
mod map;
mod order;
mod state;

pub use key::KeyBounds;
pub use map::TopNMap;
pub use order::{Ascending, Descending, Order};
pub use state::TopNState;

/// A Top-N Aggregator
///
/// Orders data in ascending order by default
#[derive(Debug, Clone, Copy)]
pub struct TopNAggregator<Key: KeyBounds, const N: usize, A: Aggregator, OrderBy = Ascending>(
    PhantomData<(Key, OrderBy, A)>,
);
impl<Key, const N: usize, A, OrderBy> Default for TopNAggregator<Key, N, A, OrderBy>
where
    Key: KeyBounds,
    OrderBy: Order,
    A: Aggregator + Clone + Copy,
    A::PartialAggregate: Ord + Copy,
{
    // have to implement manually as Key does not implement Default
    fn default() -> Self {
        Self(PhantomData)
    }
}
impl<Key, const N: usize, A, OrderBy> Aggregator for TopNAggregator<Key, N, A, OrderBy>
where
    Key: KeyBounds,
    OrderBy: Order,
    A: Aggregator + Clone + Copy,
    A::PartialAggregate: Ord + Copy,
{
    const IDENTITY: Self::PartialAggregate = TopNState::identity();

    type Input = (Key, A::Input);
    type MutablePartialAggregate = TopNMap<Key, A>;
    type PartialAggregate = TopNState<Key, N, A>;
    type Aggregate = TopNState<Key, N, A>;

    #[inline]
    fn lift(input: Self::Input) -> Self::MutablePartialAggregate {
        let mut map = TopNMap::default();
        Self::combine_mutable(&mut map, input);
        map
    }
    #[inline]
    fn combine_mutable(map: &mut Self::MutablePartialAggregate, input: Self::Input) {
        let inner_mutable = A::lift(input.1);
        map.insert(input.0, A::freeze(inner_mutable));
    }
    fn freeze(mutable: Self::MutablePartialAggregate) -> Self::PartialAggregate {
        mutable.build(OrderBy::ordering())
    }

    #[inline]
    fn combine(mut a: Self::PartialAggregate, b: Self::PartialAggregate) -> Self::PartialAggregate {
        a.merge(b, OrderBy::ordering());
        a
    }
    #[inline]
    fn lower(a: Self::PartialAggregate) -> Self::Aggregate {
        a
    }
}
#[cfg(test)]
mod tests {
    use crate::{
        Entry,
        RwWheel,
        aggregator::{all::AllAggregator, sum::U64SumAggregator, top_n::TopNAggregator},
        duration::NumericalDuration,
    };

    use super::state::TopNState;

    #[test]
    fn top_n_all_aggregator_test() {
        let mut wheel: RwWheel<TopNAggregator<u32, 10, AllAggregator>> = RwWheel::new(0);

        wheel.insert(Entry::new((1u32, 10.0), 1000));
        wheel.insert(Entry::new((2u32, 50.0), 1000));
        wheel.insert(Entry::new((3u32, 30.0), 1000));

        wheel.advance_to(2000);

        let state: TopNState<u32, 10, AllAggregator> = wheel.read().interval(1.seconds()).unwrap();
        let arr = state.as_ref();
        assert_eq!(arr[0].unwrap().data.sum(), 10.0);
        assert_eq!(arr[1].unwrap().data.sum(), 30.0);
        assert_eq!(arr[2].unwrap().data.sum(), 50.0);
        assert!(arr[3].is_none());
        assert!(arr[4].is_none());
        assert!(arr[5].is_none());
        assert!(arr[6].is_none());
        assert!(arr[7].is_none());
        assert!(arr[8].is_none());
        assert!(arr[9].is_none());

        // insert same keys with different values at different timestamp
        wheel.insert(Entry::new((1u32, 100.0), 2000));
        wheel.insert(Entry::new((2u32, 10.0), 2000));
        wheel.insert(Entry::new((3u32, 20.0), 2000));

        // insert some new keys
        wheel.insert(Entry::new((4u32, 15.0), 2000));
        wheel.insert(Entry::new((5u32, 1.0), 2000));
        wheel.insert(Entry::new((6u32, 5000.0), 2000));

        // advance again
        wheel.advance_to(3000);

        // interval of last 2 seconds should be two TopKState's combined
        let state: TopNState<u32, 10, AllAggregator> = wheel.read().interval(2.seconds()).unwrap();
        let arr = state.as_ref();
        assert_eq!(arr[0].unwrap().data.sum(), 1.0);
        assert_eq!(arr[1].unwrap().data.sum(), 15.0);
        assert_eq!(arr[2].unwrap().data.sum(), 50.0);
        assert_eq!(arr[3].unwrap().data.sum(), 60.0);
        assert_eq!(arr[4].unwrap().data.sum(), 110.0);
        assert_eq!(arr[5].unwrap().data.sum(), 5000.0);
        assert!(arr[6].is_none());
        assert!(arr[7].is_none());
        assert!(arr[8].is_none());
        assert!(arr[9].is_none());
    }
    #[test]
    fn top_n_u64_sum_aggregator_test() {
        let mut wheel: RwWheel<TopNAggregator<u32, 10, U64SumAggregator>> = RwWheel::new(0);

        wheel.insert(Entry::new((1u32, 10), 1000));
        wheel.insert(Entry::new((2u32, 50), 1000));
        wheel.insert(Entry::new((3u32, 30), 1000));

        wheel.advance_to(2000);

        let state: TopNState<u32, 10, U64SumAggregator> =
            wheel.read().interval(1.seconds()).unwrap();
        let arr = state.as_ref();
        assert_eq!(arr[0].unwrap().data, 10);
        assert_eq!(arr[1].unwrap().data, 30);
        assert_eq!(arr[2].unwrap().data, 50);
        assert!(arr[3].is_none());
        assert!(arr[4].is_none());
        assert!(arr[5].is_none());
        assert!(arr[6].is_none());
        assert!(arr[7].is_none());
        assert!(arr[8].is_none());
        assert!(arr[9].is_none());

        // insert same keys with different values at different timestamp
        wheel.insert(Entry::new((1u32, 100), 2000));
        wheel.insert(Entry::new((2u32, 10), 2000));
        wheel.insert(Entry::new((3u32, 20), 2000));

        // insert some new keys
        wheel.insert(Entry::new((4u32, 15), 2000));
        wheel.insert(Entry::new((5u32, 1), 2000));
        wheel.insert(Entry::new((6u32, 5000), 2000));

        // advance again
        wheel.advance_to(3000);

        // interval of last 2 seconds should be two TopKState's combined
        let state: TopNState<u32, 10, U64SumAggregator> =
            wheel.read().interval(2.seconds()).unwrap();
        let arr = state.as_ref();
        assert_eq!(arr[0].unwrap().data, 1);
        assert_eq!(arr[1].unwrap().data, 15);
        assert_eq!(arr[2].unwrap().data, 50);
        assert_eq!(arr[3].unwrap().data, 60);
        assert_eq!(arr[4].unwrap().data, 110);
        assert_eq!(arr[5].unwrap().data, 5000);
        assert!(arr[6].is_none());
        assert!(arr[7].is_none());
        assert!(arr[8].is_none());
        assert!(arr[9].is_none());
    }
}