from __future__ import annotations
from functools import total_ordering
-from typing import Any, Optional, Union
+from typing import Any, Generator, Optional, Union
from overrides import overrides
@total_ordering
class NumericRange(object):
+ """Essentially a tuple of numbers denoting a range with some added
+ helper methods on it."""
+
def __init__(self, low: Numeric, high: Numeric):
if low > high:
temp: Numeric = low
class AugmentedIntervalTree(bst.BinarySearchTree):
- def __init__(self):
- super().__init__()
-
@staticmethod
- def assert_value_must_be_range(value: Any) -> None:
+ def _assert_value_must_be_range(value: Any) -> None:
if not isinstance(value, NumericRange):
raise Exception(
"AugmentedIntervalTree expects to use NumericRanges, see bst for a "
@overrides
def _on_insert(self, parent: Optional[bst.Node], new: bst.Node) -> None:
- AugmentedIntervalTree.assert_value_must_be_range(new.value)
+ AugmentedIntervalTree._assert_value_must_be_range(new.value)
for ancestor in self.parent_path(new):
assert ancestor
if new.value.high > ancestor.value.highest_in_subtree:
"""
return self._find_one_overlap(self.root, x)
- def _find_one_overlap(self, root: bst.Node, x: NumericRange):
+ def _find_one_overlap(
+ self, root: bst.Node, x: NumericRange
+ ) -> Optional[NumericRange]:
if root is None:
- return
+ return None
if root.value.overlaps_with(x):
return root.value
if root.right:
return self._find_one_overlap(root.right, x)
+ return None
def find_all_overlaps(self, x: NumericRange):
"""Yields ranges previously added to the tree that x overlaps with.
return
yield from self._find_all_overlaps(self.root, x)
- def _find_all_overlaps(self, root: bst.Node, x: NumericRange):
+ def _find_all_overlaps(
+ self, root: bst.Node, x: NumericRange
+ ) -> Generator[NumericRange, None, None]:
if root is None:
- return
+ return None
if root.value.overlaps_with(x):
yield root.value