org.jacop.constraints

Class LinearIntDom

java.lang.Object

org.jacop.constraints.DecomposedConstraint<Constraint>

org.jacop.constraints.Constraint

org.jacop.constraints.PrimitiveConstraint

org.jacop.constraints.LinearInt

org.jacop.constraints.LinearIntDom

All Implemented Interfaces:

SatisfiedPresent, StoreAware

public class LinearIntDom
extends LinearInt

LinearIntDom 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. Domain consistency is used.

Version:

4.9

Author:

Krzysztof Kuchcinski

Field Summary

Fields inherited from class org.jacop.constraints.LinearInt

relationType

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

Constructor and Description
LinearIntDom(IntVar[] list, int[] weights, String rel, int sum) It constructs the constraint LinearIntDom.
LinearIntDom(IntVar[] list, int[] weights, String rel, IntVar sum) It constructs the constraint LinearIntDom.
LinearIntDom(List<? extends IntVar> variables, List<Integer> weights, String rel, int sum) It constructs the constraint LinearIntDom.
LinearIntDom(Store store, IntVar[] list, int[] weights, String rel, int sum) Deprecated. LinearIntDom constraint does not use Store parameter any longer.
LinearIntDom(Store store, IntVar[] list, int[] weights, String rel, IntVar sum) Deprecated. LinearIntDom constraint does not use Store parameter any longer.
LinearIntDom(Store store, List<? extends IntVar> variables, List<Integer> weights, String rel, int sum) Deprecated. LinearIntDom constraint does not use Store parameter any longer.

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	getDefaultConsistencyPruningEvent()
protected int	getDefaultNestedConsistencyPruningEvent()
protected int	getDefaultNestedNotConsistencyPruningEvent()
protected int	getDefaultNotConsistencyPruningEvent()
void	notConsistency(Store store) It makes pruning in such a way that constraint is notConsistent.
void	propagate(int rel)
String	toString() It produces a string representation of a constraint state.

Methods inherited from class org.jacop.constraints.LinearInt

commonInitialization, impose, notSatisfied, rel2String, relation, satisfied, satisfiedEq, satisfiedGtEq, satisfiedLtEq, satisfiedNeq

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, 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

Constructor Detail

LinearIntDom

@Deprecated
public LinearIntDom(Store store,
                                 IntVar[] list,
                                 int[] weights,
                                 String rel,
                                 int sum)

Deprecated. LinearIntDom constraint does not use Store parameter any longer.

It constructs the constraint LinearIntDom.

Parameters:

store - current store

list - variables which are being multiplied by weights.

weights - weight for each variable.

rel - the relation, one of "==", "<", ">", "<=", ">=", "!="

sum - the sum of weighted variables.

LinearIntDom

@Deprecated
public LinearIntDom(Store store,
                                 IntVar[] list,
                                 int[] weights,
                                 String rel,
                                 IntVar sum)

Deprecated. LinearIntDom constraint does not use Store parameter any longer.

It constructs the constraint LinearIntDom.

Parameters:

store - current store

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

LinearIntDom

@Deprecated
public LinearIntDom(Store store,
                                 List<? extends IntVar> variables,
                                 List<Integer> weights,
                                 String rel,
                                 int sum)

Deprecated. LinearIntDom constraint does not use Store parameter any longer.

It constructs the constraint LinearIntDom.

Parameters:

store - current store

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

LinearIntDom

public LinearIntDom(IntVar[] list,
                    int[] weights,
                    String rel,
                    int sum)

It constructs the constraint LinearIntDom.

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.

LinearIntDom

public LinearIntDom(IntVar[] list,
                    int[] weights,
                    String rel,
                    IntVar sum)

It constructs the constraint LinearIntDom.

Parameters:

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

LinearIntDom

public LinearIntDom(List<? extends IntVar> variables,
                    List<Integer> weights,
                    String rel,
                    int sum)

It constructs the constraint LinearIntDom.

Parameters:

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

Overrides:

consistency in class LinearInt

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.

Overrides:

notConsistency in class LinearInt

Parameters:

store - the constraint store in which context the notConsistency technique is evaluated.

propagate

public void propagate(int rel)

Overrides:

propagate in class LinearInt

getDefaultNestedConsistencyPruningEvent

protected int getDefaultNestedConsistencyPruningEvent()

Overrides:

getDefaultNestedConsistencyPruningEvent in class LinearInt

getDefaultNestedNotConsistencyPruningEvent

protected int getDefaultNestedNotConsistencyPruningEvent()

Overrides:

getDefaultNestedNotConsistencyPruningEvent in class LinearInt

getDefaultConsistencyPruningEvent

public int getDefaultConsistencyPruningEvent()

Overrides:

getDefaultConsistencyPruningEvent in class LinearInt

getDefaultNotConsistencyPruningEvent

protected int getDefaultNotConsistencyPruningEvent()

Overrides:

getDefaultNotConsistencyPruningEvent in class LinearInt

toString

public String toString()

Description copied from class: Constraint

It produces a string representation of a constraint state.

Overrides:

toString in class LinearInt