diff --git a/backtracking/all_permutations.py b/backtracking/all_permutations.py index f376e6fa0945..8a9f532abb83 100644 --- a/backtracking/all_permutations.py +++ b/backtracking/all_permutations.py @@ -1,88 +1,86 @@ """ -In this problem, we want to determine all possible permutations -of the given sequence. We use backtracking to solve this problem. +Backtracking: generate all permutations of a sequence. -Time complexity: O(n! * n), -where n denotes the length of the given sequence. +Time complexity: O(n! * n), where n is length of sequence. """ from __future__ import annotations +Element = int | str -def generate_all_permutations(sequence: list[int | str]) -> None: - create_state_space_tree(sequence, [], 0, [0 for i in range(len(sequence))]) + +def generate_all_permutations(sequence: list[Element]) -> list[list[Element]]: + """ + Generate and return all permutations of the given sequence. + + :param sequence: The input sequence. + :return: A list of permutations (each permutation is a list). + + Example 1 (integers): + >>> generate_all_permutations([1, 2, 3]) # doctest: +NORMALIZE_WHITESPACE + [[1, 2, 3], + [1, 3, 2], + [2, 1, 3], + [2, 3, 1], + [3, 1, 2], + [3, 2, 1]] + + Example 2 (strings): + >>> generate_all_permutations(["A", "B", "C"]) # doctest: +NORMALIZE_WHITESPACE + [['A', 'B', 'C'], + ['A', 'C', 'B'], + ['B', 'A', 'C'], + ['B', 'C', 'A'], + ['C', 'A', 'B'], + ['C', 'B', 'A']] + + Example 3 (single element): + >>> generate_all_permutations([1]) + [[1]] + + Example 4 (empty sequence): + >>> generate_all_permutations([]) + [[]] + """ + result: list[list[Element]] = [] + index_used = [False] * len(sequence) + create_state_space_tree(sequence, [], 0, index_used, result) + return result def create_state_space_tree( - sequence: list[int | str], - current_sequence: list[int | str], + sequence: list[Element], + current_sequence: list[Element], index: int, - index_used: list[int], + index_used: list[bool], + result: list[list[Element]], ) -> None: """ - Creates a state space tree to iterate through each branch using DFS. - We know that each state has exactly len(sequence) - index children. - It terminates when it reaches the end of the given sequence. - - :param sequence: The input sequence for which permutations are generated. - :param current_sequence: The current permutation being built. - :param index: The current index in the sequence. - :param index_used: list to track which elements are used in permutation. - - Example 1: - >>> sequence = [1, 2, 3] - >>> current_sequence = [] - >>> index_used = [False, False, False] - >>> create_state_space_tree(sequence, current_sequence, 0, index_used) - [1, 2, 3] - [1, 3, 2] - [2, 1, 3] - [2, 3, 1] - [3, 1, 2] - [3, 2, 1] - - Example 2: - >>> sequence = ["A", "B", "C"] - >>> current_sequence = [] - >>> index_used = [False, False, False] - >>> create_state_space_tree(sequence, current_sequence, 0, index_used) - ['A', 'B', 'C'] - ['A', 'C', 'B'] - ['B', 'A', 'C'] - ['B', 'C', 'A'] - ['C', 'A', 'B'] - ['C', 'B', 'A'] - - Example 3: - >>> sequence = [1] - >>> current_sequence = [] - >>> index_used = [False] - >>> create_state_space_tree(sequence, current_sequence, 0, index_used) - [1] - """ + Backtracking helper that appends permutations into result. + Example: + >>> res = [] + >>> create_state_space_tree([1, 2], [], 0, [False, False], res) + >>> res + [[1, 2], [2, 1]] + """ if index == len(sequence): - print(current_sequence) + # append a shallow copy + result.append(current_sequence[:]) return for i in range(len(sequence)): if not index_used[i]: current_sequence.append(sequence[i]) index_used[i] = True - create_state_space_tree(sequence, current_sequence, index + 1, index_used) + create_state_space_tree( + sequence, current_sequence, index + 1, index_used, result + ) current_sequence.pop() index_used[i] = False -""" -remove the comment to take an input from the user - -print("Enter the elements") -sequence = list(map(int, input().split())) -""" - -sequence: list[int | str] = [3, 1, 2, 4] -generate_all_permutations(sequence) - -sequence_2: list[int | str] = ["A", "B", "C"] -generate_all_permutations(sequence_2) +if __name__ == "__main__": + # example usage; kept under __main__ so it doesn't run on import/tests + print(generate_all_permutations([3, 1, 2, 4])) + print(generate_all_permutations(["A", "B", "C"]))