algokit-py 0.3.0__tar.gz → 0.4.0__tar.gz

{algokit_py-0.3.0 → algokit_py-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: algokit-py
-Version: 0.3.0
+Version: 0.4.0
 Summary: A minimal Python algorithms library with clean implementations of search algorithms and sort algorithms
 Author: Chanaka Prasanna
 License: MIT

{algokit_py-0.3.0 → algokit_py-0.4.0}/algokit_py/__init__.py

@@ -3,6 +3,6 @@ algokit_py - A minimal Python algorithms library
 """
 
 from algokit_py.search import binary_search, linear_search
-from algokit_py.sort import insertion_sort, merge_sort
+from algokit_py.sort import insertion_sort, merge_sort,quick_sort
 
-__all__ = ["binary_search", "linear_search","insertion_sort","merge_sort"]
+__all__ = ["binary_search", "linear_search","insertion_sort","merge_sort","quick_sort"]

algokit_py-0.4.0/algokit_py/sort/__init__.py

@@ -0,0 +1,5 @@
+from .insertion import insertion_sort
+from .merge import merge_sort
+from .quick import quick_sort
+
+__all__ = ["insertion_sort", "merge_sort","quick_sort"]

algokit_py-0.4.0/algokit_py/sort/quick.py

@@ -0,0 +1,88 @@
+from typing import TypeVar, MutableSequence
+
+T =  TypeVar("T")
+
+# We use mutable sequence because we need to modify the list in place
+def quick_sort(sequence: MutableSequence[T]):
+    """
+    In-place Quick Sort implementation using divide-and-conquer.
+
+    This function sorts the given sequence in place.
+
+    Average Time Complexity: O(n log n)
+    Worst Case Time Complexity: O(n^2)
+    Space Complexity: O(log n) due to recursion
+    """
+
+    if len(sequence) <= 1:
+        return
+
+    _quick_sort(sequence, 0, len(sequence) - 1)
+
+
+def _partition(sequence,low,high)-> int:
+    """
+    Partition the sequence using the Lomuto partition scheme.
+
+    This function selects the last element as the pivot and rearranges
+    the sequence in place so that:
+    - all elements less than or equal to the pivot are placed to its left
+    - all elements greater than the pivot are placed to its right
+
+    The pivot is moved to its final correct position, and its index
+    is returned.
+
+    :param sequence: Mutable sequence to be partitioned
+    :param low: Starting index of the subarray
+    :param high: Ending index of the subarray (pivot index)
+    :return: Final index position of the pivot
+    """
+
+    pivot = sequence[high]
+
+    # at the start, no elements <= pivot.
+    i = low - 1
+
+    #  we need to arrange the sub array into these segments: [≤ pivot  |  > pivot  | pivot]
+    for j in range(low,high): # up to high - 1
+        if sequence[j] <= pivot:
+            i += 1
+            sequence[i],sequence[j] = sequence[j],sequence[i]
+
+    # place pivot in its final position
+    sequence[i+1],sequence[high] = sequence[high], sequence[i+1]
+
+    return i + 1
+
+
+def _quick_sort(sequence,low,high):
+    """
+    Recursively sort a subarray of the sequence in place using Quick Sort.
+
+    This helper function sorts the elements in the index range
+    sequence[low : high + 1] using the divide-and-conquer approach.
+    It assumes that the partitioning logic correctly places the pivot
+    in its final position and recursively sorts the left and right
+    subarrays around the pivot.
+
+    Base case:
+    - If low >= high, the subarray has zero or one element and is already sorted.
+
+    :param sequence: Mutable sequence to be sorted in place
+    :param low: Starting index of the subarray
+    :param high: Ending index of the subarray
+    :return: None
+    """
+
+    # If the subarray has 0 or 1 element
+    # That means it is already sorted
+    # This happens when:low >= high
+
+    if low >= high:
+        return # No return: because we do this in place
+
+    p = _partition(sequence,low,high)
+
+    _quick_sort(sequence,low,p-1)
+    _quick_sort(sequence,p+1,high)
+

{algokit_py-0.3.0 → algokit_py-0.4.0}/algokit_py.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: algokit-py
-Version: 0.3.0
+Version: 0.4.0
 Summary: A minimal Python algorithms library with clean implementations of search algorithms and sort algorithms
 Author: Chanaka Prasanna
 License: MIT

{algokit_py-0.3.0 → algokit_py-0.4.0}/algokit_py.egg-info/SOURCES.txt

@@ -11,7 +11,9 @@ algokit_py/search/linear.py
 algokit_py/sort/__init__.py
 algokit_py/sort/insertion.py
 algokit_py/sort/merge.py
+algokit_py/sort/quick.py
 tests/test_binary.py
 tests/test_insertion.py
 tests/test_linear.py
-tests/test_merge.py
+tests/test_merge.py
+tests/test_quick.py

{algokit_py-0.3.0 → algokit_py-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "algokit-py"
-version = "0.3.0"
+version = "0.4.0"
 description = "A minimal Python algorithms library with clean implementations of search algorithms and sort algorithms"
 readme = "README.md"
 requires-python = ">=3.9"

algokit_py-0.4.0/tests/test_quick.py

@@ -0,0 +1,37 @@
+from algokit_py.sort import quick_sort
+
+
+def test_quick_sort_basic():
+    data = [3, 1, 2]
+    quick_sort(data)
+    assert data == [1, 2, 3]
+
+
+def test_quick_sort_already_sorted():
+    data = [1, 2, 3, 4]
+    quick_sort(data)
+    assert data == [1, 2, 3, 4]
+
+
+def test_quick_sort_reverse():
+    data = [4, 3, 2, 1]
+    quick_sort(data)
+    assert data == [1, 2, 3, 4]
+
+
+def test_quick_sort_duplicates():
+    data = [3, 1, 2, 1]
+    quick_sort(data)
+    assert data == [1, 1, 2, 3]
+
+
+def test_quick_sort_single_element():
+    data = [5]
+    quick_sort(data)
+    assert data == [5]
+
+
+def test_quick_sort_empty():
+    data = []
+    quick_sort(data)
+    assert data == []

algokit_py-0.3.0/algokit_py/sort/__init__.py

@@ -1,4 +0,0 @@
-from .insertion import insertion_sort
-from .merge import merge_sort
-
-__all__ = ["insertion_sort", "merge_sort"]