Skip to content

Commit 8ba0e9a

Browse files
cicirellocicirello
committed
documentation improvements
1 parent f9dabb2 commit 8ba0e9a

37 files changed

+135
-167
lines changed

‎src/main/java/org/cicirello/permutations/distance/AcyclicEdgeDistance.java‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
/*
2-
* Copyright 2014-2021 Vincent A. Cicirello, <https://www.cicirello.org/>.
3-
*
4-
* This file is part of JavaPermutationTools (https://jpt.cicirello.org/).
2+
* JavaPermutationTools - A Java library for computation on permutations.
3+
* Copyright 2005-2022 Vincent A. Cicirello, <https://www.cicirello.org/>.
54
*
65
* JavaPermutationTools is free software: you can
76
* redistribute it and/or modify it under the terms of the GNU
@@ -17,13 +16,12 @@
1716
*
1817
* You should have received a copy of the GNU General Public License
1918
* along with JavaPermutationTools. If not, see <http://www.gnu.org/licenses/>.
19+
*
2020
*/
2121
package org.cicirello.permutations.distance;
2222

2323
import org.cicirello.permutations.Permutation;
2424
/**
25-
* Acyclic Edge Distance:
26-
*
2725
* <p>Acyclic edge distance treats the permutations as if they represent sets of edges, and counts
2826
* the number of edges that differ.</p>
2927
*
@@ -41,8 +39,8 @@
4139
* <p>Acyclic edge distance was first described in:<br>
4240
* S. Ronald, "Distance functions for order-based encodings," in Proc. IEEE CEC. IEEE Press, 1997, pp. 49–54.</p>
4341
*
44-
* @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>
45-
* @version 4.2.2021
42+
* @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>,
43+
* <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>
4644
*/
4745
public final class AcyclicEdgeDistance implements NormalizedPermutationDistanceMeasurer {
4846

‎src/main/java/org/cicirello/permutations/distance/BlockInterchangeDistance.java‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
/*
2-
* Copyright 2019, 2021 Vincent A. Cicirello, <https://www.cicirello.org/>.
3-
*
4-
* This file is part of JavaPermutationTools (https://jpt.cicirello.org/).
2+
* JavaPermutationTools - A Java library for computation on permutations.
3+
* Copyright 2005-2022 Vincent A. Cicirello, <https://www.cicirello.org/>.
54
*
65
* JavaPermutationTools is free software: you can
76
* redistribute it and/or modify it under the terms of the GNU
@@ -17,14 +16,13 @@
1716
*
1817
* You should have received a copy of the GNU General Public License
1918
* along with JavaPermutationTools. If not, see <http://www.gnu.org/licenses/>.
19+
*
2020
*/
2121
package org.cicirello.permutations.distance;
2222

2323
import org.cicirello.permutations.Permutation;
2424

2525
/**
26-
* Block Interchange Distance:
27-
*
2826
* <p>Block Interchange Distance is the minimum number of block interchanges
2927
* necessary to transform one permutation into the other. A block interchange is
3028
* an edit operation that takes two non-overlapping blocks (i.e., subsequence)
@@ -39,8 +37,8 @@
3937
*
4038
* <p>Runtime: O(n), where n is the permutation length.</p>
4139
*
42-
* @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>
43-
* @version 4.2.2021
40+
* @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>,
41+
* <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>
4442
*/
4543
public class BlockInterchangeDistance implements NormalizedPermutationDistanceMeasurer {
4644

‎src/main/java/org/cicirello/permutations/distance/CyclicEdgeDistance.java‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
/*
2-
* Copyright 2014-2021 Vincent A. Cicirello, <https://www.cicirello.org/>.
3-
*
4-
* This file is part of JavaPermutationTools (https://jpt.cicirello.org/).
2+
* JavaPermutationTools - A Java library for computation on permutations.
3+
* Copyright 2005-2022 Vincent A. Cicirello, <https://www.cicirello.org/>.
54
*
65
* JavaPermutationTools is free software: you can
76
* redistribute it and/or modify it under the terms of the GNU
@@ -17,13 +16,12 @@
1716
*
1817
* You should have received a copy of the GNU General Public License
1918
* along with JavaPermutationTools. If not, see <http://www.gnu.org/licenses/>.
19+
*
2020
*/
2121
package org.cicirello.permutations.distance;
2222

2323
import org.cicirello.permutations.Permutation;
2424
/**
25-
* Cyclic Edge Distance:
26-
*
2725
* <p>Cyclic edge distance treats the permutations as if they represent sets of edges, and counts
2826
* the number of edges that differ. It treats the last to the first element as an edge.</p>
2927
*
@@ -41,8 +39,8 @@
4139
* <p>Cyclic edge distance was first described in:<br>
4240
* S. Ronald, "Distance functions for order-based encodings," in Proc. IEEE CEC. IEEE Press, 1997, pp. 49–54.</p>
4341
*
44-
* @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>
45-
* @version 4.2.2021
42+
* @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>,
43+
* <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>
4644
*/
4745
public final class CyclicEdgeDistance implements NormalizedPermutationDistanceMeasurer {
4846

‎src/main/java/org/cicirello/permutations/distance/CyclicIndependentDistance.java‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
/*
2-
* Copyright 2018-2021 Vincent A. Cicirello, <https://www.cicirello.org/>.
3-
*
4-
* This file is part of JavaPermutationTools (https://jpt.cicirello.org/).
2+
* JavaPermutationTools - A Java library for computation on permutations.
3+
* Copyright 2005-2022 Vincent A. Cicirello, <https://www.cicirello.org/>.
54
*
65
* JavaPermutationTools is free software: you can
76
* redistribute it and/or modify it under the terms of the GNU
@@ -17,6 +16,7 @@
1716
*
1817
* You should have received a copy of the GNU General Public License
1918
* along with JavaPermutationTools. If not, see <http://www.gnu.org/licenses/>.
19+
*
2020
*/
2121
package org.cicirello.permutations.distance;
2222

@@ -31,9 +31,8 @@
3131
* to rotations of p2, where the underlying distance measure is passed as a parameter to
3232
* the constructor.</p>
3333
*
34-
* @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>
35-
* @version 4.2.2021
36-
*
34+
* @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>,
35+
* <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>
3736
*/
3837
public final class CyclicIndependentDistance implements PermutationDistanceMeasurer {
3938

‎src/main/java/org/cicirello/permutations/distance/CyclicIndependentDistanceDouble.java‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
/*
2-
* Copyright 2018-2021 Vincent A. Cicirello, <https://www.cicirello.org/>.
3-
*
4-
* This file is part of JavaPermutationTools (https://jpt.cicirello.org/).
2+
* JavaPermutationTools - A Java library for computation on permutations.
3+
* Copyright 2005-2022 Vincent A. Cicirello, <https://www.cicirello.org/>.
54
*
65
* JavaPermutationTools is free software: you can
76
* redistribute it and/or modify it under the terms of the GNU
@@ -17,6 +16,7 @@
1716
*
1817
* You should have received a copy of the GNU General Public License
1918
* along with JavaPermutationTools. If not, see <http://www.gnu.org/licenses/>.
19+
*
2020
*/
2121
package org.cicirello.permutations.distance;
2222

@@ -31,9 +31,8 @@
3131
* to rotations of p2, where the underlying distance measure is passed as a parameter to
3232
* the constructor.</p>
3333
*
34-
* @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>
35-
* @version 1.28.2021
36-
*
34+
* @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>,
35+
* <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>
3736
*/
3837
public final class CyclicIndependentDistanceDouble implements PermutationDistanceMeasurerDouble {
3938

‎src/main/java/org/cicirello/permutations/distance/CyclicRTypeDistance.java‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
/*
2-
* Copyright 2010, 2014-2015, 2017-2021 Vincent A. Cicirello, <https://www.cicirello.org/>.
3-
*
4-
* This file is part of JavaPermutationTools (https://jpt.cicirello.org/).
2+
* JavaPermutationTools - A Java library for computation on permutations.
3+
* Copyright 2005-2022 Vincent A. Cicirello, <https://www.cicirello.org/>.
54
*
65
* JavaPermutationTools is free software: you can
76
* redistribute it and/or modify it under the terms of the GNU
@@ -17,13 +16,12 @@
1716
*
1817
* You should have received a copy of the GNU General Public License
1918
* along with JavaPermutationTools. If not, see <http://www.gnu.org/licenses/>.
19+
*
2020
*/
2121
package org.cicirello.permutations.distance;
2222

2323
import org.cicirello.permutations.Permutation;
2424
/**
25-
* Cyclic RType Distance:
26-
*
2725
* <p>Cyclic RType distance treats the permutations as if they represent sets of directed edges, and counts
2826
* the number of edges that differ. It treats the last to the first element as an edge.</p>
2927
*
@@ -44,7 +42,6 @@
4442
* IEEE Transactions on Evolutionary Computation, 20(3):434-446, June 2016.</p>
4543
*
4644
* @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>
47-
* @version 4.2.2021
4845
*/
4946
public final class CyclicRTypeDistance implements NormalizedPermutationDistanceMeasurer {
5047

‎src/main/java/org/cicirello/permutations/distance/CyclicReversalIndependentDistance.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
/*
2-
* Copyright 2018-2021 Vincent A. Cicirello, <https://www.cicirello.org/>.
3-
*
4-
* This file is part of JavaPermutationTools (https://jpt.cicirello.org/).
2+
* JavaPermutationTools - A Java library for computation on permutations.
3+
* Copyright 2005-2022 Vincent A. Cicirello, <https://www.cicirello.org/>.
54
*
65
* JavaPermutationTools is free software: you can
76
* redistribute it and/or modify it under the terms of the GNU
@@ -17,6 +16,7 @@
1716
*
1817
* You should have received a copy of the GNU General Public License
1918
* along with JavaPermutationTools. If not, see <http://www.gnu.org/licenses/>.
19+
*
2020
*/
2121
package org.cicirello.permutations.distance;
2222

@@ -32,8 +32,8 @@
3232
* to rotations of p2 and rotations of the reverse of p2, where the underlying distance measure is passed as a parameter to
3333
* the constructor.</p>
3434
*
35-
* @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>
36-
* @version 4.2.2021
35+
* @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>,
36+
* <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>
3737
*
3838
*/
3939
public final class CyclicReversalIndependentDistance implements PermutationDistanceMeasurer {

‎src/main/java/org/cicirello/permutations/distance/CyclicReversalIndependentDistanceDouble.java‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
/*
2-
* Copyright 2018-2021 Vincent A. Cicirello, <https://www.cicirello.org/>.
3-
*
4-
* This file is part of JavaPermutationTools (https://jpt.cicirello.org/).
2+
* JavaPermutationTools - A Java library for computation on permutations.
3+
* Copyright 2005-2022 Vincent A. Cicirello, <https://www.cicirello.org/>.
54
*
65
* JavaPermutationTools is free software: you can
76
* redistribute it and/or modify it under the terms of the GNU
@@ -17,6 +16,7 @@
1716
*
1817
* You should have received a copy of the GNU General Public License
1918
* along with JavaPermutationTools. If not, see <http://www.gnu.org/licenses/>.
19+
*
2020
*/
2121
package org.cicirello.permutations.distance;
2222

@@ -33,7 +33,6 @@
3333
* the constructor.</p>
3434
*
3535
* @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>
36-
* @version 1.28.2021
3736
*
3837
*/
3938
public final class CyclicReversalIndependentDistanceDouble implements PermutationDistanceMeasurerDouble {

‎src/main/java/org/cicirello/permutations/distance/DeviationDistance.java‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
/*
2-
* Copyright 2008, 2010, 2014, 2017-2021 Vincent A. Cicirello, <https://www.cicirello.org/>.
3-
*
4-
* This file is part of JavaPermutationTools (https://jpt.cicirello.org/).
2+
* JavaPermutationTools - A Java library for computation on permutations.
3+
* Copyright 2005-2022 Vincent A. Cicirello, <https://www.cicirello.org/>.
54
*
65
* JavaPermutationTools is free software: you can
76
* redistribute it and/or modify it under the terms of the GNU
@@ -17,13 +16,12 @@
1716
*
1817
* You should have received a copy of the GNU General Public License
1918
* along with JavaPermutationTools. If not, see <http://www.gnu.org/licenses/>.
19+
*
2020
*/
2121
package org.cicirello.permutations.distance;
2222

2323
import org.cicirello.permutations.Permutation;
2424
/**
25-
* Deviation Distance:
26-
*
2725
* <p>Deviation distance is the sum of the positional deviation of the permutation elements.
2826
* The positional deviation of an element is the difference in its location in the two
2927
* permutations.</p>
@@ -42,7 +40,6 @@
4240
* S. Ronald, "More distance functions for order-based encodings," in Proc. IEEE CEC. IEEE Press, 1998, pp. 558–563.</p>
4341
*
4442
* @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>
45-
* @version 4.2.2021
4643
*
4744
*/
4845
public final class DeviationDistance implements NormalizedPermutationDistanceMeasurer {

‎src/main/java/org/cicirello/permutations/distance/DeviationDistanceNormalized.java‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
/*
2-
* Copyright 2014, 2017-2021 Vincent A. Cicirello, <https://www.cicirello.org/>.
3-
*
4-
* This file is part of JavaPermutationTools (https://jpt.cicirello.org/).
2+
* JavaPermutationTools - A Java library for computation on permutations.
3+
* Copyright 2005-2022 Vincent A. Cicirello, <https://www.cicirello.org/>.
54
*
65
* JavaPermutationTools is free software: you can
76
* redistribute it and/or modify it under the terms of the GNU
@@ -17,14 +16,13 @@
1716
*
1817
* You should have received a copy of the GNU General Public License
1918
* along with JavaPermutationTools. If not, see <http://www.gnu.org/licenses/>.
19+
*
2020
*/
2121
package org.cicirello.permutations.distance;
2222

2323
import org.cicirello.permutations.Permutation;
2424

2525
/**
26-
* Normalized Deviation Distance:
27-
*
2826
* <p>Normalized Deviation distance is the sum of the positional deviation of the permutation elements
2927
* divided by N-1 (where N is the length of the permutation).
3028
* The positional deviation of an element is the difference in its location in the two
@@ -48,7 +46,6 @@
4846
* Proc. IEEE CEC. IEEE Press, 1998, pp. 558–563.</p>
4947
*
5048
* @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>
51-
* @version 4.2.2021
5249
*
5350
*/
5451
public final class DeviationDistanceNormalized implements NormalizedPermutationDistanceMeasurerDouble {

0 commit comments

Comments
 (0)