git.sesse.net Git - bcachefs-tools-debian/blob - linux/mean_and_variance.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Functions for incremental mean and variance.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 as published by
   7  * the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12  * more details.
  13  *
  14  * Copyright © 2022 Daniel B. Hill
  15  *
  16  * Author: Daniel B. Hill <daniel@gluo.nz>
  17  *
  18  * Description:
  19  *
  20  * This is includes some incremental algorithms for mean and variance calculation
  21  *
  22  * Derived from the paper: https://fanf2.user.srcf.net/hermes/doc/antiforgery/stats.pdf
  23  *
  24  * Create a struct and if it's the weighted variant set the w field (weight = 2^k).
  25  *
  26  * Use mean_and_variance[_weighted]_update() on the struct to update it's state.
  27  *
  28  * Use the mean_and_variance[_weighted]_get_* functions to calculate the mean and variance, some computation
  29  * is deferred to these functions for performance reasons.
  30  *
  31  * see lib/math/mean_and_variance_test.c for examples of usage.
  32  *
  33  * DO NOT access the mean and variance fields of the weighted variants directly.
  34  * DO NOT change the weight after calling update.
  35  */
  36
  37 #include <linux/bug.h>
  38 #include <linux/compiler.h>
  39 #include <linux/export.h>
  40 #include <linux/limits.h>
  41 #include <linux/math.h>
  42 #include <linux/math64.h>
  43 #include <linux/mean_and_variance.h>
  44 #include <linux/module.h>
  45
  46 u128_u u128_div(u128_u n, u64 d)
  47 {
  48         u128_u r;
  49         u64 rem;
  50         u64 hi = u128_hi(n);
  51         u64 lo = u128_lo(n);
  52         u64  h =  hi & ((u64) U32_MAX  << 32);
  53         u64  l = (hi &  (u64) U32_MAX) << 32;
  54
  55         r =             u128_shl(u64_to_u128(div64_u64_rem(h,                d, &rem)), 64);
  56         r = u128_add(r, u128_shl(u64_to_u128(div64_u64_rem(l  + (rem << 32), d, &rem)), 32));
  57         r = u128_add(r,          u64_to_u128(div64_u64_rem(lo + (rem << 32), d, &rem)));
  58         return r;
  59 }
  60 EXPORT_SYMBOL_GPL(u128_div);
  61
  62 /**
  63  * mean_and_variance_get_mean() - get mean from @s
  64  */
  65 s64 mean_and_variance_get_mean(struct mean_and_variance s)
  66 {
  67         return s.n ? div64_u64(s.sum, s.n) : 0;
  68 }
  69 EXPORT_SYMBOL_GPL(mean_and_variance_get_mean);
  70
  71 /**
  72  * mean_and_variance_get_variance() -  get variance from @s1
  73  *
  74  * see linked pdf equation 12.
  75  */
  76 u64 mean_and_variance_get_variance(struct mean_and_variance s1)
  77 {
  78         if (s1.n) {
  79                 u128_u s2 = u128_div(s1.sum_squares, s1.n);
  80                 u64  s3 = abs(mean_and_variance_get_mean(s1));
  81
  82                 return u128_lo(u128_sub(s2, u128_square(s3)));
  83         } else {
  84                 return 0;
  85         }
  86 }
  87 EXPORT_SYMBOL_GPL(mean_and_variance_get_variance);
  88
  89 /**
  90  * mean_and_variance_get_stddev() - get standard deviation from @s
  91  */
  92 u32 mean_and_variance_get_stddev(struct mean_and_variance s)
  93 {
  94         return int_sqrt64(mean_and_variance_get_variance(s));
  95 }
  96 EXPORT_SYMBOL_GPL(mean_and_variance_get_stddev);
  97
  98 /**
  99  * mean_and_variance_weighted_update() - exponentially weighted variant of mean_and_variance_update()
 100  * @s1: ..
 101  * @s2: ..
 102  *
 103  * see linked pdf: function derived from equations 140-143 where alpha = 2^w.
 104  * values are stored bitshifted for performance and added precision.
 105  */
 106 void mean_and_variance_weighted_update(struct mean_and_variance_weighted *s, s64 x)
 107 {
 108         // previous weighted variance.
 109         u8 w            = s->weight;
 110         u64 var_w0      = s->variance;
 111         // new value weighted.
 112         s64 x_w         = x << w;
 113         s64 diff_w      = x_w - s->mean;
 114         s64 diff        = fast_divpow2(diff_w, w);
 115         // new mean weighted.
 116         s64 u_w1        = s->mean + diff;
 117
 118         if (!s->init) {
 119                 s->mean = x_w;
 120                 s->variance = 0;
 121         } else {
 122                 s->mean = u_w1;
 123                 s->variance = ((var_w0 << w) - var_w0 + ((diff_w * (x_w - u_w1)) >> w)) >> w;
 124         }
 125         s->init = true;
 126 }
 127 EXPORT_SYMBOL_GPL(mean_and_variance_weighted_update);
 128
 129 /**
 130  * mean_and_variance_weighted_get_mean() - get mean from @s
 131  */
 132 s64 mean_and_variance_weighted_get_mean(struct mean_and_variance_weighted s)
 133 {
 134         return fast_divpow2(s.mean, s.weight);
 135 }
 136 EXPORT_SYMBOL_GPL(mean_and_variance_weighted_get_mean);
 137
 138 /**
 139  * mean_and_variance_weighted_get_variance() -- get variance from @s
 140  */
 141 u64 mean_and_variance_weighted_get_variance(struct mean_and_variance_weighted s)
 142 {
 143         // always positive don't need fast divpow2
 144         return s.variance >> s.weight;
 145 }
 146 EXPORT_SYMBOL_GPL(mean_and_variance_weighted_get_variance);
 147
 148 /**
 149  * mean_and_variance_weighted_get_stddev() - get standard deviation from @s
 150  */
 151 u32 mean_and_variance_weighted_get_stddev(struct mean_and_variance_weighted s)
 152 {
 153         return int_sqrt64(mean_and_variance_weighted_get_variance(s));
 154 }
 155 EXPORT_SYMBOL_GPL(mean_and_variance_weighted_get_stddev);
 156
 157 MODULE_AUTHOR("Daniel B. Hill");
 158 MODULE_LICENSE("GPL");