math_utils.py

   1 #!/usr/bin/env python3
   2
   3 # © Copyright 2021-2022, Scott Gasch
   4
   5 """Mathematical helpers."""
   6
   7 import collections
   8 import functools
   9 import math
  10 from heapq import heappop, heappush
  11 from typing import Dict, List, Optional, Tuple
  12
  13 import dict_utils
  14
  15
  16 class NumericPopulation(object):
  17     """A numeric population with some statistics such as median, mean, pN,
  18     stdev, etc...
  19
  20     >>> pop = NumericPopulation()
  21     >>> pop.add_number(1)
  22     >>> pop.add_number(10)
  23     >>> pop.add_number(3)
  24     >>> pop.get_median()
  25     3
  26     >>> pop.add_number(7)
  27     >>> pop.add_number(5)
  28     >>> pop.get_median()
  29     5
  30     >>> pop.get_mean()
  31     5.2
  32     >>> round(pop.get_stdev(), 2)
  33     1.75
  34     >>> pop.get_percentile(20)
  35     3
  36     >>> pop.get_percentile(60)
  37     7
  38
  39     """
  40
  41     def __init__(self):
  42         self.lowers, self.highers = [], []
  43         self.aggregate = 0.0
  44         self.sorted_copy: Optional[List[float]] = None
  45
  46     def add_number(self, number: float):
  47         """O(2 log2 n)"""
  48
  49         if not self.highers or number > self.highers[0]:
  50             heappush(self.highers, number)
  51         else:
  52             heappush(self.lowers, -number)  # for lowers we need a max heap
  53         self.aggregate += number
  54         self._rebalance()
  55
  56     def _rebalance(self):
  57         if len(self.lowers) - len(self.highers) > 1:
  58             heappush(self.highers, -heappop(self.lowers))
  59         elif len(self.highers) - len(self.lowers) > 1:
  60             heappush(self.lowers, -heappop(self.highers))
  61
  62     def get_median(self) -> float:
  63         """Returns the approximate median (p50) so far in O(1) time."""
  64
  65         if len(self.lowers) == len(self.highers):
  66             return -self.lowers[0]
  67         elif len(self.lowers) > len(self.highers):
  68             return -self.lowers[0]
  69         else:
  70             return self.highers[0]
  71
  72     def get_mean(self) -> float:
  73         """Returns the mean (arithmetic mean) so far in O(1) time."""
  74
  75         count = len(self.lowers) + len(self.highers)
  76         return self.aggregate / count
  77
  78     def get_mode(self) -> Tuple[float, int]:
  79         """Returns the mode (most common member)."""
  80
  81         count: Dict[float, int] = collections.defaultdict(int)
  82         for n in self.lowers:
  83             count[-n] += 1
  84         for n in self.highers:
  85             count[n] += 1
  86         return dict_utils.item_with_max_value(count)
  87
  88     def get_stdev(self) -> float:
  89         """Returns the stdev so far in O(n) time."""
  90
  91         mean = self.get_mean()
  92         variance = 0.0
  93         for n in self.lowers:
  94             n = -n
  95             variance += (n - mean) ** 2
  96         for n in self.highers:
  97             variance += (n - mean) ** 2
  98         count = len(self.lowers) + len(self.highers) - 1
  99         return math.sqrt(variance) / count
 100
 101     def get_percentile(self, n: float) -> float:
 102         """Returns the number at approximately pn% (i.e. the nth percentile)
 103         of the distribution in O(n log n) time (expensive, requires a
 104         complete sort).  Not thread safe.  Caching does across
 105         multiple calls without an invocation to add_number.
 106
 107         """
 108         if n == 50:
 109             return self.get_median()
 110         count = len(self.lowers) + len(self.highers)
 111         if self.sorted_copy is not None:
 112             if count == len(self.sorted_copy):
 113                 index = round(count * (n / 100.0))
 114                 assert 0 <= index < count
 115                 return self.sorted_copy[index]
 116         self.sorted_copy = [-x for x in self.lowers]
 117         for x in self.highers:
 118             self.sorted_copy.append(x)
 119         self.sorted_copy = sorted(self.sorted_copy)
 120         index = round(count * (n / 100.0))
 121         assert 0 <= index < count
 122         return self.sorted_copy[index]
 123
 124
 125 def gcd_floats(a: float, b: float) -> float:
 126     if a < b:
 127         return gcd_floats(b, a)
 128
 129     # base case
 130     if abs(b) < 0.001:
 131         return a
 132     return gcd_floats(b, a - math.floor(a / b) * b)
 133
 134
 135 def gcd_float_sequence(lst: List[float]) -> float:
 136     if len(lst) <= 0:
 137         raise ValueError("Need at least one number")
 138     elif len(lst) == 1:
 139         return lst[0]
 140     assert len(lst) >= 2
 141     gcd = gcd_floats(lst[0], lst[1])
 142     for i in range(2, len(lst)):
 143         gcd = gcd_floats(gcd, lst[i])
 144     return gcd
 145
 146
 147 def truncate_float(n: float, decimals: int = 2):
 148     """
 149     Truncate a float to a particular number of decimals.
 150
 151     >>> truncate_float(3.1415927, 3)
 152     3.141
 153
 154     """
 155     assert 0 < decimals < 10
 156     multiplier = 10**decimals
 157     return int(n * multiplier) / multiplier
 158
 159
 160 def percentage_to_multiplier(percent: float) -> float:
 161     """Given a percentage (e.g. 155%), return a factor needed to scale a
 162     number by that percentage.
 163
 164     >>> percentage_to_multiplier(155)
 165     2.55
 166     >>> percentage_to_multiplier(45)
 167     1.45
 168     >>> percentage_to_multiplier(-25)
 169     0.75
 170
 171     """
 172     multiplier = percent / 100
 173     multiplier += 1.0
 174     return multiplier
 175
 176
 177 def multiplier_to_percent(multiplier: float) -> float:
 178     """Convert a multiplicative factor into a percent change.
 179
 180     >>> multiplier_to_percent(0.75)
 181     -25.0
 182     >>> multiplier_to_percent(1.0)
 183     0.0
 184     >>> multiplier_to_percent(1.99)
 185     99.0
 186
 187     """
 188     percent = multiplier
 189     if percent > 0.0:
 190         percent -= 1.0
 191     else:
 192         percent = 1.0 - percent
 193     percent *= 100.0
 194     return percent
 195
 196
 197 @functools.lru_cache(maxsize=1024, typed=True)
 198 def is_prime(n: int) -> bool:
 199     """
 200     Returns True if n is prime and False otherwise.  Obviously(?) very slow for
 201     very large input numbers.
 202
 203     >>> is_prime(13)
 204     True
 205     >>> is_prime(22)
 206     False
 207     >>> is_prime(51602981)
 208     True
 209
 210     """
 211     if not isinstance(n, int):
 212         raise TypeError("argument passed to is_prime is not of 'int' type")
 213
 214     # Corner cases
 215     if n <= 1:
 216         return False
 217     if n <= 3:
 218         return True
 219
 220     # This is checked so that we can skip middle five numbers in below
 221     # loop
 222     if n % 2 == 0 or n % 3 == 0:
 223         return False
 224
 225     i = 5
 226     while i * i <= n:
 227         if n % i == 0 or n % (i + 2) == 0:
 228             return False
 229         i = i + 6
 230     return True
 231
 232
 233 if __name__ == '__main__':
 234     import doctest
 235
 236     doctest.testmod()