org.chocosolver.solver.variables.impl

Class AbstractVariable

java.lang.Object

org.chocosolver.solver.variables.impl.AbstractVariable

All Implemented Interfaces:

Serializable, Comparable<Variable>, Identity, Variable

Direct Known Subclasses:

BitsetArrayIntVarImpl, BitsetIntVarImpl, BoolVarImpl, FixedIntVarImpl, FixedSetVarImpl, IntervalIntVarImpl, IntView, RealVarImpl, RealView, SetVarImpl

public abstract class AbstractVariable
extends Object
implements Variable

Class used to factorise code The subclass must implement Variable interface

Since:

30 june 2011

Author:

Jean-Guillaume Fages, Charles Prud'homme

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	_plugexpl
protected int	mIdx
protected int	modificationEvents
protected IVariableMonitor[]	monitors
static String	MSG_BOUND
static String	MSG_EMPTY
static String	MSG_INST
static String	MSG_LOW
static String	MSG_REMOVE
static String	MSG_UNKNOWN
static String	MSG_UPP
protected String	name
protected Solver	solver

Fields inherited from interface org.chocosolver.solver.variables.Variable

BOOL, CSTE, INT, KIND, REAL, SET, TYPE, VAR, VIEW

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractVariable(String name, Solver solver)

Method Summary

Methods

Modifier and Type	Method and Description
void	addMonitor(IVariableMonitor monitor) Build and add a monitor to the monitor list of this.
int	compareTo(Variable o)
int	getId()
int	getIndexInPropagator(int pidx) Return the position of the variable in the propagator at position pidx
String	getName() Returns the name of this
int	getNbProps() Return the number of propagators
int[]	getPIndices()
Propagator	getPropagator(int idx) Return the "idx" th propagator of this
Propagator[]	getPropagators() Return the array of propagators this
Solver	getSolver() Return the associated solver
IView[]	getViews() Get the views observing this variables
boolean	isBool()
int	link(Propagator propagator, int idxInProp) Link the propagator to this
void	notifyPropagators(IEventType event, ICause cause) If this has changed, then notify all of its observers.
void	notifyViews(IEventType event, ICause cause) Notify views of observed variable modifications
void	recordMask(int mask) Analysis propagator event reaction on this, and adapt this
void	removeMonitor(IVariableMonitor monitor)
void	subscribeView(IView view)
String	toString()
void	unlink(Propagator propagator) Remove a propagator from the list of propagator of this.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.chocosolver.solver.variables.Variable

contradiction, createDelta, duplicate, duplicate, getDelta, getTypeAndKind, isInstantiated, notifyMonitors

Field Detail

MSG_REMOVE

public static final String MSG_REMOVE

See Also:

Constant Field Values

MSG_EMPTY

public static final String MSG_EMPTY

See Also:

Constant Field Values

MSG_INST

public static final String MSG_INST

See Also:

Constant Field Values

MSG_UNKNOWN

public static final String MSG_UNKNOWN

See Also:

Constant Field Values

MSG_UPP

public static final String MSG_UPP

See Also:

Constant Field Values

MSG_LOW

public static final String MSG_LOW

See Also:

Constant Field Values

MSG_BOUND

public static final String MSG_BOUND

See Also:

Constant Field Values

solver

protected final Solver solver

name

protected final String name

monitors

protected IVariableMonitor[] monitors

mIdx

protected int mIdx

modificationEvents

protected int modificationEvents

_plugexpl

protected final boolean _plugexpl

Constructor Detail

AbstractVariable

protected AbstractVariable(String name,
                Solver solver)

Method Detail

getId

public int getId()

Specified by:

getId in interface Identity

link

public int link(Propagator propagator,
       int idxInProp)

Description copied from interface: Variable

Link the propagator to this

Specified by:

link in interface Variable

Parameters:

propagator - a newly added propagator

idxInProp - index of the variable in the propagator

Returns:

return the index of the propagator within the variable

recordMask

public void recordMask(int mask)

Description copied from interface: Variable

Analysis propagator event reaction on this, and adapt this

Specified by:

recordMask in interface Variable

Parameters:

mask - event mask

unlink

public void unlink(Propagator propagator)

Description copied from interface: Variable

Remove a propagator from the list of propagator of this. SHOULD BE CONTAINED IN THIS.

Specified by:

unlink in interface Variable

Parameters:

propagator - the propagator to remove

getPropagators

public Propagator[] getPropagators()

Description copied from interface: Variable

Return the array of propagators this

Specified by:

getPropagators in interface Variable

Returns:

the array of proapgators of this

getPropagator

public Propagator getPropagator(int idx)

Description copied from interface: Variable

Return the "idx" th propagator of this

Specified by:

getPropagator in interface Variable

Parameters:

idx - position of the propagator

Returns:

a propagator

getNbProps

public int getNbProps()

Description copied from interface: Variable

Return the number of propagators

Specified by:

getNbProps in interface Variable

Returns:

number of propagators of this

getPIndices

public int[] getPIndices()

Specified by:

getPIndices in interface Variable

getIndexInPropagator

public int getIndexInPropagator(int pidx)

Description copied from interface: Variable

Return the position of the variable in the propagator at position pidx

Specified by:

getIndexInPropagator in interface Variable

Parameters:

pidx - index of the propagator within the list of propagators of this

Returns:

position of this in the propagator pidx

getName

public String getName()

Description copied from interface: Variable

Returns the name of this

Specified by:

getName in interface Variable

Returns:

a String representing the name of this

notifyPropagators

public void notifyPropagators(IEventType event,
                     ICause cause)
                       throws ContradictionException

Description copied from interface: Variable

If this has changed, then notify all of its observers.
Each observer has its update method.

Specified by:

notifyPropagators in interface Variable

Parameters:

event - event on this object

cause - object which leads to the modification of this object

Throws:

ContradictionException - if a contradiction occurs during notification

notifyViews

public void notifyViews(IEventType event,
               ICause cause)
                 throws ContradictionException

Description copied from interface: Variable

Notify views of observed variable modifications

Specified by:

notifyViews in interface Variable

Parameters:

event - the event which occurred on the variable

Throws:

ContradictionException

addMonitor

public void addMonitor(IVariableMonitor monitor)

Description copied from interface: Variable

Build and add a monitor to the monitor list of this. The monitor is inactive at the creation and must be activated (by the engine propagation).

Specified by:

addMonitor in interface Variable

Parameters:

monitor - a variable monitor

removeMonitor

public void removeMonitor(IVariableMonitor monitor)

Specified by:

removeMonitor in interface Variable

subscribeView

public void subscribeView(IView view)

Specified by:

subscribeView in interface Variable

getSolver

public Solver getSolver()

Description copied from interface: Variable

Return the associated solver

Specified by:

getSolver in interface Variable

Returns:

a Solver object

getViews

public IView[] getViews()

Description copied from interface: Variable

Get the views observing this variables

Specified by:

getViews in interface Variable

Returns:

views observing this variables

compareTo

public int compareTo(Variable o)

Specified by:

compareTo in interface Comparable<Variable>

toString

public String toString()

Overrides:

toString in class Object

isBool

public boolean isBool()