Package org.jacop.constraints
Class SumInt
java.lang.Object
org.jacop.constraints.DecomposedConstraint<Constraint>
org.jacop.constraints.Constraint
org.jacop.constraints.PrimitiveConstraint
org.jacop.constraints.SumInt
- All Implemented Interfaces:
SatisfiedPresent
,StoreAware
SumInt constraint implements the summation over several variables.
sum(i in 1..N)(xi) = sum
It provides the sum from all variables on the list.
This implementaiton is based on "Bounds Consistency Techniques for Long Linear Constraints" by Warwick Harvey and Joachim Schimpf
- Version:
- 4.9
-
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) int
(package private) long[]
It specifies "variability" of each variable(package private) static 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) long
It specifies sum of lower bounds (min values) and sum of upper bounds (max values)(package private) long
It specifies sum of lower bounds (min values) and sum of upper bounds (max values)(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 SumInt.Deprecated.SumInt constraint does not use Store parameter any longer.Deprecated.SumInt constraint does not use Store parameter any longer. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
void
consistency
(Store store) It is a (most probably incomplete) consistency function which removes the values from variables domains.private boolean
entailed
(int rel) int
protected int
protected int
protected int
It specifies a constraint which if imposed by search will enhance propagation of this constraint.int
This function provides a value which if assigned to a variable returned by getGuideVariable() will enhance propagation of this constraint.This function provides a variable which assigned a value returned by will enhance propagation of this constraint.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.void
propagate
(int rel) private void
pruneGtEq
(long b) private void
pruneLtEq
(long b) private boolean
private boolean
private boolean
private void
pruneNeq()
byte
boolean
It checks if the constraint is satisfied.boolean
boolean
satisfiedGtEq
(int b) boolean
satisfiedLtEq
(int b) boolean
void
supplyGuideFeedback
(boolean feedback) This function allows to provide a guide feedback.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, 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 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. -
I
long[] IIt specifies "variability" of each variable -
sumXmin
long sumXminIt specifies sum of lower bounds (min values) and sum of upper bounds (max values) -
sumXmax
long sumXmaxIt specifies sum of lower bounds (min values) and sum of upper bounds (max values) -
guideValue
int guideValue
-
-
Constructor Details
-
SumInt
Deprecated.SumInt 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.
-
SumInt
Deprecated.SumInt constraint does not use Store parameter any longer.It constructs the constraint SumInt.- Parameters:
store
- current storevariables
- variables which are being multiplied by weights.rel
- the relation, one of "==", "<", ">", "<=", ">=", "!="sum
- variable containing the sum of weighted variables.
-
SumInt
- Parameters:
list
- variables which are being multiplied by weights.rel
- the relation, one of "==", "<", ">", "<=", ">=", "!="sum
- variable containing the sum of weighted variables.
-
SumInt
It constructs the constraint SumInt.- 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.
-
propagate
public void propagate(int rel) -
getDefaultConsistencyPruningEvent
public int getDefaultConsistencyPruningEvent()- Specified by:
getDefaultConsistencyPruningEvent
in classConstraint
-
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
-
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.
-
computeInit
private void computeInit() -
pruneLtEq
private void pruneLtEq(long b) -
pruneGtEq
private void pruneGtEq(long b) -
pruneNeq
private void pruneNeq() -
pruneMin
-
pruneMax
-
pruneNe
-
satisfiedEq
public boolean satisfiedEq() -
satisfiedNeq
public boolean satisfiedNeq() -
satisfiedLtEq
public boolean satisfiedLtEq(int b) -
satisfiedGtEq
public boolean satisfiedGtEq(int b) -
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(int rel) -
relation
-
rel2String
-
toString
Description copied from class:Constraint
It produces a string representation of a constraint state.- Overrides:
toString
in classConstraint
-
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
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.
-