org.jacop.constraints

Class LinearInt

java.lang.Object

org.jacop.constraints.DecomposedConstraint<Constraint>

org.jacop.constraints.Constraint

org.jacop.constraints.PrimitiveConstraint

org.jacop.constraints.LinearInt

All Implemented Interfaces:

SatisfiedPresent, StoreAware

Direct Known Subclasses:

LinearIntDom

public class LinearInt
extends PrimitiveConstraint

Field Summary

Fields

Modifier and Type	Field and Description
byte	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

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

Method Summary

Modifier and Type	Method and Description
protected void	commonInitialization(Store store, IntVar[] list, int[] weights, String rel, int sum)
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	impose(Store store) It imposes the constraint in a given store.
void	notConsistency(Store store) It makes pruning in such a way that constraint is notConsistent.
boolean	notSatisfied() It checks if constraint would be always not satisfied.
void	propagate(int rel)
String	rel2String()
byte	relation(String r)
boolean	satisfied() It checks if the constraint is satisfied.
boolean	satisfiedEq()
boolean	satisfiedGtEq(long b)
boolean	satisfiedLtEq(long b)
boolean	satisfiedNeq()
String	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, 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

relationType

public byte relationType

Constructor Detail

LinearInt

protected LinearInt()

LinearInt

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

Deprecated.

LinearInt

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

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

It constructs the constraint LinearInt.

Parameters:

store - current store

list - list which are being multiplied by weights.

weights - weight for each variable.

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

sum - the sum of weighted list.

LinearInt

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

Deprecated.

LinearInt

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

LinearInt

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

It constructs the constraint LinearInt.

Parameters:

list - list which are being multiplied by weights.

weights - weight for each variable.

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

sum - the sum of weighted list.

LinearInt

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

Method Detail

commonInitialization

protected void commonInitialization(Store store,
                                    IntVar[] list,
                                    int[] weights,
                                    String rel,
                                    int sum)

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.

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.

Specified by:

notConsistency in class PrimitiveConstraint

Parameters:

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

propagate

public void propagate(int rel)

getDefaultNestedConsistencyPruningEvent

protected int getDefaultNestedConsistencyPruningEvent()

Overrides:

getDefaultNestedConsistencyPruningEvent in class PrimitiveConstraint

getDefaultNestedNotConsistencyPruningEvent

protected int getDefaultNestedNotConsistencyPruningEvent()

Overrides:

getDefaultNestedNotConsistencyPruningEvent in class PrimitiveConstraint

getDefaultConsistencyPruningEvent

public int getDefaultConsistencyPruningEvent()

Specified by:

getDefaultConsistencyPruningEvent in class Constraint

getDefaultNotConsistencyPruningEvent

protected int getDefaultNotConsistencyPruningEvent()

Specified by:

getDefaultNotConsistencyPruningEvent in class PrimitiveConstraint

impose

public void impose(Store store)

Description copied from class: Constraint

It imposes the constraint in a given store.

Overrides:

impose in class PrimitiveConstraint

Parameters:

store - the constraint store to which the constraint is imposed to.

satisfiedEq

public boolean satisfiedEq()

satisfiedNeq

public boolean satisfiedNeq()

satisfiedLtEq

public boolean satisfiedLtEq(long b)

satisfiedGtEq

public boolean satisfiedGtEq(long b)

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.

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

Returns:

true if constraint must be notSatisfied, false otherwise.

relation

public byte relation(String r)

rel2String

public String rel2String()

toString

public String toString()

Description copied from class: Constraint

It produces a string representation of a constraint state.

Overrides:

toString in class Constraint