refactor: Enhance docs, add more tests in ArrayCombination (#5841)

This commit is contained in:
Hardik Pawar
2024-10-15 14:29:16 +05:30
committed by GitHub
parent adf21ab0c8
commit 32bf532133
2 changed files with 26 additions and 10 deletions

View File

@ -4,22 +4,24 @@ import java.util.ArrayList;
import java.util.List; import java.util.List;
/** /**
* Finds all combinations of 0...n-1 of length k * This class provides methods to find all combinations of integers from 0 to n-1
* of a specified length k using backtracking.
*/ */
public final class ArrayCombination { public final class ArrayCombination {
private ArrayCombination() { private ArrayCombination() {
} }
/** /**
* Finds all combinations of length k of 0..n-1 using backtracking. * Generates all possible combinations of length k from the integers 0 to n-1.
* *
* @param n Number of the elements. * @param n The total number of elements (0 to n-1).
* @param k Length of the combination. * @param k The desired length of each combination.
* @return A list of all combinations of length k. * @return A list containing all combinations of length k.
* @throws IllegalArgumentException if n or k are negative, or if k is greater than n.
*/ */
public static List<List<Integer>> combination(int n, int k) { public static List<List<Integer>> combination(int n, int k) {
if (n < 0 || k < 0 || k > n) { if (n < 0 || k < 0 || k > n) {
throw new IllegalArgumentException("Wrong input."); throw new IllegalArgumentException("Invalid input: n must be non-negative, k must be non-negative and less than or equal to n.");
} }
List<List<Integer>> combinations = new ArrayList<>(); List<List<Integer>> combinations = new ArrayList<>();
@ -27,9 +29,19 @@ public final class ArrayCombination {
return combinations; return combinations;
} }
/**
* A helper method that uses backtracking to find combinations.
*
* @param combinations The list to store all valid combinations found.
* @param current The current combination being built.
* @param start The starting index for the current recursion.
* @param n The total number of elements (0 to n-1).
* @param k The desired length of each combination.
*/
private static void combine(List<List<Integer>> combinations, List<Integer> current, int start, int n, int k) { private static void combine(List<List<Integer>> combinations, List<Integer> current, int start, int n, int k) {
if (current.size() == k) { // Base case: combination found // Base case: combination found
combinations.add(new ArrayList<>(current)); // Copy to avoid modification if (current.size() == k) {
combinations.add(new ArrayList<>(current));
return; return;
} }

View File

@ -27,10 +27,14 @@ public class ArrayCombinationTest {
private static Stream<Arguments> regularInputs() { private static Stream<Arguments> regularInputs() {
return Stream.of(Arguments.of(0, 0, List.of(new ArrayList<Integer>())), Arguments.of(1, 0, List.of(new ArrayList<Integer>())), Arguments.of(1, 1, List.of(List.of(0))), Arguments.of(3, 0, List.of(new ArrayList<Integer>())), Arguments.of(3, 1, List.of(List.of(0), List.of(1), List.of(2))), return Stream.of(Arguments.of(0, 0, List.of(new ArrayList<Integer>())), Arguments.of(1, 0, List.of(new ArrayList<Integer>())), Arguments.of(1, 1, List.of(List.of(0))), Arguments.of(3, 0, List.of(new ArrayList<Integer>())), Arguments.of(3, 1, List.of(List.of(0), List.of(1), List.of(2))),
Arguments.of(4, 2, List.of(List.of(0, 1), List.of(0, 2), List.of(0, 3), List.of(1, 2), List.of(1, 3), List.of(2, 3)))); Arguments.of(4, 2, List.of(List.of(0, 1), List.of(0, 2), List.of(0, 3), List.of(1, 2), List.of(1, 3), List.of(2, 3))),
Arguments.of(5, 3, List.of(List.of(0, 1, 2), List.of(0, 1, 3), List.of(0, 1, 4), List.of(0, 2, 3), List.of(0, 2, 4), List.of(0, 3, 4), List.of(1, 2, 3), List.of(1, 2, 4), List.of(1, 3, 4), List.of(2, 3, 4))),
Arguments.of(6, 4,
List.of(List.of(0, 1, 2, 3), List.of(0, 1, 2, 4), List.of(0, 1, 2, 5), List.of(0, 1, 3, 4), List.of(0, 1, 3, 5), List.of(0, 1, 4, 5), List.of(0, 2, 3, 4), List.of(0, 2, 3, 5), List.of(0, 2, 4, 5), List.of(0, 3, 4, 5), List.of(1, 2, 3, 4), List.of(1, 2, 3, 5), List.of(1, 2, 4, 5),
List.of(1, 3, 4, 5), List.of(2, 3, 4, 5))));
} }
private static Stream<Arguments> wrongInputs() { private static Stream<Arguments> wrongInputs() {
return Stream.of(Arguments.of(-1, 0), Arguments.of(0, -1), Arguments.of(2, 100)); return Stream.of(Arguments.of(-1, 0), Arguments.of(0, -1), Arguments.of(2, 100), Arguments.of(3, 4));
} }
} }