org.chocosolver.solver.constraints.set

Class PropMaxElement

java.lang.Object

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

org.chocosolver.solver.constraints.set.PropMaxElement

All Implemented Interfaces:

Serializable, Comparable<Propagator>, ICause, Identity

public class PropMaxElement
extends Propagator<Variable>

Retrieves the maximum element of the set the set must not be empty

Author:

Jean-Guillaume Fages

See Also:

Serialized Form

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
PropMaxElement(SetVar setVar, int[] weights, int offset, IntVar max, boolean notEmpty) Retrieves the maximum element induced by set MAX{weight[i-offset] | i in setVar} = max
PropMaxElement(SetVar setVar, IntVar max, boolean notEmpty) Retrieves the maximum element of the set MAX{i | i in setVar} = max

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.
int	getPropagationConditions(int vIdx) 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.

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, propagate, reactToFineEvent, setActive, setPassive, setReifiedSilent, setReifiedTrue, setVIndices, toString, why

Methods inherited from class java.lang.Object

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

Constructor Detail

PropMaxElement

public PropMaxElement(SetVar setVar,
              IntVar max,
              boolean notEmpty)

Retrieves the maximum element of the set MAX{i | i in setVar} = max

Parameters:

setVar - set variable

max - integer variable

notEmpty - true : the set variable cannot be empty false : the set may be empty (if so, the MAX constraint is not applied)

PropMaxElement

public PropMaxElement(SetVar setVar,
              int[] weights,
              int offset,
              IntVar max,
              boolean notEmpty)

Retrieves the maximum element induced by set MAX{weight[i-offset] | i in setVar} = max

Parameters:

setVar - set variable

weights - array of int

offset - int

max - integer variable

notEmpty - true : the set variable cannot be empty false : the set may be empty (if so, the MAX constraint is not applied)

Method Detail

getPropagationConditions

public int getPropagationConditions(int vIdx)

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

Parameters:

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

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

Parameters:

solver - the target solver

identitymap - a map to ensure uniqueness of objects