org.jacop.constraints

Class OrBoolVector

java.lang.Object

org.jacop.constraints.DecomposedConstraint<Constraint>

org.jacop.constraints.Constraint

org.jacop.constraints.PrimitiveConstraint

org.jacop.constraints.OrBoolVector

All Implemented Interfaces:

SatisfiedPresent, StoreAware

public class OrBoolVector
extends PrimitiveConstraint

If at least one variable from the list is equal 1 then result variable is equal 1 too. Otherwise, result variable is equal to zero. It restricts the domain of all x as well as result to be between 0 and 1.

Version:

4.9

Author:

Krzysztof Kuchcinski and Radoslaw Szymanek

Field Summary

Fields

Modifier and Type	Field and Description
IntVar[]	list It specifies a list of variables among which one must be equal to 1 to set result variable to 1.
IntVar	result It specifies variable result, storing the result of or function performed a list of variables.

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 and Description
OrBoolVector(IntVar[] list, IntVar result) It constructs orBool.
OrBoolVector(List<? extends IntVar> list, IntVar result) It constructs orBool.

Method Summary

Modifier and Type	Method and Description
String	checkInvariants() It checks invariants required by the constraint.
void	consistency(Store store) It is a (most probably incomplete) consistency function which removes the values from variables domains.
List<Constraint>	decompose(Store store) It returns an array list of constraint which are used to decompose this constraint.
int	getDefaultConsistencyPruningEvent()
protected int	getDefaultNestedConsistencyPruningEvent()
protected int	getDefaultNestedNotConsistencyPruningEvent()
protected int	getDefaultNotConsistencyPruningEvent()
void	imposeDecomposition(Store store) It imposes the decomposition of the given constraint in a given store.
void	include(Store store) It provide store for constraints that are not imposed but called from other constraints.
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, setNotConsistencyPruningEvent

Methods inherited from class org.jacop.constraints.Constraint

afc, arguments, cleanAfterFailure, getConsistencyPruningEvent, getGuideConstraint, getGuideValue, getGuideVariable, grounded, grounded, id, impose, 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

list

public IntVar[] list

It specifies a list of variables among which one must be equal to 1 to set result variable to 1.

result

public IntVar result

It specifies variable result, storing the result of or function performed a list of variables.

Constructor Detail

OrBoolVector

public OrBoolVector(IntVar[] list,
                    IntVar result)

It constructs orBool.

Parameters:

list - list of x's which one of them must be equal 1 to make result equal 1.

result - variable which is equal 0 if none of x is equal to zero.

OrBoolVector

public OrBoolVector(List<? extends IntVar> list,
                    IntVar result)

It constructs orBool.

Parameters:

list - list of x's which one of them must be equal 1 to make result equal 1.

result - variable which is equal 0 if none of x is equal to zero.

Method Detail

checkInvariants

public String checkInvariants()

It checks invariants required by the constraint. Namely that boolean variables have boolean domain.

Returns:

the string describing the violation of the invariant, null otherwise.

getDefaultNestedNotConsistencyPruningEvent

protected int getDefaultNestedNotConsistencyPruningEvent()

Overrides:

getDefaultNestedNotConsistencyPruningEvent in class PrimitiveConstraint

getDefaultNestedConsistencyPruningEvent

protected int getDefaultNestedConsistencyPruningEvent()

Overrides:

getDefaultNestedConsistencyPruningEvent in class PrimitiveConstraint

getDefaultConsistencyPruningEvent

public int getDefaultConsistencyPruningEvent()

Specified by:

getDefaultConsistencyPruningEvent in class Constraint

getDefaultNotConsistencyPruningEvent

protected int getDefaultNotConsistencyPruningEvent()

Specified by:

getDefaultNotConsistencyPruningEvent in class PrimitiveConstraint

include

public void include(Store store)

Description copied from interface: StoreAware

It provide store for constraints that are not imposed but called from other constraints.

Specified by:

include in interface StoreAware

Overrides:

include in class PrimitiveConstraint

Parameters:

store - the constraint store in which context the constraint is executed.

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.

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.

toString

public String toString()

Description copied from class: Constraint

It produces a string representation of a constraint state.

Overrides:

toString in class Constraint

decompose

public List<Constraint> decompose(Store store)

Description copied from class: Constraint

It returns an array list of constraint which are used to decompose this constraint. It actually creates a decomposition (possibly also creating variables), but it does not impose the constraint.

Overrides:

decompose in class Constraint

Parameters:

store - the constraint store in which context the decomposition takes place.

Returns:

an array list of constraints used to decompose this constraint.

imposeDecomposition

public void imposeDecomposition(Store store)

Description copied from class: Constraint

It imposes the decomposition of the given constraint in a given store.

Overrides:

imposeDecomposition in class Constraint

Parameters:

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