org.chocosolver.solver.constraints.reification

Class PropReif

java.lang.Object

org.chocosolver.solver.constraints.Propagator<Variable>

org.chocosolver.solver.constraints.reification.PropReif

All Implemented Interfaces:

Comparable<Propagator>, ICause, Identity

public class PropReif
extends Propagator<Variable>

Implication propagator

Since:

02/2013

Author:

Jean-Guillaume Fages

Field Summary

Fields inherited from class org.chocosolver.solver.constraints.Propagator

ACTIVE, constraint, model, NEW, PASSIVE, priority, reactToFineEvt, REIFIED, vars

Constructor Summary

Constructors

Constructor and Description
PropReif(Variable[] allVars, Constraint consIfBoolTrue, Constraint consIfBoolFalse)

Method Summary

Modifier and Type	Method and Description
ESat	isEntailed() Check wether this is entailed according to the current state of its internal structure.
void	propagate(int evtmask) Call the main filtering algorithm to apply to the Domain of the Variable objects.
void	setReifCons(ReificationConstraint reifCons)
String	toString()
boolean	why(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, defineIn, dynPriority, equals, fails, forcePropagate, forcePropagationOnBacktrack, getConstraint, getId, getModel, getNbVars, getPriority, getPropagationConditions, getVar, getVars, getVIndices, hashCode, isActive, isCompletelyInstantiated, isPassive, isReifiedAndSilent, isStateLess, linkVariables, propagate, reactToFineEvent, setActive, setPassive, setReifiedSilent, setReifiedTrue, setVIndices

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PropReif

public PropReif(Variable[] allVars,
                Constraint consIfBoolTrue,
                Constraint consIfBoolFalse)

Method Detail

setReifCons

public void setReifCons(ReificationConstraint reifCons)

propagate

public void propagate(int evtmask)
               throws ContradictionException

Description copied from class: Propagator

Call the main filtering algorithm to apply to the Domain of the Variable objects. 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:

propagate in class Propagator<Variable>

Parameters:

evtmask - type of propagation event this must consider.

Throws:

ContradictionException - when a contradiction occurs, like domain wipe out or other incoherencies.

isEntailed

public ESat isEntailed()

Description copied from class: Propagator

Check wether this is entailed according to the current state of its internal structure. At least, should check the satisfaction of this (when all is instantiated).

Specified by:

isEntailed in class Propagator<Variable>

Returns:

ESat.TRUE if entailed, ESat.FALSE if not entailed, ESat.UNDEFINED if unknown

why

public boolean why(RuleStore ruleStore,
                   IntVar var,
                   IEventType evt,
                   int value)

Description copied from interface: ICause

Add new rules to the rule store

Specified by:

why in interface ICause

Overrides:

why in class Propagator<Variable>

Parameters:

ruleStore - the rule store

var - the modified variable

evt - the undergoing event

value - the value (for REMOVE only)

Returns:

true if at least one rule has been added to the rule store

toString

public String toString()

Overrides:

toString in class Propagator<Variable>