Package org.jacop.set.constraints
Class XeqA
- java.lang.Object
-
- org.jacop.constraints.DecomposedConstraint<Constraint>
-
- org.jacop.constraints.Constraint
-
- org.jacop.constraints.PrimitiveConstraint
-
- org.jacop.set.constraints.XeqA
-
- All Implemented Interfaces:
SatisfiedPresent
,StoreAware
public class XeqA extends PrimitiveConstraint
It creates a constraint that makes sure that the value assigned to the integer variable x is the only element of the set assigned to a set variable a.- Version:
- 4.8
-
-
Field Summary
Fields Modifier and Type Field Description SetVar
a
It specifies variable b.(package private) static java.util.concurrent.atomic.AtomicInteger
idNumber
IntVar
x
It specifies variable a.-
Fields inherited from class org.jacop.constraints.PrimitiveConstraint
notConsistencyPruningEvents
-
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
-
-
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
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.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, impose, include, setNotConsistencyPruningEvent
-
Methods inherited from class org.jacop.constraints.Constraint
afc, arguments, cleanAfterFailure, decompose, getGuideConstraint, getGuideValue, getGuideVariable, grounded, grounded, id, impose, imposeDecomposition, increaseWeight, intArrayToString, numberArgs, queueVariable, 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
-
-
-
-
Constructor Detail
-
XeqA
public XeqA(IntVar x, SetVar a)
It constructs an XeqA constraint to restrict the domain of the integer variables x and set variable a.- Parameters:
x
- variable x that is restricted to be the only element of a set assigned to set variable a.a
- set variable that must be equal to a set containing only one element as specified by integer variable x.
-
-
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.
-
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.
-
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.
-
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.
-
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.
- Returns:
- true if constraint is possible to verify that it is satisfied.
-
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
-
toString
public java.lang.String toString()
Description copied from class:Constraint
It produces a string representation of a constraint state.- Overrides:
toString
in classConstraint
-
-