Package org.jacop.constraints

Class Channel

java.lang.Object

org.jacop.constraints.DecomposedConstraint<Constraint>

org.jacop.constraints.Constraint

org.jacop.constraints.Channel

All Implemented Interfaces:

SatisfiedPresent

public class Channel
extends Constraint
implements SatisfiedPresent

Channel constraints "constraint" <=> B

Version:

4.8

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	Channel.Item

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static java.util.concurrent.atomic.AtomicInteger	idNumber
(package private) Channel.Item[]	item	It specifies variables b and related values for variable x.
(package private) int	n	length of vector bs
private TimeStamp<java.lang.Integer>	position
(package private) java.util.Map<java.lang.Integer,IntVar>	valueMap
IntVar	x	Variables that is checked for a value.

Fields inherited from class org.jacop.constraints.Constraint

afcWeight, atomicExecution, consistencyPruningEvents, constraintScope, earlyTerminationOK, increaseWeight, numberId, scope, trace, watchedVariableGrounded

Fields inherited from class org.jacop.constraints.DecomposedConstraint

queueIndex

Constructor Summary

Constructors

Constructor	Description
Channel(IntVar x, java.util.Map<java.lang.Integer,IntVar> bs)
Channel(IntVar x, IntVar[] bs)
Channel(IntVar x, IntVar[] bs, int[] value)	It creates Channel constraint.
Channel(IntVar x, IntVar[] bs, IntDomain value)	It creates Channel constraint.

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()
void	impose(Store store)	It imposes the constraint in a given store.
boolean	satisfied()	It checks if the constraint is satisfied.
private void	swap(int i, int j)
(package private) static int[]	toArray(IntDomain d)
java.lang.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, toInt, toInt, 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

idNumber

static final java.util.concurrent.atomic.AtomicInteger idNumber

x

public final IntVar x

Variables that is checked for a value.

n

final int n

length of vector bs

item

final Channel.Item[] item

It specifies variables b and related values for variable x.

position

private TimeStamp<java.lang.Integer> position

valueMap

java.util.Map<java.lang.Integer,IntVar> valueMap

Constructor Detail

Channel

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

It creates Channel 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.

Channel

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

It creates Channel 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.

Channel

public Channel(IntVar x,
               IntVar[] bs)

Channel

public Channel(IntVar x,
               java.util.Map<java.lang.Integer,IntVar> bs)

Method Detail

toArray

static int[] toArray(IntDomain d)

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.

swap

private void swap(int i,
                  int j)

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 java.lang.String toString()

Description copied from class: Constraint

It produces a string representation of a constraint state.

Overrides:

toString in class Constraint