Package org.jacop.constraints.table
Class SimpleTable
- java.lang.Object
-
- org.jacop.constraints.DecomposedConstraint<Constraint>
-
- org.jacop.constraints.Constraint
-
- org.jacop.constraints.table.SimpleTable
-
- All Implemented Interfaces:
SatisfiedPresent
,Stateful
,UsesQueueVariable
public class SimpleTable extends Constraint implements UsesQueueVariable, Stateful, SatisfiedPresent
SimpleTable implements the table constraint using a method presented in"Compact-Table: Efficient Filtering Table Constraints with Reversible Sparse Bit-Sets" Jordan Demeulenaere, Renaud Hartert, Christophe Lecoutre, Guillaume Perez, Laurent Perron, Jean-Charles ReĢgin, Pierre Schaus. Proc. International Conference on Principles and Practice of Constraint Programming, CP 2016. pp 207-223
- Version:
- 4.7
-
-
Field Summary
Fields Modifier and Type Field Description (package private) static boolean
debug
(package private) static java.util.concurrent.atomic.AtomicInteger
idNumber
(package private) long
mask
(package private) int
noNoGround
(package private) Store
store
(package private) java.util.Map<java.lang.Integer,java.lang.Long>[]
supports
Data specifying support tuples for each variable; static structure created once when constraint is posed.int[][]
tuple
Tuples specifying the allowed values(package private) java.util.Set<IntVar>
variableQueue
(package private) java.util.Map<IntVar,java.lang.Integer>
varMap
(package private) TimeStamp<java.lang.Long>
words
Main data structure for the constraintIntVar[]
x
Variables within the scope of table constraint-
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 Description SimpleTable(IntVar[] list, int[][] tuples)
It constructs a table constraint.SimpleTable(IntVar[] list, int[][] tuples, boolean reuseTupleArguments)
It constructs a table constraint.
-
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.(package private) void
filterDomains()
int
getDefaultConsistencyPruningEvent()
void
impose(Store store)
It imposes the constraint in a given store.(package private) boolean
intersectWithMask()
void
queueVariable(int level, Var v)
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.(package private) void
updateTable(java.util.Set<IntVar> fdvs)
(package private) boolean
validTuple(int index)
-
Methods inherited from class org.jacop.constraints.Constraint
afc, arguments, cleanAfterFailure, decompose, getConsistencyPruningEvent, getGuideConstraint, getGuideValue, getGuideVariable, grounded, grounded, id, impose, imposeDecomposition, increaseWeight, intArrayToString, numberArgs, 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
-
Methods inherited from interface org.jacop.api.Stateful
isStateful
-
-
-
-
Field Detail
-
store
Store store
-
x
public IntVar[] x
Variables within the scope of table constraint
-
tuple
public int[][] tuple
Tuples specifying the allowed values
-
words
TimeStamp<java.lang.Long> words
Main data structure for the constraint
-
mask
long mask
-
varMap
java.util.Map<IntVar,java.lang.Integer> varMap
-
supports
java.util.Map<java.lang.Integer,java.lang.Long>[] supports
Data specifying support tuples for each variable; static structure created once when constraint is posed.
-
variableQueue
java.util.Set<IntVar> variableQueue
-
noNoGround
int noNoGround
-
idNumber
static java.util.concurrent.atomic.AtomicInteger idNumber
-
debug
static final boolean debug
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
SimpleTable
public SimpleTable(IntVar[] list, int[][] tuples)
It constructs a table constraint.- Parameters:
list
- the variables in the scope of the constraint.tuples
- the tuples which define alloed values.
-
SimpleTable
public SimpleTable(IntVar[] list, int[][] tuples, boolean reuseTupleArguments)
It constructs a table constraint.- Parameters:
list
- the variables in the scope of the constraint.tuples
- the tuples which define allowed values.reuseTupleArguments
- specifies if the tuples argument should be used directly without copying.
-
-
Method Detail
-
validTuple
boolean validTuple(int index)
-
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.
-
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.
-
updateTable
void updateTable(java.util.Set<IntVar> fdvs)
-
intersectWithMask
boolean intersectWithMask()
-
filterDomains
void filterDomains()
-
queueVariable
public void queueVariable(int level, Var v)
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.
-
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.
-
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.
-
toString
public java.lang.String toString()
Description copied from class:Constraint
It produces a string representation of a constraint state.- Overrides:
toString
in classConstraint
-
-