Module org.chocosolver

Package org.chocosolver.solver.constraints.reification

Class PropXinSReif

java.lang.Object

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

org.chocosolver.solver.constraints.reification.PropXinSReif

All Implemented Interfaces:

Comparable<Propagator>, ICause, Identity

public class PropXinSReif
extends Propagator<IntVar>

A propagator dedicated to express in a compact way: (x = c) ⇔ b

Since:

03/05/2016.

Author:

Charles Prud'homme

Field Summary

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

ACTIVE, constraint, DEFAULT_EXPL, model, operations, OUTPUT_DEFAULT_EXPL, priority, reactToFineEvt, state, vars

Constructor Summary

Constructors

Constructor	Description
PropXinSReif(IntVar x, IntIterableRangeSet set, BoolVar r)

Method Summary

Modifier and Type	Method	Description
void	explain(ExplanationForSignedClause explanation, ValueSortedMap<IntVar> front, Implications ig, int p)	Clausal explanation for this cause.
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.
String	toString()

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

addVariable, arity, compareTo, defaultExplain, doFinePropagation, doFlush, doSchedule, doScheduleEvent, dynPriority, equals, fails, forcePropagate, forcePropagationOnBacktrack, forEachIntVar, getConstraint, getId, getModel, getNbVars, getPosition, getPriority, getPropagationConditions, getVar, getVars, getVIndice, getVIndices, hashCode, isActive, isCompletelyInstantiated, isPassive, isReified, isReifiedAndSilent, isScheduled, isStateLess, linkVariables, propagate, reactToFineEvent, reifiedWith, setActive, setActive0, setPassive, setPosition, setReifiedSilent, setReifiedTrue, setVIndices, unlinkVariables, unschedule

Methods inherited from class java.lang.Object

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

Constructor Detail

PropXinSReif

public PropXinSReif(IntVar x,
                    IntIterableRangeSet set,
                    BoolVar r)

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.

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

explain

public void explain(ExplanationForSignedClause explanation,
                    ValueSortedMap<IntVar> front,
                    Implications ig,
                    int p)

Description copied from interface: ICause

Clausal explanation for this cause.

This method must filled explanations with inferred literals. These literals are inferred from the analysis of (a subset of) conflicting nodes stored in front, the implication graph ig and the current node in conflict, not yet contained in front.

Optionally, this method can update front by looking for a predecessor of any node that seems more relevant than the declared one.

Specified by:

explain in interface ICause

Overrides:

explain in class Propagator<IntVar>

Parameters:

explanation - explanation to compute

front - ordered map of (variable,node> in the conflict frontier of the implication graph.

ig - an implication graph

p - the pivot node out of front

toString

public String toString()

Overrides:

toString in class Propagator<IntVar>