org.jacop.floats.constraints

Class Max

java.lang.Object

org.jacop.constraints.DecomposedConstraint

org.jacop.constraints.Constraint

org.jacop.floats.constraints.Max

public class Max
extends Constraint

Max constraint implements the Maximum/2 constraint. It provides the maximum variable from all variables on the list. max(list) = max.

Version:

4.2

Author:

Krzysztof Kuchcinski and Radoslaw Szymanek

Field Summary

Fields

Modifier and Type	Field and Description
FloatVar[]	list It specifies a list of variables among which a maximum value is being searched for.
FloatVar	max It specifies variable max which stores the maximum value present in the list.
static String[]	xmlAttributes It specifies the arguments required to be saved by an XML format as well as the constructor being called to recreate an object from an XML format.

Fields inherited from class org.jacop.constraints.Constraint

atomicExecution, consistencyPruningEvents, earlyTerminationOK, id, increaseWeight, numberArgs, numberId, trace

Fields inherited from class org.jacop.constraints.DecomposedConstraint

queueIndex

Constructor Summary

Constructors

Constructor and Description
Max(ArrayList<? extends FloatVar> variables, FloatVar max) It constructs max constraint.
Max(FloatVar[] list, FloatVar max) It constructs max constraint.

Method Summary

Modifier and Type	Method and Description
ArrayList<Var>	arguments() It returns the variables in a scope of the constraint.
void	consistency(Store store) It is a (most probably incomplete) consistency function which removes the values from variables domains.
int	getConsistencyPruningEvent(Var var) It retrieves the pruning event which causes reevaluation of the constraint.
void	impose(Store store) It imposes the constraint in a given store.
void	increaseWeight() It increases the weight of the variables in the constraint scope.
void	removeConstraint() It removes the constraint by removing this constraint from all variables.
boolean	satisfied() It checks if the constraint is satisfied.
String	toString() It produces a string representation of a constraint state.

Methods inherited from class org.jacop.constraints.Constraint

cleanAfterFailure, decompose, getGuideConstraint, getGuideValue, getGuideVariable, id, impose, imposeDecomposition, numberArgs, queueVariable, removeLevel, removeLevelLate, requiresMonotonicity, setConsistencyPruningEvent, supplyGuideFeedback

Methods inherited from class org.jacop.constraints.DecomposedConstraint

auxiliaryVariables, derivative, imposeDecomposition

Methods inherited from class java.lang.Object

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

Field Detail

list

public FloatVar[] list

It specifies a list of variables among which a maximum value is being searched for.

max

public FloatVar max

It specifies variable max which stores the maximum value present in the list.

xmlAttributes

public static String[] xmlAttributes

It specifies the arguments required to be saved by an XML format as well as the constructor being called to recreate an object from an XML format.

Constructor Detail

Max

public Max(FloatVar[] list,
           FloatVar max)

It constructs max constraint.

Parameters:

max - variable denoting the maximum value

list - the array of variables for which the maximum value is imposed.

Max

public Max(ArrayList<? extends FloatVar> variables,
           FloatVar max)

It constructs max constraint.

Parameters:

max - variable denoting the maximum value

variables - the array of variables for which the maximum value is imposed.

Method Detail

arguments

public ArrayList<Var> arguments()

Description copied from class: Constraint

It returns the variables in a scope of the constraint.

Specified by:

arguments in class Constraint

Returns:

variables in a scope of the constraint.

consistency

public void consistency(Store store)

Description copied from class: Constraint

It is a (most probably incomplete) consistency function which removes the values from variables domains. Only values which do not have any support in a solution space are removed.

Specified by:

consistency in class Constraint

Parameters:

store - constraint store within which the constraint consistency is being checked.

getConsistencyPruningEvent

public int getConsistencyPruningEvent(Var var)

Description copied from class: Constraint

It retrieves the pruning event which causes reevaluation of the constraint.

Specified by:

getConsistencyPruningEvent in class Constraint

Parameters:

var - variable for which pruning event is retrieved

Returns:

it returns the int code of the pruning event (GROUND, BOUND, ANY, NONE)

impose

public void impose(Store store)

Description copied from class: Constraint

It imposes the constraint in a given store.

Specified by:

impose in class Constraint

Parameters:

store - the constraint store to which the constraint is imposed to.

removeConstraint

public void removeConstraint()

Description copied from class: Constraint

It removes the constraint by removing this constraint from all variables.

Specified by:

removeConstraint in class Constraint

satisfied

public boolean satisfied()

Description copied from class: Constraint

It checks if the constraint is satisfied. If this function is incorrectly implemented a constraint may not be satisfied in a solution.

Specified by:

satisfied in class Constraint

Returns:

true if the constraint is for certain satisfied, false otherwise.

toString

public String toString()

Description copied from class: Constraint

It produces a string representation of a constraint state.

Specified by:

toString in class Constraint

increaseWeight

public void increaseWeight()

Description copied from class: Constraint

It increases the weight of the variables in the constraint scope.

Specified by:

increaseWeight in class Constraint