Class PropSquare
- java.lang.Object
-
- org.chocosolver.solver.constraints.Propagator<IntVar>
-
- org.chocosolver.solver.constraints.binary.PropSquare
-
- All Implemented Interfaces:
Comparable<Propagator>,ICause,Identity
public class PropSquare extends Propagator<IntVar>
Enforces X = Y^2- Since:
- 18/05/11
- Author:
- Charles Prud'homme
-
-
Field Summary
-
Fields inherited from class org.chocosolver.solver.constraints.Propagator
constraint, model, priority, reactToFineEvt, vars
-
-
Constructor Summary
Constructors Constructor Description PropSquare(IntVar X, IntVar Y)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ESatisEntailed()Check wetherthisis entailed according to the current state of its internal structure.voidpropagate(int evtmask)Call the main filtering algorithm to apply to theDomainof theVariableobjects.voidpropagate(int varIdx, int mask)Incremental filtering algorithm defined within thePropagator, called whenever the variable of index idxVarInProp has changed.StringtoString()protected voidupdateHoleinX(int remVal)protected voidupdateHoleinY(int remVal)protected voidupdateHolesinX()protected voidupdateHolesinY()protected voidupdateLowerBoundofX()protected voidupdateLowerBoundofY()protected voidupdateUpperBoundofX()protected voidupdateUpperBoundofY()booleanwhy(RuleStore ruleStore, IntVar var, IEventType evt, int value)Add new rules to the rule store-
Methods inherited from class org.chocosolver.solver.constraints.Propagator
addVariable, arity, compareTo, doFinePropagation, doFlush, doSchedule, doScheduleEvent, dynPriority, equals, fails, forcePropagate, forcePropagationOnBacktrack, getConstraint, getId, getModel, getNbVars, getPosition, getPriority, getPropagationConditions, getVar, getVars, getVIndice, getVIndices, hashCode, isActive, isCompletelyInstantiated, isPassive, isReifiedAndSilent, isStateLess, linkVariables, reactToFineEvent, setActive, setPassive, setPosition, setReifiedSilent, setReifiedTrue, setVIndices, unlinkVariables, unschedule
-
-
-
-
Method Detail
-
propagate
public void propagate(int evtmask) throws ContradictionExceptionDescription copied from class:PropagatorCall the main filtering algorithm to apply to theDomainof theVariableobjects. It considers the current state of this objects to remove some values from domains and/or instantiate some variables. Calling this method is done from 2 (and only 2) steps:
- at the initial propagation step,
- when involved in a reified constraint.
It should initialized the internal data structure and apply filtering algorithm from scratch.- Specified by:
propagatein classPropagator<IntVar>- Parameters:
evtmask- type of propagation eventthismust consider.- Throws:
ContradictionException- when a contradiction occurs, like domain wipe out or other incoherencies.
-
propagate
public void propagate(int varIdx, int mask) throws ContradictionExceptionDescription copied from class:PropagatorIncremental filtering algorithm defined within thePropagator, called whenever the variable of index idxVarInProp has changed. This method calls a CUSTOM_PROPAGATION (coarse-grained) by default.This method should be overridden if the argument
reactToFineEvtis set totruein the constructor. Otherwise, it executespropagate(PropagatorEventType.CUSTOM_PROPAGATION.getStrengthenedMask());- Overrides:
propagatein classPropagator<IntVar>- Parameters:
varIdx- index of the variablevarinthismask- type of event- Throws:
ContradictionException- if a contradiction occurs
-
isEntailed
public ESat isEntailed()
Description copied from class:PropagatorCheck wetherthisis entailed according to the current state of its internal structure. At least, should check the satisfaction ofthis(when all is instantiated).- Specified by:
isEntailedin classPropagator<IntVar>- Returns:
- ESat.TRUE if entailed, ESat.FALSE if not entailed, ESat.UNDEFINED if unknown
-
toString
public String toString()
- Overrides:
toStringin classPropagator<IntVar>
-
updateLowerBoundofX
protected void updateLowerBoundofX() throws ContradictionException- Throws:
ContradictionException
-
updateUpperBoundofX
protected void updateUpperBoundofX() throws ContradictionException- Throws:
ContradictionException
-
updateHolesinX
protected void updateHolesinX() throws ContradictionException- Throws:
ContradictionException
-
updateHoleinX
protected void updateHoleinX(int remVal) throws ContradictionException- Throws:
ContradictionException
-
updateLowerBoundofY
protected void updateLowerBoundofY() throws ContradictionException- Throws:
ContradictionException
-
updateUpperBoundofY
protected void updateUpperBoundofY() throws ContradictionException- Throws:
ContradictionException
-
updateHolesinY
protected void updateHolesinY() throws ContradictionException- Throws:
ContradictionException
-
updateHoleinY
protected void updateHoleinY(int remVal) throws ContradictionException- Throws:
ContradictionException
-
why
public boolean why(RuleStore ruleStore, IntVar var, IEventType evt, int value)
Description copied from interface:ICauseAdd new rules to the rule store- Specified by:
whyin interfaceICause- Overrides:
whyin classPropagator<IntVar>- Parameters:
ruleStore- the rule storevar- the modified variableevt- the undergoing eventvalue- the value (for REMOVE only)- Returns:
- true if at least one rule has been added to the rule store
-
-