Package org.jacop.constraints
Class Assignment
- java.lang.Object
-
- org.jacop.constraints.DecomposedConstraint<Constraint>
-
- org.jacop.constraints.Constraint
-
- org.jacop.constraints.Assignment
-
- All Implemented Interfaces:
SatisfiedPresent
,Stateful
,UsesQueueVariable
public class Assignment extends Constraint implements UsesQueueVariable, Stateful, SatisfiedPresent
Assignment constraint implements facility to improve channeling constraints between dual viewpoints of permutation models. It enforces the relationship x[d[i]-shiftX]=i+shiftD and d[x[i]-shiftD]=i+shiftX.- Version:
- 4.7
-
-
Field Summary
Fields Modifier and Type Field Description IntVar[]
d
It specifies a list of variables d.(package private) java.util.Map<IntVar,java.lang.Integer>
ds
(package private) boolean
firstConsistencyCheck
(package private) int
firstConsistencyLevel
(package private) static java.util.concurrent.atomic.AtomicInteger
idNumber
(package private) IntervalDomain
rangeD
(package private) IntervalDomain
rangeX
int
shiftD
It specifies a shift applied to variables d.int
shiftX
It specifies a shift applied to variables x.(package private) java.util.LinkedHashSet<IntVar>
variableQueue
IntVar[]
x
It specifies a list of variables x.(package private) java.util.Map<IntVar,java.lang.Integer>
xs
-
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 Constructor Description Assignment(java.util.List<? extends IntVar> xs, java.util.List<? extends IntVar> ds)
It constructs an Assignment constraint with shift equal 0.Assignment(java.util.List<? extends IntVar> xs, java.util.List<? extends IntVar> ds, int shiftX, int shiftD)
It enforces the relationship x[d[i]-shiftX]=i+shiftD and d[x[i]-shiftD]=i+shiftX.Assignment(java.util.List<? extends Var> xs, java.util.List<? extends Var> ds, int min)
It enforces the relationship x[d[i]-min]=i+min and d[x[i]-min]=i+min.Assignment(IntVar[] xs, IntVar[] ds)
It constructs an Assignment constraint with shift equal 0.Assignment(IntVar[] xs, IntVar[] ds, int min)
It enforces the relationship x[d[i]-min]=i+min and d[x[i]-min]=i+min.Assignment(IntVar[] xs, IntVar[] ds, int shiftX, int shiftD)
It enforces the relationship x[d[i]-shiftX]=i+shiftD and d[x[i]-shiftD]=i+shiftX.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
consistency(Store store)
It is a (most probably incomplete) consistency function which removes the values from variables domains.int
getDefaultConsistencyPruningEvent()
void
impose(Store store)
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.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
satisfied()
It checks if the constraint is satisfied.java.lang.String
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 Detail
-
idNumber
static final java.util.concurrent.atomic.AtomicInteger idNumber
-
d
public final IntVar[] d
It specifies a list of variables d.
-
shiftD
public int shiftD
It specifies a shift applied to variables d.
-
ds
java.util.Map<IntVar,java.lang.Integer> ds
-
x
public IntVar[] x
It specifies a list of variables x.
-
shiftX
public int shiftX
It specifies a shift applied to variables x.
-
xs
java.util.Map<IntVar,java.lang.Integer> xs
-
variableQueue
java.util.LinkedHashSet<IntVar> variableQueue
-
firstConsistencyCheck
boolean firstConsistencyCheck
-
firstConsistencyLevel
int firstConsistencyLevel
-
rangeX
IntervalDomain rangeX
-
rangeD
IntervalDomain rangeD
-
-
Constructor Detail
-
Assignment
public Assignment(IntVar[] xs, IntVar[] ds, int shiftX, int shiftD)
It enforces the relationship x[d[i]-shiftX]=i+shiftD and d[x[i]-shiftD]=i+shiftX.- Parameters:
xs
- array of variables xds
- array of variables dshiftX
- a shift of indexes in X array.shiftD
- a shift of indexes in D array.
-
Assignment
public Assignment(java.util.List<? extends IntVar> xs, java.util.List<? extends IntVar> ds, int shiftX, int shiftD)
It enforces the relationship x[d[i]-shiftX]=i+shiftD and d[x[i]-shiftD]=i+shiftX.- Parameters:
xs
- arraylist of variables xds
- arraylist of variables dshiftX
- shift for parameter xsshiftD
- shift for parameter ds
-
Assignment
public Assignment(java.util.List<? extends IntVar> xs, java.util.List<? extends IntVar> ds)
It constructs an Assignment constraint with shift equal 0. It enforces relation - d[x[j]] = i and x[d[i]] = j.- Parameters:
xs
- arraylist of x variablesds
- arraylist of d variables
-
Assignment
public Assignment(java.util.List<? extends Var> xs, java.util.List<? extends Var> ds, int min)
It enforces the relationship x[d[i]-min]=i+min and d[x[i]-min]=i+min.- Parameters:
xs
- arraylist of variables xds
- arraylist of variables dmin
- shift
-
Assignment
public Assignment(IntVar[] xs, IntVar[] ds)
It constructs an Assignment constraint with shift equal 0. It enforces relation - d[x[i]] = i and x[d[i]] = i.- Parameters:
xs
- array of x variablesds
- array of d variables
-
-
Method Detail
-
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
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 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.
-
getDefaultConsistencyPruningEvent
public int getDefaultConsistencyPruningEvent()
- Specified by:
getDefaultConsistencyPruningEvent
in classConstraint
-
impose
public void impose(Store store)
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
public void queueVariable(int level, Var var)
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.
-
toString
public java.lang.String toString()
Description copied from class:Constraint
It produces a string representation of a constraint state.- Overrides:
toString
in classConstraint
-
-