Package org.jacop.constraints
Class LexOrder
java.lang.Object
org.jacop.constraints.DecomposedConstraint<Constraint>
org.jacop.constraints.Constraint
org.jacop.constraints.LexOrder
- All Implemented Interfaces:
RemoveLevelLate
,SatisfiedPresent
,Stateful
,UsesQueueVariable
public class LexOrder
extends Constraint
implements UsesQueueVariable, Stateful, SatisfiedPresent, RemoveLevelLate
It constructs a LexOrder (lexicographical order) constraint.
The algorithm is based on paper
"Propagation algorithms for lexicographic ordering constraints" by Alan M. Frisch, Brahim Hnich, Zeynep Kiziltan, Ian Miguel, and Toby Walsh , Artificial Intelligence 170 (2006) 803-834.
- Version:
- 4.9
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private int
(package private) static final boolean
(package private) boolean
(package private) int
(package private) static AtomicInteger
(package private) SimpleHashSet<Integer>
boolean
Lex enforcing "<" relationship (true).(package private) int
size of the longest vector.boolean
(package private) boolean
private Store
IntVar[]
Two vectors that have to be lexicographically ordered.IntVar[]
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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
consistency
(Store store) It is a (most probably incomplete) consistency function which removes the values from variables domains.private boolean
eqSingletons
(IntVar x, IntVar y) protected void
private void
forceLE
(int i) private void
forceLT
(int i) int
void
It imposes the constraint in a given store.void
queueVariable
(int level, Var var) This is a function called to indicate which variable in a scope of constraint has changed.(package private) void
reestablishGAC
(int i) 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.void
removeLevelLate
(int level) This function is called in case of the backtrack.boolean
It checks if the constraint is satisfied.toString()
It produces a string representation of a constraint state.void
void
updateBeta
(int i) 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
-
idNumber
-
debug
static final boolean debug- See Also:
-
x
Two vectors that have to be lexicographically ordered. -
y
-
lexLT
public boolean lexLTLex enforcing "<" relationship (true). -
originalLexLT
public boolean originalLexLT -
n
int nsize of the longest vector. -
satisfied
boolean satisfied -
firstConsistencyCheck
boolean firstConsistencyCheck -
firstConsistencyLevel
int firstConsistencyLevel -
store
-
alpha
-
beta
-
alphaValue
private int alphaValue -
betaValue
private int betaValue -
indexQueue
SimpleHashSet<Integer> indexQueue -
varXToIndex
-
varYToIndex
-
-
Constructor Details
-
LexOrder
It creates a lexicographical order for vectors x and y,vectors x and y does not need to be of the same size. boolean lt defines if we require strict order, Lex_{<} (lt = true) or Lex_{=<} (lt = false).
- Parameters:
x
- first vector constrained by LexOrder constraint.y
- second vector constrained by LexOrder constraint.
-
LexOrder
-
-
Method Details
-
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.
-
getDefaultConsistencyPruningEvent
public int getDefaultConsistencyPruningEvent()- Specified by:
getDefaultConsistencyPruningEvent
in classConstraint
-
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.
-
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.
-
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.
-
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.
-
removeLevelLate
public void removeLevelLate(int level) Description copied from interface:RemoveLevelLate
This function is called in case of the backtrack. It is called after all timestamps, variables, mutablevariables have reverted to their values *after* removing the level.- Specified by:
removeLevelLate
in interfaceRemoveLevelLate
- Parameters:
level
- the level which is being removed.
-
toString
Description copied from class:Constraint
It produces a string representation of a constraint state.- Overrides:
toString
in classConstraint
-
establishGACInit
protected void establishGACInit() -
reestablishGAC
void reestablishGAC(int i) -
updateAlpha
public void updateAlpha() -
updateBeta
public void updateBeta(int i) -
eqSingletons
-
forceLT
private void forceLT(int i) -
forceLE
private void forceLE(int i)
-