org.clafer.choco.constraint.propagator

Class PropJoinFunction

java.lang.Object

solver.constraints.Propagator<solver.variables.Variable>

org.clafer.choco.constraint.propagator.PropJoinFunction

All Implemented Interfaces:

Serializable, Comparable<solver.constraints.Propagator>, solver.ICause, solver.Identity

public class PropJoinFunction
extends solver.constraints.Propagator<solver.variables.Variable>

Join a unary set relation with a binary function. This propagator is a specialized version of PropJoinRelation. The take variable is the unary relation and the ref variables are the function. The to variable is the result of the join.

Here is how the binary function is encoded. Consider the function: (0, 1), (1, 3), (2, 1). This is encoded as 3 different ref variables: ref0={1}, ref1={3}, ref2={1}.

Author:

jimmy

See Also:

Serialized Form

Field Summary

Fields inherited from class solver.constraints.Propagator

aCause, ACTIVE, coarseERcalls, constraint, environment, eventmasks, fails, fineERcalls, LOGGER, NEW, PASSIVE, priority, reactToFineEvt, REIFIED, solver, vars

Constructor Summary

Constructors

Constructor and Description
PropJoinFunction(solver.variables.SetVar take, solver.variables.IntVar[] refs, solver.variables.SetVar to)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	advise(int idxVarInProp, int mask)
int	getPropagationConditions(int vIdx)
util.ESat	isEntailed()
void	propagate(int evtmask)
void	propagate(int idxVarInProp, int mask)
String	toString()

Methods inherited from class solver.constraints.Propagator

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PropJoinFunction

public PropJoinFunction(solver.variables.SetVar take,
                solver.variables.IntVar[] refs,
                solver.variables.SetVar to)

Method Detail

advise

public boolean advise(int idxVarInProp,
             int mask)

Overrides:

advise in class solver.constraints.Propagator<solver.variables.Variable>

getPropagationConditions

public int getPropagationConditions(int vIdx)

Specified by:

getPropagationConditions in class solver.constraints.Propagator<solver.variables.Variable>

propagate

public void propagate(int evtmask)
               throws solver.exception.ContradictionException

Specified by:

propagate in class solver.constraints.Propagator<solver.variables.Variable>

Throws:

solver.exception.ContradictionException

propagate

public void propagate(int idxVarInProp,
             int mask)
               throws solver.exception.ContradictionException

Specified by:

propagate in class solver.constraints.Propagator<solver.variables.Variable>

Throws:

solver.exception.ContradictionException

isEntailed

public util.ESat isEntailed()

Specified by:

isEntailed in class solver.constraints.Propagator<solver.variables.Variable>

toString

public String toString()

Overrides:

toString in class Object