public class FixedIntVarImpl extends AbstractVariable implements IntVar
| Modifier and Type | Field and Description |
|---|---|
protected int |
constante |
protected IStateBool |
empty |
_plugexpl, mIdx, modificationEvents, monitors, MSG_BOUND, MSG_EMPTY, MSG_INST, MSG_LOW, MSG_REMOVE, MSG_UNKNOWN, MSG_UPP, name, solver| Constructor and Description |
|---|
FixedIntVarImpl(String name,
int constante,
Solver solver) |
| Modifier and Type | Method and Description |
|---|---|
void |
addMonitor(IVariableMonitor monitor)
Build and add a monitor to the monitor list of
this. |
boolean |
contains(int value)
Checks if a value
v belongs to the domain of this |
void |
contradiction(ICause cause,
IEventType event,
String message)
Throws a contradiction exception based on
|
void |
createDelta()
Create a delta, if necessary, in order to observe removed values of a this.
|
IntVar |
duplicate()
Duplicate
this. |
void |
duplicate(Solver solver,
gnu.trove.map.hash.THashMap<Object,Object> identitymap)
Duplicate
this (which naturally adds it into solver). |
NoDelta |
getDelta()
Return the delta domain of this
|
int |
getDomainSize()
Returns the size of the domain of
this |
int |
getLB()
Retrieves the lower bound of the variable
|
DisposableRangeIterator |
getRangeIterator(boolean bottomUp)
Retrieves an iterator over ranges (or intervals) of
this. |
int |
getTypeAndKind()
Return a MASK composed of 2 main information: TYPE and KIND.
|
int |
getUB()
Retrieves the upper bound of the variable
|
int |
getValue()
Retrieves the current value of the variable if instantiated, otherwier the lower bound.
|
DisposableValueIterator |
getValueIterator(boolean bottomUp)
Retrieves an iterator over values of
this. |
boolean |
hasEnumeratedDomain()
Indicates wether (or not)
this has an enumerated domain (represented in extension)
or not (only bounds) |
boolean |
instantiateTo(int value,
ICause cause)
Instantiates the domain of
this to value. |
boolean |
isInstantiated()
Indicates whether
this is instantiated (see implemtations to know what instantiation means). |
boolean |
isInstantiatedTo(int value)
Checks wether
this is instantiated to val |
IIntDeltaMonitor |
monitorDelta(ICause propagator)
Allow to monitor removed values of
this. |
int |
nextValue(int v)
Returns the next value just after v in
this. |
void |
notifyMonitors(IEventType event)
Notify monitors of observed variable modifications
|
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
|
int |
previousValue(int v)
Returns the previous value just befor v in
this. |
void |
recordMask(int mask)
Analysis propagator event reaction on this, and adapt this
|
boolean |
removeInterval(int from,
int to,
ICause cause)
Removes values between [
from, to] from the domain of this. |
boolean |
removeValue(int value,
ICause cause)
Removes
valuefrom the domain of this. |
void |
subscribeView(IView view) |
String |
toString() |
boolean |
updateLowerBound(int value,
ICause cause)
Updates the lower bound of the domain of
this to value. |
boolean |
updateUpperBound(int value,
ICause cause)
Updates the upper bound of the domain of
this to value. |
compareTo, getId, getIndexInPropagator, getName, getNbProps, getPIndices, getPropagator, getPropagators, getSolver, getViews, isBool, link, removeMonitor, unlinkclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetIndexInPropagator, getName, getNbProps, getPIndices, getPropagator, getPropagators, getSolver, getViews, link, removeMonitor, unlinkcompareToprotected final int constante
protected IStateBool empty
public boolean removeValue(int value,
ICause cause)
throws ContradictionException
IntVarvaluefrom the domain of this. The instruction comes from propagator.
value is out of the domain, nothing is done and the return value is false,value leads to a dead-end (domain wipe-out),
a ContradictionException is thrown,value from the domain can be done safely,
the event type is created (the original event can be promoted) and observers are notified
and the return value is trueremoveValue in interface IntVarvalue - value to remove from the domain (int)cause - removal releaserContradictionException - if the domain become empty due to this actionpublic boolean removeInterval(int from,
int to,
ICause cause)
throws ContradictionException
IntVarfrom, to] from the domain of this. The instruction comes from propagator.
false,value leads to a dead-end (domain wipe-out),
a ContradictionException is thrown,value from the domain can be done safely,
the event type is created (the original event can be promoted) and observers are notified
and the return value is trueremoveInterval in interface IntVarfrom - lower bound of the interval to remove (int)to - upper bound of the interval to remove(int)cause - removal releaserContradictionException - if the domain become empty due to this actionpublic boolean instantiateTo(int value,
ICause cause)
throws ContradictionException
IntVarthis to value. The instruction comes from propagator.
this is already instantiated to value,
nothing is done and the return value is false,this is already instantiated to another value,
then a ContradictionException is thrown,this is restricted to value and the observers are notified
and the return value is true.instantiateTo in interface IntVarvalue - instantiation value (int)cause - instantiation releaserContradictionException - if the domain become empty due to this actionpublic boolean updateLowerBound(int value,
ICause cause)
throws ContradictionException
IntVarthis to value.
The instruction comes from propagator.
value is smaller than the lower bound of the domain, nothing is done and the return value is false,value leads to a dead-end (domain wipe-out),
a ContradictionException is thrown,value can be done safely,
the event type is created (the original event can be promoted) and observers are notified
and the return value is trueupdateLowerBound in interface IntVarvalue - new lower bound (included)cause - updating releaserContradictionException - if the domain become empty due to this actionpublic boolean updateUpperBound(int value,
ICause cause)
throws ContradictionException
IntVarthis to value.
The instruction comes from propagator.
value is greater than the upper bound of the domain, nothing is done and the return value is false,value leads to a dead-end (domain wipe-out),
a ContradictionException is thrown,value can be done safely,
the event type is created (the original event can be promoted) and observers are notified
and the return value is trueupdateUpperBound in interface IntVarvalue - new upper bound (included)cause - update releaserContradictionException - if the domain become empty due to this actionpublic boolean contains(int value)
IntVarv belongs to the domain of thispublic boolean isInstantiatedTo(int value)
IntVarthis is instantiated to valisInstantiatedTo in interface IntVarvalue - intthis is instantiated to val, false otherwisepublic int getValue()
IntVarpublic int getLB()
IntVarpublic int getUB()
IntVarpublic int getDomainSize()
IntVarthisgetDomainSize in interface IntVarpublic int nextValue(int v)
IntVarthis.
If no such value exists, returns Integer.MAX_VALUE;
To iterate over the values in a IntVar,
use the following loop:
int ub = iv.getUB();
for (int i = iv.getLB(); i <= ub; i = iv.nextValue(i)) {
// operate on value i here
}public int previousValue(int v)
IntVarthis.
If no such value exists, returns Integer.MIN_VALUE;
To iterate over the values in a IntVar,
use the following loop:
int lb = iv.getLB();
for (int i = iv.getUB(); i >= lb; i = iv.previousValue(i)) {
// operate on value i here
}previousValue in interface IntVarv - the value to start checking (exclusive)public boolean hasEnumeratedDomain()
IntVarthis has an enumerated domain (represented in extension)
or not (only bounds)hasEnumeratedDomain in interface IntVartrue if the domain is enumerated, false otherwise.public NoDelta getDelta()
Variablepublic boolean isInstantiated()
Variablethis is instantiated (see implemtations to know what instantiation means).isInstantiated in interface Variabletrue if this is instantiatedpublic void addMonitor(IVariableMonitor monitor)
Variablethis.
The monitor is inactive at the creation and must be activated (by the engine propagation).addMonitor in interface VariableaddMonitor in class AbstractVariablemonitor - a variable monitorpublic void subscribeView(IView view)
subscribeView in interface VariablesubscribeView in class AbstractVariablepublic void recordMask(int mask)
VariablerecordMask in interface VariablerecordMask in class AbstractVariablemask - event maskpublic IIntDeltaMonitor monitorDelta(ICause propagator)
IntVarthis.monitorDelta in interface IntVarpropagator - the cause that requires to monitor deltapublic void createDelta()
VariablecreateDelta in interface Variablepublic void notifyPropagators(IEventType event, ICause cause) throws ContradictionException
Variablethis has changed, then notify all of its observers.notifyPropagators in interface VariablenotifyPropagators in class AbstractVariableevent - event on this objectcause - object which leads to the modification of this objectContradictionException - if a contradiction occurs during notificationpublic void notifyMonitors(IEventType event) throws ContradictionException
VariablenotifyMonitors in interface Variableevent - the event which occurred on the variableContradictionExceptionpublic void notifyViews(IEventType event, ICause cause) throws ContradictionException
VariablenotifyViews in interface VariablenotifyViews in class AbstractVariableevent - the event which occurred on the variableContradictionExceptionpublic String toString()
toString in class AbstractVariablepublic void contradiction(ICause cause, IEventType event, String message) throws ContradictionException
Variablecontradiction in interface Variablecause - ICause causing the exceptionevent - event causing the contradictionmessage - the detailed message @throws ContradictionException expected behaviorContradictionExceptionpublic int getTypeAndKind()
Variableint type = var.getTypeAndKind() & Variable.TYPE;To get the KIND of a variable:
int kind = var.getTypeAndKind() & Variable.KIND;To check a specific type or kind of a variable:
boolean isVar = (var.getTypeAndKind() & Variable.VAR) !=0;
boolean isInt = (var.getTypeAndKind() & Variable.INT) !=0;
getTypeAndKind in interface Variablepublic void duplicate(Solver solver, gnu.trove.map.hash.THashMap<Object,Object> identitymap)
Variablethis (which naturally adds it into solver).public DisposableValueIterator getValueIterator(boolean bottomUp)
IntVarthis.
The values can be iterated in a bottom-up way or top-down way.
To bottom-up iterate over the values in a IntVar,
use the following loop:
DisposableValueIterator vit = var.getValueIterator(true);
while(vit.hasNext()){
int v = vit.next();
// operate on value v here
}
vit.dispose();
To top-down iterate over the values in a IntVar,
use the following loop:
DisposableValueIterator vit = var.getValueIterator(false);
while(vit.hasPrevious()){
int v = vit.previous();
// operate on value v here
}
vit.dispose();
Using both previous and next can lead to unexpected behaviour.getValueIterator in interface IntVarbottomUp - way to iterate over values. true means from lower bound to upper bound,
false means from upper bound to lower bound.this.public DisposableRangeIterator getRangeIterator(boolean bottomUp)
IntVarthis.
The ranges can be iterated in a bottom-up way or top-down way.
To bottom-up iterate over the values in a IntVar,
use the following loop:
DisposableRangeIterator rit = var.getRangeIterator(true);
while (rit.hasNext()) {
int from = rit.min();
int to = rit.max();
// operate on range [from,to] here
rit.next();
}
rit.dispose();
To top-down iterate over the values in a IntVar,
use the following loop:
DisposableRangeIterator rit = var.getRangeIterator(false);
while (rit.hasPrevious()) {
int from = rit.min();
int to = rit.max();
// operate on range [from,to] here
rit.previous();
}
rit.dispose();
Using both previous and next can lead to unexpected behaviour.getRangeIterator in interface IntVarbottomUp - way to iterate over ranges. true means from lower bound to upper bound,
false means from upper bound to lower bound.this.Copyright © 2015. All rights reserved.