Module org.chocosolver

Package org.chocosolver.solver.constraints.nary.lex

Class PropLex

java.lang.Object

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

org.chocosolver.solver.constraints.nary.lex.PropLex

All Implemented Interfaces:

Comparable<Propagator>, ICause, Identity

public class PropLex
extends Propagator<IntVar>

Enforce a lexicographic ordering on two vectors of integer variables x <_lex y with x = , and y = . ref : Global Constraints for Lexicographic Orderings (Frisch and al)

Since:

10/08/11

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
PropLex(IntVar[] X, IntVar[] Y, boolean strict)

Method Summary

Modifier and Type	Method	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.
String	toString()

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

addVariable, arity, compareTo, defaultExplain, doFinePropagation, doFlush, doSchedule, doScheduleEvent, dynPriority, equals, explain, fails, forcePropagate, forcePropagationOnBacktrack, forEachIntVar, getConstraint, getId, getModel, getNbVars, getPosition, getPriority, getPropagationConditions, getVar, getVars, getVIndice, getVIndices, hashCode, isActive, isCompletelyInstantiated, isPassive, isReified, isReifiedAndSilent, isScheduled, isStateLess, linkVariables, 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

PropLex

public PropLex(IntVar[] X,
               IntVar[] Y,
               boolean strict)

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

toString

public String toString()

Overrides:

toString in class Propagator<IntVar>