org.jacop.constraints

Class ArgMax

java.lang.Object

org.jacop.constraints.DecomposedConstraint<Constraint>

org.jacop.constraints.Constraint

org.jacop.constraints.ArgMax

All Implemented Interfaces:

SatisfiedPresent

public class ArgMax
extends Constraint
implements SatisfiedPresent

ArgMax constraint provides the index of the maximum variable from all variables on the list.

Version:

4.9

Author:

Krzysztof Kuchcinski and Radoslaw Szymanek

Field Summary

Fields

Modifier and Type	Field and Description
int	indexOffset It specifies indexOffset within an element constraint list[index-indexOffset] = value.
IntVar[]	list It specifies a list of variables among which a maximum value is being searched for.
IntVar	maxIndex It specifies variable max which stores the maximum value present in the list.

Fields inherited from class org.jacop.constraints.Constraint

atomicExecution, consistencyPruningEvents, constraintScope, earlyTerminationOK, increaseWeight, numberId, scope, trace

Fields inherited from class org.jacop.constraints.DecomposedConstraint

queueIndex

Constructor Summary

Constructors

Constructor and Description
ArgMax(IntVar[] list, IntVar maxIndex)
ArgMax(IntVar[] list, IntVar maxIndex, int indexOffset) It constructs max constraint.
ArgMax(List<? extends IntVar> variables, IntVar maxIndex)
ArgMax(List<? extends IntVar> variables, IntVar maxIndex, int indexOffset) It constructs max constraint.

Method Summary

Modifier and Type	Method and Description
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.
int	getDefaultConsistencyPruningEvent()
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

afc, arguments, cleanAfterFailure, decompose, getGuideConstraint, getGuideValue, getGuideVariable, grounded, grounded, id, impose, impose, imposeDecomposition, increaseWeight, intArrayToString, long2int, numberArgs, queueVariable, removeConstraint, requiresMonotonicity, setConsistencyPruningEvent, setConstraintScope, setScope, setScope, setScope, setScope, setScope, setWatchedVariableGrounded, supplyGuideFeedback, updateAFC, watchedVariableGrounded

Methods inherited from class org.jacop.constraints.DecomposedConstraint

auxiliaryVariables, checkInput, checkInput, checkInputForDuplication, checkInputForDuplicationSkipSingletons, checkInputForNullness, checkInputForNullness, checkInputForNullness, derivative, getDubletonsSkipSingletons, imposeDecomposition

Methods inherited from class java.lang.Object

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

Field Detail

list

public final IntVar[] list

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

maxIndex

public final IntVar maxIndex

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

indexOffset

public int indexOffset

It specifies indexOffset within an element constraint list[index-indexOffset] = value.

Constructor Detail

ArgMax

public ArgMax(IntVar[] list,
              IntVar maxIndex,
              int indexOffset)

It constructs max constraint.

Parameters:

maxIndex - variable denoting the index of the maximum value

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

indexOffset - the offset for the index that is computed from 1 by default (if needed from 0, use -1 for this parameter)

ArgMax

public ArgMax(IntVar[] list,
              IntVar maxIndex)

ArgMax

public ArgMax(List<? extends IntVar> variables,
              IntVar maxIndex,
              int indexOffset)

It constructs max constraint.

Parameters:

maxIndex - variable denoting index of the maximum value

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

indexOffset - the offset for the index that is computed from 1 by default (if needed from 0, use -1 for this parameter)

ArgMax

public ArgMax(List<? extends IntVar> variables,
              IntVar maxIndex)

Method Detail

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.

getDefaultConsistencyPruningEvent

public int getDefaultConsistencyPruningEvent()

Specified by:

getDefaultConsistencyPruningEvent in class Constraint

getConsistencyPruningEvent

public int getConsistencyPruningEvent(Var var)

Description copied from class: Constraint

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

Overrides:

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)

satisfied

public boolean satisfied()

Description copied from interface: SatisfiedPresent

It checks if the constraint is satisfied. It can return false even if constraint is satisfied but not all variables in its scope are grounded. It needs to return true if all variables in its scope are grounded and constraint is satisfied.

Implementations of this interface for constraints that are not PrimitiveConstraint may require constraint imposition and consistency check as a requirement to work correctly.

Specified by:

satisfied in interface SatisfiedPresent

Returns:

true if constraint is possible to verify that it is satisfied.

toString

public String toString()

Description copied from class: Constraint

It produces a string representation of a constraint state.

Overrides:

toString in class Constraint