choco.bool
Class LargeDisjunction

java.lang.Object
  choco.AbstractEntity
      choco.AbstractConstraint
          choco.bool.AbstractCompositeConstraint
              choco.bool.AbstractLargeCompositeConstraint
                  choco.bool.AbstractLargeBoolConstraint
                      choco.bool.AbstractLargeBoolConstraintWithCounterOpposite
                          choco.bool.LargeDisjunction

All Implemented Interfaces:

BoolConstraint, CompositeConstraint, Constraint, Entity, IntConstraint, IntVarEventListener, VarEventListener, Propagator, java.lang.Cloneable, java.util.EventListener

public class LargeDisjunction
extends AbstractLargeBoolConstraintWithCounterOpposite

Field Summary

Fields inherited from class choco.bool.AbstractLargeBoolConstraint

nbFalseStatus, nbTrueStatus, statusBitVector

Fields inherited from class choco.bool.AbstractLargeCompositeConstraint

additionalIndices, additionalVars, constraints, nbConstraints, offsets

Fields inherited from class choco.AbstractConstraint

active, constAwakeEvent, hook, priority

Fields inherited from class choco.AbstractEntity

problem

Constructor Summary

LargeDisjunction(Constraint[] subConstraints)

Method Summary

void	awake() Default initial propagation: full constraint re-propagation.
void	awakeOnBounds(int varIdx)
void	awakeOnInf(int varIdx) Default propagation on improved lower bound: propagation on domain revision.
void	awakeOnInst(int varIdx) Default propagation on instantiation: full constraint re-propagation.
void	awakeOnRem(int varIdx, int val) Default propagation on one value removal: propagation on domain revision.
void	awakeOnRemovals(int varIdx, IntIterator deltaDomain)
void	awakeOnSup(int varIdx) Default propagation on improved upper bound: propagation on domain revision.
protected void	checkNbFalseStatus() this compares the number of false constraints (subconstraints whose status is false) with the overall number of constraints.
protected void	checkStatus(int constIdx) checks the status of the i-th constraint of the disjunction and propagates accordingly
java.lang.Object	clone() returns a copy of the constraint.
boolean	isConsistent() tests if the constraint is consistent with respect to the current state of domains
java.lang.Boolean	isEntailed() Checks whether the constraint is definitely satisfied, no matter what further restrictions occur to the domain of its variables.
boolean	isEquivalentTo(Constraint compareTo) tests the equivalence (logical equality of the conditions) between two constraints.
boolean	isSatisfied() Semantic: Testing if the constraint is satisfied.
AbstractConstraint	opposite() computes the constraint modelling the counter-opposite condition of this
java.lang.String	pretty() Pretty print of the constraint.
void	propagate() Propagation: Propagating the constraint until local consistency is reached.

Methods inherited from class choco.bool.AbstractLargeBoolConstraintWithCounterOpposite

assignIndices, getOppositeSubConstraint, initAbstractLargeBoolConstraintWithCounterOpposite, setSubConstraintStatus

Methods inherited from class choco.bool.AbstractLargeBoolConstraint

getStatus, getTargetStatus, initAbstractLargeBoolConstraint, setStatus, setTargetStatus

Methods inherited from class choco.bool.AbstractLargeCompositeConstraint

getConstraintIdx, getIntVar, getLocalVarIndex, getNbSubConstraints, getNbVars, getNbVarsFromSubConst, getSubConstraint, getSubConstraintIdx, getVar, getVarIdxInOpposite, isCompletelyInstantiated, setConstraintIndex, setVar

Methods inherited from class choco.bool.AbstractCompositeConstraint

addListener, getGlobalVarIndex

Methods inherited from class choco.AbstractConstraint

awakeOnVar, connectVar, constAwake, delete, fail, getEvent, getPlugIn, getPriority, getProblem, isActive, setActive, setEntailed, setPassive, setPlugIn, substituteVar

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface choco.bool.CompositeConstraint

getGlobalVarIndex, getNbSubConstraints, getSubConstraint, getSubConstraintIdx

Methods inherited from interface choco.integer.var.IntVarEventListener

getConstraintIdx, setConstraintIndex

Methods inherited from interface choco.prop.VarEventListener

addListener, isActive, setActive, setPassive

Methods inherited from interface choco.integer.IntConstraint

getIntVar

Methods inherited from interface choco.Propagator

awakeOnVar, constAwake, delete, getEvent, getPlugIn, getPriority, isCompletelyInstantiated

Methods inherited from interface choco.prop.VarEventListener

addListener, isActive, setActive, setPassive

Methods inherited from interface choco.integer.var.IntVarEventListener

getConstraintIdx, setConstraintIndex

Methods inherited from interface choco.prop.VarEventListener

addListener, isActive, setActive, setPassive

Constructor Detail

LargeDisjunction

public LargeDisjunction(Constraint[] subConstraints)

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Description copied from interface: Constraint

returns a copy of the constraint. This copy is a new object, may be a recursive copy in case of composite constraints. The original and the copy share the same variables & plugins

Specified by:

clone in interface Constraint

Overrides:

clone in class AbstractLargeBoolConstraintWithCounterOpposite

Returns:

Throws:

java.lang.CloneNotSupportedException

pretty

public java.lang.String pretty()

Pretty print of the constraint.

Specified by:

pretty in interface Entity

Overrides:

pretty in class AbstractEntity

Returns:

a readable string representation of the object

checkNbFalseStatus

protected void checkNbFalseStatus()
                           throws ContradictionException

this compares the number of false constraints (subconstraints whose status is false) with the overall number of constraints.

Throws:

ContradictionException

checkStatus

protected void checkStatus(int constIdx)
                    throws ContradictionException

checks the status of the i-th constraint of the disjunction and propagates accordingly

Parameters:

constIdx -

Throws:

ContradictionException

awakeOnInf

public void awakeOnInf(int varIdx)
                throws ContradictionException

Description copied from interface: IntVarEventListener

Default propagation on improved lower bound: propagation on domain revision.

Throws:

ContradictionException

awakeOnSup

public void awakeOnSup(int varIdx)
                throws ContradictionException

Description copied from interface: IntVarEventListener

Default propagation on improved upper bound: propagation on domain revision.

Throws:

ContradictionException

awakeOnRemovals

public void awakeOnRemovals(int varIdx,
                            IntIterator deltaDomain)
                     throws ContradictionException

Specified by:

awakeOnRemovals in interface IntConstraint

Overrides:

awakeOnRemovals in class AbstractCompositeConstraint

Throws:

ContradictionException

awakeOnBounds

public void awakeOnBounds(int varIdx)
                   throws ContradictionException

Specified by:

awakeOnBounds in interface IntConstraint

Overrides:

awakeOnBounds in class AbstractCompositeConstraint

Throws:

ContradictionException

awakeOnInst

public void awakeOnInst(int varIdx)
                 throws ContradictionException

Description copied from interface: IntVarEventListener

Default propagation on instantiation: full constraint re-propagation.

Throws:

ContradictionException

awakeOnRem

public void awakeOnRem(int varIdx,
                       int val)
                throws ContradictionException

Description copied from interface: IntVarEventListener

Default propagation on one value removal: propagation on domain revision.

Throws:

ContradictionException

isSatisfied

public boolean isSatisfied()

Description copied from interface: Constraint

Semantic: Testing if the constraint is satisfied. Note that all variables involved in the constraint must be instantiated when this method is called.

isConsistent

public boolean isConsistent()

Description copied from interface: Propagator

tests if the constraint is consistent with respect to the current state of domains

isEntailed

public java.lang.Boolean isEntailed()

Description copied from interface: Propagator

Checks whether the constraint is definitely satisfied, no matter what further restrictions occur to the domain of its variables.

Specified by:

isEntailed in interface Propagator

Overrides:

isEntailed in class AbstractConstraint

propagate

public void propagate()
               throws ContradictionException

Description copied from interface: Propagator

Propagation: Propagating the constraint until local consistency is reached.

Throws:

ContradictionException

awake

public void awake()
           throws ContradictionException

Description copied from class: AbstractConstraint

Default initial propagation: full constraint re-propagation.

Specified by:

awake in interface Propagator

Overrides:

awake in class AbstractConstraint

Throws:

ContradictionException

opposite

public AbstractConstraint opposite()

Description copied from interface: Constraint

computes the constraint modelling the counter-opposite condition of this

Specified by:

opposite in interface Constraint

Overrides:

opposite in class AbstractConstraint

Returns:

a new constraint (modelling the opposite condition)

isEquivalentTo

public boolean isEquivalentTo(Constraint compareTo)

Description copied from interface: Constraint

tests the equivalence (logical equality of the conditions) between two constraints. In particular whenever c1.equals(c2), then c1.isEquivalent(c2).

Specified by:

isEquivalentTo in interface Constraint

Overrides:

isEquivalentTo in class AbstractConstraint

Parameters:

compareTo - the constraint to be compared to

Returns:

true if and only if the constraints model the same logical condition.