Package org.jacop.constraints
Class SumWeight
java.lang.Object
org.jacop.constraints.DecomposedConstraint<Constraint>
org.jacop.constraints.Constraint
org.jacop.constraints.SumWeight
- All Implemented Interfaces:
RemoveLevelLate
,SatisfiedPresent
,UsesQueueVariable
public class SumWeight
extends Constraint
implements UsesQueueVariable, SatisfiedPresent, RemoveLevelLate
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
protected final long
It specifies value to which SumWeight is equal to.(package private) static final AtomicInteger
protected final IntVar[]
It specifies a list of variables being summed.private long
private long[]
private long
private long[]
The position for the next grounded variable.The sum of grounded variables.(package private) LinkedHashSet<IntVar>
protected final long[]
It specifies a list of weights associated with the variables being summed.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
ConstructorsModifierConstructorDescriptionIt constructs the constraint SumWeight.SumWeight constraint implements the weighted summation over several variables.SumWeight constraint implements the weighted summation over several variables.private
-
Method Summary
Modifier and TypeMethodDescription(package private) void
void
consistency
(Store store) It is a (most probably incomplete) consistency function which removes the values from variables domains.int
void
It imposes the constraint in a given store.void
queueVariable
(int level, Var var) This is a function called to indicate which variable in a scope of constraint has changed.void
removeLevelLate
(int level) This function is called in case of the backtrack.boolean
It checks if the constraint is satisfied.toString()
It produces a string representation of a constraint state.private void
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, 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
-
idNumber
-
list
It specifies a list of variables being summed. -
weights
protected final long[] weightsIt specifies a list of weights associated with the variables being summed. -
equalTo
protected final long equalToIt specifies value to which SumWeight is equal to. -
sumGrounded
The sum of grounded variables. -
nextGroundedPosition
The position for the next grounded variable. -
variableQueue
LinkedHashSet<IntVar> variableQueue -
lMin
private long lMin -
lMax
private long lMax -
lMinArray
private long[] lMinArray -
lMaxArray
private long[] lMaxArray -
positionMaping
-
backtrackHasOccured
private boolean backtrackHasOccured
-
-
Constructor Details
-
SumWeight
SumWeight constraint implements the weighted summation over several variables.- Parameters:
list
- the list of varibalesweights
- the list of weightssum
- the resulting sum
-
SumWeight
SumWeight constraint implements the weighted summation over several variables.- Parameters:
list
- the list of varibalesweights
- the list of weightsequalTo
- the value to which SumWeight is equal to.
-
SumWeight
-
SumWeight
It constructs the constraint SumWeight.- Parameters:
variables
- variables which are being multiplied by weights.weights
- weight for each variable.sum
- variable containing the sum of weighted variables.
-
-
Method Details
-
removeLevelLate
public void removeLevelLate(int level) Description copied from interface:RemoveLevelLate
This function is called in case of the backtrack. It is called after all timestamps, variables, mutablevariables have reverted to their values *after* removing the level.- Specified by:
removeLevelLate
in interfaceRemoveLevelLate
- Parameters:
level
- the level which is being removed.
-
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.
-
getDefaultConsistencyPruningEvent
public int getDefaultConsistencyPruningEvent()- Specified by:
getDefaultConsistencyPruningEvent
in classConstraint
-
impose
Description copied from class:Constraint
It imposes the constraint in a given store.- Overrides:
impose
in classConstraint
- 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.
-
treatChangedVariables
private void treatChangedVariables() -
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.
-
checkForOverflow
void checkForOverflow() -
toString
Description copied from class:Constraint
It produces a string representation of a constraint state.- Overrides:
toString
in classConstraint
-