Merge branch 'TheAlgorithms:master' into master

cclauss · web-flow · commit dad936637de2 · 2023-11-05T13:36:27.000+05:45
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -16,12 +16,12 @@ repos:
     -   id: auto-walrus
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.1.1
+    rev: v0.1.3
     hooks:
       - id: ruff
 
   - repo: https://github.com/psf/black
-    rev: 23.10.0
+    rev: 23.10.1
     hooks:
       - id: black
 
@@ -33,7 +33,7 @@ repos:
           - tomli
 
   - repo: https://github.com/tox-dev/pyproject-fmt
-    rev: "1.2.0"
+    rev: "1.3.0"
     hooks:
       - id: pyproject-fmt
 
diff --git a/data_structures/hashing/hash_map.py b/data_structures/hashing/hash_map.py
@@ -242,6 +242,25 @@ def __delitem__(self, key: KEY) -> None:
             self._size_down()
 
     def __getitem__(self, key: KEY) -> VAL:
+        """
+        Returns the item at the given key
+
+        >>> hm = HashMap(5)
+        >>> hm._add_item(1, 10)
+        >>> hm.__getitem__(1)
+        10
+
+        >>> hm = HashMap(5)
+        >>> hm._add_item(10, -10)
+        >>> hm._add_item(20, -20)
+        >>> hm.__getitem__(20)
+        -20
+
+        >>> hm = HashMap(5)
+        >>> hm._add_item(-1, 10)
+        >>> hm.__getitem__(-1)
+        10
+        """
         for ind in self._iterate_buckets(key):
             item = self._buckets[ind]
             if item is None:
@@ -253,6 +272,20 @@ def __getitem__(self, key: KEY) -> VAL:
         raise KeyError(key)
 
     def __len__(self) -> int:
+        """
+        Returns the number of items present in hashmap
+
+        >>> hm = HashMap(5)
+        >>> hm._add_item(1, 10)
+        >>> hm._add_item(2, 20)
+        >>> hm._add_item(3, 30)
+        >>> hm.__len__()
+        3
+
+        >>> hm = HashMap(5)
+        >>> hm.__len__()
+        0
+        """
         return self._len
 
     def __iter__(self) -> Iterator[KEY]:
diff --git a/maths/special_numbers/happy_number.py b/maths/special_numbers/happy_number.py
@@ -0,0 +1,48 @@
+def is_happy_number(number: int) -> bool:
+    """
+    A happy number is a number which eventually reaches 1 when replaced by the sum of
+    the square of each digit.
+
+    :param number: The number to check for happiness.
+    :return: True if the number is a happy number, False otherwise.
+
+    >>> is_happy_number(19)
+    True
+    >>> is_happy_number(2)
+    False
+    >>> is_happy_number(23)
+    True
+    >>> is_happy_number(1)
+    True
+    >>> is_happy_number(0)
+    Traceback (most recent call last):
+        ...
+    ValueError: number=0 must be a positive integer
+    >>> is_happy_number(-19)
+    Traceback (most recent call last):
+        ...
+    ValueError: number=-19 must be a positive integer
+    >>> is_happy_number(19.1)
+    Traceback (most recent call last):
+        ...
+    ValueError: number=19.1 must be a positive integer
+    >>> is_happy_number("happy")
+    Traceback (most recent call last):
+        ...
+    ValueError: number='happy' must be a positive integer
+    """
+    if not isinstance(number, int) or number <= 0:
+        msg = f"{number=} must be a positive integer"
+        raise ValueError(msg)
+
+    seen = set()
+    while number != 1 and number not in seen:
+        seen.add(number)
+        number = sum(int(digit) ** 2 for digit in str(number))
+    return number == 1
+
+
+if __name__ == "__main__":
+    import doctest
+
+    doctest.testmod()
diff --git a/matrix/validate_sudoku_board.py b/matrix/validate_sudoku_board.py
@@ -54,6 +54,66 @@ def is_valid_sudoku_board(sudoku_board: list[list[str]]) -> bool:
     ... ,[".",".",".",".","8",".",".","7","9"]
     ... ])
     False
+    >>> is_valid_sudoku_board([
+    ...  ["1","2","3","4","5","6","7","8","9"]
+    ... ,["4","5","6","7","8","9","1","2","3"]
+    ... ,["7","8","9","1","2","3","4","5","6"]
+    ... ,[".",".",".",".",".",".",".",".","."]
+    ... ,[".",".",".",".",".",".",".",".","."]
+    ... ,[".",".",".",".",".",".",".",".","."]
+    ... ,[".",".",".",".",".",".",".",".","."]
+    ... ,[".",".",".",".",".",".",".",".","."]
+    ... ,[".",".",".",".",".",".",".",".","."]
+    ... ])
+    True
+    >>> is_valid_sudoku_board([
+    ...  ["1","2","3",".",".",".",".",".","."]
+    ... ,["4","5","6",".",".",".",".",".","."]
+    ... ,["7","8","9",".",".",".",".",".","."]
+    ... ,[".",".",".","4","5","6",".",".","."]
+    ... ,[".",".",".","7","8","9",".",".","."]
+    ... ,[".",".",".","1","2","3",".",".","."]
+    ... ,[".",".",".",".",".",".","7","8","9"]
+    ... ,[".",".",".",".",".",".","1","2","3"]
+    ... ,[".",".",".",".",".",".","4","5","6"]
+    ... ])
+    True
+    >>> is_valid_sudoku_board([
+    ...  ["1","2","3",".",".",".","5","6","4"]
+    ... ,["4","5","6",".",".",".","8","9","7"]
+    ... ,["7","8","9",".",".",".","2","3","1"]
+    ... ,[".",".",".","4","5","6",".",".","."]
+    ... ,[".",".",".","7","8","9",".",".","."]
+    ... ,[".",".",".","1","2","3",".",".","."]
+    ... ,["3","1","2",".",".",".","7","8","9"]
+    ... ,["6","4","5",".",".",".","1","2","3"]
+    ... ,["9","7","8",".",".",".","4","5","6"]
+    ... ])
+    True
+    >>> is_valid_sudoku_board([
+    ...  ["1","2","3","4","5","6","7","8","9"]
+    ... ,["2",".",".",".",".",".",".",".","8"]
+    ... ,["3",".",".",".",".",".",".",".","7"]
+    ... ,["4",".",".",".",".",".",".",".","6"]
+    ... ,["5",".",".",".",".",".",".",".","5"]
+    ... ,["6",".",".",".",".",".",".",".","4"]
+    ... ,["7",".",".",".",".",".",".",".","3"]
+    ... ,["8",".",".",".",".",".",".",".","2"]
+    ... ,["9","8","7","6","5","4","3","2","1"]
+    ... ])
+    False
+    >>> is_valid_sudoku_board([
+    ...  ["1","2","3","8","9","7","5","6","4"]
+    ... ,["4","5","6","2","3","1","8","9","7"]
+    ... ,["7","8","9","5","6","4","2","3","1"]
+    ... ,["2","3","1","4","5","6","9","7","8"]
+    ... ,["5","6","4","7","8","9","3","1","2"]
+    ... ,["8","9","7","1","2","3","6","4","5"]
+    ... ,["3","1","2","6","4","5","7","8","9"]
+    ... ,["6","4","5","9","7","8","1","2","3"]
+    ... ,["9","7","8","3","1","2","4","5","6"]
+    ... ])
+    True
     >>> is_valid_sudoku_board([["1", "2", "3", "4", "5", "6", "7", "8", "9"]])
     Traceback (most recent call last):
         ...
diff --git a/sorts/intro_sort.py b/sorts/intro_sort.py
@@ -11,6 +11,18 @@ def insertion_sort(array: list, start: int = 0, end: int = 0) -> list:
     >>> array = [4, 2, 6, 8, 1, 7, 8, 22, 14, 56, 27, 79, 23, 45, 14, 12]
     >>> insertion_sort(array, 0, len(array))
     [1, 2, 4, 6, 7, 8, 8, 12, 14, 14, 22, 23, 27, 45, 56, 79]
+    >>> array = [21, 15, 11, 45, -2, -11, 46]
+    >>> insertion_sort(array, 0, len(array))
+    [-11, -2, 11, 15, 21, 45, 46]
+    >>> array = [-2, 0, 89, 11, 48, 79, 12]
+    >>> insertion_sort(array, 0, len(array))
+    [-2, 0, 11, 12, 48, 79, 89]
+    >>> array = ['a', 'z', 'd', 'p', 'v', 'l', 'o', 'o']
+    >>> insertion_sort(array, 0, len(array))
+    ['a', 'd', 'l', 'o', 'o', 'p', 'v', 'z']
+    >>> array = [73.568, 73.56, -45.03, 1.7, 0, 89.45]
+    >>> insertion_sort(array, 0, len(array))
+    [-45.03, 0, 1.7, 73.56, 73.568, 89.45]
     """
     end = end or len(array)
     for i in range(start, end):
@@ -47,6 +59,12 @@ def heap_sort(array: list) -> list:
     """
     >>> heap_sort([4, 2, 6, 8, 1, 7, 8, 22, 14, 56, 27, 79, 23, 45, 14, 12])
     [1, 2, 4, 6, 7, 8, 8, 12, 14, 14, 22, 23, 27, 45, 56, 79]
+    >>> heap_sort([-2, -11, 0, 0, 0, 87, 45, -69, 78, 12, 10, 103, 89, 52])
+    [-69, -11, -2, 0, 0, 0, 10, 12, 45, 52, 78, 87, 89, 103]
+    >>> heap_sort(['b', 'd', 'e', 'f', 'g', 'p', 'x', 'z', 'b', 's', 'e', 'u', 'v'])
+    ['b', 'b', 'd', 'e', 'e', 'f', 'g', 'p', 's', 'u', 'v', 'x', 'z']
+    >>> heap_sort([6.2, -45.54, 8465.20, 758.56, -457.0, 0, 1, 2.879, 1.7, 11.7])
+    [-457.0, -45.54, 0, 1, 1.7, 2.879, 6.2, 11.7, 758.56, 8465.2]
     """
     n = len(array)
 
@@ -91,6 +109,15 @@ def partition(array: list, low: int, high: int, pivot: int) -> int:
     >>> array = [4, 2, 6, 8, 1, 7, 8, 22, 14, 56, 27, 79, 23, 45, 14, 12]
     >>> partition(array, 0, len(array), 12)
     8
+    >>> array = [21, 15, 11, 45, -2, -11, 46]
+    >>> partition(array, 0, len(array), 15)
+    3
+    >>> array = ['a', 'z', 'd', 'p', 'v', 'l', 'o', 'o']
+    >>> partition(array, 0, len(array), 'p')
+    5
+    >>> array = [6.2, -45.54, 8465.20, 758.56, -457.0, 0, 1, 2.879, 1.7, 11.7]
+    >>> partition(array, 0, len(array), 2.879)
+    6
     """
     i = low
     j = high
