Package org.jacop.constraints

Class SumBool

java.lang.Object

org.jacop.constraints.DecomposedConstraint<Constraint>

org.jacop.constraints.Constraint

org.jacop.constraints.PrimitiveConstraint

org.jacop.constraints.SumBool

All Implemented Interfaces:

SatisfiedPresent, StoreAware

public class SumBool
extends PrimitiveConstraint

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final byte	eq
(package private) static final byte	ge
(package private) static final byte	gt
(package private) static final AtomicInteger	idNumber
(package private) int	l
(package private) static final byte	le
(package private) static final byte	lt
(package private) static final byte	ne
(package private) static final byte[]	negRel
(package private) boolean	reified
byte	relationType
(package private) Store	store
(package private) IntVar	sum
(package private) IntVar[]	x

Fields inherited from class org.jacop.constraints.PrimitiveConstraint

notConsistencyPruningEvents

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
SumBool(List<? extends IntVar> variables, String rel, IntVar sum)
SumBool(IntVar[] list, String rel, IntVar sum)
SumBool(Store store, List<? extends IntVar> variables, String rel, IntVar sum)	Deprecated.
SumBool(Store store, IntVar[] list, String rel, IntVar sum)	Deprecated.

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.
private boolean	entailed(byte rel)
(package private) IntVar[]	filterAndOverflow(IntVar[] x)
int	getDefaultConsistencyPruningEvent()
protected int	getDefaultNestedConsistencyPruningEvent()
protected int	getDefaultNestedNotConsistencyPruningEvent()
protected int	getDefaultNotConsistencyPruningEvent()
void	impose(Store store)	It imposes the constraint in a given store.
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.
private void	prune(byte rel)
String	rel2String()
byte	relation(String r)
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, 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, 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 Details

store

Store store

idNumber

static final AtomicInteger idNumber

reified

boolean reified

eq

static final byte eq

See Also:

• Constant Field Values

le

static final byte le

See Also:

• Constant Field Values

lt

static final byte lt

See Also:

• Constant Field Values

ne

static final byte ne

See Also:

• Constant Field Values

gt

static final byte gt

See Also:

• Constant Field Values

ge

static final byte ge

See Also:

• Constant Field Values

negRel

static final byte[] negRel

relationType

public byte relationType

x

IntVar[] x

sum

IntVar sum

l

int l

Constructor Details

SumBool

@Deprecated
public SumBool(Store store,
 IntVar[] list,
 String rel,
 IntVar sum)

Deprecated.

SumBool

@Deprecated
public SumBool(Store store,
 List<? extends IntVar> variables,
 String rel,
 IntVar sum)

Deprecated.

SumBool

public SumBool(IntVar[] list,
 String rel,
 IntVar sum)

SumBool

public SumBool(List<? extends IntVar> variables,
 String rel,
 IntVar sum)

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.

prune

private void prune(byte rel)

getDefaultConsistencyPruningEvent

public int getDefaultConsistencyPruningEvent()

Specified by:

getDefaultConsistencyPruningEvent in class Constraint

getDefaultNestedNotConsistencyPruningEvent

protected int getDefaultNestedNotConsistencyPruningEvent()

Overrides:

getDefaultNestedNotConsistencyPruningEvent in class PrimitiveConstraint

getDefaultNestedConsistencyPruningEvent

protected int getDefaultNestedConsistencyPruningEvent()

Overrides:

getDefaultNestedConsistencyPruningEvent in class PrimitiveConstraint

getDefaultNotConsistencyPruningEvent

protected int getDefaultNotConsistencyPruningEvent()

Specified by:

getDefaultNotConsistencyPruningEvent in class PrimitiveConstraint

impose

public void impose(Store store)

Description copied from class: Constraint

It imposes the constraint in a given store.

Overrides:

impose in class PrimitiveConstraint

Parameters:

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

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.

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.

entailed

private boolean entailed(byte rel)

relation

public byte relation(String r)

rel2String

public String rel2String()

filterAndOverflow

IntVar[] filterAndOverflow(IntVar[] x)

toString

public String toString()

Description copied from class: Constraint

It produces a string representation of a constraint state.

Overrides:

toString in class Constraint