MOEA Framework 2.1
API Specification

org.moeaframework.core.comparator
Class LexicographicalComparator

java.lang.Object
  extended by org.moeaframework.core.comparator.LexicographicalComparator
All Implemented Interfaces:
Serializable, Comparator<Solution>

public class LexicographicalComparator
extends Object
implements Comparator<Solution>, Serializable

Compares solutions lexicographically.

See Also:
Serialized Form

Constructor Summary
LexicographicalComparator()
          Constructs a comparator for comparing solutions lexicographically.
 
Method Summary
 int compare(Solution a, Solution b)
          Compares its two arguments for order.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.util.Comparator
equals
 

Constructor Detail

LexicographicalComparator

public LexicographicalComparator()
Constructs a comparator for comparing solutions lexicographically.

Method Detail

compare

public int compare(Solution a,
                   Solution b)
Description copied from interface: java.util.Comparator
Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

In the foregoing description, the notation sgn(expression) designates the mathematical signum function, which is defined to return one of -1, 0, or 1 according to whether the value of expression is negative, zero or positive.

The implementor must ensure that sgn(compare(x, y)) == -sgn(compare(y, x)) for all x and y. (This implies that compare(x, y) must throw an exception if and only if compare(y, x) throws an exception.)

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that sgn(compare(x, z))==sgn(compare(y, z)) for all z.

It is generally the case, but not strictly required that (compare(x, y)==0) == (x.equals(y)). Generally speaking, any comparator that violates this condition should clearly indicate this fact. The recommended language is "Note: this comparator imposes orderings that are inconsistent with equals."

Specified by:
compare in interface Comparator<Solution>
Parameters:
a - the first object to be compared.
b - the second object to be compared.
Returns:
a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

MOEA Framework 2.1
API Specification

Copyright 2009-2014 MOEA Framework. All rights reserved.
Licensed under the GNU Lesser General Public License.
Return to the MOEA Framework homepage. Hosted by Get MOEA Framework at SourceForge.net. Fast, secure and Free Open Source software downloads