Merge pull request #17 from cicirello/doc-add-citation

cicirello · web-flow · commit 94012a1468ca · 2022-11-09T17:20:28.000-05:00
Added citation to MONE article in README and in javadoc comments
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 target/
+dependency-reduced-pom.xml
diff --git a/README.md b/README.md
@@ -5,12 +5,16 @@ Copyright &copy; 2018-2019, 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. On Fitness Landscape Analysis of Permutation Problems: From Distance Metrics to Mutation Operator Selection. *CURRENTLY UNDER REVIEW*.
+> Vincent A. Cicirello. 2022. [On Fitness Landscape Analysis of Permutation Problems: From Distance Metrics to Mutation Operator Selection](https://www.cicirello.org/publications/Cicirello-MONE-2022.pdf). *Mobile Networks and Applications* (2022). doi:[10.1007/s11036-022-02060-z](https://doi.org/10.1007/s11036-022-02060-z)
 
+The above article is an extended version the following earlier conference paper:
 
-|  |  |
+> Vincent A. Cicirello. 2019. [Classification of Permutation Distance Metrics for Fitness Landscape Analysis](https://www.cicirello.org/publications/cicirello-bict2019.pdf). In *Proceedings of the 11th International Conference on Bio-inspired Information and Communication Technologies*, pages 81-97. Springer Nature, March 2019. doi:[10.1007/978-3-030-24202-2_7](https://doi.org/10.1007/978-3-030-24202-2_7)
+
+| __Related Publications__ | [![DOI](doi.svg)](https://doi.org/10.1007/s11036-022-02060-z) [![DOI](bict-doi.svg)](https://doi.org/10.1007/978-3-030-24202-2_7) |
 | :--- | :--- |
 | __License__ | [![GitHub](https://img.shields.io/github/license/cicirello/MONE2022-experiments)](LICENSE) | 
+| __Packages and Releases__ | [![Maven Central](https://img.shields.io/maven-central/v/org.cicirello/mone-article-experiments.svg?label=Maven%20Central)](https://search.maven.org/artifact/org.cicirello/mone-article-experiments) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/cicirello/MONE2022-experiments?logo=GitHub)](https://github.com/cicirello/MONE2022-experiments/releases) |
 
 ## Requirements to Build and Run the Experiments
 
diff --git a/bict-doi.svg b/bict-doi.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="222" height="20" role="img" aria-label="BICT: 10.1007/978-3-030-24202-2_7"><title>BICT: 10.1007/978-3-030-24202-2_7</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="222" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="37" height="20" fill="#555"/><rect x="37" width="185" height="20" fill="#4c1"/><rect width="222" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="195" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">BICT</text><text x="195" y="140" transform="scale(.1)" fill="#fff" textLength="270">BICT</text><text aria-hidden="true" x="1285" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="1750">10.1007/978-3-030-24202-2_7</text><text x="1285" y="140" transform="scale(.1)" fill="#fff" textLength="1750">10.1007/978-3-030-24202-2_7</text></g></svg>
diff --git a/doi.svg b/doi.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="284" height="20" role="img" aria-label="Mobile Netw Appl: 10.1007/s11036-022-02060-z"><title>Mobile Netw Appl: 10.1007/s11036-022-02060-z</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="284" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="105" height="20" fill="#555"/><rect x="105" width="179" height="20" fill="#4c1"/><rect width="284" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="535" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="950">Mobile Netw Appl</text><text x="535" y="140" transform="scale(.1)" fill="#fff" textLength="950">Mobile Netw Appl</text><text aria-hidden="true" x="1935" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="1690">10.1007/s11036-022-02060-z</text><text x="1935" y="140" transform="scale(.1)" fill="#fff" textLength="1690">10.1007/s11036-022-02060-z</text></g></svg>
diff --git a/src/main/java/module-info.java b/src/main/java/module-info.java
@@ -17,7 +17,12 @@
  */
 
 /**
+ * <p>Code to reproduce the experiments from the following article:</p>
  *
+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/Cicirello-MONE-2022.pdf">On 
+ * Fitness Landscape Analysis of Permutation Problems: From Distance Metrics to Mutation Operator Selection</a>, 
+ * <i>Mobile Networks and Applications</i>, 2022. 
+ * doi:<a href="https://doi.org/10.1007/s11036-022-02060-z">10.1007/s11036-022-02060-z</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>
diff --git a/src/main/java/org/cicirello/experiments/mone2022/ATSPExperiments.java b/src/main/java/org/cicirello/experiments/mone2022/ATSPExperiments.java
@@ -38,7 +38,14 @@
 import org.cicirello.search.operators.permutations.PermutationInitializer;
 
 /**
- * Experiments with the ATSP.
+ * <p>Experiments with the ATSP.</p>
+ *
+ * <p>Code to reproduce the experiments from the following article:</p>
+ *
+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/Cicirello-MONE-2022.pdf">On 
+ * Fitness Landscape Analysis of Permutation Problems: From Distance Metrics to Mutation Operator Selection</a>, 
+ * <i>Mobile Networks and Applications</i>, 2022. 
+ * doi:<a href="https://doi.org/10.1007/s11036-022-02060-z">10.1007/s11036-022-02060-z</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>
diff --git a/src/main/java/org/cicirello/experiments/mone2022/BICT2019.java b/src/main/java/org/cicirello/experiments/mone2022/BICT2019.java
@@ -29,11 +29,19 @@
 
 /**
  * <p>This program replicates the principal component analysis (PCA), and the fitness distance corrleation
- * examples for the paper:<br>
- * V.A. Cicirello, <a href="https://www.cicirello.org/publications/cicirello2019bict.html">"Classification 
+ * examples for the paper:</p>
+ *
+ * <p>V.A. Cicirello, <a href="https://www.cicirello.org/publications/cicirello2019bict.html">"Classification 
  * of Permutation Distance Metrics for Fitness Landscape Analysis,"</a> 
  * <i>Proceedings of the 11th International Conference on Bio-inspired Information and Communication Technologies</i>, 
- * pages 81-97. Springer Nature, March 2019. doi:10.1007/978-3-030-24202-2_7.</p>
+ * pages 81-97. Springer Nature, March 2019. doi:<a href="https://doi.org/10.1007/978-3-030-24202-2_7">10.1007/978-3-030-24202-2_7</a></p>
+ *
+ * <p>This is also included in the following extended version of that paper:</p>
+ *
+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/Cicirello-MONE-2022.pdf">On 
+ * Fitness Landscape Analysis of Permutation Problems: From Distance Metrics to Mutation Operator Selection</a>, 
+ * <i>Mobile Networks and Applications</i>, 2022. 
+ * doi:<a href="https://doi.org/10.1007/s11036-022-02060-z">10.1007/s11036-022-02060-z</a></p>
  *
  * @author <a href=https://www.cicirello.org/>Vincent A. Cicirello</a>, 
  * <a href=https://www.cicirello.org/>https://www.cicirello.org/</a>
diff --git a/src/main/java/org/cicirello/experiments/mone2022/HaystackEMExperiments.java b/src/main/java/org/cicirello/experiments/mone2022/HaystackEMExperiments.java
@@ -40,7 +40,14 @@
 import org.cicirello.permutations.distance.ExactMatchDistance;
 
 /**
- * Experiments with the Permutation in a Haystack problem using the Exact Match Distance.
+ * <p>Experiments with the Permutation in a Haystack problem using the Exact Match Distance.</p>
+ *
+ * <p>Code to reproduce the experiments from the following article:</p>
+ *
+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/Cicirello-MONE-2022.pdf">On 
+ * Fitness Landscape Analysis of Permutation Problems: From Distance Metrics to Mutation Operator Selection</a>, 
+ * <i>Mobile Networks and Applications</i>, 2022. 
+ * doi:<a href="https://doi.org/10.1007/s11036-022-02060-z">10.1007/s11036-022-02060-z</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>
diff --git a/src/main/java/org/cicirello/experiments/mone2022/HaystackLeeExperiments.java b/src/main/java/org/cicirello/experiments/mone2022/HaystackLeeExperiments.java
@@ -40,7 +40,14 @@
 import org.cicirello.permutations.distance.LeeDistance;
 
 /**
- * Experiments with the Permutation in a Haystack problem using the Lee Distance.
+ * <p>Experiments with the Permutation in a Haystack problem using the Lee Distance.</p>
+ *
+ * <p>Code to reproduce the experiments from the following article:</p>
+ *
+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/Cicirello-MONE-2022.pdf">On 
+ * Fitness Landscape Analysis of Permutation Problems: From Distance Metrics to Mutation Operator Selection</a>, 
+ * <i>Mobile Networks and Applications</i>, 2022. 
+ * doi:<a href="https://doi.org/10.1007/s11036-022-02060-z">10.1007/s11036-022-02060-z</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>
diff --git a/src/main/java/org/cicirello/experiments/mone2022/HaystackTauExperiments.java b/src/main/java/org/cicirello/experiments/mone2022/HaystackTauExperiments.java
@@ -40,7 +40,14 @@
 import org.cicirello.permutations.distance.KendallTauDistance;
 
 /**
- * Experiments with the Permutation in a Haystack problem using Kendall Tau Distance.
+ * <p>Experiments with the Permutation in a Haystack problem using Kendall Tau Distance.</p>
+ *
+ * <p>Code to reproduce the experiments from the following article:</p>
+ *
+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/Cicirello-MONE-2022.pdf">On 
+ * Fitness Landscape Analysis of Permutation Problems: From Distance Metrics to Mutation Operator Selection</a>, 
+ * <i>Mobile Networks and Applications</i>, 2022. 
+ * doi:<a href="https://doi.org/10.1007/s11036-022-02060-z">10.1007/s11036-022-02060-z</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>
diff --git a/src/main/java/org/cicirello/experiments/mone2022/TSPExperiments.java b/src/main/java/org/cicirello/experiments/mone2022/TSPExperiments.java
@@ -38,7 +38,14 @@
 import org.cicirello.search.operators.permutations.PermutationInitializer;
 
 /**
- * Experiments with the TSP.
+ * <p>Experiments with the TSP.</p>
+ *
+ * <p>Code to reproduce the experiments from the following article:</p>
+ *
+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/Cicirello-MONE-2022.pdf">On 
+ * Fitness Landscape Analysis of Permutation Problems: From Distance Metrics to Mutation Operator Selection</a>, 
+ * <i>Mobile Networks and Applications</i>, 2022. 
+ * doi:<a href="https://doi.org/10.1007/s11036-022-02060-z">10.1007/s11036-022-02060-z</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>

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`target/`
	`2`	`+dependency-reduced-pom.xml`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,12 @@`
`17`	`17`	`*/`
`18`	`18`
`19`	`19`	`/**`
	`20`	`+ * <p>Code to reproduce the experiments from the following article:</p>`
`20`	`21`	`*`
	`22`	`+ * <p>Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/Cicirello-MONE-2022.pdf">On`
	`23`	`+ * Fitness Landscape Analysis of Permutation Problems: From Distance Metrics to Mutation Operator Selection</a>,`
	`24`	`+ * <i>Mobile Networks and Applications</i>, 2022.`
	`25`	`+ * doi:<a href="https://doi.org/10.1007/s11036-022-02060-z">10.1007/s11036-022-02060-z</a></p>`
`21`	`26`	`*`
`22`	`27`	`* @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>,`
`23`	`28`	`* <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>`