org.jacop.search

Class SmallestMin<T extends IntVar>

java.lang.Object

org.jacop.search.SmallestMin<T>

Type Parameters:

T - type of variable being used in the search.

All Implemented Interfaces:

ComparatorVariable<T>

public class SmallestMin<T extends IntVar>
extends Object
implements ComparatorVariable<T>

Defines a SmallestMin comparator for variables. It prefers variables which have smaller minimal value in their domain.

Version:

4.9

Author:

Krzysztof Kuchcinski and Radoslaw Szymanek

Constructor Summary

Constructors

Constructor and Description
SmallestMin() It constructs SmallestMin Comparator.

Method Summary

Modifier and Type	Method and Description
int	compare(double 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.
double	metric(T o) It returns the metric of the variable given according to the comparator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SmallestMin

public SmallestMin()

It constructs SmallestMin Comparator.

Method Detail

compare

public int compare(double 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 IntVar>

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 IntVar>

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 double metric(T o)

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 IntVar>

Parameters:

o - variable for which metric is computed.

Returns:

the metric of the variable according to the comparator.