Package org.jacop.constraints
Class OrBoolVector
java.lang.Object
org.jacop.constraints.DecomposedConstraint<Constraint>
org.jacop.constraints.Constraint
org.jacop.constraints.PrimitiveConstraint
org.jacop.constraints.OrBoolVector
- All Implemented Interfaces:
SatisfiedPresent
,StoreAware
If at least one variable from the list is equal 1 then result variable is equal 1 too.
Otherwise, result variable is equal to zero.
It restricts the domain of all x as well as result to be between 0 and 1.
- Version:
- 4.9
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) List<Constraint>
(package private) static AtomicInteger
(package private) final int
It specifies the length of the list of variables.IntVar[]
It specifies a list of variables among which one must be equal to 1 to set result variable to 1.It specifies variable result, storing the result of or function performed a list of variables.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
ConstructorsConstructorDescriptionOrBoolVector
(List<? extends IntVar> list, IntVar result) It constructs orBool.OrBoolVector
(IntVar[] list, IntVar result) It constructs orBool. -
Method Summary
Modifier and TypeMethodDescriptionIt checks invariants required by the constraint.void
consistency
(Store store) It is a (most probably incomplete) consistency function which removes the values from variables domains.It returns an array list of constraint which are used to decompose this constraint.int
protected int
protected int
protected int
void
imposeDecomposition
(Store store) It imposes the decomposition of the given constraint in a given store.void
It provide store for constraints that are not imposed but called from other constraints.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.boolean
It checks if the constraint is satisfied.private void
swap
(int i, int j) toString()
It produces a string representation of a constraint state.Methods inherited from class org.jacop.constraints.PrimitiveConstraint
getNestedPruningEvent, getNotConsistencyPruningEvent, impose, setNotConsistencyPruningEvent
Methods inherited from class org.jacop.constraints.Constraint
afc, arguments, cleanAfterFailure, getConsistencyPruningEvent, getGuideConstraint, getGuideValue, getGuideVariable, grounded, grounded, id, impose, increaseWeight, intArrayToString, long2int, numberArgs, queueVariable, 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
-
list
It specifies a list of variables among which one must be equal to 1 to set result variable to 1. -
result
It specifies variable result, storing the result of or function performed a list of variables. -
l
final int lIt specifies the length of the list of variables. -
position
-
constraints
List<Constraint> constraints
-
-
Constructor Details
-
OrBoolVector
It constructs orBool.- Parameters:
list
- list of x's which one of them must be equal 1 to make result equal 1.result
- variable which is equal 0 if none of x is equal to zero.
-
OrBoolVector
It constructs orBool.- Parameters:
list
- list of x's which one of them must be equal 1 to make result equal 1.result
- variable which is equal 0 if none of x is equal to zero.
-
-
Method Details
-
checkInvariants
It checks invariants required by the constraint. Namely that boolean variables have boolean domain.- Returns:
- the string describing the violation of the invariant, null otherwise.
-
getDefaultNestedNotConsistencyPruningEvent
protected int getDefaultNestedNotConsistencyPruningEvent()- Overrides:
getDefaultNestedNotConsistencyPruningEvent
in classPrimitiveConstraint
-
getDefaultNestedConsistencyPruningEvent
protected int getDefaultNestedConsistencyPruningEvent()- Overrides:
getDefaultNestedConsistencyPruningEvent
in classPrimitiveConstraint
-
getDefaultConsistencyPruningEvent
public int getDefaultConsistencyPruningEvent()- Specified by:
getDefaultConsistencyPruningEvent
in classConstraint
-
getDefaultNotConsistencyPruningEvent
protected int getDefaultNotConsistencyPruningEvent()- Specified by:
getDefaultNotConsistencyPruningEvent
in classPrimitiveConstraint
-
include
Description copied from interface:StoreAware
It provide store for constraints that are not imposed but called from other constraints.- Specified by:
include
in interfaceStoreAware
- Overrides:
include
in classPrimitiveConstraint
- Parameters:
store
- the constraint store in which context the constraint is executed.
-
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.
-
swap
private void swap(int i, int j) -
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.
-
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.
-
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
Description copied from class:Constraint
It produces a string representation of a constraint state.- Overrides:
toString
in classConstraint
-
decompose
Description copied from class:Constraint
It returns an array list of constraint which are used to decompose this constraint. It actually creates a decomposition (possibly also creating variables), but it does not impose the constraint.- Overrides:
decompose
in classConstraint
- Parameters:
store
- the constraint store in which context the decomposition takes place.- Returns:
- an array list of constraints used to decompose this constraint.
-
imposeDecomposition
Description copied from class:Constraint
It imposes the decomposition of the given constraint in a given store.- Overrides:
imposeDecomposition
in classConstraint
- Parameters:
store
- the constraint store to which the constraint is imposed to.
-