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.9

Author:

Radoslaw Szymanek and Krzysztof Kuchcinski

Field Summary

Fields

Modifier and Type	Field and Description
SetVar	a A set variable a whose elements contribute with their weight to the sum.
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 and 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

Modifier and Type	Method and 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.
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, long2int, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

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.

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 class Constraint

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 class Constraint

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 class Constraint

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 interface SatisfiedPresent

Returns:

true if constraint is possible to verify that it is satisfied.

toString

public String toString()

Description copied from class: Constraint

It produces a string representation of a constraint state.

Overrides:

toString in class Constraint