Hammer on that run_tests.py thing again.

[python_utils.git] / list_utils.py

diff --git a/list_utils.py b/list_utils.py
index b877e381041d32564789232e1bb7329cc04503e6..1141af2fe9b6bb8861dfd25c08dab735bfd4ceaf 100644 (file)
--- a/list_utils.py
+++ b/list_utils.py
@@ -1,8 +1,13 @@
 #!/usr/bin/env python3
 
+# © Copyright 2021-2022, Scott Gasch
+
+"""Some useful(?) utilities for dealing with Lists."""
+
+import random
 from collections import Counter
-from itertools import islice
-from typing import Any, Iterator, List, Mapping, Sequence, Tuple
+from itertools import chain, combinations, islice
+from typing import Any, Iterator, List, MutableSequence, Sequence, Tuple
 
 
 def shard(lst: List[Any], size: int) -> Iterator[Any]:
@@ -65,7 +70,7 @@ def remove_list_if_one_element(lst: List[Any]) -> Any:
         return lst
 
 
-def population_counts(lst: List[Any]) -> Mapping[Any, int]:
+def population_counts(lst: Sequence[Any]) -> Counter:
     """
     Return a population count mapping for the list (i.e. the keys are
     list items and the values are the number of occurrances of that
@@ -200,9 +205,9 @@ def ngrams(lst: Sequence[Any], n):
         yield lst[i : i + n]
 
 
-def permute(seq: Sequence[Any]):
+def permute(seq: str):
     """
-    Returns all permutations of a sequence; takes O(N^2) time.
+    Returns all permutations of a sequence; takes O(N!) time.
 
     >>> for x in permute('cat'):
     ...     print(x)
@@ -217,11 +222,12 @@ def permute(seq: Sequence[Any]):
     yield from _permute(seq, "")
 
 
-def _permute(seq: Sequence[Any], path):
-    if len(seq) == 0:
+def _permute(seq: str, path: str):
+    seq_len = len(seq)
+    if seq_len == 0:
         yield path
 
-    for i in range(len(seq)):
+    for i in range(seq_len):
         car = seq[i]
         left = seq[0:i]
         right = seq[i + 1 :]
@@ -229,6 +235,30 @@ def _permute(seq: Sequence[Any], path):
         yield from _permute(cdr, path + car)
 
 
+def shuffle(seq: MutableSequence[Any]) -> MutableSequence[Any]:
+    """Shuffles a sequence into a random order.
+
+    >>> random.seed(22)
+    >>> shuffle([1, 2, 3, 4, 5])
+    [3, 4, 1, 5, 2]
+
+    >>> shuffle('example')
+    'empaelx'
+
+    """
+    if isinstance(seq, str):
+        import string_utils
+
+        return string_utils.shuffle(seq)
+    else:
+        random.shuffle(seq)
+        return seq
+
+
+def scramble(seq: MutableSequence[Any]) -> MutableSequence[Any]:
+    return shuffle(seq)
+
+
 def binary_search(lst: Sequence[Any], target: Any, *, sanity_check=False) -> Tuple[bool, int]:
     """Performs a binary search on lst (which must already be sorted).
     Returns a Tuple composed of a bool which indicates whether the
@@ -264,9 +294,7 @@ def binary_search(lst: Sequence[Any], target: Any, *, sanity_check=False) -> Tup
     return _binary_search(lst, target, 0, len(lst) - 1)
 
 
-def _binary_search(
-    lst: Sequence[Any], target: Any, low: int, high: int
-) -> Tuple[bool, int]:
+def _binary_search(lst: Sequence[Any], target: Any, low: int, high: int) -> Tuple[bool, int]:
     if high >= low:
         mid = (high + low) // 2
         if lst[mid] == target:
@@ -279,6 +307,23 @@ def _binary_search(
         return (False, low)
 
 
+def powerset(lst: Sequence[Any]) -> Iterator[Sequence[Any]]:
+    """Returns the powerset of the items in the input sequence.
+
+    >>> for x in powerset([1, 2, 3]):
+    ...     print(x)
+    ()
+    (1,)
+    (2,)
+    (3,)
+    (1, 2)
+    (1, 3)
+    (2, 3)
+    (1, 2, 3)
+    """
+    return chain.from_iterable(combinations(lst, r) for r in range(len(lst) + 1))
+
+
 if __name__ == '__main__':
     import doctest