Package org.jacop.constraints

Class XmulYeqZ

java.lang.Object

org.jacop.constraints.DecomposedConstraint<Constraint>

org.jacop.constraints.Constraint

org.jacop.constraints.XmulYeqZ

All Implemented Interfaces:

SatisfiedPresent

public class XmulYeqZ
extends Constraint
implements SatisfiedPresent

Constraint X * Y #= Z

Boundary consistency is used.

Version:

4.8

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static java.util.concurrent.atomic.AtomicInteger	idNumber
IntVar	x	It specifies variable x in constraint x * y = z.
private boolean	xSquare
IntVar	y	It specifies variable y in constraint x * y = z.
IntVar	z	It specifies variable z in constraint x * y = z.

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
XmulYeqZ(IntVar x, IntVar y, IntVar z)	It constructs a constraint X * Y = Z.

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()
boolean	satisfied()	It checks if the constraint is satisfied.
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, 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

It specifies variable x in constraint x * y = z.

y

public final IntVar y

It specifies variable y in constraint x * y = z.

z

public final IntVar z

It specifies variable z in constraint x * y = z.

xSquare

private final boolean xSquare

Constructor Detail

XmulYeqZ

public XmulYeqZ(IntVar x,
                IntVar y,
                IntVar z)

It constructs a constraint X * Y = Z.

Parameters:

x - variable x.

y - variable y.

z - variable z.

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.

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