Refactored permutation distance related interfaces, abstract base classes

Author: cicirello

src/org/cicirello/permutations/distance/AbstractNormalizedPermutationDistanceMeasurer.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2019 Vincent A. Cicirello, <https://www.cicirello.org/>.
+ *
+ * This file is part of JavaPermutationTools (https://jpt.cicirello.org/).
+ *
+ * JavaPermutationTools is free software: you can 
+ * redistribute it and/or modify it under the terms of the GNU 
+ * General Public License as published by the Free Software 
+ * Foundation, either version 3 of the License, or (at your 
+ * option) any later version.
+ *
+ * JavaPermutationTools is distributed in the hope 
+ * that it will be useful, but WITHOUT ANY WARRANTY; without even 
+ * the implied warranty of MERCHANTABILITY or FITNESS FOR A 
+ * PARTICULAR PURPOSE.  See the GNU General Public License for more 
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with JavaPermutationTools.  If not, see <http://www.gnu.org/licenses/>. *
+ */
+package org.cicirello.permutations.distance;
+
+import org.cicirello.permutations.Permutation;
+
+/**
+ * Extend this abstract class to define a distance metric for permutations
+ * where distance is an integer value, and which supports normalizing the distance. 
+ * 
+ * @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>
+ * @version 1.19.5.10
+ * @since 1.2.5
+ *
+ */
+abstract class AbstractNormalizedPermutationDistanceMeasurer extends AbstractPermutationDistanceMeasurer implements NormalizedPermutationDistanceMeasurer {
+	
+	/**
+	 * {@inheritDoc}
+	 */
+	@Override
+	final public double maxf(int length) {
+		return max(length);
+	}
+	
+	
+	/**
+	 * {@inheritDoc}
+	 */
+	@Override
+	final public double normalizedDistance(Permutation p1, Permutation p2) {
+		int m = max(p1.length());
+		if (m==0) return 0;
+		return 1.0 * distance(p1,p2) / m;
+	}
+}

src/org/cicirello/permutations/distance/AbstractPermutationDistanceMeasurer.java

@@ -27,53 +27,17 @@
  * where distance is an integer value.
  * 
  * @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>
- * @version 1.19.5.9
+ * @version 1.19.5.10
  * @since 1.0
  *
  */
-abstract class AbstractPermutationDistanceMeasurer implements PermutationDistanceMeasurer, PermutationDistanceMeasurerDouble {
+abstract class AbstractPermutationDistanceMeasurer implements PermutationDistanceMeasurer {
 
-		
 	/**
 	 * {@inheritDoc}
 	 */
 	@Override
 	final public double distancef(Permutation p1, Permutation p2) {
 		return distance(p1,p2);
 	}
-	
-	/**
-	 * {@inheritDoc}
-	 *
-	 * This method is supported by any extending class that implements the max method.
-	 * If the max method is not supported by this class, then neither is maxf.  Consult the
-	 * documentation of the max method for support information.
-	 *
-	 * @throws UnsupportedOperationException If this class doesn't support the max method.
-	 */
-	@Override
-	final public double maxf(int length) {
-		return max(length);
-	}
-	
-	
-	/**
-	 * <p>Measures the distance between two permutations, normalized to the interval [0.0, 1.0].</p>
-	 *
-	 * <p>This method is supported by any implementing class that implements the max method.
-	 * If max is unsupported, then so is normalizedDistance.  Please consult the documentation
-	 * of max for support information.</p>
-	 * 
-	 * @param p1 first permutation
-	 * @param p2 second permutation 
-	 * @return distance between p1 and p2 
-	 * @throws UnsupportedOperationException If this class doesn't support the max method.
-	 * @since 1.2.4
-	 */
-	@Override
-	final public double normalizedDistance(Permutation p1, Permutation p2) {
-		int m = max(p1.length());
-		if (m==0) return 0;
-		return distancef(p1,p2) / m;
-	}
 }

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

@@ -42,10 +42,10 @@
  * S. Ronald, "Distance functions for order-based encodings," in Proc. IEEE CEC. IEEE Press, 1997, pp. 49–54.</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>
- * @version 1.19.5.8 
+ * @version 1.19.5.10 
  * @since 1.0
  */
-public class AcyclicEdgeDistance extends AbstractPermutationDistanceMeasurer {
+public class AcyclicEdgeDistance extends AbstractNormalizedPermutationDistanceMeasurer {
 
 
 	/**

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

@@ -42,10 +42,10 @@
  * S. Ronald, "Distance functions for order-based encodings," in Proc. IEEE CEC. IEEE Press, 1997, pp. 49–54.</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>
- * @version 1.19.5.8 
+ * @version 1.19.5.10 
  * @since 1.0
  */
-public class CyclicEdgeDistance extends AbstractPermutationDistanceMeasurer {
+public class CyclicEdgeDistance extends AbstractNormalizedPermutationDistanceMeasurer {
 
 
 

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

@@ -32,11 +32,11 @@
  * the constructor.</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>
- * @version 1.19.5.9
+ * @version 1.19.5.10
  * @since 1.0
  *  
  */
-public final class CyclicIndependentDistance implements PermutationDistanceMeasurer {
+public final class CyclicIndependentDistance extends AbstractPermutationDistanceMeasurer {
 
 	private PermutationDistanceMeasurer d;
 
@@ -69,14 +69,4 @@ public int distance(Permutation p1, Permutation p2) {
 		return result;
 	}
 
-	/**
-	 * The max method is unsupported when computing
-	 * distance with cyclic independence.
-	 * 
-	 * @throws UnsupportedOperationException If method is invoked.
-	 */
-	@Override
-	public int max(int length) {
-		throw new UnsupportedOperationException("Unimplemented.");
-	}
 }

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

@@ -32,7 +32,7 @@
  * the constructor.</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>
- * @version 1.19.5.9
+ * @version 1.19.5.10
  * @since 1.0
  *  
  */
@@ -69,14 +69,4 @@ public double distancef(Permutation p1, Permutation p2) {
 		return result;
 	}
 
-	/**
-	 * The maxf method is unsupported when computing
-	 * distance with cyclic independence.
-	 * 
-	 * @throws UnsupportedOperationException If method is invoked.
-	 */
-	@Override
-	public double maxf(int length) {
-		throw new UnsupportedOperationException("Unimplemented.");
-	}
 }

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

@@ -44,10 +44,10 @@
  * IEEE Transactions on Evolutionary Computation, 20(3):434-446, June 2016.</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>
- * @version 1.19.5.8 
+ * @version 1.19.5.10 
  * @since 1.0
  */
-public class CyclicRTypeDistance extends AbstractPermutationDistanceMeasurer {
+public class CyclicRTypeDistance extends AbstractNormalizedPermutationDistanceMeasurer {
 
 
 

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

@@ -33,11 +33,11 @@
  * the constructor.</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>
- * @version 1.19.5.9
+ * @version 1.19.5.10
  * @since 1.0
  *  
  */
-public final class CyclicReversalIndependentDistance implements PermutationDistanceMeasurer {
+public final class CyclicReversalIndependentDistance extends AbstractPermutationDistanceMeasurer {
 
 	private PermutationDistanceMeasurer d;
 
@@ -84,14 +84,4 @@ public int distance(Permutation p1, Permutation p2) {
 		return result;
 	}
 
-	/**
-	 * The max method is unsupported when computing
-	 * distance with cyclic and reversal independence.
-	 * 
-	 * @throws UnsupportedOperationException If method is invoked.
-	 */
-	@Override
-	public int max(int length) {
-		throw new UnsupportedOperationException("Unimplemented.");
-	}
 }

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

@@ -33,7 +33,7 @@
  * the constructor.</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>
- * @version 1.19.5.9
+ * @version 1.19.5.10
  * @since 1.0
  *  
  */
@@ -84,14 +84,4 @@ public double distancef(Permutation p1, Permutation p2) {
 		return result;
 	}
 
-	/**
-	 * The maxf method is unsupported when computing
-	 * distance with cyclic and reversal independence.
-	 * 
-	 * @throws UnsupportedOperationException If method is invoked.
-	 */
-	@Override
-	public double maxf(int length) {
-		throw new UnsupportedOperationException("Unimplemented.");
-	}
 }

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

@@ -42,11 +42,11 @@
  * S. Ronald, "More distance functions for order-based encodings," in Proc. IEEE CEC. IEEE Press, 1998, pp. 558–563.</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>
- * @version 1.19.5.8  
+ * @version 1.19.5.10  
  * @since 1.0
  * 
  */
-public class DeviationDistance extends AbstractPermutationDistanceMeasurer {
+public class DeviationDistance extends AbstractNormalizedPermutationDistanceMeasurer {
 
 	/**
 	 * {@inheritDoc}