dsa.sorttools

 1""" Module to access functions for sort benchmarking. """
 2import random
 3
 4def rand_int_array(n: int, maxnum: int) -> list:
 5    """ 
 6    Return an array of n integers of random numbers from 0 to maxnum.
 7
 8    Args:
 9        n (int): The number of integers to generate.
10        maxnum (int): The maximum number in a range (0-maxnum inclusive).
11    Returns:
12        Array of n integers of random numbers from 0 to maxnum.
13    """
14    array = [None] * n
15    for i in range(n):
16        array[i] = random.randint(0, maxnum)
17    return array
18
19def filled_array(n: int) -> list:
20    """ 
21    Return an array filled with integers from 0 to n-1.
22
23    Args:
24        n (int): the number of integers to generate.
25
26    Returns:
27        Array filled with integers from 0 to n-1.
28    """
29    array = [None] * n
30    for i in range(n):
31        array[i] = i
32    return array    
33
34def shuffle_array(n: int) -> list:
35    """ 
36    Return a shuffled array filled with integers from 0 to n-1.
37
38    Args:
39        n (int): The number of integers to generate.
40    Returns:
41        Array shuffled with integers from 0 to n-1.
42    """
43    array = filled_array(n)
44    for i in range(n):
45        r = random.randint(i, n-1)
46        array[i], array[r] = array[r], array[i]
47    return array
48
49def is_sorted(array: list) -> bool:
50    """ 
51    Return a boolean on whether an array is sorted in ascending order or not.
52
53    Args:
54        array: the array to verify.
55    Returns:
56        True if the array is sorted, False otherwise.   
57    """
58    for i in range(len(array)-1):
59        if array[i + 1] < array[i]:
60            return False
61    return True
62
63def array_details(array: list) -> str:
64    """
65    Return a string with details about the array.
66    Args:
67        array: the array to analyze.
68    Returns:
69        A string with the count of elements, first 10 elements, and last 10 elements.
70    """
71    return f"Count: {len(array)} first 10: {array[:10]} last 10: {array[-10:]}"
72
73def generate_almost_sorted_array(size: int, swaps: int) -> list:
74    """
75    Generate an almost sorted array of a given size with a specified number of swaps.   
76    Args:
77        size (int): The size of the array to generate.
78        swaps (int): The number of adjacent elements to swap to create disorder.
79    Returns:
80        list: An array of integers that is mostly sorted with a few local swaps.
81    """
82
83    arr = list(range(size))
84    for _ in range(swaps):
85        i = random.randint(0, size - 2)
86        arr[i], arr[i + 1] = arr[i + 1], arr[i]  # introduce a small local disorder
87    return arr