Package org.chocosolver.sat
Class PropNogoods
- java.lang.Object
-
- org.chocosolver.solver.constraints.Propagator<IntVar>
-
- org.chocosolver.sat.PropNogoods
-
- All Implemented Interfaces:
Comparable<Propagator>,ICause,Identity
public class PropNogoods extends Propagator<IntVar>
A propagator to store and propagate no-goods. Created by cprudhom on 20/01/15. Project: choco.- 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 PropNogoods(Model model)Create a (unique) propagator for no-goods recording and propagation.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddLearnt(int... lits)Add learnt clause to no-goods storebooleanaddNogood(int p)Add unit clause to no-goods storebooleanaddNogood(gnu.trove.list.TIntList lits)Add unit clause to no-goods storevoidinitialize()Initializes this propagatorESatisEntailed()Check wetherthisis entailed according to the current state of its internal structure.intLiteral(IntVar ivar, int value, boolean eq)Creates or returns if already existing, the literal corresponding to :voidpropagate(int evtmask)Call the main filtering algorithm to apply to theDomainof theVariableobjects.voidpropagate(int idxVarInProp, int mask)Incremental filtering algorithm defined within thePropagator, called whenever the variable of index idxVarInProp has changed.booleanwhy(RuleStore ruleStore, IntVar ivar, IEventType evt, int ivalue)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, toString, unlinkVariables, unschedule
-
-
-
-
Constructor Detail
-
PropNogoods
public PropNogoods(Model model)
Create a (unique) propagator for no-goods recording and propagation.- Parameters:
model- the model that declares the propagator
-
-
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 idxVarInProp, 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:
idxVarInProp- 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
-
initialize
public void initialize()
Initializes this propagator
-
Literal
public int Literal(IntVar ivar, int value, boolean eq)
Creates or returns if already existing, the literal corresponding to :ivar(eq?"=":"<=")valuewhere "=" is selected if
eqis true, "<=" otherwise.The negation of the literal is managed outside.
- Parameters:
ivar- an integer variablevalue- a valueeq- set to true to select "=", to false to select "<=".- Returns:
- the literal corresponding to
ivar(eq?"=":"<=")value
-
addNogood
public boolean addNogood(int p)
Add unit clause to no-goods store- Parameters:
p- unit clause- Returns:
- false if failure is detected
-
addNogood
public boolean addNogood(gnu.trove.list.TIntList lits)
Add unit clause to no-goods store- Parameters:
lits- clause- Returns:
- false if failure is detected
-
addLearnt
public void addLearnt(int... lits)
Add learnt clause to no-goods store- Parameters:
lits- clause
-
why
public boolean why(RuleStore ruleStore, IntVar ivar, IEventType evt, int ivalue)
Description copied from interface:ICauseAdd new rules to the rule store- Specified by:
whyin interfaceICause- Overrides:
whyin classPropagator<IntVar>- Parameters:
ruleStore- the rule storeivar- the modified variableevt- the undergoing eventivalue- the value (for REMOVE only)- Returns:
- true if at least one rule has been added to the rule store
-
-