Package org.jacop.constraints
Class ExtensionalSupportSTR
java.lang.Object
org.jacop.constraints.DecomposedConstraint<Constraint>
org.jacop.constraints.Constraint
org.jacop.constraints.ExtensionalSupportSTR
- All Implemented Interfaces:
Stateful
,UsesQueueVariable
Extensional constraint assures that one of the tuples is enforced in the
relation.
This implementation uses technique developed/improved by Christophe Lecoutre. Paper presented at CP2008. We would like to thank him for making his code available, which helped to create our own version of this algorithm.
- Version:
- 4.9
-
Field Summary
FieldsModifier and TypeFieldDescriptionboolean
It specifies if there was a backtrack and no yet consistency function execution after backtracking.(package private) static final boolean
(package private) int[]
int
Gives the position of the first tuple (in the current list) or -1 if the current list is empty.boolean
It specifies if there was no first consistency check yet.(package private) int
int
It stores the position of the first residue.Gives the first position of the eliminated tuple at a given level.(package private) static AtomicInteger
int
Gives the position of the last tuple (in the current list) or -1 if the current list is empty.int
int
It stores the position of the last residue.IntVar[]
It stores variables within this extensional constraint, order does matter.int
The number of variable-value pairs which need to have support.int
It specifies the current number of variables for which it is required to check if their values from the domains are supported.int
It specifies the number of variables for which validity check within a tuple must be performed.int[]
The number of variable-value pairs which need to have support per variable.int[]
Gives the position of the next tuple wrt the position given in index, or -1.boolean
It specifies if the tuples previously removed are re-inserted at the beginning.boolean
It specifies if the residues are moved at the beginning of the list.(package private) Store
int[]
The positions of the variables for which GAC must be checked.Gives the last position of the eliminated tuple at a given level.int[][]
int[]
The positions of the variables for which validity of any tuple must be checked.(package private) IntervalDomain[]
It specifies the mapping of the variable into its index.(package private) IndexDomainView[]
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
ConstructorsConstructorDescriptionExtensionalSupportSTR
(IntVar[] list, boolean reinsertBefore, boolean residuesBefore) Deprecated.ExtensionalSupportSTR
(IntVar[] variables, int[][] tuples) It creates an extensional constraint.ExtensionalSupportSTR
(IntVar[] list, int[][] tuples, boolean reinsertBefore, boolean residuesBefore) It constructs an extensional constraint. -
Method Summary
Modifier and TypeMethodDescriptionvoid
consistency
(Store store) It is a (most probably incomplete) consistency function which removes the values from variables domains.int
void
It imposes the constraint in a given store.void
queueVariable
(int level, Var V) This is a function called to indicate which variable in a scope of constraint has changed.void
remove
(int previous, int current) It removes the tuple which is no longer valid.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.(package private) boolean
smaller
(int[] tuple1, int[] tuple2) void
storeResidue
(int previous, int current) It moves the residue to the beginning of the list.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
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.jacop.api.Stateful
isStateful
-
Field Details
-
store
Store store -
list
It stores variables within this extensional constraint, order does matter. -
tuples
public int[][] tuples -
idNumber
-
debugAll
static final boolean debugAll- See Also:
-
views
IndexDomainView[] views -
first
public int firstGives the position of the first tuple (in the current list) or -1 if the current list is empty. -
last
public int lastGives the position of the last tuple (in the current list) or -1 if the current list is empty. -
nexts
public int[] nextsGives the position of the next tuple wrt the position given in index, or -1. -
headsOfEliminatedTuples
Gives the first position of the eliminated tuple at a given level. -
tailsOfEliminatedTuples
Gives the last position of the eliminated tuple at a given level. -
nbGlobalValuesToBeSupported
public int nbGlobalValuesToBeSupportedThe number of variable-value pairs which need to have support. -
nbValuesToBeSupported
public int[] nbValuesToBeSupportedThe number of variable-value pairs which need to have support per variable. -
firstResidue
public int firstResidueIt stores the position of the first residue. -
lastResidue
public int lastResidueIt stores the position of the last residue. -
nbValidityVariables
public int nbValidityVariablesIt specifies the number of variables for which validity check within a tuple must be performed. -
validityVariablePositions
public int[] validityVariablePositionsThe positions of the variables for which validity of any tuple must be checked. -
nbSupportsVariables
public int nbSupportsVariablesIt specifies the current number of variables for which it is required to check if their values from the domains are supported. -
supportsVariablePositions
public int[] supportsVariablePositionsThe positions of the variables for which GAC must be checked. It does not contain variables which were singletons in previous invocation of the consistency function. -
valuesInFocus
IntervalDomain[] valuesInFocus -
domainSizeAfterConsistency
int[] domainSizeAfterConsistency -
varToIndex
It specifies the mapping of the variable into its index. -
lastAssignedVariablePosition
public int lastAssignedVariablePosition -
reinsertBefore
public boolean reinsertBeforeIt specifies if the tuples previously removed are re-inserted at the beginning. -
residuesBefore
public boolean residuesBeforeIt specifies if the residues are moved at the beginning of the list. -
firstConsistencyCheck
public boolean firstConsistencyCheckIt specifies if there was no first consistency check yet. -
firstConsistencyLevel
int firstConsistencyLevel -
backtrackOccured
public boolean backtrackOccuredIt specifies if there was a backtrack and no yet consistency function execution after backtracking.
-
-
Constructor Details
-
ExtensionalSupportSTR
@Deprecated public ExtensionalSupportSTR(IntVar[] list, boolean reinsertBefore, boolean residuesBefore) Deprecated.Partial constructor which stores variables involved in a constraint but does not get information about tuples yet. The tuples must set separately.- Parameters:
list
- the variables in the scope of the constraint.reinsertBefore
- it specifies if the tuples which were removed and are reinstatiated are inserted at the beginning.residuesBefore
- it specifies if the residue tuples are moved to the beginning.
-
ExtensionalSupportSTR
public ExtensionalSupportSTR(IntVar[] list, int[][] tuples, boolean reinsertBefore, boolean residuesBefore) It constructs an extensional constraint.- Parameters:
list
- the variables in the scope of the constraint.tuples
- the tuples which are supports.reinsertBefore
- it specifies if the tuples which were removed and are reinstatiated are inserted at the beginning.residuesBefore
- it specifies if the residue tuples are moved to the beginning.
-
ExtensionalSupportSTR
It creates an extensional constraint.- Parameters:
variables
- the variables in the scope of the constraint.tuples
- the support tuples.
-
-
Method Details
-
remove
public void remove(int previous, int current) It removes the tuple which is no longer valid.- Parameters:
previous
- the tuple pointing at removed tuple.current
- the removed tuple.
-
storeResidue
public void storeResidue(int previous, int current) It moves the residue to the beginning of the list.- Parameters:
previous
- the tuple pointing at tuple residue.current
- the residue tuple.
-
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.
-
getDefaultConsistencyPruningEvent
public int getDefaultConsistencyPruningEvent()- Specified by:
getDefaultConsistencyPruningEvent
in classConstraint
-
impose
Description copied from class:Constraint
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.V
- variable which has changed.
-
smaller
boolean smaller(int[] tuple1, int[] tuple2) -
toString
Description copied from class:Constraint
It produces a string representation of a constraint state.- Overrides:
toString
in classConstraint
-