JaCoP.search
Class LargestDomain<T extends Var>

java.lang.Object
  extended by JaCoP.search.LargestDomain<T>
Type Parameters:
T - it specifies the class of the variable being used in this variable selection method.
All Implemented Interfaces:
ComparatorVariable<T>

public class LargestDomain<T extends Var>
extends java.lang.Object
implements ComparatorVariable<T>

Defines LargestDomain comparator for Variables. Variable with the largest domain has the priority.

Version:
3.1
Author:
Krzysztof Kuchcinski and Radoslaw Szymanek

Constructor Summary
LargestDomain()
          It constructs variable comparator based on the largest domain priority.
 
Method Summary
 int compare(float left, T var)
          It compares the baseline metric to the variable metric.
 int compare(T leftVar, T rightVar)
          It compares the metric of the left variable against the right one.
 float metric(T var)
          It returns the metric of the variable given according to the comparator.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LargestDomain

public LargestDomain()
It constructs variable comparator based on the largest domain priority.

Method Detail

compare

public int compare(float left,
                   T var)
Description copied from interface: ComparatorVariable
It compares the baseline metric to the variable metric.

Specified by:
compare in interface ComparatorVariable<T extends Var>
Parameters:
left - the baseline for comparison.
var - variable which is compared to baseline.
Returns:
1 if metric is larger than variable, 0 if equal, -1 if baseline is smaller.

compare

public int compare(T leftVar,
                   T rightVar)
Description copied from interface: ComparatorVariable
It compares the metric of the left variable against the right one.

Specified by:
compare in interface ComparatorVariable<T extends Var>
Parameters:
leftVar - left variable
rightVar - right variable
Returns:
1 if metric for left variable is greater, 0 is they are equal, -1 if smaller.

metric

public float metric(T var)
Description copied from interface: ComparatorVariable
It returns the metric of the variable given according to the comparator.

Specified by:
metric in interface ComparatorVariable<T extends Var>
Parameters:
var - variable for which metric is computed.
Returns:
the metric of the variable according to the comparator.