histogram.py

   1 #!/usr/bin/env python3
   2
   3 import math
   4 from numbers import Number
   5 from typing import Generic, Iterable, List, Optional, Tuple, TypeVar
   6
   7 T = TypeVar("T", bound=Number)
   8
   9
  10 class SimpleHistogram(Generic[T]):
  11
  12     # Useful in defining wide open bottom/top bucket bounds:
  13     POSITIVE_INFINITY = math.inf
  14     NEGATIVE_INFINITY = -math.inf
  15
  16     def __init__(self, buckets: List[Tuple[T, T]]):
  17         from math_utils import RunningMedian
  18
  19         self.buckets = {}
  20         for start_end in buckets:
  21             if self._get_bucket(start_end[0]) is not None:
  22                 raise Exception("Buckets overlap?!")
  23             self.buckets[start_end] = 0
  24         self.sigma = 0
  25         self.median = RunningMedian()
  26         self.maximum = None
  27         self.minimum = None
  28         self.count = 0
  29
  30     @staticmethod
  31     def n_evenly_spaced_buckets(
  32         min_bound: T,
  33         max_bound: T,
  34         n: int,
  35     ) -> List[Tuple[T, T]]:
  36         ret = []
  37         stride = int((max_bound - min_bound) / n)
  38         if stride <= 0:
  39             raise Exception("Min must be < Max")
  40         for bucket_start in range(min_bound, max_bound, stride):
  41             ret.append((bucket_start, bucket_start + stride))
  42         return ret
  43
  44     def _get_bucket(self, item: T) -> Optional[Tuple[T, T]]:
  45         for start_end in self.buckets:
  46             if start_end[0] <= item < start_end[1]:
  47                 return start_end
  48         return None
  49
  50     def add_item(self, item: T) -> bool:
  51         bucket = self._get_bucket(item)
  52         if bucket is None:
  53             return False
  54         self.count += 1
  55         self.buckets[bucket] += 1
  56         self.sigma += item
  57         self.median.add_number(item)
  58         if self.maximum is None or item > self.maximum:
  59             self.maximum = item
  60         if self.minimum is None or item < self.minimum:
  61             self.minimum = item
  62         return True
  63
  64     def add_items(self, lst: Iterable[T]) -> bool:
  65         all_true = True
  66         for item in lst:
  67             all_true = all_true and self.add_item(item)
  68         return all_true
  69
  70     def __repr__(self, label_formatter='%10s') -> str:
  71         from text_utils import bar_graph
  72
  73         max_population: Optional[int] = None
  74         for bucket in self.buckets:
  75             pop = self.buckets[bucket]
  76             if pop > 0:
  77                 last_bucket_start = bucket[0]  # beginning of range
  78             if max_population is None or pop > max_population:
  79                 max_population = pop  # bucket with max items
  80
  81         txt = ""
  82         if max_population is None:
  83             return txt
  84
  85         for bucket in sorted(self.buckets, key=lambda x: x[0]):
  86             pop = self.buckets[bucket]
  87             start = bucket[0]
  88             end = bucket[1]
  89             bar = bar_graph(
  90                 (pop / max_population),
  91                 include_text=False,
  92                 width=58,
  93                 left_end="",
  94                 right_end="",
  95             )
  96             label = f'{label_formatter}..{label_formatter}' % (start, end)
  97             txt += f'{label:20}: ' + bar + f"({pop/self.count*100.0:5.2f}% n={pop})\n"
  98             if start == last_bucket_start:
  99                 break
 100         return txt