Package org.jacop.constraints
Class ElementInteger
java.lang.Object
org.jacop.constraints.DecomposedConstraint<Constraint>
org.jacop.constraints.Constraint
org.jacop.constraints.ElementInteger
- All Implemented Interfaces:
SatisfiedPresent
,Stateful
,UsesQueueVariable
public class ElementInteger
extends Constraint
implements UsesQueueVariable, Stateful, SatisfiedPresent
ElementInteger constraint defines a relation
list[index - indexOffset] = value.
The first element of the list corresponds to index - indexOffset = 1. By default indexOffset is equal 0 so first value within a list corresponds to index equal 1.
If index has a domain from 0 to list.length-1 then indexOffset has to be equal -1 to make addressing of list array starting from 1.
- Version:
- 4.10
-
Field Summary
FieldsModifier and TypeFieldDescriptionfinal boolean
It specifies whether duplicate values should be treated specially (combined to a single check).It holds information about the positions within list array that are equal.(package private) IntDomain
(package private) boolean
(package private) int
(package private) static AtomicInteger
It specifies variable index within an element constraint list[index-indexOffset] = value.(package private) boolean
It specifies for each value what are the possible values of the index variable (it takes into account indexOffset.final int
It specifies indexOffset within an element constraint list[index-indexOffset] = value.(package private) static final int
It specifies the maximal size of index domain when the constraint will apply domain consistency for value.int[]
It specifies list of variables within an element constraint list[index-indexOffset] = value.(package private) static final int
It specifies the minimal size of number of duplicated values on the list that are consodered together..It specifies variable value within an element constraint list[index-indexOffset] = value.(package private) boolean
Fields inherited from class org.jacop.constraints.Constraint
afcWeight, atomicExecution, consistencyPruningEvents, constraintScope, earlyTerminationOK, increaseWeight, numberId, scope, trace, watchedVariableGrounded
Fields inherited from class org.jacop.constraints.DecomposedConstraint
queueIndex
-
Constructor Summary
ConstructorsConstructorDescriptionElementInteger
(IntVar index, int[] list, IntVar value) It constructs an element constraint with indexOffset by default set to 0.ElementInteger
(IntVar index, int[] list, IntVar value, int indexOffset) It constructs an element constraint.ElementInteger
(IntVar index, int[] list, IntVar value, int indexOffset, boolean checkDuplicates) It constructs an element constraint.ElementInteger
(IntVar index, List<Integer> list, IntVar value) It constructs an element constraint with default indexOffset equal 0.ElementInteger
(IntVar index, List<Integer> list, IntVar value, int indexOffset) It constructs an element constraint.ElementInteger
(IntVar index, List<Integer> list, IntVar value, int indexOffset, boolean checkDuplicates) It constructs an element constraint. -
Method Summary
Modifier and TypeMethodDescriptionvoid
consistency
(Store store) It is a (most probably incomplete) consistency function which removes the values from variables domains.(package private) boolean
int
void
It imposes the constraint in a given store.boolean
This function can be overriden by any constraint to specify dynamic conditions (based on the domain of variables at imposition level to decide if it is a stateful constraint.void
queueVariable
(int level, Var var) This is a function called to indicate which variable in a scope of constraint has changed.void
removeLevel
(int level) This function is called in case of the backtrack, so a constraint can clear the queue of changed variables which is no longer valid.boolean
It checks if the constraint is satisfied.toString()
It produces a string representation of a constraint state.Methods inherited from class org.jacop.constraints.Constraint
afc, arguments, cleanAfterFailure, decompose, getConsistencyPruningEvent, getGuideConstraint, getGuideValue, getGuideVariable, grounded, grounded, id, impose, imposeDecomposition, increaseWeight, intArrayToString, long2int, numberArgs, removeConstraint, requiresMonotonicity, setConsistencyPruningEvent, setConstraintScope, setScope, setScope, setScope, setScope, setScope, setWatchedVariableGrounded, supplyGuideFeedback, toInt, toInt, updateAFC, watchedVariableGrounded
Methods inherited from class org.jacop.constraints.DecomposedConstraint
auxiliaryVariables, checkInput, checkInput, checkInputForDuplication, checkInputForDuplicationSkipSingletons, checkInputForNullness, checkInputForNullness, checkInputForNullness, derivative, getDubletonsSkipSingletons, imposeDecomposition
-
Field Details
-
idNumber
-
firstConsistencyCheck
boolean firstConsistencyCheck -
firstConsistencyLevel
int firstConsistencyLevel -
limitForDomainPruning
static final int limitForDomainPruningIt specifies the maximal size of index domain when the constraint will apply domain consistency for value. Otherwise bound consistency is applied. This limit applies to both duplicates and index.- See Also:
-
minDuplicatesSize
static final int minDuplicatesSizeIt specifies the minimal size of number of duplicated values on the list that are consodered together.. Otherwise they are processed one by one.- See Also:
-
index
It specifies variable index within an element constraint list[index-indexOffset] = value. -
value
It specifies variable value within an element constraint list[index-indexOffset] = value. -
indexOffset
public final int indexOffsetIt specifies indexOffset within an element constraint list[index-indexOffset] = value. -
checkDuplicates
public final boolean checkDuplicatesIt specifies whether duplicate values should be treated specially (combined to a single check). In general a good idea but when lists are long it makes the process slower instead of faster. -
list
public int[] listIt specifies list of variables within an element constraint list[index-indexOffset] = value. The list is addressed by positive integers (>=1
) if indexOffset is equal to 0. -
indexHasChanged
boolean indexHasChangedIt specifies for each value what are the possible values of the index variable (it takes into account indexOffset. -
valueHasChanged
boolean valueHasChanged -
duplicates
It holds information about the positions within list array that are equal. It allows to safely skip duplicates when enumerating index domain. duplicatesIndexes is a domain having indexes of all indexes for duplicates. -
duplicatesIndexes
IntDomain duplicatesIndexes
-
-
Constructor Details
-
ElementInteger
It constructs an element constraint.- Parameters:
index
- variable indexlist
- list of integers from which an index-th element is takenvalue
- a value of the index-th element from listindexOffset
- shift applied to index variable.
-
ElementInteger
public ElementInteger(IntVar index, int[] list, IntVar value, int indexOffset, boolean checkDuplicates) It constructs an element constraint.- Parameters:
index
- variable indexlist
- list of integers from which an index-th element is takenvalue
- a value of the index-th element from listindexOffset
- shift applied to index variable.checkDuplicates
- informs whether to create duplicates list for values from list (default = true).
-
ElementInteger
It constructs an element constraint with default indexOffset equal 0.- Parameters:
index
- index variable.list
- list containing variables which one pointed out by index variable is made equal to value variable.value
- a value variable equal to the specified element from the list.
-
ElementInteger
It constructs an element constraint.- Parameters:
index
- variable indexlist
- list of integers from which an index-th element is takenvalue
- a value of the index-th element from listindexOffset
- shift applied to index variable.
-
ElementInteger
public ElementInteger(IntVar index, List<Integer> list, IntVar value, int indexOffset, boolean checkDuplicates) It constructs an element constraint.- Parameters:
index
- variable indexlist
- list of integers from which an index-th element is takenvalue
- a value of the index-th element from listindexOffset
- shift applied to index variable.checkDuplicates
- informs whether to create duplicates list for values from list (default = true).
-
ElementInteger
It constructs an element constraint with indexOffset by default set to 0.- Parameters:
index
- variable indexlist
- list of integers from which an index-th element is takenvalue
- a value of the index-th element from list
-
-
Method Details
-
removeLevel
public void removeLevel(int level) Description copied from interface:Stateful
This function is called in case of the backtrack, so a constraint can clear the queue of changed variables which is no longer valid. This function is called *before* all timestamps, variables, mutablevariables have reverted to their previous value.- Specified by:
removeLevel
in interfaceStateful
- Parameters:
level
- the level which is being removed.
-
consistency
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 classConstraint
- Parameters:
store
- constraint store within which the constraint consistency is being checked.
-
disjoint
-
getDefaultConsistencyPruningEvent
public int getDefaultConsistencyPruningEvent()- Specified by:
getDefaultConsistencyPruningEvent
in classConstraint
-
isStateful
public boolean isStateful()Description copied from interface:Stateful
This function can be overriden by any constraint to specify dynamic conditions (based on the domain of variables at imposition level to decide if it is a stateful constraint.- Specified by:
isStateful
in interfaceStateful
- Returns:
- true if constraint is stateful.
-
impose
It imposes the constraint in a given store.- Overrides:
impose
in classConstraint
- Parameters:
store
- the constraint store to which the constraint is imposed to.
-
queueVariable
Description copied from class:Constraint
This is a function called to indicate which variable in a scope of constraint has changed. It also indicates a store level at which the change has occurred.- Overrides:
queueVariable
in classConstraint
- Parameters:
level
- the level of the store at which the change has occurred.var
- variable which has changed.
-
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 interfaceSatisfiedPresent
- Returns:
- true if constraint is possible to verify that it is satisfied.
-
toString
Description copied from class:Constraint
It produces a string representation of a constraint state.- Overrides:
toString
in classConstraint
-