Class Linear
java.lang.Object
org.jacop.constraints.DecomposedConstraint<Constraint>
org.jacop.constraints.Constraint
org.jacop.constraints.PrimitiveConstraint
org.jacop.floats.constraints.linear.Linear
- All Implemented Interfaces:
SatisfiedPresent
,StoreAware
,UsesQueueVariable
- Direct Known Subclasses:
LinearFloat
Linear constraint implements the weighted summation over several
Variable's . It provides the weighted sum from all Variable's on the list.
The weights must be positive integers.
- Version:
- 4.9
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static class
Linear.VarWeightComparator<T extends VariableNode>
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final byte
Defines relationsstatic final byte
Defines relationsstatic final byte
Defines relations(package private) static AtomicInteger
static final byte
Defines relations(package private) BTree
FloatVar[]
It specifies a list of variables being summed.static final byte
Defines relationsstatic 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
double
It specifies variable for the overall sum.(package private) SimpleHashSet
<FloatVar> (package private) Map
<FloatVar, VariableNode> double[]
It specifies a list of weights associated with the variables being summed.Fields inherited from class org.jacop.constraints.PrimitiveConstraint
notConsistencyPruningEvents
Fields inherited from class org.jacop.constraints.Constraint
atomicExecution, consistencyPruningEvents, constraintScope, earlyTerminationOK, increaseWeight, numberId, scope, trace
Fields inherited from class org.jacop.constraints.DecomposedConstraint
queueIndex
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) RootBNode
buildBinaryTree
(BinaryNode[] nodes) (package private) void
private void
commonInitialization
(Store store, FloatVar[] list, double[] weights, String rel, double sum) void
consistency
(Store store) It is a (most probably incomplete) consistency function which removes the values from variables domains.private boolean
entailed
(byte rel) 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.(package private) void
propagate
(SimpleHashSet<FloatVar> fdvs) private void
void
queueVariable
(int level, Var var) This is a function called to indicate which variable in a scope of constraint has changed.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, removeConstraint, requiresMonotonicity, setConsistencyPruningEvent, setConstraintScope, setScope, setScope, setScope, setScope, setScope, setWatchedVariableGrounded, supplyGuideFeedback, 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
-
eq
public static final byte eqDefines relations- See Also:
-
lt
public static final byte ltDefines relations- See Also:
-
le
public static final byte leDefines relations- See Also:
-
ne
public static final byte neDefines relations- See Also:
-
gt
public static final byte gtDefines relations- See Also:
-
ge
public 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 -
list
It specifies a list of variables being summed. -
weights
public double[] weightsIt specifies a list of weights associated with the variables being summed. -
sum
public double sumIt specifies variable for the overall sum. -
varMap
Map<FloatVar,VariableNode> varMap -
variableQueue
SimpleHashSet<FloatVar> variableQueue -
reified
boolean reified -
linearTree
BTree linearTree -
noSat
-
-
Constructor Details
-
Linear
- 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.
-
Linear
- Parameters:
store
- current storelist
- variables which are being multiplied by weights.weights
- weight for each variable.rel
- the relation, one of "==", "<", ">", "<=", ">=", "!="sum
- variable containing the sum of weighted variables.
-
Linear
public Linear(Store store, List<? extends FloatVar> variables, List<Double> weights, String rel, double sum) It constructs the constraint Linear.- Parameters:
store
- current storevariables
- variables which are being multiplied by weights.weights
- weight for each variable.rel
- the relation, one of "==", "<", ">", "<=", ">="sum
- variable containing the sum of weighted variables.
-
-
Method Details
-
commonInitialization
-
buildBinaryTree
-
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.
-
pruneRelation
private void pruneRelation() -
propagate
-
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.
-
queueVariable
Description copied from class:Constraint
This is a function called to indicate which variable in a scope of constraint has changed. It also indicates a store level at which the change has occurred.- Overrides:
queueVariable
in classConstraint
- Parameters:
level
- the level of the store at which the change has occurred.var
- variable which has changed.
-
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.
- Specified by:
satisfied
in interfaceSatisfiedPresent
- 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) -
checkForOverflow
void checkForOverflow() -
relation
-
rel2String
-
toString
Description copied from class:Constraint
It produces a string representation of a constraint state.- Overrides:
toString
in classConstraint
-