From 66eea0482f6ca07e8eb40a53d08c57003060a2d9 Mon Sep 17 00:00:00 2001
From: eukub <ekublin@gmail.com>
Date: Sat, 11 Nov 2023 13:53:41 +0300
Subject: [PATCH 01/21] Algorithm solving problem "136. Single Number" from
 Leetcode (https://leetcode.com/problems/single-number/)

---
 bit_manipulation/single_number.py | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 bit_manipulation/single_number.py

diff --git a/bit_manipulation/single_number.py b/bit_manipulation/single_number.py
new file mode 100644
index 000000000000..c30af407a819
--- /dev/null
+++ b/bit_manipulation/single_number.py
@@ -0,0 +1,23 @@
+"""
+    Given a non-empty array of integers nums, every element
+    appears twice except for one. Find that single one.
+
+    You must implement a solution with a linear runtime complexity
+    and use only constant extra space.
+
+    Reference: https://leetcode.com/problems/single-number/
+"""
+
+
+def single_number(nums: list) -> int:
+    """
+    :param nums: A non-empty array of any integers nums,
+                 every element appears twice except for one.
+    :return: element that appears only one time
+    """
+    result = 0
+
+    for el in nums:
+        result ^= el
+
+    return result

From e6624519e8ed0aec445e78bfab1396eba541d9c8 Mon Sep 17 00:00:00 2001
From: eukub <ekublin@gmail.com>
Date: Sat, 11 Nov 2023 14:02:49 +0300
Subject: [PATCH 02/21] Algorithm solving problem "136. Single Number" from
 Leetcode (https://leetcode.com/problems/single-number/)

---
 bit_manipulation/single_number.py | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/bit_manipulation/single_number.py b/bit_manipulation/single_number.py
index c30af407a819..199c74a5ce56 100644
--- a/bit_manipulation/single_number.py
+++ b/bit_manipulation/single_number.py
@@ -1,6 +1,6 @@
 """
     Given a non-empty array of integers nums, every element
-    appears twice except for one. Find that single one.
+    appears twice except for one. Find that single one
 
     You must implement a solution with a linear runtime complexity
     and use only constant extra space.
@@ -14,6 +14,17 @@ def single_number(nums: list) -> int:
     :param nums: A non-empty array of any integers nums,
                  every element appears twice except for one.
     :return: element that appears only one time
+
+    Examples:
+        Example 1
+            Input: nums = [1, 3, 3, 2, 6, 2, 1]
+            Output: 6
+        Example 2
+            Input: nums = [12, 1, 1, 7, 1, 12, 1]
+            Output: 7
+        Example 3
+            Input: nums = [6]
+            Output: 6
     """
     result = 0
 

From 352d0fb2e12106b1bc68509b1391bc336f4e9766 Mon Sep 17 00:00:00 2001
From: eukub <ekublin@gmail.com>
Date: Tue, 14 Nov 2023 17:08:21 +0300
Subject: [PATCH 03/21] Algorithm solving problem "136. Single Number" from
 Leetcode (https://leetcode.com/problems/single-number/)

---
 bit_manipulation/single_number.py | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)

diff --git a/bit_manipulation/single_number.py b/bit_manipulation/single_number.py
index 199c74a5ce56..69dcbc3543b7 100644
--- a/bit_manipulation/single_number.py
+++ b/bit_manipulation/single_number.py
@@ -15,20 +15,21 @@ def single_number(nums: list) -> int:
                  every element appears twice except for one.
     :return: element that appears only one time
 
-    Examples:
+     Examples:
         Example 1
-            Input: nums = [1, 3, 3, 2, 6, 2, 1]
-            Output: 6
+            >>> print(single_number([1, 3, 3, 2, 6, 2, 1]))
+            6
+
         Example 2
-            Input: nums = [12, 1, 1, 7, 1, 12, 1]
-            Output: 7
+            >>> print(single_number([12, 1, 1, 7, 1, 12, 1]))
+            7
+
         Example 3
-            Input: nums = [6]
-            Output: 6
+            >>> print(single_number([6]))
+            6
     """
-    result = 0
 
+    result = 0
     for el in nums:
         result ^= el
-
     return result

From ea22368cf42a99003c03d2de4ef7ada5c23bef9a Mon Sep 17 00:00:00 2001
From: eukub <ekublin@gmail.com>
Date: Tue, 14 Nov 2023 20:51:18 +0300
Subject: [PATCH 04/21] Algorithm solving problem "136. Single Number" from
 Leetcode (https://leetcode.com/problems/single-number/)

---
 bit_manipulation/single_number.py | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/bit_manipulation/single_number.py b/bit_manipulation/single_number.py
index 69dcbc3543b7..8eeeefeecd60 100644
--- a/bit_manipulation/single_number.py
+++ b/bit_manipulation/single_number.py
@@ -33,3 +33,9 @@ def single_number(nums: list) -> int:
     for el in nums:
         result ^= el
     return result
+
+
+if __name__ == "__main__":
+    import doctest
+
+    doctest.testmod()

From 2fec97b96f132757f33ae7ae8cdceab124210539 Mon Sep 17 00:00:00 2001
From: eukub <ekublin@gmail.com>
Date: Sat, 11 Nov 2023 13:53:41 +0300
Subject: [PATCH 05/21] Algorithm solving problem "136. Single Number" from
 Leetcode (https://leetcode.com/problems/single-number/)

---
 bit_manipulation/single_number.py | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 bit_manipulation/single_number.py

diff --git a/bit_manipulation/single_number.py b/bit_manipulation/single_number.py
new file mode 100644
index 000000000000..c30af407a819
--- /dev/null
+++ b/bit_manipulation/single_number.py
@@ -0,0 +1,23 @@
+"""
+    Given a non-empty array of integers nums, every element
+    appears twice except for one. Find that single one.
+
+    You must implement a solution with a linear runtime complexity
+    and use only constant extra space.
+
+    Reference: https://leetcode.com/problems/single-number/
+"""
+
+
+def single_number(nums: list) -> int:
+    """
+    :param nums: A non-empty array of any integers nums,
+                 every element appears twice except for one.
+    :return: element that appears only one time
+    """
+    result = 0
+
+    for el in nums:
+        result ^= el
+
+    return result

From 09a990b8c7c55738b39887c48b0d8ab06d41da67 Mon Sep 17 00:00:00 2001
From: eukub <ekublin@gmail.com>
Date: Sat, 11 Nov 2023 14:02:49 +0300
Subject: [PATCH 06/21] Algorithm solving problem "136. Single Number" from
 Leetcode (https://leetcode.com/problems/single-number/)

---
 bit_manipulation/single_number.py | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/bit_manipulation/single_number.py b/bit_manipulation/single_number.py
index c30af407a819..199c74a5ce56 100644
--- a/bit_manipulation/single_number.py
+++ b/bit_manipulation/single_number.py
@@ -1,6 +1,6 @@
 """
     Given a non-empty array of integers nums, every element
-    appears twice except for one. Find that single one.
+    appears twice except for one. Find that single one
 
     You must implement a solution with a linear runtime complexity
     and use only constant extra space.
@@ -14,6 +14,17 @@ def single_number(nums: list) -> int:
     :param nums: A non-empty array of any integers nums,
                  every element appears twice except for one.
     :return: element that appears only one time
+
+    Examples:
+        Example 1
+            Input: nums = [1, 3, 3, 2, 6, 2, 1]
+            Output: 6
+        Example 2
+            Input: nums = [12, 1, 1, 7, 1, 12, 1]
+            Output: 7
+        Example 3
+            Input: nums = [6]
+            Output: 6
     """
     result = 0
 

From 66af9cbb9f88850df5758c1925379fd22ace12d8 Mon Sep 17 00:00:00 2001
From: eukub <ekublin@gmail.com>
Date: Tue, 14 Nov 2023 17:08:21 +0300
Subject: [PATCH 07/21] Algorithm solving problem "136. Single Number" from
 Leetcode (https://leetcode.com/problems/single-number/)

---
 bit_manipulation/single_number.py | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)

diff --git a/bit_manipulation/single_number.py b/bit_manipulation/single_number.py
index 199c74a5ce56..69dcbc3543b7 100644
--- a/bit_manipulation/single_number.py
+++ b/bit_manipulation/single_number.py
@@ -15,20 +15,21 @@ def single_number(nums: list) -> int:
                  every element appears twice except for one.
     :return: element that appears only one time
 
-    Examples:
+     Examples:
         Example 1
-            Input: nums = [1, 3, 3, 2, 6, 2, 1]
-            Output: 6
+            >>> print(single_number([1, 3, 3, 2, 6, 2, 1]))
+            6
+
         Example 2
-            Input: nums = [12, 1, 1, 7, 1, 12, 1]
-            Output: 7
+            >>> print(single_number([12, 1, 1, 7, 1, 12, 1]))
+            7
+
         Example 3
-            Input: nums = [6]
-            Output: 6
+            >>> print(single_number([6]))
+            6
     """
-    result = 0
 
+    result = 0
     for el in nums:
         result ^= el
-
     return result

From 56017b757643f4484dae840f90f25dccac65e2b1 Mon Sep 17 00:00:00 2001
From: eukub <ekublin@gmail.com>
Date: Tue, 14 Nov 2023 20:51:18 +0300
Subject: [PATCH 08/21] Algorithm solving problem "136. Single Number" from
 Leetcode (https://leetcode.com/problems/single-number/)

---
 bit_manipulation/single_number.py | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/bit_manipulation/single_number.py b/bit_manipulation/single_number.py
index 69dcbc3543b7..8eeeefeecd60 100644
--- a/bit_manipulation/single_number.py
+++ b/bit_manipulation/single_number.py
@@ -33,3 +33,9 @@ def single_number(nums: list) -> int:
     for el in nums:
         result ^= el
     return result
+
+
+if __name__ == "__main__":
+    import doctest
+
+    doctest.testmod()

From b91dbfc76801583bde2f0035163e18b0d6225c65 Mon Sep 17 00:00:00 2001
From: MC <129918860+FishyGitHubUser@users.noreply.github.com>
Date: Thu, 16 Nov 2023 19:00:48 +0800
Subject: [PATCH 09/21] Fix ignore venv in build_directory_md.py (#11156)

Co-authored-by: MICHAEL CASTLE <CASTLM@tdm.local>
---
 scripts/build_directory_md.py                               | 6 +++++-
 web_programming/{get_imdbtop.py => get_imdbtop.py.DISABLED} | 0
 2 files changed, 5 insertions(+), 1 deletion(-)
 rename web_programming/{get_imdbtop.py => get_imdbtop.py.DISABLED} (100%)

diff --git a/scripts/build_directory_md.py b/scripts/build_directory_md.py
index 24bc00cd036f..aa95b95db4b5 100755
--- a/scripts/build_directory_md.py
+++ b/scripts/build_directory_md.py
@@ -6,7 +6,11 @@
 
 def good_file_paths(top_dir: str = ".") -> Iterator[str]:
     for dir_path, dir_names, filenames in os.walk(top_dir):
-        dir_names[:] = [d for d in dir_names if d != "scripts" and d[0] not in "._"]
+        dir_names[:] = [
+            d
+            for d in dir_names
+            if d != "scripts" and d[0] not in "._" and "venv" not in d
+        ]
         for filename in filenames:
             if filename == "__init__.py":
                 continue
diff --git a/web_programming/get_imdbtop.py b/web_programming/get_imdbtop.py.DISABLED
similarity index 100%
rename from web_programming/get_imdbtop.py
rename to web_programming/get_imdbtop.py.DISABLED

From f693cd9c115098c932ed2f7b99ec96c5d607e8e1 Mon Sep 17 00:00:00 2001
From: Margaret <62753112+meg-1@users.noreply.github.com>
Date: Fri, 24 Nov 2023 20:00:21 +0200
Subject: [PATCH 10/21] adding a geometry module (#11138)

* adding a geometry module

* fixing errors and adding type hints

* Create code_review_feedback.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* implementing suggestions

* fixing ruff errors

* Update geometry/code_review_feedback.py

* Update geometry/code_review_feedback.py

* Update geometry/geometry.py

* Apply suggestions from code review

* Delete geometry/code_review_feedback.py

* Update geometry/geometry.py

* Update geometry/geometry.py

---------

Co-authored-by: Christian Clauss <cclauss@me.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
---
 geometry/geometry.py | 259 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 259 insertions(+)
 create mode 100644 geometry/geometry.py

diff --git a/geometry/geometry.py b/geometry/geometry.py
new file mode 100644
index 000000000000..9e353dee17a7
--- /dev/null
+++ b/geometry/geometry.py
@@ -0,0 +1,259 @@
+from __future__ import annotations
+
+import math
+from dataclasses import dataclass, field
+from types import NoneType
+from typing import Self
+
+# Building block classes
+
+
+@dataclass
+class Angle:
+    """
+    An Angle in degrees (unit of measurement)
+
+    >>> Angle()
+    Angle(degrees=90)
+    >>> Angle(45.5)
+    Angle(degrees=45.5)
+    >>> Angle(-1)
+    Traceback (most recent call last):
+        ...
+    TypeError: degrees must be a numeric value between 0 and 360.
+    >>> Angle(361)
+    Traceback (most recent call last):
+        ...
+    TypeError: degrees must be a numeric value between 0 and 360.
+    """
+
+    degrees: float = 90
+
+    def __post_init__(self) -> None:
+        if not isinstance(self.degrees, (int, float)) or not 0 <= self.degrees <= 360:
+            raise TypeError("degrees must be a numeric value between 0 and 360.")
+
+
+@dataclass
+class Side:
+    """
+    A side of a two dimensional Shape such as Polygon, etc.
+    adjacent_sides: a list of sides which are adjacent to the current side
+    angle: the angle in degrees between each adjacent side
+    length: the length of the current side in meters
+
+    >>> Side(5)
+    Side(length=5, angle=Angle(degrees=90), next_side=None)
+    >>> Side(5, Angle(45.6))
+    Side(length=5, angle=Angle(degrees=45.6), next_side=None)
+    >>> Side(5, Angle(45.6), Side(1, Angle(2)))  # doctest: +ELLIPSIS
+    Side(length=5, angle=Angle(degrees=45.6), next_side=Side(length=1, angle=Angle(d...
+    """
+
+    length: float
+    angle: Angle = field(default_factory=Angle)
+    next_side: Side | None = None
+
+    def __post_init__(self) -> None:
+        if not isinstance(self.length, (int, float)) or self.length <= 0:
+            raise TypeError("length must be a positive numeric value.")
+        if not isinstance(self.angle, Angle):
+            raise TypeError("angle must be an Angle object.")
+        if not isinstance(self.next_side, (Side, NoneType)):
+            raise TypeError("next_side must be a Side or None.")
+
+
+@dataclass
+class Ellipse:
+    """
+    A geometric Ellipse on a 2D surface
+
+    >>> Ellipse(5, 10)
+    Ellipse(major_radius=5, minor_radius=10)
+    >>> Ellipse(5, 10) is Ellipse(5, 10)
+    False
+    >>> Ellipse(5, 10) == Ellipse(5, 10)
+    True
+    """
+
+    major_radius: float
+    minor_radius: float
+
+    @property
+    def area(self) -> float:
+        """
+        >>> Ellipse(5, 10).area
+        157.07963267948966
+        """
+        return math.pi * self.major_radius * self.minor_radius
+
+    @property
+    def perimeter(self) -> float:
+        """
+        >>> Ellipse(5, 10).perimeter
+        47.12388980384689
+        """
+        return math.pi * (self.major_radius + self.minor_radius)
+
+
+class Circle(Ellipse):
+    """
+    A geometric Circle on a 2D surface
+
+    >>> Circle(5)
+    Circle(radius=5)
+    >>> Circle(5) is Circle(5)
+    False
+    >>> Circle(5) == Circle(5)
+    True
+    >>> Circle(5).area
+    78.53981633974483
+    >>> Circle(5).perimeter
+    31.41592653589793
+    """
+
+    def __init__(self, radius: float) -> None:
+        super().__init__(radius, radius)
+        self.radius = radius
+
+    def __repr__(self) -> str:
+        return f"Circle(radius={self.radius})"
+
+    @property
+    def diameter(self) -> float:
+        """
+        >>> Circle(5).diameter
+        10
+        """
+        return self.radius * 2
+
+    def max_parts(self, num_cuts: float) -> float:
+        """
+        Return the maximum number of parts that circle can be divided into if cut
+        'num_cuts' times.
+
+        >>> circle = Circle(5)
+        >>> circle.max_parts(0)
+        1.0
+        >>> circle.max_parts(7)
+        29.0
+        >>> circle.max_parts(54)
+        1486.0
+        >>> circle.max_parts(22.5)
+        265.375
+        >>> circle.max_parts(-222)
+        Traceback (most recent call last):
+            ...
+        TypeError: num_cuts must be a positive numeric value.
+        >>> circle.max_parts("-222")
+        Traceback (most recent call last):
+            ...
+        TypeError: num_cuts must be a positive numeric value.
+        """
+        if not isinstance(num_cuts, (int, float)) or num_cuts < 0:
+            raise TypeError("num_cuts must be a positive numeric value.")
+        return (num_cuts + 2 + num_cuts**2) * 0.5
+
+
+@dataclass
+class Polygon:
+    """
+    An abstract class which represents Polygon on a 2D surface.
+
+    >>> Polygon()
+    Polygon(sides=[])
+    """
+
+    sides: list[Side] = field(default_factory=list)
+
+    def add_side(self, side: Side) -> Self:
+        """
+        >>> Polygon().add_side(Side(5))
+        Polygon(sides=[Side(length=5, angle=Angle(degrees=90), next_side=None)])
+        """
+        self.sides.append(side)
+        return self
+
+    def get_side(self, index: int) -> Side:
+        """
+        >>> Polygon().get_side(0)
+        Traceback (most recent call last):
+            ...
+        IndexError: list index out of range
+        >>> Polygon().add_side(Side(5)).get_side(-1)
+        Side(length=5, angle=Angle(degrees=90), next_side=None)
+        """
+        return self.sides[index]
+
+    def set_side(self, index: int, side: Side) -> Self:
+        """
+        >>> Polygon().set_side(0, Side(5))
+        Traceback (most recent call last):
+            ...
+        IndexError: list assignment index out of range
+        >>> Polygon().add_side(Side(5)).set_side(0, Side(10))
+        Polygon(sides=[Side(length=10, angle=Angle(degrees=90), next_side=None)])
+        """
+        self.sides[index] = side
+        return self
+
+
+class Rectangle(Polygon):
+    """
+    A geometric rectangle on a 2D surface.
+
+    >>> rectangle_one = Rectangle(5, 10)
+    >>> rectangle_one.perimeter()
+    30
+    >>> rectangle_one.area()
+    50
+    """
+
+    def __init__(self, short_side_length: float, long_side_length: float) -> None:
+        super().__init__()
+        self.short_side_length = short_side_length
+        self.long_side_length = long_side_length
+        self.post_init()
+
+    def post_init(self) -> None:
+        """
+        >>> Rectangle(5, 10)  # doctest: +NORMALIZE_WHITESPACE
+        Rectangle(sides=[Side(length=5, angle=Angle(degrees=90), next_side=None),
+        Side(length=10, angle=Angle(degrees=90), next_side=None)])
+        """
+        self.short_side = Side(self.short_side_length)
+        self.long_side = Side(self.long_side_length)
+        super().add_side(self.short_side)
+        super().add_side(self.long_side)
+
+    def perimeter(self) -> float:
+        return (self.short_side.length + self.long_side.length) * 2
+
+    def area(self) -> float:
+        return self.short_side.length * self.long_side.length
+
+
+@dataclass
+class Square(Rectangle):
+    """
+    a structure which represents a
+    geometrical square on a 2D surface
+    >>> square_one = Square(5)
+    >>> square_one.perimeter()
+    20
+    >>> square_one.area()
+    25
+    """
+
+    def __init__(self, side_length: float) -> None:
+        super().__init__(side_length, side_length)
+
+    def perimeter(self) -> float:
+        return super().perimeter()
+
+    def area(self) -> float:
+        return super().area()
+
+
+if __name__ == "__main__":
+    __import__("doctest").testmod()

From 9a3ddf184ca611d70382743c8a8edc3a5c6a9bd5 Mon Sep 17 00:00:00 2001
From: MC <129918860+FishyGitHubUser@users.noreply.github.com>
Date: Sat, 25 Nov 2023 19:17:59 +0800
Subject: [PATCH 11/21] Fix typo in knight_tour.py (#11173)

---
 backtracking/knight_tour.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/backtracking/knight_tour.py b/backtracking/knight_tour.py
index cc88307b7fe8..5f7dee8d97bf 100644
--- a/backtracking/knight_tour.py
+++ b/backtracking/knight_tour.py
@@ -79,7 +79,7 @@ def open_knight_tour(n: int) -> list[list[int]]:
     >>> open_knight_tour(2)
     Traceback (most recent call last):
         ...
-    ValueError: Open Kight Tour cannot be performed on a board of size 2
+    ValueError: Open Knight Tour cannot be performed on a board of size 2
     """
 
     board = [[0 for i in range(n)] for j in range(n)]
@@ -91,7 +91,7 @@ def open_knight_tour(n: int) -> list[list[int]]:
                 return board
             board[i][j] = 0
 
-    msg = f"Open Kight Tour cannot be performed on a board of size {n}"
+    msg = f"Open Knight Tour cannot be performed on a board of size {n}"
     raise ValueError(msg)
 
 

From 826f64d2aa129934b58bb3bab69211e941422caf Mon Sep 17 00:00:00 2001
From: Rahid Zeynalov <44039543+rahidzeynal@users.noreply.github.com>
Date: Sat, 25 Nov 2023 15:25:46 +0400
Subject: [PATCH 12/21] Typo deicmal -> decimal (#11169)

---
 bit_manipulation/is_even.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/bit_manipulation/is_even.py b/bit_manipulation/is_even.py
index ba036f35aa1e..6f95a1160797 100644
--- a/bit_manipulation/is_even.py
+++ b/bit_manipulation/is_even.py
@@ -1,7 +1,7 @@
 def is_even(number: int) -> bool:
     """
     return true if the input integer is even
-    Explanation: Lets take a look at the following deicmal to binary conversions
+    Explanation: Lets take a look at the following decimal to binary conversions
     2 => 10
     14 => 1110
     100 => 1100100

From 8ecbc70c549d71392d76de9a62b84915a898b199 Mon Sep 17 00:00:00 2001
From: Clark <1009013283@qq.com>
Date: Sat, 25 Nov 2023 20:26:03 +0800
Subject: [PATCH 13/21] add graphs/ant_colony_optimization_algorithms.py
 (#11163)

* add ant_colonyant_colony_optimization_algorithms.py

* Modify details

* Modify type annotation

* Add tests for KeyError, IndexError, StopIteration, etc.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: Christian Clauss <cclauss@me.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
---
 graphs/ant_colony_optimization_algorithms.py | 226 +++++++++++++++++++
 1 file changed, 226 insertions(+)
 create mode 100644 graphs/ant_colony_optimization_algorithms.py

diff --git a/graphs/ant_colony_optimization_algorithms.py b/graphs/ant_colony_optimization_algorithms.py
new file mode 100644
index 000000000000..652ad6144297
--- /dev/null
+++ b/graphs/ant_colony_optimization_algorithms.py
@@ -0,0 +1,226 @@
+"""
+Use an ant colony optimization algorithm to solve the travelling salesman problem (TSP)
+which asks the following question:
+"Given a list of cities and the distances between each pair of cities, what is the
+ shortest possible route that visits each city exactly once and returns to the origin
+ city?"
+
+https://en.wikipedia.org/wiki/Ant_colony_optimization_algorithms
+https://en.wikipedia.org/wiki/Travelling_salesman_problem
+
+Author: Clark
+"""
+
+import copy
+import random
+
+cities = {
+    0: [0, 0],
+    1: [0, 5],
+    2: [3, 8],
+    3: [8, 10],
+    4: [12, 8],
+    5: [12, 4],
+    6: [8, 0],
+    7: [6, 2],
+}
+
+
+def main(
+    cities: dict[int, list[int]],
+    ants_num: int,
+    iterations_num: int,
+    pheromone_evaporation: float,
+    alpha: float,
+    beta: float,
+    q: float,  # Pheromone system parameters Q，which is a constant
+) -> tuple[list[int], float]:
+    """
+    Ant colony algorithm main function
+    >>> main(cities=cities, ants_num=10, iterations_num=20,
+    ...      pheromone_evaporation=0.7, alpha=1.0, beta=5.0, q=10)
+    ([0, 1, 2, 3, 4, 5, 6, 7, 0], 37.909778143828696)
+    >>> main(cities={0: [0, 0], 1: [2, 2]}, ants_num=5, iterations_num=5,
+    ...      pheromone_evaporation=0.7, alpha=1.0, beta=5.0, q=10)
+    ([0, 1, 0], 5.656854249492381)
+    >>> main(cities={0: [0, 0], 1: [2, 2], 4: [4, 4]}, ants_num=5, iterations_num=5,
+    ...      pheromone_evaporation=0.7, alpha=1.0, beta=5.0, q=10)
+    Traceback (most recent call last):
+      ...
+    IndexError: list index out of range
+    >>> main(cities={}, ants_num=5, iterations_num=5,
+    ...      pheromone_evaporation=0.7, alpha=1.0, beta=5.0, q=10)
+    Traceback (most recent call last):
+      ...
+    StopIteration
+    >>> main(cities={0: [0, 0], 1: [2, 2]}, ants_num=0, iterations_num=5,
+    ...      pheromone_evaporation=0.7, alpha=1.0, beta=5.0, q=10)
+    ([], inf)
+    >>> main(cities={0: [0, 0], 1: [2, 2]}, ants_num=5, iterations_num=0,
+    ...      pheromone_evaporation=0.7, alpha=1.0, beta=5.0, q=10)
+    ([], inf)
+    >>> main(cities={0: [0, 0], 1: [2, 2]}, ants_num=5, iterations_num=5,
+    ...      pheromone_evaporation=1, alpha=1.0, beta=5.0, q=10)
+    ([0, 1, 0], 5.656854249492381)
+    >>> main(cities={0: [0, 0], 1: [2, 2]}, ants_num=5, iterations_num=5,
+    ...      pheromone_evaporation=0, alpha=1.0, beta=5.0, q=10)
+    ([0, 1, 0], 5.656854249492381)
+    """
+    # Initialize the pheromone matrix
+    cities_num = len(cities)
+    pheromone = [[1.0] * cities_num] * cities_num
+
+    best_path: list[int] = []
+    best_distance = float("inf")
+    for _ in range(iterations_num):
+        ants_route = []
+        for _ in range(ants_num):
+            unvisited_cities = copy.deepcopy(cities)
+            current_city = {next(iter(cities.keys())): next(iter(cities.values()))}
+            del unvisited_cities[next(iter(current_city.keys()))]
+            ant_route = [next(iter(current_city.keys()))]
+            while unvisited_cities:
+                current_city, unvisited_cities = city_select(
+                    pheromone, current_city, unvisited_cities, alpha, beta
+                )
+                ant_route.append(next(iter(current_city.keys())))
+            ant_route.append(0)
+            ants_route.append(ant_route)
+
+        pheromone, best_path, best_distance = pheromone_update(
+            pheromone,
+            cities,
+            pheromone_evaporation,
+            ants_route,
+            q,
+            best_path,
+            best_distance,
+        )
+    return best_path, best_distance
+
+
+def distance(city1: list[int], city2: list[int]) -> float:
+    """
+    Calculate the distance between two coordinate points
+    >>> distance([0, 0], [3, 4] )
+    5.0
+    >>> distance([0, 0], [-3, 4] )
+    5.0
+    >>> distance([0, 0], [-3, -4] )
+    5.0
+    """
+    return (((city1[0] - city2[0]) ** 2) + ((city1[1] - city2[1]) ** 2)) ** 0.5
+
+
+def pheromone_update(
+    pheromone: list[list[float]],
+    cities: dict[int, list[int]],
+    pheromone_evaporation: float,
+    ants_route: list[list[int]],
+    q: float,  # Pheromone system parameters Q，which is a constant
+    best_path: list[int],
+    best_distance: float,
+) -> tuple[list[list[float]], list[int], float]:
+    """
+    Update pheromones on the route and update the best route
+    >>>
+    >>> pheromone_update(pheromone=[[1.0, 1.0], [1.0, 1.0]],
+    ...                  cities={0: [0,0], 1: [2,2]}, pheromone_evaporation=0.7,
+    ...                  ants_route=[[0, 1, 0]], q=10, best_path=[],
+    ...                  best_distance=float("inf"))
+    ([[0.7, 4.235533905932737], [4.235533905932737, 0.7]], [0, 1, 0], 5.656854249492381)
+    >>> pheromone_update(pheromone=[],
+    ...                  cities={0: [0,0], 1: [2,2]}, pheromone_evaporation=0.7,
+    ...                  ants_route=[[0, 1, 0]], q=10, best_path=[],
+    ...                  best_distance=float("inf"))
+    Traceback (most recent call last):
+      ...
+    IndexError: list index out of range
+    >>> pheromone_update(pheromone=[[1.0, 1.0], [1.0, 1.0]],
+    ...                  cities={}, pheromone_evaporation=0.7,
+    ...                  ants_route=[[0, 1, 0]], q=10, best_path=[],
+    ...                  best_distance=float("inf"))
+    Traceback (most recent call last):
+      ...
+    KeyError: 0
+    """
+    for a in range(len(cities)):  # Update the volatilization of pheromone on all routes
+        for b in range(len(cities)):
+            pheromone[a][b] *= pheromone_evaporation
+    for ant_route in ants_route:
+        total_distance = 0.0
+        for i in range(len(ant_route) - 1):  # Calculate total distance
+            total_distance += distance(cities[ant_route[i]], cities[ant_route[i + 1]])
+        delta_pheromone = q / total_distance
+        for i in range(len(ant_route) - 1):  # Update pheromones
+            pheromone[ant_route[i]][ant_route[i + 1]] += delta_pheromone
+            pheromone[ant_route[i + 1]][ant_route[i]] = pheromone[ant_route[i]][
+                ant_route[i + 1]
+            ]
+
+        if total_distance < best_distance:
+            best_path = ant_route
+            best_distance = total_distance
+
+    return pheromone, best_path, best_distance
+
+
+def city_select(
+    pheromone: list[list[float]],
+    current_city: dict[int, list[int]],
+    unvisited_cities: dict[int, list[int]],
+    alpha: float,
+    beta: float,
+) -> tuple[dict[int, list[int]], dict[int, list[int]]]:
+    """
+    Choose the next city for ants
+    >>> city_select(pheromone=[[1.0, 1.0], [1.0, 1.0]], current_city={0: [0, 0]},
+    ...             unvisited_cities={1: [2, 2]}, alpha=1.0, beta=5.0)
+    ({1: [2, 2]}, {})
+    >>> city_select(pheromone=[], current_city={0: [0,0]},
+    ...             unvisited_cities={1: [2, 2]}, alpha=1.0, beta=5.0)
+    Traceback (most recent call last):
+      ...
+    IndexError: list index out of range
+    >>> city_select(pheromone=[[1.0, 1.0], [1.0, 1.0]], current_city={},
+    ...             unvisited_cities={1: [2, 2]}, alpha=1.0, beta=5.0)
+    Traceback (most recent call last):
+      ...
+    StopIteration
+    >>> city_select(pheromone=[[1.0, 1.0], [1.0, 1.0]], current_city={0: [0, 0]},
+    ...             unvisited_cities={}, alpha=1.0, beta=5.0)
+    Traceback (most recent call last):
+      ...
+    IndexError: list index out of range
+    """
+    probabilities = []
+    for city in unvisited_cities:
+        city_distance = distance(
+            unvisited_cities[city], next(iter(current_city.values()))
+        )
+        probability = (pheromone[city][next(iter(current_city.keys()))] ** alpha) * (
+            (1 / city_distance) ** beta
+        )
+        probabilities.append(probability)
+
+    chosen_city_i = random.choices(
+        list(unvisited_cities.keys()), weights=probabilities
+    )[0]
+    chosen_city = {chosen_city_i: unvisited_cities[chosen_city_i]}
+    del unvisited_cities[next(iter(chosen_city.keys()))]
+    return chosen_city, unvisited_cities
+
+
+if __name__ == "__main__":
+    best_path, best_distance = main(
+        cities=cities,
+        ants_num=10,
+        iterations_num=20,
+        pheromone_evaporation=0.7,
+        alpha=1.0,
+        beta=5.0,
+        q=10,
+    )
+
+    print(f"{best_path = }")
+    print(f"{best_distance = }")

From 3c2925d966a39f03522edeee8dde117666173688 Mon Sep 17 00:00:00 2001
From: moaldeen <132774635+moaldeen@users.noreply.github.com>
Date: Sat, 25 Nov 2023 08:31:17 -0500
Subject: [PATCH 14/21] Bug fix combinations (#11158)

* Update all_combinations.py

The original implementation had limitations in handling edge cases and certain input parameters, leading to potential RecursionError.

* Update all_combinations.py

Added checks to handle cases where n or k are negative or where k is greater than n. In such scenarios, the function now returns an empty list, avoiding invalid recursive calls.

* Update error handling

Added checks to handle cases where `n` or `k` are negative or where `k` is greater than `n`. In such scenarios, the function now returns an empty list, avoiding invalid recursive calls.

* Update backtracking/all_combinations.py

* Update all_combinations.py

---------

Co-authored-by: Christian Clauss <cclauss@me.com>
---
 backtracking/all_combinations.py | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/backtracking/all_combinations.py b/backtracking/all_combinations.py
index ecbcc5882ec1..407304948c39 100644
--- a/backtracking/all_combinations.py
+++ b/backtracking/all_combinations.py
@@ -26,9 +26,11 @@ def generate_all_combinations(n: int, k: int) -> list[list[int]]:
     >>> generate_all_combinations(n=10, k=-1)
     Traceback (most recent call last):
         ...
-    RecursionError: maximum recursion depth exceeded
+    ValueError: k must not be negative
     >>> generate_all_combinations(n=-1, k=10)
-    []
+    Traceback (most recent call last):
+        ...
+    ValueError: n must not be negative
     >>> generate_all_combinations(n=5, k=4)
     [[1, 2, 3, 4], [1, 2, 3, 5], [1, 2, 4, 5], [1, 3, 4, 5], [2, 3, 4, 5]]
     >>> from itertools import combinations
@@ -36,6 +38,10 @@ def generate_all_combinations(n: int, k: int) -> list[list[int]]:
     ...     for n in range(1, 6) for k in range(1, 6))
     True
     """
+    if k < 0:
+        raise ValueError("k must not be negative")
+    if n < 0:
+        raise ValueError("n must not be negative")
 
     result: list[list[int]] = []
     create_all_state(1, n, k, [], result)

From f474f4593665deedf8c1e1694856361f7dd64c53 Mon Sep 17 00:00:00 2001
From: "pre-commit-ci[bot]"
 <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Date: Sat, 25 Nov 2023 14:53:18 +0100
Subject: [PATCH 15/21] [pre-commit.ci] pre-commit autoupdate (#11154)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* [pre-commit.ci] pre-commit autoupdate

updates:
- [github.com/astral-sh/ruff-pre-commit: v0.1.4 → v0.1.6](https://github.com/astral-sh/ruff-pre-commit/compare/v0.1.4...v0.1.6)
- [github.com/psf/black: 23.10.1 → 23.11.0](https://github.com/psf/black/compare/23.10.1...23.11.0)
- [github.com/tox-dev/pyproject-fmt: 1.4.1 → 1.5.1](https://github.com/tox-dev/pyproject-fmt/compare/1.4.1...1.5.1)
- [github.com/pre-commit/mirrors-mypy: v1.6.1 → v1.7.0](https://github.com/pre-commit/mirrors-mypy/compare/v1.6.1...v1.7.0)

* updating DIRECTORY.md

* Update spiral_print.py

* Update matrix/spiral_print.py

* Update matrix/spiral_print.py

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
Co-authored-by: Christian Clauss <cclauss@me.com>
---
 .pre-commit-config.yaml | 8 ++++----
 DIRECTORY.md            | 1 -
 matrix/spiral_print.py  | 2 +-
 3 files changed, 5 insertions(+), 6 deletions(-)

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 1bb3de782275..9a0f78fdde5a 100644
--- 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.4
+    rev: v0.1.6
     hooks:
       - id: ruff
 
   - repo: https://github.com/psf/black
-    rev: 23.10.1
+    rev: 23.11.0
     hooks:
       - id: black
 
@@ -33,7 +33,7 @@ repos:
           - tomli
 
   - repo: https://github.com/tox-dev/pyproject-fmt
-    rev: "1.4.1"
+    rev: "1.5.1"
     hooks:
       - id: pyproject-fmt
 
@@ -51,7 +51,7 @@ repos:
       - id: validate-pyproject
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.6.1
+    rev: v1.7.0
     hooks:
       - id: mypy
         args:
diff --git a/DIRECTORY.md b/DIRECTORY.md
index cb4b00b045b5..438950325380 100644
--- a/DIRECTORY.md
+++ b/DIRECTORY.md
@@ -1310,7 +1310,6 @@
   * [Fetch Well Rx Price](web_programming/fetch_well_rx_price.py)
   * [Get Amazon Product Data](web_programming/get_amazon_product_data.py)
   * [Get Imdb Top 250 Movies Csv](web_programming/get_imdb_top_250_movies_csv.py)
-  * [Get Imdbtop](web_programming/get_imdbtop.py)
   * [Get Ip Geolocation](web_programming/get_ip_geolocation.py)
   * [Get Top Billionaires](web_programming/get_top_billionaires.py)
   * [Get Top Hn Posts](web_programming/get_top_hn_posts.py)
diff --git a/matrix/spiral_print.py b/matrix/spiral_print.py
index 5eef263f7aef..7ba0a275157b 100644
--- a/matrix/spiral_print.py
+++ b/matrix/spiral_print.py
@@ -116,7 +116,7 @@ def spiral_traversal(matrix: list[list]) -> list[int]:
     [1, 2, 3, 4, 8, 12, 11, 10, 9, 5, 6, 7] + spiral_traversal([])
     """
     if matrix:
-        return list(matrix.pop(0)) + spiral_traversal(list(zip(*matrix))[::-1])
+        return list(matrix.pop(0)) + spiral_traversal(list(zip(*matrix))[::-1])  # type: ignore
     else:
         return []
 

From 7922760ca02b1f8bdf5b4bc86442c0f7028bbf17 Mon Sep 17 00:00:00 2001
From: Harsh Kumar <61012869+cyrixninja@users.noreply.github.com>
Date: Sat, 25 Nov 2023 19:50:42 +0530
Subject: [PATCH 16/21] Create Spearman's rank correlation coefficient (#11155)

* Create spearman_rank_correlation_coefficient.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fixed Issues

* Added More Description

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fixed Issues

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Tried Fixing Issues

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Tried Fixing Issues

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fixed Issues

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fixed Issues

* Apply suggestions from code review

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update maths/spearman_rank_correlation_coefficient.py

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Christian Clauss <cclauss@me.com>
---
 .../spearman_rank_correlation_coefficient.py  | 82 +++++++++++++++++++
 1 file changed, 82 insertions(+)
 create mode 100644 maths/spearman_rank_correlation_coefficient.py

diff --git a/maths/spearman_rank_correlation_coefficient.py b/maths/spearman_rank_correlation_coefficient.py
new file mode 100644
index 000000000000..32ff6b9e3d71
--- /dev/null
+++ b/maths/spearman_rank_correlation_coefficient.py
@@ -0,0 +1,82 @@
+from collections.abc import Sequence
+
+
+def assign_ranks(data: Sequence[float]) -> list[int]:
+    """
+    Assigns ranks to elements in the array.
+
+    :param data: List of floats.
+    :return: List of ints representing the ranks.
+
+    Example:
+    >>> assign_ranks([3.2, 1.5, 4.0, 2.7, 5.1])
+    [3, 1, 4, 2, 5]
+
+    >>> assign_ranks([10.5, 8.1, 12.4, 9.3, 11.0])
+    [3, 1, 5, 2, 4]
+    """
+    ranked_data = sorted((value, index) for index, value in enumerate(data))
+    ranks = [0] * len(data)
+
+    for position, (_, index) in enumerate(ranked_data):
+        ranks[index] = position + 1
+
+    return ranks
+
+
+def calculate_spearman_rank_correlation(
+    variable_1: Sequence[float], variable_2: Sequence[float]
+) -> float:
+    """
+    Calculates Spearman's rank correlation coefficient.
+
+    :param variable_1: List of floats representing the first variable.
+    :param variable_2: List of floats representing the second variable.
+    :return: Spearman's rank correlation coefficient.
+
+    Example Usage:
+
+    >>> x = [1, 2, 3, 4, 5]
+    >>> y = [5, 4, 3, 2, 1]
+    >>> calculate_spearman_rank_correlation(x, y)
+    -1.0
+
+    >>> x = [1, 2, 3, 4, 5]
+    >>> y = [2, 4, 6, 8, 10]
+    >>> calculate_spearman_rank_correlation(x, y)
+    1.0
+
+    >>> x = [1, 2, 3, 4, 5]
+    >>> y = [5, 1, 2, 9, 5]
+    >>> calculate_spearman_rank_correlation(x, y)
+    0.6
+    """
+    n = len(variable_1)
+    rank_var1 = assign_ranks(variable_1)
+    rank_var2 = assign_ranks(variable_2)
+
+    # Calculate differences of ranks
+    d = [rx - ry for rx, ry in zip(rank_var1, rank_var2)]
+
+    # Calculate the sum of squared differences
+    d_squared = sum(di**2 for di in d)
+
+    # Calculate the Spearman's rank correlation coefficient
+    rho = 1 - (6 * d_squared) / (n * (n**2 - 1))
+
+    return rho
+
+
+if __name__ == "__main__":
+    import doctest
+
+    doctest.testmod()
+
+    # Example usage:
+    print(
+        f"{calculate_spearman_rank_correlation([1, 2, 3, 4, 5], [2, 4, 6, 8, 10]) = }"
+    )
+
+    print(f"{calculate_spearman_rank_correlation([1, 2, 3, 4, 5], [5, 4, 3, 2, 1]) = }")
+
+    print(f"{calculate_spearman_rank_correlation([1, 2, 3, 4, 5], [5, 1, 2, 9, 5]) = }")

From 414f8549e3a49a931d7180018cb521b42020782e Mon Sep 17 00:00:00 2001
From: Suyash Dongre <109069262+Suyashd999@users.noreply.github.com>
Date: Sat, 25 Nov 2023 19:59:44 +0530
Subject: [PATCH 17/21] Added doctest to binary_search_tree.py (#11145)

* Added doctest to binary_search_tree.py

* Apply suggestions from code review

---------

Co-authored-by: Christian Clauss <cclauss@me.com>
---
 .../binary_tree/binary_search_tree.py         | 42 +++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/data_structures/binary_tree/binary_search_tree.py b/data_structures/binary_tree/binary_search_tree.py
index f08f278a8e47..9071f03dcc8c 100644
--- a/data_structures/binary_tree/binary_search_tree.py
+++ b/data_structures/binary_tree/binary_search_tree.py
@@ -198,6 +198,30 @@ def insert(self, *values) -> Self:
         return self
 
     def search(self, value) -> Node | None:
+        """
+        >>> tree = BinarySearchTree().insert(10, 20, 30, 40, 50)
+        >>> tree.search(10)
+        {'10': (None, {'20': (None, {'30': (None, {'40': (None, 50)})})})}
+        >>> tree.search(20)
+        {'20': (None, {'30': (None, {'40': (None, 50)})})}
+        >>> tree.search(30)
+        {'30': (None, {'40': (None, 50)})}
+        >>> tree.search(40)
+        {'40': (None, 50)}
+        >>> tree.search(50)
+        50
+        >>> tree.search(5) is None  # element not present
+        True
+        >>> tree.search(0) is None  # element not present
+        True
+        >>> tree.search(-5) is None  # element not present
+        True
+        >>> BinarySearchTree().search(10)
+        Traceback (most recent call last):
+            ...
+        IndexError: Warning: Tree is empty! please use another.
+        """
+
         if self.empty():
             raise IndexError("Warning: Tree is empty! please use another.")
         else:
@@ -210,6 +234,15 @@ def search(self, value) -> Node | None:
     def get_max(self, node: Node | None = None) -> Node | None:
         """
         We go deep on the right branch
+
+        >>> BinarySearchTree().insert(10, 20, 30, 40, 50).get_max()
+        50
+        >>> BinarySearchTree().insert(-5, -1, 0.1, -0.3, -4.5).get_max()
+        {'0.1': (-0.3, None)}
+        >>> BinarySearchTree().insert(1, 78.3, 30, 74.0, 1).get_max()
+        {'78.3': ({'30': (1, 74.0)}, None)}
+        >>> BinarySearchTree().insert(1, 783, 30, 740, 1).get_max()
+        {'783': ({'30': (1, 740)}, None)}
         """
         if node is None:
             if self.root is None:
@@ -224,6 +257,15 @@ def get_max(self, node: Node | None = None) -> Node | None:
     def get_min(self, node: Node | None = None) -> Node | None:
         """
         We go deep on the left branch
+
+        >>> BinarySearchTree().insert(10, 20, 30, 40, 50).get_min()
+        {'10': (None, {'20': (None, {'30': (None, {'40': (None, 50)})})})}
+        >>> BinarySearchTree().insert(-5, -1, 0, -0.3, -4.5).get_min()
+        {'-5': (None, {'-1': (-4.5, {'0': (-0.3, None)})})}
+        >>> BinarySearchTree().insert(1, 78.3, 30, 74.0, 1).get_min()
+        {'1': (None, {'78.3': ({'30': (1, 74.0)}, None)})}
+        >>> BinarySearchTree().insert(1, 783, 30, 740, 1).get_min()
+        {'1': (None, {'783': ({'30': (1, 740)}, None)})}
         """
         if node is None:
             node = self.root

From c36b5a7e8fa228728251bad3fa3859f90a952176 Mon Sep 17 00:00:00 2001
From: Pedram_Mohajer <48964282+pedram-mohajer@users.noreply.github.com>
Date: Sun, 26 Nov 2023 17:46:54 -0500
Subject: [PATCH 18/21] Update levenshtein_distance.py (#11171)

* Update levenshtein_distance.py

* Update levenshtein_distance.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update levenshtein_distance.py

* Update levenshtein_distance.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update levenshtein_distance.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update levenshtein_distance.py

* Update levenshtein_distance.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Christian Clauss <cclauss@me.com>
---
 strings/levenshtein_distance.py | 93 ++++++++++++++++++++++++++-------
 1 file changed, 74 insertions(+), 19 deletions(-)

diff --git a/strings/levenshtein_distance.py b/strings/levenshtein_distance.py
index 7be4074dc39b..3af6608723a5 100644
--- a/strings/levenshtein_distance.py
+++ b/strings/levenshtein_distance.py
@@ -1,20 +1,9 @@
-"""
-This is a Python implementation of the levenshtein distance.
-Levenshtein distance is a string metric for measuring the
-difference between two sequences.
-
-For doctests run following command:
-python -m doctest -v levenshtein-distance.py
-or
-python3 -m doctest -v levenshtein-distance.py
-
-For manual testing run:
-python levenshtein-distance.py
-"""
+from collections.abc import Callable
 
 
 def levenshtein_distance(first_word: str, second_word: str) -> int:
-    """Implementation of the levenshtein distance in Python.
+    """
+    Implementation of the Levenshtein distance in Python.
     :param first_word: the first word to measure the difference.
     :param second_word: the second word to measure the difference.
     :return: the levenshtein distance between the two words.
@@ -47,7 +36,7 @@ def levenshtein_distance(first_word: str, second_word: str) -> int:
         current_row = [i + 1]
 
         for j, c2 in enumerate(second_word):
-            # Calculate insertions, deletions and substitutions
+            # Calculate insertions, deletions, and substitutions
             insertions = previous_row[j + 1] + 1
             deletions = current_row[j] + 1
             substitutions = previous_row[j] + (c1 != c2)
@@ -62,9 +51,75 @@ def levenshtein_distance(first_word: str, second_word: str) -> int:
     return previous_row[-1]
 
 
+def levenshtein_distance_optimized(first_word: str, second_word: str) -> int:
+    """
+    Compute the Levenshtein distance between two words (strings).
+    The function is optimized for efficiency by modifying rows in place.
+    :param first_word: the first word to measure the difference.
+    :param second_word: the second word to measure the difference.
+    :return: the Levenshtein distance between the two words.
+    Examples:
+    >>> levenshtein_distance_optimized("planet", "planetary")
+    3
+    >>> levenshtein_distance_optimized("", "test")
+    4
+    >>> levenshtein_distance_optimized("book", "back")
+    2
+    >>> levenshtein_distance_optimized("book", "book")
+    0
+    >>> levenshtein_distance_optimized("test", "")
+    4
+    >>> levenshtein_distance_optimized("", "")
+    0
+    >>> levenshtein_distance_optimized("orchestration", "container")
+    10
+    """
+    if len(first_word) < len(second_word):
+        return levenshtein_distance_optimized(second_word, first_word)
+
+    if len(second_word) == 0:
+        return len(first_word)
+
+    previous_row = list(range(len(second_word) + 1))
+
+    for i, c1 in enumerate(first_word):
+        current_row = [i + 1] + [0] * len(second_word)
+
+        for j, c2 in enumerate(second_word):
+            insertions = previous_row[j + 1] + 1
+            deletions = current_row[j] + 1
+            substitutions = previous_row[j] + (c1 != c2)
+            current_row[j + 1] = min(insertions, deletions, substitutions)
+
+        previous_row = current_row
+
+    return previous_row[-1]
+
+
+def benchmark_levenshtein_distance(func: Callable) -> None:
+    """
+    Benchmark the Levenshtein distance function.
+    :param str: The name of the function being benchmarked.
+    :param func: The function to be benchmarked.
+    """
+    from timeit import timeit
+
+    stmt = f"{func.__name__}('sitting', 'kitten')"
+    setup = f"from __main__ import {func.__name__}"
+    number = 25_000
+    result = timeit(stmt=stmt, setup=setup, number=number)
+    print(f"{func.__name__:<30} finished {number:,} runs in {result:.5f} seconds")
+
+
 if __name__ == "__main__":
-    first_word = input("Enter the first word:\n").strip()
-    second_word = input("Enter the second word:\n").strip()
+    # Get user input for words
+    first_word = input("Enter the first word for Levenshtein distance:\n").strip()
+    second_word = input("Enter the second word for Levenshtein distance:\n").strip()
+
+    # Calculate and print Levenshtein distances
+    print(f"{levenshtein_distance(first_word, second_word) = }")
+    print(f"{levenshtein_distance_optimized(first_word, second_word) = }")
 
-    result = levenshtein_distance(first_word, second_word)
-    print(f"Levenshtein distance between {first_word} and {second_word} is {result}")
+    # Benchmark the Levenshtein distance functions
+    benchmark_levenshtein_distance(levenshtein_distance)
+    benchmark_levenshtein_distance(levenshtein_distance_optimized)

From 9b8e185c0f7b651808ff934a631238f5b40c4131 Mon Sep 17 00:00:00 2001
From: Pedram_Mohajer <48964282+pedram-mohajer@users.noreply.github.com>
Date: Mon, 27 Nov 2023 12:43:51 -0500
Subject: [PATCH 19/21] Add doctest to is_safe function (#11183)

---
 backtracking/n_queens.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/backtracking/n_queens.py b/backtracking/n_queens.py
index 0f237d95e7c8..2cd8c703fc72 100644
--- a/backtracking/n_queens.py
+++ b/backtracking/n_queens.py
@@ -24,6 +24,10 @@ def is_safe(board: list[list[int]], row: int, column: int) -> bool:
     Returns:
     Boolean Value
 
+    >>> is_safe([[0, 0, 0], [0, 0, 0], [0, 0, 0]], 1, 1)
+    True
+    >>> is_safe([[1, 0, 0], [0, 0, 0], [0, 0, 0]], 1, 1)
+    False
     """
 
     n = len(board)  # Size of the board

From 262c01fc31a05c145a2d1fcc1591c5b3a104fd56 Mon Sep 17 00:00:00 2001
From: "pre-commit-ci[bot]"
 <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Date: Mon, 27 Nov 2023 19:13:24 +0100
Subject: [PATCH 20/21] [pre-commit.ci] pre-commit autoupdate (#11184)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* [pre-commit.ci] pre-commit autoupdate

updates:
- [github.com/pre-commit/mirrors-mypy: v1.7.0 → v1.7.1](https://github.com/pre-commit/mirrors-mypy/compare/v1.7.0...v1.7.1)

* updating DIRECTORY.md

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
---
 .pre-commit-config.yaml | 2 +-
 DIRECTORY.md            | 5 +++++
 2 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 9a0f78fdde5a..28f83a638d7b 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -51,7 +51,7 @@ repos:
       - id: validate-pyproject
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.7.0
+    rev: v1.7.1
     hooks:
       - id: mypy
         args:
diff --git a/DIRECTORY.md b/DIRECTORY.md
index 438950325380..ea0ba22bcc13 100644
--- a/DIRECTORY.md
+++ b/DIRECTORY.md
@@ -428,12 +428,16 @@
   * [Haversine Distance](geodesy/haversine_distance.py)
   * [Lamberts Ellipsoidal Distance](geodesy/lamberts_ellipsoidal_distance.py)
 
+## Geometry
+  * [Geometry](geometry/geometry.py)
+
 ## Graphics
   * [Bezier Curve](graphics/bezier_curve.py)
   * [Vector3 For 2D Rendering](graphics/vector3_for_2d_rendering.py)
 
 ## Graphs
   * [A Star](graphs/a_star.py)
+  * [Ant Colony Optimization Algorithms](graphs/ant_colony_optimization_algorithms.py)
   * [Articulation Points](graphs/articulation_points.py)
   * [Basic Graphs](graphs/basic_graphs.py)
   * [Bellman Ford](graphs/bellman_ford.py)
@@ -718,6 +722,7 @@
   * [Sock Merchant](maths/sock_merchant.py)
   * [Softmax](maths/softmax.py)
   * [Solovay Strassen Primality Test](maths/solovay_strassen_primality_test.py)
+  * [Spearman Rank Correlation Coefficient](maths/spearman_rank_correlation_coefficient.py)
   * Special Numbers
     * [Armstrong Numbers](maths/special_numbers/armstrong_numbers.py)
     * [Automorphic Number](maths/special_numbers/automorphic_number.py)

From 0a893318060f1cd65a58c567ec79aae7380613a2 Mon Sep 17 00:00:00 2001
From: Pedram_Mohajer <48964282+pedram-mohajer@users.noreply.github.com>
Date: Fri, 1 Dec 2023 11:53:47 -0500
Subject: [PATCH 21/21] Create smallestRange.py (#11179)

* Create smallestRange.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update smallestRange.py

* Update smallestRange.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update smallestRange.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update and rename smallestRange.py to smallestrange.py

* Update smallestrange.py

* Update smallestrange.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update smallestrange.py

* Rename smallestrange.py to smallest_range.py

* Update smallest_range.py

* Update smallest_range.py

* Update smallest_range.py

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Christian Clauss <cclauss@me.com>
---
 greedy_methods/smallest_range.py | 71 ++++++++++++++++++++++++++++++++
 1 file changed, 71 insertions(+)
 create mode 100644 greedy_methods/smallest_range.py

diff --git a/greedy_methods/smallest_range.py b/greedy_methods/smallest_range.py
new file mode 100644
index 000000000000..e2b7f8d7e96a
--- /dev/null
+++ b/greedy_methods/smallest_range.py
@@ -0,0 +1,71 @@
+"""
+smallest_range function takes a list of sorted integer lists and finds the smallest
+range that includes at least one number from each list, using a min heap for efficiency.
+"""
+
+from heapq import heappop, heappush
+from sys import maxsize
+
+
+def smallest_range(nums: list[list[int]]) -> list[int]:
+    """
+    Find the smallest range from each list in nums.
+
+    Uses min heap for efficiency. The range includes at least one number from each list.
+
+    Args:
+        nums: List of k sorted integer lists.
+
+    Returns:
+        list: Smallest range as a two-element list.
+
+    Examples:
+    >>> smallest_range([[4, 10, 15, 24, 26], [0, 9, 12, 20], [5, 18, 22, 30]])
+    [20, 24]
+    >>> smallest_range([[1, 2, 3], [1, 2, 3], [1, 2, 3]])
+    [1, 1]
+    >>> smallest_range(((1, 2, 3), (1, 2, 3), (1, 2, 3)))
+    [1, 1]
+    >>> smallest_range(((-3, -2, -1), (0, 0, 0), (1, 2, 3)))
+    [-1, 1]
+    >>> smallest_range([[1, 2, 3], [4, 5, 6], [7, 8, 9]])
+    [3, 7]
+    >>> smallest_range([[0, 0, 0], [0, 0, 0], [0, 0, 0]])
+    [0, 0]
+    >>> smallest_range([[], [], []])
+    Traceback (most recent call last):
+        ...
+    IndexError: list index out of range
+    """
+
+    min_heap: list[tuple[int, int, int]] = []
+    current_max = -maxsize - 1
+
+    for i, items in enumerate(nums):
+        heappush(min_heap, (items[0], i, 0))
+        current_max = max(current_max, items[0])
+
+    # Initialize smallest_range with large integer values
+    smallest_range = [-maxsize - 1, maxsize]
+
+    while min_heap:
+        current_min, list_index, element_index = heappop(min_heap)
+
+        if current_max - current_min < smallest_range[1] - smallest_range[0]:
+            smallest_range = [current_min, current_max]
+
+        if element_index == len(nums[list_index]) - 1:
+            break
+
+        next_element = nums[list_index][element_index + 1]
+        heappush(min_heap, (next_element, list_index, element_index + 1))
+        current_max = max(current_max, next_element)
+
+    return smallest_range
+
+
+if __name__ == "__main__":
+    from doctest import testmod
+
+    testmod()
+    print(f"{smallest_range([[1, 2, 3], [1, 2, 3], [1, 2, 3]])}")  # Output: [1, 1]