Package org.jacop.set.constraints

Class EinA

java.lang.Object

org.jacop.constraints.DecomposedConstraint<Constraint>

org.jacop.constraints.Constraint

org.jacop.constraints.PrimitiveConstraint

org.jacop.set.constraints.EinA

All Implemented Interfaces:

SatisfiedPresent, StoreAware

public class EinA
extends PrimitiveConstraint

It constructs a constraint which makes sure that a given element is in the domain of the set variable.

Version:

4.10

Field Summary

Fields

Modifier and Type	Field	Description
SetVar	a	It specifies the set variable which must contain a specified element.
int	element	It specifies the element which must be present in the set variable.
(package private) static AtomicInteger	idNumber
boolean	strict	It specifies if the inclusion relation is strict.

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	Description
EinA(int element, SetVar a)	It constructs an eInA constraint to restrict the domain of the variable.
EinA(int element, SetVar a, boolean strict)	It constructs an eInA constraint to restrict the domain of the variable.

Method Summary

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	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.
boolean	notSatisfied()	It checks if constraint would be always not satisfied.
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.PrimitiveConstraint

getNestedPruningEvent, getNotConsistencyPruningEvent, impose, 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 Details

idNumber

static AtomicInteger idNumber

element

public int element

It specifies the element which must be present in the set variable.

a

public SetVar a

It specifies the set variable which must contain a specified element.

strict

public boolean strict

It specifies if the inclusion relation is strict.

Constructor Details

EinA

public EinA(int element,
 SetVar a,
 boolean strict)

It constructs an eInA constraint to restrict the domain of the variable.

Parameters:

element - the element that has to be a part of the variable domain.

a - variable a for which the restriction is applied.

strict - it specifies if the inclusion relation is strict.

EinA

public EinA(int element,
 SetVar a)

It constructs an eInA constraint to restrict the domain of the variable.

Parameters:

element - the element that has to be a part of the variable domain.

a - variable a for which the restriction is applied.

Method Details

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.

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.

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.

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

toString

public String toString()

Description copied from class: Constraint

It produces a string representation of a constraint state.

Overrides:

toString in class Constraint