Skip to content

Commit 5988b42

Browse files
committed
documentation updates
1 parent 3efb9d8 commit 5988b42

File tree

10 files changed

+70
-12
lines changed

10 files changed

+70
-12
lines changed

src/main/java/module-info.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,11 @@
1717
*/
1818

1919
/**
20+
* <p>Code to reproduce the experiments from the following article:</p>
2021
*
22+
* <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction.
23+
* <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022).
24+
* <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
2125
*
2226
* @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>,
2327
* <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>

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

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,15 @@
3636
import java.util.SplittableRandom;
3737

3838
/**
39-
* Computes FDC for one small instance of each of the TSP, QAP, and LCS problems,
39+
* <p>Computes FDC for one small instance of each of the TSP, QAP, and LCS problems,
4040
* for a distance metric corresponding to each of the mutation operators Swap,
41-
* Insertion, Reversal, and Cycle.
41+
* Insertion, Reversal, and Cycle.</p>
42+
*
43+
* <p>Code to reproduce the FDC analysis from the following article:</p>
44+
*
45+
* <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction.
46+
* <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022).
47+
* <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
4248
*
4349
* @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>,
4450
* <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,13 @@
3333
import org.cicirello.search.operators.permutations.PermutationInitializer;
3434

3535
/**
36-
* Experiments with the Largest Common Subgraph Problem.
36+
* <p>Experiments with the Largest Common Subgraph Problem.</p>
37+
*
38+
* <p>Code to reproduce the experiments from the following article:</p>
39+
*
40+
* <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction.
41+
* <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022).
42+
* <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
3743
*
3844
* @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>,
3945
* <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,13 @@
3232
import org.cicirello.search.operators.permutations.PermutationInitializer;
3333

3434
/**
35-
* Experiments with the Largest Common Subgraph Problem and with Simulated Annealing.
35+
* <p>Experiments with the Largest Common Subgraph Problem and with Simulated Annealing.</p>
36+
*
37+
* <p>Code to reproduce the experiments from the following article:</p>
38+
*
39+
* <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction.
40+
* <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022).
41+
* <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
3642
*
3743
* @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>,
3844
* <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>

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

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,14 @@
3333
import org.cicirello.search.operators.permutations.PermutationInitializer;
3434

3535
/**
36-
* Experiments with the Largest Common Subgraph Problem,
37-
* with a strongly regular instance of the LCS.
36+
* <p>Experiments with the Largest Common Subgraph Problem,
37+
* with a strongly regular instance of the LCS.</p>
38+
*
39+
* <p>Code to reproduce the experiments from the following article:</p>
40+
*
41+
* <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction.
42+
* <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022).
43+
* <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
3844
*
3945
* @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>,
4046
* <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>

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

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,14 @@
3232
import org.cicirello.search.operators.permutations.PermutationInitializer;
3333

3434
/**
35-
* Experiments with the Largest Common Subgraph Problem and with Simulated Annealing,
36-
* with a strongly regular instance of the LCS.
35+
* <p>Experiments with the Largest Common Subgraph Problem and with Simulated Annealing,
36+
* with a strongly regular instance of the LCS.</p>
37+
*
38+
* <p>Code to reproduce the experiments from the following article:</p>
39+
*
40+
* <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction.
41+
* <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022).
42+
* <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
3743
*
3844
* @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>,
3945
* <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,13 @@
3333
import org.cicirello.search.operators.permutations.PermutationInitializer;
3434

3535
/**
36-
* Experiments with the Quadratic Assignment Problem.
36+
* <p>Experiments with the Quadratic Assignment Problem.</p>
37+
*
38+
* <p>Code to reproduce the experiments from the following article:</p>
39+
*
40+
* <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction.
41+
* <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022).
42+
* <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
3743
*
3844
* @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>,
3945
* <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,13 @@
3232
import org.cicirello.search.operators.permutations.PermutationInitializer;
3333

3434
/**
35-
* Experiments with the Quadratic Assignment Problem and with Simulated Annealing.
35+
* <p>Experiments with the Quadratic Assignment Problem and with Simulated Annealing.</p>
36+
*
37+
* <p>Code to reproduce the experiments from the following article:</p>
38+
*
39+
* <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction.
40+
* <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022).
41+
* <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
3642
*
3743
* @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>,
3844
* <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,13 @@
3333
import org.cicirello.search.operators.permutations.PermutationInitializer;
3434

3535
/**
36-
* Experiments with the Traveling Salesperson Problem.
36+
* <p>Experiments with the Traveling Salesperson Problem.</p>
37+
*
38+
* <p>Code to reproduce the experiments from the following article:</p>
39+
*
40+
* <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction.
41+
* <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022).
42+
* <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
3743
*
3844
* @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>,
3945
* <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,13 @@
3232
import org.cicirello.search.operators.permutations.PermutationInitializer;
3333

3434
/**
35-
* Experiments with the Traveling Salesperson Problem and with Simulated Annealing.
35+
* <p>Experiments with the Traveling Salesperson Problem and with Simulated Annealing.</p>
36+
*
37+
* <p>Code to reproduce the experiments from the following article:</p>
38+
*
39+
* <p>Vincent A. Cicirello. 2022. Cycle Mutation: Evolving Permutations via Cycle Induction.
40+
* <i>Applied Sciences</i>, 12, 11, Article 5506 (May 2022).
41+
* <a href="https://doi.org/10.3390/app12115506">https://doi.org/10.3390/app12115506</a></p>
3642
*
3743
* @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>,
3844
* <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>

0 commit comments

Comments
 (0)