Class PropElement
- java.lang.Object
-
- org.chocosolver.solver.constraints.Propagator<IntVar>
-
- org.chocosolver.solver.constraints.binary.element.PropElement
-
- All Implemented Interfaces:
Comparable<Propagator>,ICause,Identity
public class PropElement extends Propagator<IntVar>
VALUE = TABLE[INDEX-OFFSET], ensuring arc consistency on result and index.- Since:
- 02/02/12
- Author:
- Hadrien Cambazard, Fabien Hermenier, Charles Prud'homme, Jean-Guillaume Fages
-
-
Field Summary
-
Fields inherited from class org.chocosolver.solver.constraints.Propagator
constraint, model, priority, reactToFineEvt, vars
-
-
Constructor Summary
Constructors Constructor Description PropElement(IntVar value, int[] values, IntVar index, int offset)Create a propagator which ensures that VALUE = TABLE[INDEX-OFFSET] holds.
-
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.StringtoString()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, propagate, 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.
-
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>
-
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
-
-