Package org.jacop.set.constraints
Class SumWeightedSet
- java.lang.Object
-
- org.jacop.constraints.DecomposedConstraint<Constraint>
-
- org.jacop.constraints.Constraint
-
- org.jacop.set.constraints.SumWeightedSet
-
- All Implemented Interfaces:
SatisfiedPresent
public class SumWeightedSet extends Constraint implements SatisfiedPresent
It computes a weighted sum of the elements in the domain of the given set variable. The sum must be equal to the specified sum variable.- Version:
- 4.7
-
-
Field Summary
Fields Modifier and Type Field Description SetVar
a
A set variable a whose elements contribute with their weight to the sum.(package private) java.util.Map<java.lang.Integer,java.lang.Integer>
elementWeights
It provides a quick access to the weights of given elements of the set.(package private) static java.util.concurrent.atomic.AtomicInteger
idNumber
(package private) boolean
increasingCosts
It specifies if the costs of elements are increasing given the lexical order of the elements.IntVar
totalWeight
Integer variable containing the total weight of all elements within a set variable a.-
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 Constructor Description SumWeightedSet(SetVar a, int[] elements, int[] weights, IntVar totalWeight)
It constructs a weighted set sum constraint.SumWeightedSet(SetVar a, int[] weights, IntVar totalWeight)
It constructs a weighted set sum constraint.SumWeightedSet(SetVar a, IntVar totalWeight)
It constructs a weighted set sum constraint.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
consistency(Store store)
It is a (most probably incomplete) consistency function which removes the values from variables domains.int
getConsistencyPruningEvent(Var var)
It retrieves the pruning event which causes reevaluation of the constraint.int
getDefaultConsistencyPruningEvent()
boolean
satisfied()
It checks if the constraint is satisfied.java.lang.String
toString()
It produces a string representation of a constraint state.-
Methods inherited from class org.jacop.constraints.Constraint
afc, arguments, cleanAfterFailure, decompose, getGuideConstraint, getGuideValue, getGuideVariable, grounded, grounded, id, impose, impose, imposeDecomposition, increaseWeight, intArrayToString, numberArgs, queueVariable, 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 Detail
-
idNumber
static java.util.concurrent.atomic.AtomicInteger idNumber
-
a
public SetVar a
A set variable a whose elements contribute with their weight to the sum.
-
totalWeight
public IntVar totalWeight
Integer variable containing the total weight of all elements within a set variable a.
-
increasingCosts
boolean increasingCosts
It specifies if the costs of elements are increasing given the lexical order of the elements.
-
elementWeights
java.util.Map<java.lang.Integer,java.lang.Integer> elementWeights
It provides a quick access to the weights of given elements of the set.
-
-
Constructor Detail
-
SumWeightedSet
public SumWeightedSet(SetVar a, int[] elements, int[] weights, IntVar totalWeight)
It constructs a weighted set sum constraint.- Parameters:
a
- a set variable for which the weighted sum of its element is computed.elements
- it specifies the elements which are allowed and for which the weight is specified.weights
- the weight for each element present in a.lub().totalWeight
- an integer variable equal to the total weight of the elements in set variable a.
-
SumWeightedSet
public SumWeightedSet(SetVar a, IntVar totalWeight)
It constructs a weighted set sum constraint. This constructor assumes that every element within a set variable has a weight equal to its value.- Parameters:
a
- set variable being used in weighted set constraint.totalWeight
- integer variable containing information about total weight of the elements in set variable a.
-
SumWeightedSet
public SumWeightedSet(SetVar a, int[] weights, IntVar totalWeight)
It constructs a weighted set sum constraint. This constructor assumes that every element within a set variable has a weight equal to its value.- Parameters:
a
- set variable being used in weighted set constraint.weights
- it specifies a weight for each possible element of a set variable.totalWeight
- integer variable containing information about total weight of the elements in set variable a.
-
-
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.
-
getConsistencyPruningEvent
public int getConsistencyPruningEvent(Var var)
Description copied from class:Constraint
It retrieves the pruning event which causes reevaluation of the constraint.- Overrides:
getConsistencyPruningEvent
in classConstraint
- Parameters:
var
- variable for which pruning event is retrieved- Returns:
- it returns the int code of the pruning event (GROUND, BOUND, ANY, NONE)
-
getDefaultConsistencyPruningEvent
public int getDefaultConsistencyPruningEvent()
- Specified by:
getDefaultConsistencyPruningEvent
in classConstraint
-
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.
-
toString
public java.lang.String toString()
Description copied from class:Constraint
It produces a string representation of a constraint state.- Overrides:
toString
in classConstraint
-
-