choco.integer.constraints
Class AbstractUnIntConstraint

java.lang.Object
  choco.AbstractEntity
      choco.AbstractConstraint
          choco.integer.constraints.AbstractIntConstraint
              choco.integer.constraints.AbstractUnIntConstraint

All Implemented Interfaces:

Constraint, Entity, IntConstraint, IntVarEventListener, VarEventListener, Propagator, java.lang.Cloneable, java.util.EventListener

Direct Known Subclasses:

AbstractPalmUnIntConstraint, EqualXC, GreaterOrEqualXC, LessOrEqualXC, NotEqualXC

public abstract class AbstractUnIntConstraint
extends AbstractIntConstraint

An abstract class for all implementations of (unary) listeners over one search variable.

Field Summary

int	cIdx0 The index of the constraint among all listeners of its first (and unique) variable.
IntDomainVar	v0 The unique variable of the constraint.

Fields inherited from class choco.integer.constraints.AbstractIntConstraint

logger

Fields inherited from class choco.AbstractConstraint

active, constAwakeEvent, hook, priority

Fields inherited from class choco.AbstractEntity

problem

Constructor Summary

AbstractUnIntConstraint()

Method Summary

int	assignIndices(AbstractCompositeConstraint root, int i, boolean dynamicAddition) performs the global numbering (wrt root) of the variables contained in the subtree this, starting from i
int	getConstraintIdx(int idx) Returns the index of this listeners in the variable idx.
IntDomainVar	getIntVar(int i) Gets the ith search valued variable.
int	getNbVars() Returns the number of variables: 1 for an unIntConstraint.
Var	getVar(int i) Returns the variable number i.
boolean	isCompletelyInstantiated() Checks if all the variables of the constraint are instantiated.
void	propagate() Propagation on the constraint awake var.
void	setConstraintIndex(int i, int val) Let v be the i-th var of c, records that c is the n-th constraint involving v.
void	setVar(int i, Var v) Network management: Setting (or overwriting) the ith variable of a constraint.

Methods inherited from class choco.integer.constraints.AbstractIntConstraint

awakeOnBounds, awakeOnInf, awakeOnInst, awakeOnRem, awakeOnRemovals, awakeOnSup, getSelfIndex, isConsistent

Methods inherited from class choco.AbstractConstraint

addListener, awake, awakeOnVar, clone, connectVar, constAwake, delete, fail, getEvent, getPlugIn, getPriority, getProblem, getVarIdxInOpposite, isActive, isEntailed, isEquivalentTo, opposite, setActive, setEntailed, setPassive, setPlugIn, substituteVar

Methods inherited from class choco.AbstractEntity

pretty

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface choco.Propagator

awake, awakeOnVar, constAwake, delete, getEvent, getPlugIn, getPriority, isEntailed

Methods inherited from interface choco.prop.VarEventListener

addListener, isActive, setActive, setPassive

Methods inherited from interface choco.prop.VarEventListener

addListener, isActive, setActive, setPassive

Field Detail

v0

public IntDomainVar v0

The unique variable of the constraint.

cIdx0

public int cIdx0

The index of the constraint among all listeners of its first (and unique) variable.

Constructor Detail

AbstractUnIntConstraint

public AbstractUnIntConstraint()

Method Detail

setConstraintIndex

public void setConstraintIndex(int i,
                               int val)

Let v be the i-th var of c, records that c is the n-th constraint involving v.

Parameters:

i - index of the variable in the constraint

val - index of the constraint in the among all listeners linked to that variable

getConstraintIdx

public int getConstraintIdx(int idx)

Returns the index of this listeners in the variable idx.

Parameters:

idx - Index of the variable.

isCompletelyInstantiated

public boolean isCompletelyInstantiated()

Checks if all the variables of the constraint are instantiated.

Specified by:

isCompletelyInstantiated in interface Propagator

Overrides:

isCompletelyInstantiated in class AbstractIntConstraint

getNbVars

public int getNbVars()

Returns the number of variables: 1 for an unIntConstraint.

getVar

public Var getVar(int i)

Returns the variable number i. Here, i should be 0.

Parameters:

i - index of the variable in the constraint

setVar

public void setVar(int i,
                   Var v)

Description copied from interface: Constraint

Network management: Setting (or overwriting) the ith variable of a constraint.

Parameters:

i - index of the variable in the constraint

v - the variable (may be an IntDomainVar, SetVar, RealVar, ...

propagate

public void propagate()
               throws ContradictionException

Propagation on the constraint awake var.

Throws:

ContradictionException

getIntVar

public IntDomainVar getIntVar(int i)

Gets the ith search valued variable.

Parameters:

i - index of the variable among all search variables in the constraint. Numbering start from 0 on.

Returns:

the variable, or null when no such variable is found

assignIndices

public int assignIndices(AbstractCompositeConstraint root,
                         int i,
                         boolean dynamicAddition)

Description copied from interface: Propagator

performs the global numbering (wrt root) of the variables contained in the subtree this, starting from i

Parameters:

root - the overall root constraint, for which the variables are numbered

i - the index that will assigned to the first variable in the subtree this (originally 0)

dynamicAddition - whether the addition is undone automatically on backtracking

Returns:

the index of the last variable in the subtree