Package org.jacop.constraints
Class LinearInt
- java.lang.Object
-
- org.jacop.constraints.DecomposedConstraint<Constraint>
-
- org.jacop.constraints.Constraint
-
- org.jacop.constraints.PrimitiveConstraint
-
- org.jacop.constraints.LinearInt
-
- All Implemented Interfaces:
SatisfiedPresent
,StoreAware
- Direct Known Subclasses:
LinearIntDom
public class LinearInt extends PrimitiveConstraint
LinearInt constraint implements the weighted summation over several variables .sum(i in 1..N)(ai*xi) = b
It provides the weighted sum from all variables on the list. The weights are integers.
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) long[]
a
It specifies a list of weights associated with the variables being summed.(package private) long
b
It specifies variable for the overall sum.(package private) static byte
eq
Defines relations(package private) static byte
ge
Defines relations(package private) static byte
gt
Defines relations(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/coefficients.(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) int
pos
It specifies the index of the last positive coefficient.(package private) boolean
reified
byte
relationType
It specifies what relations is used by this constraint(package private) Store
store
(package private) long
sumMax
It specifies sum of lower bounds (min values) and sum of upper bounds (max values)(package private) long
sumMin
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 Modifier Constructor Description protected
LinearInt()
LinearInt(java.util.List<? extends IntVar> list, java.util.List<java.lang.Integer> weights, java.lang.String rel, int sum)
It constructs the constraint LinearInt.LinearInt(IntVar[] list, int[] weights, java.lang.String rel, int sum)
LinearInt(IntVar[] list, int[] weights, java.lang.String rel, IntVar sum)
LinearInt(Store store, java.util.List<? extends IntVar> list, java.util.List<java.lang.Integer> weights, java.lang.String rel, int sum)
Deprecated.LinearInt constraint does not use Store parameter any longer.LinearInt(Store store, IntVar[] list, int[] weights, java.lang.String rel, int sum)
Deprecated.LinearInt constraint does not use Store parameter any longer.LinearInt(Store store, IntVar[] list, int[] weights, java.lang.String rel, IntVar sum)
Deprecated.LinearInt constraint does not use Store parameter any longer.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description (package private) void
checkForOverflow()
protected void
commonInitialization(Store store, IntVar[] list, int[] weights, java.lang.String rel, int sum)
(package private) void
computeInit()
void
consistency(Store store)
It is a (most probably incomplete) consistency function which removes the values from variables domains.private long
divRoundDown(long a, long b)
private long
divRoundUp(long a, long b)
private boolean
entailed(int rel)
int
getDefaultConsistencyPruningEvent()
protected int
getDefaultNestedConsistencyPruningEvent()
protected int
getDefaultNestedNotConsistencyPruningEvent()
protected int
getDefaultNotConsistencyPruningEvent()
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)
(package private) void
pruneGtEq(long b)
(package 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, long a)
(package 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(long b)
boolean
satisfiedLtEq(long b)
boolean
satisfiedNeq()
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, 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 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.
-
a
long[] a
It specifies a list of weights associated with the variables being summed.
-
b
long b
It specifies variable for the overall sum.
-
pos
int pos
It specifies the index of the last positive coefficient.
-
l
int l
It specifies the number of variables/coefficients.
-
I
long[] I
It specifies "variability" of each variable
-
sumMin
long sumMin
It specifies sum of lower bounds (min values) and sum of upper bounds (max values)
-
sumMax
long sumMax
It specifies sum of lower bounds (min values) and sum of upper bounds (max values)
-
-
Constructor Detail
-
LinearInt
protected LinearInt()
-
LinearInt
@Deprecated public LinearInt(Store store, IntVar[] list, int[] weights, java.lang.String rel, int sum)
Deprecated.LinearInt constraint does not use Store parameter any longer.- Parameters:
store
- current storelist
- variables which are being multiplied by weights.weights
- weight for each variable.rel
- the relation, one of "==", "<", ">", "<=", ">=", "!="sum
- the sum of weighted variables.
-
LinearInt
@Deprecated public LinearInt(Store store, java.util.List<? extends IntVar> list, java.util.List<java.lang.Integer> weights, java.lang.String rel, int sum)
Deprecated.LinearInt constraint does not use Store parameter any longer.It constructs the constraint LinearInt.- Parameters:
store
- current storelist
- list which are being multiplied by weights.weights
- weight for each variable.rel
- the relation, one of "==", "<", ">", "<=", ">=", "!="sum
- the sum of weighted list.
-
LinearInt
@Deprecated public LinearInt(Store store, IntVar[] list, int[] weights, java.lang.String rel, IntVar sum)
Deprecated.LinearInt constraint does not use Store parameter any longer.- Parameters:
store
- current storelist
- variables which are being multiplied by weights.weights
- weight for each variable.rel
- the relation, one of "==", "<", ">", "<=", ">=", "!="sum
- the sum of weighted variables.
-
LinearInt
public LinearInt(IntVar[] list, int[] weights, java.lang.String rel, int sum)
- Parameters:
list
- variables which are being multiplied by weights.weights
- weight for each variable.rel
- the relation, one of "==", "<", ">", "<=", ">=", "!="sum
- the sum of weighted variables.
-
LinearInt
public LinearInt(java.util.List<? extends IntVar> list, java.util.List<java.lang.Integer> weights, java.lang.String rel, int sum)
It constructs the constraint LinearInt.- Parameters:
list
- list which are being multiplied by weights.weights
- weight for each variable.rel
- the relation, one of "==", "<", ">", "<=", ">=", "!="sum
- the sum of weighted list.
-
-
Method Detail
-
commonInitialization
protected void commonInitialization(Store store, IntVar[] list, int[] weights, java.lang.String rel, int sum)
-
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)
-
getDefaultNestedConsistencyPruningEvent
protected int getDefaultNestedConsistencyPruningEvent()
- Overrides:
getDefaultNestedConsistencyPruningEvent
in classPrimitiveConstraint
-
getDefaultNestedNotConsistencyPruningEvent
protected int getDefaultNestedNotConsistencyPruningEvent()
- Overrides:
getDefaultNestedNotConsistencyPruningEvent
in classPrimitiveConstraint
-
getDefaultConsistencyPruningEvent
public int getDefaultConsistencyPruningEvent()
- Specified by:
getDefaultConsistencyPruningEvent
in classConstraint
-
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
void computeInit()
-
pruneLtEq
void pruneLtEq(long b)
-
pruneGtEq
void pruneGtEq(long b)
-
pruneNeq
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, long a)
-
satisfiedEq
public boolean satisfiedEq()
-
satisfiedNeq
public boolean satisfiedNeq()
-
satisfiedLtEq
public boolean satisfiedLtEq(long b)
-
satisfiedGtEq
public boolean satisfiedGtEq(long 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)
-
divRoundDown
private long divRoundDown(long a, long b)
-
divRoundUp
private long divRoundUp(long a, long b)
-
relation
public byte relation(java.lang.String r)
-
rel2String
public java.lang.String rel2String()
-
checkForOverflow
void checkForOverflow()
-
toString
public java.lang.String toString()
Description copied from class:Constraint
It produces a string representation of a constraint state.- Overrides:
toString
in classConstraint
-
-