org.jacop.constraints

Class ChannelImply

java.lang.Object

org.jacop.constraints.DecomposedConstraint<Constraint>

org.jacop.constraints.Constraint

org.jacop.constraints.ChannelImply

All Implemented Interfaces:

SatisfiedPresent

public class ChannelImply
extends Constraint
implements SatisfiedPresent

ChannelImply constraints "B => constraint".

Version:

4.9

Author:

Krzysztof Kuchcinski and Radoslaw Szymanek

Field Summary

Fields

Modifier and Type	Field and Description
IntVar	x Variables that is checked for a value.

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
ChannelImply(IntVar x, IntVar[] bs)
ChannelImply(IntVar x, IntVar[] bs, int[] value) It creates ChannelImply constraint.
ChannelImply(IntVar x, IntVar[] bs, IntDomain value) It creates ChannelImply constraint.
ChannelImply(IntVar x, Map<Integer,? extends IntVar> bs)

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()
void	impose(Store store) It imposes the constraint in a given store.
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, 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

x

public final IntVar x

Variables that is checked for a value.

Constructor Detail

ChannelImply

public ChannelImply(IntVar x,
                    IntVar[] bs,
                    int[] value)

It creates ChannelImply constraint.

Parameters:

x - variable to be checked.

bs - array representing the status of equality x = i.

value - array of values that are checked against x.

ChannelImply

public ChannelImply(IntVar x,
                    IntVar[] bs,
                    IntDomain value)

It creates ChannelImply constraint.

Parameters:

x - variable to be checked.

bs - array representing the status of equality x = i.

value - set of values that are checked against x.

ChannelImply

public ChannelImply(IntVar x,
                    IntVar[] bs)

ChannelImply

public ChannelImply(IntVar x,
                    Map<Integer,? extends IntVar> bs)

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.

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.

impose

public void impose(Store store)

Description copied from class: Constraint

It imposes the constraint in a given store.

Overrides:

impose in class Constraint

Parameters:

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

toString

public String toString()

Description copied from class: Constraint

It produces a string representation of a constraint state.

Overrides:

toString in class Constraint