org.jacop.constraints

Class PrimitiveConstraint

java.lang.Object

org.jacop.constraints.DecomposedConstraint

org.jacop.constraints.Constraint

org.jacop.constraints.PrimitiveConstraint

Direct Known Subclasses:

AbsXeqY, AeqB, AeqS, AinB, AinS, And, AndBool, Distance, EinA, Eq, EqBool, IfThen, IfThenBool, IfThenElse, In, Linear, Linear, NoGood, Not, Or, OrBool, PeqC, PeqQ, PgtC, PgteqC, PgteqQ, PgtQ, PltC, PlteqC, PlteqQ, PltQ, PneqC, PneqQ, PplusCeqR, PplusQeqR, SinA, XeqA, XeqC, XeqY, XgtC, XgteqC, XgteqY, XgtY, XinA, XltC, XlteqC, XlteqY, XltY, XmulCeqZ, XmulYeqC, XneqC, XneqY, Xor, XorBool, XplusCeqZ, XplusClteqZ, XplusYeqC, XplusYeqZ, XplusYgtC, XplusYlteqZ, XplusYplusCeqZ, XplusYplusQeqZ, XplusYplusQgtC

public abstract class PrimitiveConstraint
extends Constraint

Standard unified interface for all primitive constraints. In addition to functions defined by interface Constraint it also defines function notConsistency and notSatisfied. Only PrimitiveConstraints can be used as arguments to constraints Not, And, Or, etc.

Version:

4.2

Author:

Radoslaw Szymanek and Krzysztof Kuchcinski

Field Summary

Fields

Modifier and Type	Field and Description
Hashtable<Var,Integer>	notConsistencyPruningEvents It specifies the events which must occur for notConsistency() method being executed.

Fields inherited from class org.jacop.constraints.Constraint

atomicExecution, consistencyPruningEvents, earlyTerminationOK, id, increaseWeight, numberArgs, numberId, trace

Fields inherited from class org.jacop.constraints.DecomposedConstraint

queueIndex

Constructor Summary

Constructors

Constructor and Description
PrimitiveConstraint()

Method Summary

Modifier and Type	Method and Description
abstract int	getNestedPruningEvent(Var var, boolean mode) It retrieves the pruning event for which any composed constraint which uses this constraint should be evaluated.
abstract int	getNotConsistencyPruningEvent(Var var) It retrieves the pruning event which causes reevaluation of the constraint notConsistency() function.
void	include(Store store) It provide store for constraints that are not imposed but called from ather constraints.
abstract void	notConsistency(Store store) It makes pruning in such a way that constraint is notConsistent.
abstract boolean	notSatisfied() It checks if constraint would be always not satisfied.
void	setNotConsistencyPruningEvent(Var var, int pruningEvent) It allows to specify customized events required to trigger execution of notConsitency() method.

Methods inherited from class org.jacop.constraints.Constraint

arguments, cleanAfterFailure, consistency, decompose, getConsistencyPruningEvent, getGuideConstraint, getGuideValue, getGuideVariable, id, impose, impose, imposeDecomposition, increaseWeight, numberArgs, queueVariable, removeConstraint, removeLevel, removeLevelLate, requiresMonotonicity, satisfied, setConsistencyPruningEvent, supplyGuideFeedback, toString

Methods inherited from class org.jacop.constraints.DecomposedConstraint

auxiliaryVariables, derivative, imposeDecomposition

Methods inherited from class java.lang.Object

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

Field Detail

notConsistencyPruningEvents

public Hashtable<Var,Integer> notConsistencyPruningEvents

It specifies the events which must occur for notConsistency() method being executed.

Constructor Detail

PrimitiveConstraint

public PrimitiveConstraint()

Method Detail

getNotConsistencyPruningEvent

public abstract int getNotConsistencyPruningEvent(Var var)

It retrieves the pruning event which causes reevaluation of the constraint notConsistency() function.

Parameters:

var - for which pruning event is retrieved

Returns:

the int denoting the pruning event associated with given variable.

getNestedPruningEvent

public abstract int getNestedPruningEvent(Var var,
                                          boolean mode)

It retrieves the pruning event for which any composed constraint which uses this constraint should be evaluated. This events are the ones which can change satisfied status?

Parameters:

var - for which pruning event is retrieved

mode - decides if pruning event for consistency or nonconsistency is required.

Returns:

pruning event associated with the given variable for a given consistency mode.

notConsistency

public abstract void notConsistency(Store store)

It makes pruning in such a way that constraint is notConsistent. It removes values which always belong to a solution.

Parameters:

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

notSatisfied

public abstract boolean notSatisfied()

It checks if constraint would be always not satisfied.

Returns:

true if constraint must be notSatisfied, false otherwise.

include

public void include(Store store)

It provide store for constraints that are not imposed but called from ather constraints.

Parameters:

store - the constraint store in which context the constraint is executed.

setNotConsistencyPruningEvent

public void setNotConsistencyPruningEvent(Var var,
                                          int pruningEvent)

It allows to specify customized events required to trigger execution of notConsitency() method.

Parameters:

var - variable for which customized event is setup.

pruningEvent - the type of the event being setup.