math_utils.py

   1 #!/usr/bin/env python3
   2
   3 """Mathematical helpers."""
   4
   5 import functools
   6 import math
   7 from heapq import heappop, heappush
   8 from typing import List
   9
  10
  11 class RunningMedian(object):
  12     """A running median computer.
  13
  14     >>> median = RunningMedian()
  15     >>> median.add_number(1)
  16     >>> median.add_number(10)
  17     >>> median.add_number(3)
  18     >>> median.get_median()
  19     3
  20     >>> median.add_number(7)
  21     >>> median.add_number(5)
  22     >>> median.get_median()
  23     5
  24     >>> median.get_mean()
  25     5.2
  26     >>> round(median.get_stdev(), 2)
  27     6.99
  28     """
  29
  30     def __init__(self):
  31         self.lowers, self.highers = [], []
  32         self.aggregate = 0.0
  33
  34     def add_number(self, number: float):
  35         if not self.highers or number > self.highers[0]:
  36             heappush(self.highers, number)
  37         else:
  38             heappush(self.lowers, -number)  # for lowers we need a max heap
  39         self.aggregate += number
  40         self.rebalance()
  41
  42     def rebalance(self):
  43         if len(self.lowers) - len(self.highers) > 1:
  44             heappush(self.highers, -heappop(self.lowers))
  45         elif len(self.highers) - len(self.lowers) > 1:
  46             heappush(self.lowers, -heappop(self.highers))
  47
  48     def get_median(self) -> float:
  49         if len(self.lowers) == len(self.highers):
  50             return (-self.lowers[0] + self.highers[0]) / 2
  51         elif len(self.lowers) > len(self.highers):
  52             return -self.lowers[0]
  53         else:
  54             return self.highers[0]
  55
  56     def get_mean(self) -> float:
  57         count = len(self.lowers) + len(self.highers)
  58         return self.aggregate / count
  59
  60     def get_stdev(self) -> float:
  61         mean = self.get_mean()
  62         variance = 0.0
  63         for n in self.lowers:
  64             n = -n
  65             variance += (n - mean) ** 2
  66         for n in self.highers:
  67             variance += (n - mean) ** 2
  68         return math.sqrt(variance)
  69
  70
  71 def gcd_floats(a: float, b: float) -> float:
  72     if a < b:
  73         return gcd_floats(b, a)
  74
  75     # base case
  76     if abs(b) < 0.001:
  77         return a
  78     return gcd_floats(b, a - math.floor(a / b) * b)
  79
  80
  81 def gcd_float_sequence(lst: List[float]) -> float:
  82     if len(lst) <= 0:
  83         raise ValueError("Need at least one number")
  84     elif len(lst) == 1:
  85         return lst[0]
  86     assert len(lst) >= 2
  87     gcd = gcd_floats(lst[0], lst[1])
  88     for i in range(2, len(lst)):
  89         gcd = gcd_floats(gcd, lst[i])
  90     return gcd
  91
  92
  93 def truncate_float(n: float, decimals: int = 2):
  94     """
  95     Truncate a float to a particular number of decimals.
  96
  97     >>> truncate_float(3.1415927, 3)
  98     3.141
  99
 100     """
 101     assert 0 < decimals < 10
 102     multiplier = 10**decimals
 103     return int(n * multiplier) / multiplier
 104
 105
 106 def percentage_to_multiplier(percent: float) -> float:
 107     """Given a percentage (e.g. 155%), return a factor needed to scale a
 108     number by that percentage.
 109
 110     >>> percentage_to_multiplier(155)
 111     2.55
 112     >>> percentage_to_multiplier(45)
 113     1.45
 114     >>> percentage_to_multiplier(-25)
 115     0.75
 116
 117     """
 118     multiplier = percent / 100
 119     multiplier += 1.0
 120     return multiplier
 121
 122
 123 def multiplier_to_percent(multiplier: float) -> float:
 124     """Convert a multiplicative factor into a percent change.
 125
 126     >>> multiplier_to_percent(0.75)
 127     -25.0
 128     >>> multiplier_to_percent(1.0)
 129     0.0
 130     >>> multiplier_to_percent(1.99)
 131     99.0
 132
 133     """
 134     percent = multiplier
 135     if percent > 0.0:
 136         percent -= 1.0
 137     else:
 138         percent = 1.0 - percent
 139     percent *= 100.0
 140     return percent
 141
 142
 143 @functools.lru_cache(maxsize=1024, typed=True)
 144 def is_prime(n: int) -> bool:
 145     """
 146     Returns True if n is prime and False otherwise.  Obviously(?) very slow for
 147     very large input numbers.
 148
 149     >>> is_prime(13)
 150     True
 151     >>> is_prime(22)
 152     False
 153     >>> is_prime(51602981)
 154     True
 155
 156     """
 157     if not isinstance(n, int):
 158         raise TypeError("argument passed to is_prime is not of 'int' type")
 159
 160     # Corner cases
 161     if n <= 1:
 162         return False
 163     if n <= 3:
 164         return True
 165
 166     # This is checked so that we can skip middle five numbers in below
 167     # loop
 168     if n % 2 == 0 or n % 3 == 0:
 169         return False
 170
 171     i = 5
 172     while i * i <= n:
 173         if n % i == 0 or n % (i + 2) == 0:
 174             return False
 175         i = i + 6
 176     return True
 177
 178
 179 if __name__ == '__main__':
 180     import doctest
 181
 182     doctest.testmod()