Merge branch 'master' into feature/algorithm/Valid-Number

Author: cclauss

maths/fermat_little_theorem.py

@@ -5,15 +5,25 @@
 # Wikipedia reference: https://en.wikipedia.org/wiki/Fermat%27s_little_theorem
 
 
-def binary_exponentiation(a: int, n: float, mod: int) -> int:
+def binary_exponentiation(a: int, n: int, mod: int) -> int:
+    """
+    Calculate (a ** n) % mod using binary exponentiation, which runs in O(log n) time.
+
+    >>> binary_exponentiation(2, 10, 17)
+    4
+    >>> binary_exponentiation(3, 0, 5)
+    1
+    >>> binary_exponentiation(5, 3, 13)
+    8
+    """
     if n == 0:
         return 1
 
     elif n % 2 == 1:
         return (binary_exponentiation(a, n - 1, mod) * a) % mod
 
     else:
-        b = binary_exponentiation(a, n / 2, mod)
+        b = binary_exponentiation(a, n // 2, mod)
         return (b * b) % mod
 
 

pyproject.toml

@@ -22,7 +22,6 @@ dependencies = [
   "numpy>=2.1.3",
   "pandas>=2.3.3",
   "pillow>=11.3",
-  "polars>=1.44.2",
   "rich>=13.9.4",
   "scikit-learn>=1.9.1",
   "scipy>=1.18.1",

sorts/reversort.py

@@ -17,10 +17,14 @@
 python reversort.py
 """
 
-from typing import Any
+from typing import Any, Protocol
 
 
-def reversort(collection: list[Any]) -> list[Any]:
+class Comparable(Protocol):
+    def __lt__(self, other: Any, /) -> bool: ...
+
+
+def reversort[T: Comparable](collection: list[T]) -> list[T]:
     """
     Sort a list using the Reversort algorithm.
 
@@ -78,6 +82,10 @@ def reversort(collection: list[Any]) -> list[Any]:
     >>> collection_arg = random.choices(string.ascii_letters + string.digits, k=100)
     >>> reversort(collection_arg) == sorted(collection_arg)
     True
+    >>> reversort([1, "a"])  # doctest: +IGNORE_EXCEPTION_DETAIL
+    Traceback (most recent call last):
+        ...
+    TypeError: '<' not supported between instances of 'str' and 'int'
     """
     arr = collection[:]  # Create a copy to avoid modifying the original
     n = len(arr)
@@ -96,7 +104,7 @@ def reversort(collection: list[Any]) -> list[Any]:
     return arr
 
 
-def reversort_cost(collection: list[Any]) -> int:
+def reversort_cost[T: Comparable](collection: list[T]) -> int:
     """
     Calculate the cost of sorting using Reversort.
 
@@ -119,6 +127,10 @@ def reversort_cost(collection: list[Any]) -> int:
     0
     >>> reversort_cost([])
     0
+    >>> reversort_cost([1, "a"])  # doctest: +IGNORE_EXCEPTION_DETAIL
+    Traceback (most recent call last):
+        ...
+    TypeError: '<' not supported between instances of 'str' and 'int'
     """
     arr = collection[:]  # Create a copy to avoid modifying the original
     n = len(arr)

tests/test_sorts.py

@@ -41,6 +41,7 @@
 from sorts.patience_sort import patience_sort
 from sorts.quick_sort import quick_sort
 from sorts.recursive_insertion_sort import rec_insertion_sort
+from sorts.reversort import reversort
 from sorts.selection_sort import selection_sort
 from sorts.shell_sort import shell_sort
 from sorts.shrink_shell_sort import shell_sort as shrink_shell_sort
@@ -74,6 +75,7 @@ def test_heap_sort() -> None:
     pancake_sort,
     patience_sort,
     quick_sort,
+    reversort,
     selection_sort,
     shell_sort,
     shrink_shell_sort,
@@ -141,6 +143,7 @@ def test_rec_insertion_sort(case) -> None:
         merge_sort,
         odd_even_sort,
         pancake_sort,
+        reversort,
         selection_sort,
         shrink_shell_sort,
         strand_sort,

uv.lock

@@ -1,6 +1,6 @@
 """
-Get the citation from google scholar
-using title and year of publication, and volume and pages of journal.
+Get the citation from Google Scholar using the title and year of publication, and the
+journal volume and pages.
 """
 
 # /// script
@@ -17,17 +17,29 @@
 
 def get_citation(base_url: str, params: dict) -> str:
     """
-    Return the citation number.
+    Returns the citation number for a publication based on its title, journal, volume,
+    pages, and year of publication.
+
+    Parameters:
+    - base_url: The base URL for making requests to Google Scholar.
+    - params: A dictionary containing the publication information.
+
+    Returns:
+    - A string containing the number of citations.
     """
+    # Send a GET request to the URL with the specified parameters
     soup = BeautifulSoup(
         httpx2.get(base_url, params=params, timeout=10).content, "html.parser"
     )
+    # Find the div element with class 'gs_ri' that contains citation information
     div = soup.find("div", attrs={"class": "gs_ri"})
+    # Find all links in the div and retrieve the third link (the citation count)
     anchors = div.find("div", attrs={"class": "gs_fl"}).find_all("a")
-    return anchors[2].get_text()
+    return anchors[2].get_text()  # Return the text from the third link
 
 
 if __name__ == "__main__":
+    # Define parameters for the publication whose citation is to be searched
     params = {
         "title": (
             "Precisely geometry controlled microsupercapacitors for ultrahigh areal "
@@ -37,6 +49,7 @@ def get_citation(base_url: str, params: dict) -> str:
         "volume": 30,
         "pages": "3979-3990",
         "year": 2018,
-        "hl": "en",
+        "hl": "en",  # Language to be used (English)
     }
+    # Call the get_citation function with the specified URL and parameters
     print(get_citation("https://scholar.google.com/scholar_lookup", params=params))