Package org.jacop.constraints
Class In
- java.lang.Object
-
- All Implemented Interfaces:
SatisfiedPresent
,StoreAware
public class In extends PrimitiveConstraint
Constraints X to belong to a specified domain.Domain consistency is used.
- Version:
- 4.8
-
-
Field Summary
Fields Modifier and Type Field Description IntDomain
dom
It specifies domain d which restricts the possible value of the specified variable.private IntDomain
DomComplement
It specifies all the values which can not be taken by a variable.(package private) static java.util.concurrent.atomic.AtomicInteger
idNumber
IntVar
x
It specifies variable x whose domain must lie within a specified domain.-
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
-
-
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()
protected int
getDefaultNestedConsistencyPruningEvent()
protected int
getDefaultNestedNotConsistencyPruningEvent()
protected int
getDefaultNotConsistencyPruningEvent()
Constraint
getGuideConstraint()
It specifies a constraint which if imposed by search will enhance propagation of this constraint.int
getGuideValue()
This function provides a value which if assigned to a variable returned by getGuideVariable() will enhance propagation of this constraint.Var
getGuideVariable()
This function provides a variable which assigned a value returned by will enhance propagation of this constraint.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.void
supplyGuideFeedback(boolean feedback)
This function allows to provide a guide feedback.java.lang.String
toString()
It produces a string representation of a constraint state.-
Methods inherited from class org.jacop.constraints.PrimitiveConstraint
getNestedPruningEvent, getNotConsistencyPruningEvent, impose, include, setNotConsistencyPruningEvent
-
Methods inherited from class org.jacop.constraints.Constraint
afc, arguments, cleanAfterFailure, decompose, getConsistencyPruningEvent, grounded, grounded, id, impose, imposeDecomposition, increaseWeight, intArrayToString, long2int, numberArgs, queueVariable, removeConstraint, requiresMonotonicity, setConsistencyPruningEvent, setConstraintScope, setScope, setScope, setScope, setScope, setScope, setWatchedVariableGrounded, 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 java.util.concurrent.atomic.AtomicInteger idNumber
-
x
public IntVar x
It specifies variable x whose domain must lie within a specified domain.
-
dom
public IntDomain dom
It specifies domain d which restricts the possible value of the specified variable.
-
DomComplement
private IntDomain DomComplement
It specifies all the values which can not be taken by a variable.
-
-
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.
-
getDefaultConsistencyPruningEvent
public int getDefaultConsistencyPruningEvent()
- Specified by:
getDefaultConsistencyPruningEvent
in classConstraint
-
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.
-
getDefaultNestedConsistencyPruningEvent
protected int getDefaultNestedConsistencyPruningEvent()
- Overrides:
getDefaultNestedConsistencyPruningEvent
in classPrimitiveConstraint
-
getDefaultNestedNotConsistencyPruningEvent
protected int getDefaultNestedNotConsistencyPruningEvent()
- Overrides:
getDefaultNestedNotConsistencyPruningEvent
in classPrimitiveConstraint
-
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
-
getGuideConstraint
public Constraint getGuideConstraint()
Description copied from class:Constraint
It specifies a constraint which if imposed by search will enhance propagation of this constraint.- Overrides:
getGuideConstraint
in classConstraint
- Returns:
- Constraint enhancing propagation of this constraint.
-
getGuideValue
public int getGuideValue()
Description copied from class:Constraint
This function provides a value which if assigned to a variable returned by getGuideVariable() will enhance propagation of this constraint.- Overrides:
getGuideValue
in classConstraint
- Returns:
- Value which is a base of enhancing constraint.
-
getGuideVariable
public Var getGuideVariable()
Description copied from class:Constraint
This function provides a variable which assigned a value returned by will enhance propagation of this constraint.- Overrides:
getGuideVariable
in classConstraint
- Returns:
- Variable which is a base of enhancing constraint.
-
supplyGuideFeedback
public void supplyGuideFeedback(boolean feedback)
Description copied from class:Constraint
This function allows to provide a guide feedback. If constraint does not propose sufficiently good enhancing constraints it will be informed so it has a chance to reexamine its efforts.- Overrides:
supplyGuideFeedback
in classConstraint
- Parameters:
feedback
- true if the guide was useful, false otherwise.
-
-