Merge pull request #39 from cicirello/prep-for-maven-release

Updated documentation, etc in preparation for releasing package to Maven Central

.github/dependabot.yml

@@ -9,7 +9,3 @@ updates:
     directory: "/" # Location of package manifests
     schedule:
       interval: "daily"
-  - package-ecosystem: "maven" # See documentation for possible values
-    directory: "/" # Location of package manifests
-    schedule:
-      interval: "daily"

CITATION.cff

@@ -19,4 +19,4 @@ preferred-citation:
   issue: 11
   volume: 12
   year: 2022
-  month: "May"
+  month: "June"

README.md

@@ -5,12 +5,21 @@ Copyright © 2022 Vincent A. Cicirello
 This repository contains code to reproduce the experiments, and analysis of 
 experimental data, from the following paper:
 
-> Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction. *Applied Sciences*, 12, 11, Article 5506 (May 2022). https://doi.org/10.3390/app12115506
+> Vincent A. Cicirello. 2022. [Cycle Mutation: Evolving Permutations via Cycle Induction](https://www.cicirello.org/publications/applsci-12-05506.pdf), *Applied Sciences*, 12(11), Article 5506 (June 2022). doi:[10.3390/app12115506](https://doi.org/10.3390/app12115506)
 
-|  |  |
+| __Related Publication__ | [![DOI](doi.svg)](https://doi.org/10.3390/app12115506) |
 | :--- | :--- |
 | __License__ | [![GitHub](https://img.shields.io/github/license/cicirello/cycle-mutation-experiments)](LICENSE) |
 
+## Dependencies
+
+The experiments depend upon the following libraries, and in some cases this research has 
+also contributed to these libraries:
+* [Chips-n-Salsa](https://chips-n-salsa.cicirello.org/)
+* [JavaPermutationTools](https://jpt.cicirello.org)
+* [ρμ](https://rho-mu.cicirello.org)
+* [org.cicirello.core](https://core.cicirello.org)
+
 ## Requirements to Build and Run the Experiments
 
 To build and run the experiments on your own machine, you will need the following:

pom.xml

@@ -14,7 +14,8 @@
 	<description>This package contains Java programs for reproducing the 
 	experiments, and analysis of experimental data, from the following 
 	article: Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction. 
-	Applied Sciences, 12, 11, Article 5506 (May 2022). https://doi.org/10.3390/app12115506.
+	Applied Sciences, 12, 11, Article 5506 (June 2022). https://doi.org/10.3390/app12115506.
+	Also available at: https://www.cicirello.org/publications/applsci-12-05506.pdf
 	</description>
 
 	<url>https://github.com/cicirello/cycle-mutation-experiments</url>

src/main/java/module-info.java

@@ -19,9 +19,9 @@
 /**
  * <p>Code to reproduce the experiments from the following article:</p>
  *
- * <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction. 
- * <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022). 
- * <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle 
+ * Mutation: Evolving Permutations via Cycle Induction</a>, <i>Applied Sciences</i>, 12(11), Article 5506 (June 2022). 
+ * doi:<a href="https://doi.org/10.3390/app12115506">10.3390/app12115506</a></p>
  *
  * @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>, 
  * <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>

src/main/java/org/cicirello/experiments/cyclemutation/CycleDistance.java

@@ -28,9 +28,9 @@
  *
  * <p>It was introduced in the following article:</p>
  *
- * <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction. 
- * <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022). 
- * <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle 
+ * Mutation: Evolving Permutations via Cycle Induction</a>, <i>Applied Sciences</i>, 12(11), Article 5506 (June 2022). 
+ * doi:<a href="https://doi.org/10.3390/app12115506">10.3390/app12115506</a></p>
  *
  * <p>Runtime: O(n), where n is the permutation length.</p>
  * 

src/main/java/org/cicirello/experiments/cyclemutation/CycleEditDistance.java

@@ -32,9 +32,9 @@
  *
  * <p>Cycle edit distance was introduced in the following article:</p>
  *
- * <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction. 
- * <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022). 
- * <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle 
+ * Mutation: Evolving Permutations via Cycle Induction</a>, <i>Applied Sciences</i>, 12(11), Article 5506 (June 2022). 
+ * doi:<a href="https://doi.org/10.3390/app12115506">10.3390/app12115506</a></p>
  *
  * <p>Runtime: O(n), where n is the permutation length.</p>
  * 

src/main/java/org/cicirello/experiments/cyclemutation/CycleMutationExperimental.java

@@ -57,9 +57,9 @@
  *
  * <p>Cycle mutation in both of its forms, including Cycle(&alpha;), was introduced in the following article:</p>
  *
- * <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction. 
- * <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022). 
- * <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle 
+ * Mutation: Evolving Permutations via Cycle Induction</a>, <i>Applied Sciences</i>, 12(11), Article 5506 (June 2022). 
+ * doi:<a href="https://doi.org/10.3390/app12115506">10.3390/app12115506</a></p>
  *
  * @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>, 
  * <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>

src/main/java/org/cicirello/experiments/cyclemutation/FDC.java

@@ -42,9 +42,9 @@
  *
  * <p>Code to reproduce the FDC analysis from the following article:</p>
  *
- * <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction. 
- * <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022). 
- * <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle 
+ * Mutation: Evolving Permutations via Cycle Induction</a>, <i>Applied Sciences</i>, 12(11), Article 5506 (June 2022). 
+ * doi:<a href="https://doi.org/10.3390/app12115506">10.3390/app12115506</a></p>
  *
  * @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>, 
  * <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>

src/main/java/org/cicirello/experiments/cyclemutation/KCycleDistance.java

@@ -31,9 +31,9 @@
  *
  * <p>K-Cycle distance was introduced in the following article:</p>
  *
- * <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction. 
- * <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022). 
- * <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle 
+ * Mutation: Evolving Permutations via Cycle Induction</a>, <i>Applied Sciences</i>, 12(11), Article 5506 (June 2022). 
+ * doi:<a href="https://doi.org/10.3390/app12115506">10.3390/app12115506</a></p>
  *
  * <p>Runtime: O(n), where n is the permutation length.</p>
  * 

src/main/java/org/cicirello/experiments/cyclemutation/LCSExperiments.java

@@ -37,9 +37,9 @@
  *
  * <p>Code to reproduce the experiments from the following article:</p>
  *
- * <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction. 
- * <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022). 
- * <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle 
+ * Mutation: Evolving Permutations via Cycle Induction</a>, <i>Applied Sciences</i>, 12(11), Article 5506 (June 2022). 
+ * doi:<a href="https://doi.org/10.3390/app12115506">10.3390/app12115506</a></p>
  *
  * @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>, 
  * <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>

src/main/java/org/cicirello/experiments/cyclemutation/LCSExperimentsSA.java

@@ -36,9 +36,9 @@
  *
  * <p>Code to reproduce the experiments from the following article:</p>
  *
- * <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction. 
- * <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022). 
- * <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle 
+ * Mutation: Evolving Permutations via Cycle Induction</a>, <i>Applied Sciences</i>, 12(11), Article 5506 (June 2022). 
+ * doi:<a href="https://doi.org/10.3390/app12115506">10.3390/app12115506</a></p>
  *
  * @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>, 
  * <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>

src/main/java/org/cicirello/experiments/cyclemutation/LCSExperimentsStronglyRegular.java

@@ -38,9 +38,9 @@
  *
  * <p>Code to reproduce the experiments from the following article:</p>
  *
- * <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction. 
- * <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022). 
- * <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle 
+ * Mutation: Evolving Permutations via Cycle Induction</a>, <i>Applied Sciences</i>, 12(11), Article 5506 (June 2022). 
+ * doi:<a href="https://doi.org/10.3390/app12115506">10.3390/app12115506</a></p>
  *
  * @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>, 
  * <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>

src/main/java/org/cicirello/experiments/cyclemutation/LCSExperimentsStronglyRegularSA.java

@@ -37,9 +37,9 @@
  *
  * <p>Code to reproduce the experiments from the following article:</p>
  *
- * <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction. 
- * <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022). 
- * <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle 
+ * Mutation: Evolving Permutations via Cycle Induction</a>, <i>Applied Sciences</i>, 12(11), Article 5506 (June 2022). 
+ * doi:<a href="https://doi.org/10.3390/app12115506">10.3390/app12115506</a></p>
  *
  * @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>, 
  * <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>

src/main/java/org/cicirello/experiments/cyclemutation/QAPExperiments.java

@@ -37,9 +37,9 @@
  *
  * <p>Code to reproduce the experiments from the following article:</p>
  *
- * <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction. 
- * <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022). 
- * <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle 
+ * Mutation: Evolving Permutations via Cycle Induction</a>, <i>Applied Sciences</i>, 12(11), Article 5506 (June 2022). 
+ * doi:<a href="https://doi.org/10.3390/app12115506">10.3390/app12115506</a></p>
  *
  * @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>, 
  * <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>

src/main/java/org/cicirello/experiments/cyclemutation/QAPExperimentsSA.java

@@ -36,9 +36,9 @@
  *
  * <p>Code to reproduce the experiments from the following article:</p>
  *
- * <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction. 
- * <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022). 
- * <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle 
+ * Mutation: Evolving Permutations via Cycle Induction</a>, <i>Applied Sciences</i>, 12(11), Article 5506 (June 2022). 
+ * doi:<a href="https://doi.org/10.3390/app12115506">10.3390/app12115506</a></p>
  *
  * @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>, 
  * <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>

src/main/java/org/cicirello/experiments/cyclemutation/TSPExperiments.java

@@ -37,9 +37,9 @@
  *
  * <p>Code to reproduce the experiments from the following article:</p>
  *
- * <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction. 
- * <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022). 
- * <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle 
+ * Mutation: Evolving Permutations via Cycle Induction</a>, <i>Applied Sciences</i>, 12(11), Article 5506 (June 2022). 
+ * doi:<a href="https://doi.org/10.3390/app12115506">10.3390/app12115506</a></p>
  *
  * @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>, 
  * <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>

src/main/java/org/cicirello/experiments/cyclemutation/TSPExperimentsSA.java

@@ -36,9 +36,9 @@
  *
  * <p>Code to reproduce the experiments from the following article:</p>
  *
- * <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction. 
- * <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022). 
- * <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle 
+ * Mutation: Evolving Permutations via Cycle Induction</a>, <i>Applied Sciences</i>, 12(11), Article 5506 (June 2022). 
+ * doi:<a href="https://doi.org/10.3390/app12115506">10.3390/app12115506</a></p>
  *
  * @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>, 
  * <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>