Package org.jacop.constraints
Class SumBool
java.lang.Object
org.jacop.constraints.DecomposedConstraint<Constraint>
org.jacop.constraints.Constraint
org.jacop.constraints.PrimitiveConstraint
org.jacop.constraints.SumBool
- All Implemented Interfaces:
SatisfiedPresent
,StoreAware
SumBool constraint implements the summation over several
0/1 variables.
sum(i in 1..N)(xi) = sum
It provides the sum from all variables on the list.
- Version:
- 4.8
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) static final byte
Defines relations(package private) static final byte
Defines relations(package private) static final byte
Defines relations(package private) static final AtomicInteger
(package private) int
It specifies the number of variables.(package private) static final byte
Defines relations(package private) static final byte
Defines relations(package private) static final byte
Defines relations(package private) static final byte[]
Defines negated relations(package private) boolean
byte
It specifies what relations is used by this constraint(package private) Store
(package private) IntVar
It specifies variable for the overall sum.(package private) IntVar[]
It specifies a list of variables being summed.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
ConstructorsConstructorDescriptionIt constructs the constraint SumBool.Deprecated.SumBool constraint does not use Store parameter any longer.Deprecated.SumBool constraint does not use Store parameter any longer. -
Method Summary
Modifier and TypeMethodDescriptionvoid
consistency
(Store store) It is a (most probably incomplete) consistency function which removes the values from variables domains.private boolean
entailed
(byte rel) (package private) IntVar[]
filterAndOverflow
(IntVar[] x) int
protected int
protected int
protected int
void
It imposes the constraint in a given store.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.private void
prune
(byte rel) byte
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
getNestedPruningEvent, getNotConsistencyPruningEvent, 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, 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
-
store
Store store -
idNumber
-
reified
boolean reified -
eq
static final byte eqDefines relations- See Also:
-
le
static final byte leDefines relations- See Also:
-
lt
static final byte ltDefines relations- See Also:
-
ne
static final byte neDefines relations- See Also:
-
gt
static final byte gtDefines relations- See Also:
-
ge
static final byte geDefines relations- See Also:
-
negRel
static final byte[] negRelDefines negated relations -
relationType
public byte relationTypeIt specifies what relations is used by this constraint -
x
IntVar[] xIt specifies a list of variables being summed. -
sum
IntVar sumIt specifies variable for the overall sum. -
l
int lIt specifies the number of variables.
-
-
Constructor Details
-
SumBool
Deprecated.SumBool constraint does not use Store parameter any longer.- Parameters:
store
- current storelist
- variables which are being multiplied by weights.rel
- the relation, one of "==", "<", ">", "<=", ">=", "!="sum
- variable containing the sum of weighted variables.
-
SumBool
Deprecated.SumBool constraint does not use Store parameter any longer.It constructs the constraint SumBool.- Parameters:
store
- current storevariables
- variables which are being multiplied by weights.rel
- the relation, one of "==", "<", ">", "<=", ">=", "!="sum
- variable containing the sum of weighted variables.
-
SumBool
- Parameters:
list
- variables which are being multiplied by weights.rel
- the relation, one of "==", "<", ">", "<=", ">=", "!="sum
- variable containing the sum of weighted variables.
-
SumBool
It constructs the constraint SumBool.- Parameters:
variables
- variables which are being multiplied by weights.rel
- the relation, one of "==", "<", ">", "<=", ">=", "!="sum
- variable containing the sum of weighted variables.
-
-
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.
-
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.
-
prune
private void prune(byte rel) -
getDefaultConsistencyPruningEvent
public int getDefaultConsistencyPruningEvent()- Specified by:
getDefaultConsistencyPruningEvent
in classConstraint
-
getDefaultNestedNotConsistencyPruningEvent
protected int getDefaultNestedNotConsistencyPruningEvent()- Overrides:
getDefaultNestedNotConsistencyPruningEvent
in classPrimitiveConstraint
-
getDefaultNestedConsistencyPruningEvent
protected int getDefaultNestedConsistencyPruningEvent()- Overrides:
getDefaultNestedConsistencyPruningEvent
in classPrimitiveConstraint
-
getDefaultNotConsistencyPruningEvent
protected int getDefaultNotConsistencyPruningEvent()- Specified by:
getDefaultNotConsistencyPruningEvent
in classPrimitiveConstraint
-
impose
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.
- 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.
-
entailed
private boolean entailed(byte rel) -
relation
-
rel2String
-
filterAndOverflow
-
toString
Description copied from class:Constraint
It produces a string representation of a constraint state.- Overrides:
toString
in classConstraint
-