org.chocosolver.solver.constraints.nary.cumulative

Class PropFullCumulative

java.lang.Object

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

org.chocosolver.solver.constraints.nary.cumulative.PropFullCumulative

All Implemented Interfaces:

Serializable, Comparable<Propagator>, ICause, Identity

Direct Known Subclasses:

PropGraphCumulative

public class PropFullCumulative
extends Propagator<IntVar>

Cumulative propagator Performs energy checking and mandatory part based filtering BEWARE : not idempotent, use two propagators to get the fix point

Since:

31/01/13

Author:

Jean-Guillaume Fages

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Cumulative.Filter[]	_filters
protected ISet	allTasks
protected int	awakeningMask
protected IntVar	capa
protected IntVar[]	d
protected IntVar[]	e
protected boolean	fast
protected CumulFilter[]	filters
protected IntVar[]	h
protected IStateInt	lastCapaMax
protected int	n
protected IntVar[]	s

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

aCause, ACTIVE, constraint, LOGGER, NEW, PASSIVE, priority, reactToFineEvt, REIFIED, solver, vars

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PropFullCumulative(IntVar[] s, IntVar[] d, IntVar[] e, IntVar[] h, IntVar capa, boolean reactToFineEvt, boolean fast, Cumulative.Filter... filters) protected constructor, should not be called by a user
	PropFullCumulative(IntVar[] s, IntVar[] d, IntVar[] e, IntVar[] h, IntVar capa, boolean fast, Cumulative.Filter... filters) Classical cumulative propagator

Method Summary

Methods

Modifier and Type	Method and Description
void	duplicate(Solver solver, gnu.trove.map.hash.THashMap<Object,Object> identitymap) Duplicate the current propagator.
void	filter(ISet tasks)
int	getPropagationConditions(int idx) Return the specific mask indicating the variable events on which this Propagator object can react.
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 varIdx, int mask) Incremental filtering algorithm defined within the Propagator, called whenever the variable of index idxVarInProp has changed.
protected void	propIni()
String	toString()
protected void	updateMaxCapa()

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

addVariable, advise, arity, compareTo, contradiction, decNbPendingEvt, defineIn, dynPriority, flushPendingEvt, forcePropagate, getConstraint, getId, getNbPendingEvt, getNbVars, getPriority, getSolver, getVar, getVars, getVIndices, hashCode, incNbPendingEvt, isActive, isCompletelyInstantiated, isPassive, isReifiedAndSilent, isStateLess, reactToFineEvent, setActive, setPassive, setReifiedSilent, setReifiedTrue, setVIndices, why

Methods inherited from class java.lang.Object

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

Field Detail

n

protected final int n

s

protected final IntVar[] s

d

protected final IntVar[] d

e

protected final IntVar[] e

h

protected final IntVar[] h

capa

protected final IntVar capa

filters

protected CumulFilter[] filters

allTasks

protected ISet allTasks

fast

protected final boolean fast

awakeningMask

protected final int awakeningMask

lastCapaMax

protected final IStateInt lastCapaMax

_filters

protected final Cumulative.Filter[] _filters

Constructor Detail

PropFullCumulative

protected PropFullCumulative(IntVar[] s,
                  IntVar[] d,
                  IntVar[] e,
                  IntVar[] h,
                  IntVar capa,
                  boolean reactToFineEvt,
                  boolean fast,
                  Cumulative.Filter... filters)

protected constructor, should not be called by a user

PropFullCumulative

public PropFullCumulative(IntVar[] s,
                  IntVar[] d,
                  IntVar[] e,
                  IntVar[] h,
                  IntVar capa,
                  boolean fast,
                  Cumulative.Filter... filters)

Classical cumulative propagator

Parameters:

s - start variables

d - duration variables

e - end variables

h - height variables

capa - capacity variable

fast - optimization parameter: reduces the amount of filtering calls when set to true (only reacts to instantiation events)

filters - filtering algorithm to use

Method Detail

getPropagationConditions

public int getPropagationConditions(int idx)

Description copied from class: Propagator

Return the specific mask indicating the variable events on which this Propagator object can react.
Checks are made applying bitwise AND between the mask and the event. Reacts to any kind of event by default.

Overrides:

getPropagationConditions in class Propagator<IntVar>

Parameters:

idx - index of the variable within the propagator

Returns:

int composed of REMOVE and/or INSTANTIATE and/or DECUPP and/or INCLOW

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 varIdx,
             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:

varIdx - index of the variable var in this

mask - type of event

Throws:

ContradictionException - if a contradiction occurs

propIni

protected void propIni()
                throws ContradictionException

Throws:

ContradictionException

updateMaxCapa

protected void updateMaxCapa()
                      throws ContradictionException

Throws:

ContradictionException

filter

public void filter(ISet tasks)
            throws ContradictionException

Throws:

ContradictionException

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>

duplicate

public void duplicate(Solver solver,
             gnu.trove.map.hash.THashMap<Object,Object> identitymap)

Description copied from class: Propagator

Duplicate the current propagator. A restriction is that the resolution process should have not begun yet. That's why state of the propagator may not be duplicated.

Overrides:

duplicate in class Propagator<IntVar>

Parameters:

solver - the target solver

identitymap - a map to ensure uniqueness of objects