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
public class SumInt extends PrimitiveConstraint
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.7
-
-
Field Summary
Fields Modifier and Type Field Description (package private) static byte
eq
Defines relations(package private) static byte
ge
Defines relations(package private) static byte
gt
Defines relations(package private) int
guideValue
(package private) long[]
I
It specifies "variability" of each variable(package private) static java.util.concurrent.atomic.AtomicInteger
idNumber
(package private) int
l
It specifies the number of variables.(package private) static byte
le
Defines relations(package private) static byte
lt
Defines relations(package private) static byte
ne
Defines relations(package private) static byte[]
negRel
Defines negated relations(package private) boolean
reified
byte
relationType
It specifies what relations is used by this constraint(package private) Store
store
(package private) IntVar
sum
It specifies variable for the overall sum.(package private) long
sumXmax
It specifies sum of lower bounds (min values) and sum of upper bounds (max values)(package private) long
sumXmin
It specifies sum of lower bounds (min values) and sum of upper bounds (max values)(package private) IntVar[]
x
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
Constructors Constructor Description SumInt(java.util.List<? extends IntVar> variables, java.lang.String rel, IntVar sum)
It constructs the constraint SumInt.SumInt(IntVar[] list, java.lang.String rel, IntVar sum)
SumInt(Store store, java.util.List<? extends IntVar> variables, java.lang.String rel, IntVar sum)
Deprecated.SumInt constraint does not use Store parameter any longer.SumInt(Store store, IntVar[] list, java.lang.String rel, IntVar sum)
Deprecated.SumInt constraint does not use Store parameter any longer.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private void
computeInit()
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
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
impose(Store store)
It imposes the constraint in a given store.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.void
propagate(int rel)
private void
pruneGtEq(long b)
private void
pruneLtEq(long b)
private boolean
pruneMax(IntVar x, long max)
private boolean
pruneMin(IntVar x, long min)
private boolean
pruneNe(IntVar x, long min, long max)
private void
pruneNeq()
java.lang.String
rel2String()
byte
relation(java.lang.String r)
boolean
satisfied()
It checks if the constraint is satisfied.boolean
satisfiedEq()
boolean
satisfiedGtEq(int b)
boolean
satisfiedLtEq(int b)
boolean
satisfiedNeq()
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, 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
-
store
Store store
-
idNumber
static java.util.concurrent.atomic.AtomicInteger idNumber
-
reified
boolean reified
-
eq
static final byte eq
Defines relations- See Also:
- Constant Field Values
-
le
static final byte le
Defines relations- See Also:
- Constant Field Values
-
lt
static final byte lt
Defines relations- See Also:
- Constant Field Values
-
ne
static final byte ne
Defines relations- See Also:
- Constant Field Values
-
gt
static final byte gt
Defines relations- See Also:
- Constant Field Values
-
ge
static final byte ge
Defines relations- See Also:
- Constant Field Values
-
negRel
static final byte[] negRel
Defines negated relations
-
relationType
public byte relationType
It specifies what relations is used by this constraint
-
x
IntVar[] x
It specifies a list of variables being summed.
-
sum
IntVar sum
It specifies variable for the overall sum.
-
l
int l
It specifies the number of variables.
-
I
long[] I
It specifies "variability" of each variable
-
sumXmin
long sumXmin
It specifies sum of lower bounds (min values) and sum of upper bounds (max values)
-
sumXmax
long sumXmax
It specifies sum of lower bounds (min values) and sum of upper bounds (max values)
-
guideValue
int guideValue
-
-
Constructor Detail
-
SumInt
@Deprecated public SumInt(Store store, IntVar[] list, java.lang.String rel, IntVar sum)
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 public SumInt(Store store, java.util.List<? extends IntVar> variables, java.lang.String rel, IntVar sum)
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
public SumInt(IntVar[] list, java.lang.String rel, IntVar sum)
- Parameters:
list
- variables which are being multiplied by weights.rel
- the relation, one of "==", "<", ">", "<=", ">=", "!="sum
- variable containing the sum of weighted variables.
-
SumInt
public SumInt(java.util.List<? extends IntVar> variables, java.lang.String rel, IntVar sum)
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 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.
-
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.
-
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
public void impose(Store store)
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
private boolean pruneMin(IntVar x, long min)
-
pruneMax
private boolean pruneMax(IntVar x, long max)
-
pruneNe
private boolean pruneNe(IntVar x, long min, long max)
-
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
public byte relation(java.lang.String r)
-
rel2String
public java.lang.String rel2String()
-
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.
-
-