Package org.jacop.constraints
Class Reified
- java.lang.Object
-
- org.jacop.constraints.DecomposedConstraint<Constraint>
-
- org.jacop.constraints.Constraint
-
- org.jacop.constraints.PrimitiveConstraint
-
- org.jacop.constraints.Reified
-
- All Implemented Interfaces:
SatisfiedPresent
,StoreAware
,UsesQueueVariable
public class Reified extends PrimitiveConstraint implements UsesQueueVariable
Reified constraints "constraint" <=> B- Version:
- 4.7
-
-
Field Summary
Fields Modifier and Type Field Description IntVar
b
It specifies variable b which stores status of the constraint (0 - for certain not satisfied, 1 - for certain satisfied).PrimitiveConstraint
c
It specifies constraint c which status is being checked.(package private) static java.util.concurrent.atomic.AtomicInteger
idNumber
private boolean
needRemoveLevelLate
private QueueForward<PrimitiveConstraint>
queueForward
-
Fields inherited from class org.jacop.constraints.PrimitiveConstraint
notConsistencyPruningEvents
-
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 Reified(PrimitiveConstraint c, IntVar b)
It creates Reified 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.int
getConsistencyPruningEvent(Var var)
It retrieves the pruning event which causes reevaluation of the constraint.int
getDefaultConsistencyPruningEvent()
protected int
getDefaultNotConsistencyPruningEvent()
int
getNestedPruningEvent(Var var, boolean mode)
It retrieves the pruning event for which any composed constraint which uses this constraint should be evaluated.int
getNotConsistencyPruningEvent(Var var)
It retrieves the pruning event which causes reevaluation of the constraint notConsistency() function.void
impose(Store store)
It imposes the constraint in a given store.void
notConsistency(Store store)
It makes pruning in such a way that constraint is notConsistent.boolean
notSatisfied()
It checks if constraint would be always not satisfied.void
queueVariable(int level, Var variable)
This is a function called to indicate which variable in a scope of constraint has changed.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.PrimitiveConstraint
getDefaultNestedConsistencyPruningEvent, getDefaultNestedNotConsistencyPruningEvent, include, setNotConsistencyPruningEvent
-
Methods inherited from class org.jacop.constraints.Constraint
afc, arguments, cleanAfterFailure, decompose, 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 Detail
-
idNumber
static final java.util.concurrent.atomic.AtomicInteger idNumber
-
c
public final PrimitiveConstraint c
It specifies constraint c which status is being checked.
-
b
public final IntVar b
It specifies variable b which stores status of the constraint (0 - for certain not satisfied, 1 - for certain satisfied).
-
queueForward
private final QueueForward<PrimitiveConstraint> queueForward
-
needRemoveLevelLate
private boolean needRemoveLevelLate
-
-
Constructor Detail
-
Reified
public Reified(PrimitiveConstraint c, IntVar b)
It creates Reified constraint.- Parameters:
c
- primitive constraint c.b
- boolean variable b.
-
-
Method Detail
-
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.
-
notConsistency
public void notConsistency(Store store)
Description copied from class:PrimitiveConstraint
It makes pruning in such a way that constraint is notConsistent. It removes values which always belong to a solution.- Specified by:
notConsistency
in classPrimitiveConstraint
- Parameters:
store
- the constraint store in which context the notConsistency technique is evaluated.
-
getNestedPruningEvent
public int getNestedPruningEvent(Var var, boolean mode)
Description copied from class:PrimitiveConstraint
It retrieves the pruning event for which any composed constraint which uses this constraint should be evaluated. This events are the ones which can change satisfied status?- Overrides:
getNestedPruningEvent
in classPrimitiveConstraint
- Parameters:
var
- for which pruning event is retrievedmode
- decides if pruning event for consistency or nonconsistency is required.- Returns:
- pruning event associated with the given variable for a given consistency mode.
-
getDefaultNotConsistencyPruningEvent
protected int getDefaultNotConsistencyPruningEvent()
- Specified by:
getDefaultNotConsistencyPruningEvent
in classPrimitiveConstraint
-
getConsistencyPruningEvent
public int getConsistencyPruningEvent(Var var)
Description copied from class:Constraint
It retrieves the pruning event which causes reevaluation of the constraint.- Overrides:
getConsistencyPruningEvent
in classConstraint
- Parameters:
var
- variable for which pruning event is retrieved- Returns:
- it returns the int code of the pruning event (GROUND, BOUND, ANY, NONE)
-
getDefaultConsistencyPruningEvent
public int getDefaultConsistencyPruningEvent()
- Specified by:
getDefaultConsistencyPruningEvent
in classConstraint
-
getNotConsistencyPruningEvent
public int getNotConsistencyPruningEvent(Var var)
Description copied from class:PrimitiveConstraint
It retrieves the pruning event which causes reevaluation of the constraint notConsistency() function.- Overrides:
getNotConsistencyPruningEvent
in classPrimitiveConstraint
- Parameters:
var
- for which pruning event is retrieved- Returns:
- the int denoting the pruning event associated with given variable.
-
impose
public void impose(Store store)
Description copied from class:Constraint
It imposes the constraint in a given store.- Overrides:
impose
in classPrimitiveConstraint
- Parameters:
store
- the constraint store to which the constraint is imposed to.
-
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.
-
notSatisfied
public boolean notSatisfied()
Description copied from class:PrimitiveConstraint
It checks if constraint would be always not satisfied.- Specified by:
notSatisfied
in classPrimitiveConstraint
- Returns:
- true if constraint must be notSatisfied, false otherwise.
-
toString
public java.lang.String toString()
Description copied from class:Constraint
It produces a string representation of a constraint state.- Overrides:
toString
in classConstraint
-
queueVariable
public void queueVariable(int level, Var variable)
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.variable
- variable which has changed.
-
-