1 // SPDX-License-Identifier: GPL-2.0
2 #include <kunit/test.h>
4 #include "mean_and_variance.h"
6 #define MAX_SQR (SQRT_U64_MAX*SQRT_U64_MAX)
8 static void mean_and_variance_basic_test(struct kunit *test)
10 struct mean_and_variance s = {};
12 mean_and_variance_update(&s, 2);
13 mean_and_variance_update(&s, 2);
15 KUNIT_EXPECT_EQ(test, mean_and_variance_get_mean(s), 2);
16 KUNIT_EXPECT_EQ(test, mean_and_variance_get_variance(s), 0);
17 KUNIT_EXPECT_EQ(test, s.n, 2);
19 mean_and_variance_update(&s, 4);
20 mean_and_variance_update(&s, 4);
22 KUNIT_EXPECT_EQ(test, mean_and_variance_get_mean(s), 3);
23 KUNIT_EXPECT_EQ(test, mean_and_variance_get_variance(s), 1);
24 KUNIT_EXPECT_EQ(test, s.n, 4);
28 * Test values computed using a spreadsheet from the psuedocode at the bottom:
29 * https://fanf2.user.srcf.net/hermes/doc/antiforgery/stats.pdf
32 static void mean_and_variance_weighted_test(struct kunit *test)
34 struct mean_and_variance_weighted s = { .weight = 2 };
36 mean_and_variance_weighted_update(&s, 10);
37 KUNIT_EXPECT_EQ(test, mean_and_variance_weighted_get_mean(s), 10);
38 KUNIT_EXPECT_EQ(test, mean_and_variance_weighted_get_variance(s), 0);
40 mean_and_variance_weighted_update(&s, 20);
41 KUNIT_EXPECT_EQ(test, mean_and_variance_weighted_get_mean(s), 12);
42 KUNIT_EXPECT_EQ(test, mean_and_variance_weighted_get_variance(s), 18);
44 mean_and_variance_weighted_update(&s, 30);
45 KUNIT_EXPECT_EQ(test, mean_and_variance_weighted_get_mean(s), 16);
46 KUNIT_EXPECT_EQ(test, mean_and_variance_weighted_get_variance(s), 72);
48 s = (struct mean_and_variance_weighted) { .weight = 2 };
50 mean_and_variance_weighted_update(&s, -10);
51 KUNIT_EXPECT_EQ(test, mean_and_variance_weighted_get_mean(s), -10);
52 KUNIT_EXPECT_EQ(test, mean_and_variance_weighted_get_variance(s), 0);
54 mean_and_variance_weighted_update(&s, -20);
55 KUNIT_EXPECT_EQ(test, mean_and_variance_weighted_get_mean(s), -12);
56 KUNIT_EXPECT_EQ(test, mean_and_variance_weighted_get_variance(s), 18);
58 mean_and_variance_weighted_update(&s, -30);
59 KUNIT_EXPECT_EQ(test, mean_and_variance_weighted_get_mean(s), -16);
60 KUNIT_EXPECT_EQ(test, mean_and_variance_weighted_get_variance(s), 72);
63 static void mean_and_variance_weighted_advanced_test(struct kunit *test)
65 struct mean_and_variance_weighted s = { .weight = 8 };
68 for (i = 10; i <= 100; i += 10)
69 mean_and_variance_weighted_update(&s, i);
71 KUNIT_EXPECT_EQ(test, mean_and_variance_weighted_get_mean(s), 11);
72 KUNIT_EXPECT_EQ(test, mean_and_variance_weighted_get_variance(s), 107);
74 s = (struct mean_and_variance_weighted) { .weight = 8 };
76 for (i = -10; i >= -100; i -= 10)
77 mean_and_variance_weighted_update(&s, i);
79 KUNIT_EXPECT_EQ(test, mean_and_variance_weighted_get_mean(s), -11);
80 KUNIT_EXPECT_EQ(test, mean_and_variance_weighted_get_variance(s), 107);
83 static void do_mean_and_variance_test(struct kunit *test,
94 struct mean_and_variance mv = {};
95 struct mean_and_variance_weighted vw = { .weight = weight };
97 for (unsigned i = 0; i < initial_n; i++) {
98 mean_and_variance_update(&mv, initial_value);
99 mean_and_variance_weighted_update(&vw, initial_value);
101 KUNIT_EXPECT_EQ(test, mean_and_variance_get_mean(mv), initial_value);
102 KUNIT_EXPECT_EQ(test, mean_and_variance_get_stddev(mv), 0);
103 KUNIT_EXPECT_EQ(test, mean_and_variance_weighted_get_mean(vw), initial_value);
104 KUNIT_EXPECT_EQ(test, mean_and_variance_weighted_get_stddev(vw),0);
107 for (unsigned i = 0; i < n; i++) {
108 mean_and_variance_update(&mv, data[i]);
109 mean_and_variance_weighted_update(&vw, data[i]);
111 KUNIT_EXPECT_EQ(test, mean_and_variance_get_mean(mv), mean[i]);
112 KUNIT_EXPECT_EQ(test, mean_and_variance_get_stddev(mv), stddev[i]);
113 KUNIT_EXPECT_EQ(test, mean_and_variance_weighted_get_mean(vw), weighted_mean[i]);
114 KUNIT_EXPECT_EQ(test, mean_and_variance_weighted_get_stddev(vw),weighted_stddev[i]);
117 KUNIT_EXPECT_EQ(test, mv.n, initial_n + n);
120 /* Test behaviour with a single outlier, then back to steady state: */
121 static void mean_and_variance_test_1(struct kunit *test)
123 s64 d[] = { 100, 10, 10, 10, 10, 10, 10 };
124 s64 mean[] = { 22, 21, 20, 19, 18, 17, 16 };
125 s64 stddev[] = { 32, 29, 28, 27, 26, 25, 24 };
126 s64 weighted_mean[] = { 32, 27, 22, 19, 17, 15, 14 };
127 s64 weighted_stddev[] = { 38, 35, 31, 27, 24, 21, 18 };
129 do_mean_and_variance_test(test, 10, 6, ARRAY_SIZE(d), 2,
130 d, mean, stddev, weighted_mean, weighted_stddev);
133 /* Test behaviour where we switch from one steady state to another: */
134 static void mean_and_variance_test_2(struct kunit *test)
136 s64 d[] = { 100, 100, 100, 100, 100 };
137 s64 mean[] = { 22, 32, 40, 46, 50 };
138 s64 stddev[] = { 32, 39, 42, 44, 45 };
139 s64 weighted_mean[] = { 32, 49, 61, 71, 78 };
140 s64 weighted_stddev[] = { 38, 44, 44, 41, 38 };
142 do_mean_and_variance_test(test, 10, 6, ARRAY_SIZE(d), 2,
143 d, mean, stddev, weighted_mean, weighted_stddev);
146 static void mean_and_variance_fast_divpow2(struct kunit *test)
151 for (i = 0; i < 100; i++) {
153 KUNIT_EXPECT_EQ(test, fast_divpow2(i, d), div_u64(i, 1LLU << d));
154 KUNIT_EXPECT_EQ(test, abs(fast_divpow2(-i, d)), div_u64(i, 1LLU << d));
155 for (d = 1; d < 32; d++) {
156 KUNIT_EXPECT_EQ_MSG(test, abs(fast_divpow2(i, d)),
157 div_u64(i, 1 << d), "%lld %u", i, d);
158 KUNIT_EXPECT_EQ_MSG(test, abs(fast_divpow2(-i, d)),
159 div_u64(i, 1 << d), "%lld %u", -i, d);
164 static void mean_and_variance_u128_basic_test(struct kunit *test)
166 u128_u a = u64s_to_u128(0, U64_MAX);
167 u128_u a1 = u64s_to_u128(0, 1);
168 u128_u b = u64s_to_u128(1, 0);
169 u128_u c = u64s_to_u128(0, 1LLU << 63);
170 u128_u c2 = u64s_to_u128(U64_MAX, U64_MAX);
172 KUNIT_EXPECT_EQ(test, u128_hi(u128_add(a, a1)), 1);
173 KUNIT_EXPECT_EQ(test, u128_lo(u128_add(a, a1)), 0);
174 KUNIT_EXPECT_EQ(test, u128_hi(u128_add(a1, a)), 1);
175 KUNIT_EXPECT_EQ(test, u128_lo(u128_add(a1, a)), 0);
177 KUNIT_EXPECT_EQ(test, u128_lo(u128_sub(b, a1)), U64_MAX);
178 KUNIT_EXPECT_EQ(test, u128_hi(u128_sub(b, a1)), 0);
180 KUNIT_EXPECT_EQ(test, u128_hi(u128_shl(c, 1)), 1);
181 KUNIT_EXPECT_EQ(test, u128_lo(u128_shl(c, 1)), 0);
183 KUNIT_EXPECT_EQ(test, u128_hi(u128_square(U64_MAX)), U64_MAX - 1);
184 KUNIT_EXPECT_EQ(test, u128_lo(u128_square(U64_MAX)), 1);
186 KUNIT_EXPECT_EQ(test, u128_lo(u128_div(b, 2)), 1LLU << 63);
188 KUNIT_EXPECT_EQ(test, u128_hi(u128_div(c2, 2)), U64_MAX >> 1);
189 KUNIT_EXPECT_EQ(test, u128_lo(u128_div(c2, 2)), U64_MAX);
191 KUNIT_EXPECT_EQ(test, u128_hi(u128_div(u128_shl(u64_to_u128(U64_MAX), 32), 2)), U32_MAX >> 1);
192 KUNIT_EXPECT_EQ(test, u128_lo(u128_div(u128_shl(u64_to_u128(U64_MAX), 32), 2)), U64_MAX << 31);
195 static struct kunit_case mean_and_variance_test_cases[] = {
196 KUNIT_CASE(mean_and_variance_fast_divpow2),
197 KUNIT_CASE(mean_and_variance_u128_basic_test),
198 KUNIT_CASE(mean_and_variance_basic_test),
199 KUNIT_CASE(mean_and_variance_weighted_test),
200 KUNIT_CASE(mean_and_variance_weighted_advanced_test),
201 KUNIT_CASE(mean_and_variance_test_1),
202 KUNIT_CASE(mean_and_variance_test_2),
206 static struct kunit_suite mean_and_variance_test_suite = {
207 .name = "mean and variance tests",
208 .test_cases = mean_and_variance_test_cases
211 kunit_test_suite(mean_and_variance_test_suite);
213 MODULE_AUTHOR("Daniel B. Hill");
214 MODULE_LICENSE("GPL");