Merge pull request #2 from ZoftWhere/feature/release-2.1.0

Release 2.1.0

Author: zoftwhere-admin

.idea/codeStyles/Project.xml

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 ZoftWhere
+Copyright (c) 2019-2020 ZoftWhere
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

.idea/combinatoric.iml

@@ -0,0 +1,7 @@
+## Release Notes - Version 2.1.0
+
+* Updated Maven build for manual JDK 8.
+* Updated Maven Surefire plugin to work with Java module.
+* Updated source code Javadoc.
+* Updated class access modifiers.
+* Updated copyright and license year(s).

license.txt

@@ -13,20 +13,22 @@ abstract class AbstractPermutation<T> implements Permutation<T> {
 
     private final int kSize;
 
-    private final List<T> list;
-
     /**
-     * User PermutationBuilder to initialize a new permutation.
+     * Package-private constructor to initialize a new permutation.
      */
-    AbstractPermutation(int[] index, List<T> list, int kSize) {
+    AbstractPermutation(int[] index, int kSize) {
         this.index = index;
         this.size = index.length;
-        this.list = list;
         this.kSize = kSize;
     }
 
     /**
      * Returns an immutable instance with the values in the clone.
+     *
+     * @param index index array
+     * @param list  list of elements
+     * @param kSize count of permutation elements
+     * @return immutable permutation instance.
      */
     protected abstract Permutation<T> newInstance(int[] index, List<T> list, int kSize);
 

main-github/release-notes/2.1.0.md

@@ -52,7 +52,8 @@ public static Permutation<Void> newPermutation(int size) {
     /**
      * Creates an immutable void permutation.
      *
-     * @param size the number of elements to hold.
+     * @param size  the number of elements to hold
+     * @param kSize the number of elements for display
      * @return immutable void permutation
      */
     public static Permutation<Void> newPermutation(int size, int kSize) {
@@ -71,7 +72,9 @@ public static Permutation<Void> newPermutation(int size, int kSize) {
     /**
      * Creates an immutable linked permutation.
      *
-     * @param list the value elements
+     * @param <T>        the type
+     * @param list       the value elements
+     * @param comparator the comparator
      * @return immutable basic permutation if no duplicates are detected, an N-Tuple otherwise
      * @throws NullPointerException if any of the list items are null
      */
@@ -82,8 +85,10 @@ public static <T> Permutation<T> newPermutation(List<T> list, Comparator<T> comp
     /**
      * Creates an immutable k-permutation.
      *
-     * @param list  the value elements
-     * @param kSize kSize value
+     * @param <T>        the type
+     * @param list       the value elements
+     * @param comparator the comparator
+     * @param kSize      kSize value
      * @return immutable basic permutation if no duplicates are detected, an N-Tuple otherwise
      * @throws NullPointerException if any of the list items are null
      */
@@ -125,6 +130,7 @@ public static <T> Permutation<T> newPermutation(List<T> list, Comparator<T> comp
     /**
      * Creates an immutable linked permutation.
      *
+     * @param <T>  the type
      * @param list the value elements
      * @return immutable basic permutation if no duplicates are detected, an N-Tuple otherwise
      * @throws NullPointerException if any of the list items are null
@@ -136,6 +142,7 @@ public static <T> Permutation<T> newPermutation(List<T> list) {
     /**
      * Creates an immutable linked permutation.
      *
+     * @param <T>   the type
      * @param list  the value elements
      * @param kSize kSize value
      * @return immutable basic permutation if no duplicates are detected, an N-Tuple otherwise
@@ -180,6 +187,7 @@ public static <T> Permutation<T> newPermutation(List<T> list, int kSize) {
     /**
      * Creates an immutable linked permutation.
      *
+     * @param <T>             the type
      * @param list            the value elements
      * @param withRepetitions flag to specify if duplicates should be ignored
      * @return immutable linked permutation
@@ -192,6 +200,7 @@ public static <T> Permutation<T> newPermutation(List<T> list, boolean withRepeti
     /**
      * Creates an immutable linked permutation.
      *
+     * @param <T>             the type
      * @param list            the value elements
      * @param withRepetitions flag to specify if duplicates should be ignored
      * @param kSize           kSize value
@@ -234,6 +243,7 @@ private static <T> int getGroupInsertIndex(final List<T> list, T item) {
     /**
      * Creates an empty permutation.
      *
+     * @param <T> the type
      * @return an empty permutation
      */
     static <T> Permutation<T> empty() {

main-java/app/zoftwhere/combinatoric/AbstractPermutation.java

@@ -2,14 +2,39 @@
 
 import java.util.List;
 
+/**
+ * Permutation.
+ *
+ * @param <T> the type
+ */
 public interface Permutation<T> {
 
+    /**
+     * Check if the permutation has any elements.
+     *
+     * @return true if the permutation has elements, false otherwise
+     */
     boolean isPresent();
 
+    /**
+     * Check if the permutation is empty.
+     *
+     * @return true if the permutation is empty, false otherwise
+     */
     boolean isEmpty();
 
+    /**
+     * The element count in the selection set.
+     *
+     * @return element count in the selection set
+     */
     int size();
 
+    /**
+     * The element count in the permutation.
+     *
+     * @return element count in the permutation
+     */
     int kSize();
 
     /**
@@ -37,6 +62,7 @@ public interface Permutation<T> {
     /**
      * Progress to the next available permutation from the position provided.
      *
+     * @param position the element to change
      * @return the next permutation if possible, an empty permutation otherwise
      */
     Permutation<T> next(int position);

main-java/app/zoftwhere/combinatoric/Generator.java

@@ -15,8 +15,8 @@ class PermutationBasic<T> extends AbstractPermutation<T> {
 
     private final int kSize;
 
-    public PermutationBasic(int[] index, List<T> list, int kSize) {
-        super(index, list, kSize);
+    PermutationBasic(int[] index, List<T> list, int kSize) {
+        super(index, kSize);
         this.index = index;
         this.size = index.length;
         this.list = list;

main-java/app/zoftwhere/combinatoric/Permutation.java

@@ -6,7 +6,7 @@
 class PermutationEmpty<T> extends AbstractPermutation<T> {
 
     PermutationEmpty() {
-        super(new int[0], null, 0);
+        super(new int[0], 0);
     }
 
     @Override
@@ -75,7 +75,7 @@ public Permutation<T> next(int position) {
      */
     @Override
     public Permutation<T> progress(int position) {
-        return newInstance(null, null, 0);
+        return this;
     }
 
     @Override

main-java/app/zoftwhere/combinatoric/PermutationBasic.java

@@ -14,7 +14,7 @@ class PermutationNTuple<T> extends PermutationBasic<T> {
 
     private final int kSize;
 
-    public PermutationNTuple(int[] index, List<T> list, int kSize) {
+    PermutationNTuple(int[] index, List<T> list, int kSize) {
         super(index, list, kSize);
         this.index = index;
         this.size = index.length;