org.jacop.search

Class MaxRegret<T extends IntVar>

java.lang.Object

org.jacop.search.MaxRegret<T>

Type Parameters:

T - variable of type IntVar.

All Implemented Interfaces:

ComparatorVariable<T>

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

Defines a MaxRegret comparator for Variables.

Version:

4.2

Author:

Krzysztof Kuchcinski and Radoslaw Szymanek

Constructor Summary

Constructors

Constructor and Description
MaxRegret() It constructs MaxRegret comparator.

Method Summary

Modifier and Type	Method and Description
int	compare(float ldiff, T var) It compares the baseline metric to the variable metric.
int	compare(T left, T right) It compares the metric of the left variable against the right one.
float	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

MaxRegret

public MaxRegret()

It constructs MaxRegret comparator.

Method Detail

compare

public int compare(float ldiff,
                   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:

ldiff - 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 left,
                   T right)

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:

left - left variable

right - right variable

Returns:

1 if metric for left variable is greater, 0 is they are equal, -1 if smaller.

metric

public float 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.