Package org.jacop.constraints
Class Or
- All Implemented Interfaces:
SatisfiedPresent
,StoreAware
,UsesQueueVariable
Constraint c1 \/ c2 \/ ... \/ cn.
- Version:
- 4.8
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) static AtomicInteger
It specifies a list of constraints from which one constraint must be satisfied.private boolean
It specifies if during the consistency execution a propagation has occurred.final QueueForward<PrimitiveConstraint>
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
ConstructorsConstructorDescriptionOr
(List<PrimitiveConstraint> listOfC) It constructs Or constraint.Or
(PrimitiveConstraint[] listOfC) It constructs Or constraint.Or
(PrimitiveConstraint c1, PrimitiveConstraint c2) It constructs an Or constraint, at least one constraint has to be satisfied. -
Method Summary
Modifier and TypeMethodDescriptionvoid
consistency
(Store store) It is a (most probably incomplete) consistency function which removes the values from variables domains.int
protected int
int
getNestedPruningEvent
(Var var, boolean mode) It retrieves the pruning event for which any composed constraint which uses this constraint should be evaluated.void
notConsistency
(Store store) It makes pruning in such a way that constraint is notConsistent.boolean
It checks if constraint would be always not satisfied.void
queueVariable
(int level, Var var) This is a function called to indicate which variable in a scope of constraint has changed.boolean
It checks if the constraint is satisfied.toString()
It produces a string representation of a constraint state.Methods inherited from class org.jacop.constraints.PrimitiveConstraint
getDefaultNestedConsistencyPruningEvent, getDefaultNestedNotConsistencyPruningEvent, getNotConsistencyPruningEvent, impose, include, setNotConsistencyPruningEvent
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
-
Field Details
-
idNumber
-
listOfC
It specifies a list of constraints from which one constraint must be satisfied. -
propagation
private boolean propagationIt specifies if during the consistency execution a propagation has occurred. -
queueForward
-
-
Constructor Details
-
Or
It constructs Or constraint.- Parameters:
listOfC
- list of primitive constraints which at least one of them has to be satisfied.
-
Or
It constructs Or constraint.- Parameters:
listOfC
- list of primitive constraints which at least one of them has to be satisfied.
-
Or
It constructs an Or constraint, at least one constraint has to be satisfied.- Parameters:
c1
- the first constraint which can be satisfied.c2
- the second constraint which can be satisfied.
-
-
Method Details
-
consistency
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.
-
getNestedPruningEvent
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
-
getDefaultConsistencyPruningEvent
public int getDefaultConsistencyPruningEvent()- Specified by:
getDefaultConsistencyPruningEvent
in classConstraint
-
queueVariable
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.
-
notConsistency
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.
- Specified by:
satisfied
in interfaceSatisfiedPresent
- Returns:
- true if constraint is possible to verify that it is satisfied.
-
toString
Description copied from class:Constraint
It produces a string representation of a constraint state.- Overrides:
toString
in classConstraint
-