Skip to content

Commit 13d6bdb

Browse files
committed
Add comments to the CombinationGenerator.
1 parent a9379ee commit 13d6bdb

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/main/java/org/paukov/combinatorics3/CombinationGenerator.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,16 @@ public class CombinationGenerator<T> {
1919
this.originalVector = originalVector;
2020
}
2121

22+
/**
23+
* Creates a generator to produce combinations of the given length of elements.
24+
*/
2225
public IGenerator<List<T>> simple(int length) {
2326
return new SimpleCombinationGenerator<>(originalVector, length);
2427
}
2528

29+
/**
30+
* Creates a generator to produce combinations with repetitions of the given length of elements.
31+
*/
2632
public IGenerator<List<T>> multi(int length) {
2733
return new MultiCombinationGenerator<>(originalVector, length);
2834
}

0 commit comments

Comments
 (0)