org.chocosolver.solver.constraints.nary.channeling

Class PropClauseChanneling

java.lang.Object

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

org.chocosolver.solver.constraints.nary.channeling.PropClauseChanneling

All Implemented Interfaces:

Comparable<Propagator>, ICause, Identity

public class PropClauseChanneling
extends Propagator<IntVar>

A propagator which links an IntVar with two arrays of BoolVar, one for EQ relations, the other for LQ relations. Such a propagator is needed when clauses learning is on.

Created by cprudhom on 14/01/15. Project: choco.

Field Summary

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

constraint, model, priority, reactToFineEvt, vars

Constructor Summary

Constructors

Constructor and Description
PropClauseChanneling(IntVar iv, BoolVar[] eb, BoolVar[] lb)

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	propagate(int vidx, int mask) Incremental filtering algorithm defined within the Propagator, called whenever the variable of index idxVarInProp has changed.
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, 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

Methods inherited from class java.lang.Object

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

Constructor Detail

PropClauseChanneling

public PropClauseChanneling(IntVar iv,
                            BoolVar[] eb,
                            BoolVar[] lb)

Method Detail

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<IntVar>

Parameters:

evtmask - type of propagation event this must consider.

Throws:

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

propagate

public void propagate(int vidx,
                      int mask)
               throws ContradictionException

Description copied from class: Propagator

Incremental filtering algorithm defined within the Propagator, 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 reactToFineEvt is set to true in the constructor. Otherwise, it executes propagate(PropagatorEventType.CUSTOM_PROPAGATION.getStrengthenedMask());

Overrides:

propagate in class Propagator<IntVar>

Parameters:

vidx - index of the variable var in this

mask - type of event

Throws:

ContradictionException - if a contradiction occurs

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<IntVar>

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<IntVar>

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