Class IntView<I extends IntVar>
- java.lang.Object
-
- org.chocosolver.solver.variables.impl.AbstractVariable
-
- org.chocosolver.solver.variables.view.IntView<I>
-
- All Implemented Interfaces:
Comparable<Variable>,Iterable<Integer>,ArExpression,ICause,Identity,IntVar,Variable,IView
- Direct Known Subclasses:
BoolNotView,MinusView,OffsetView,ScaleView
public abstract class IntView<I extends IntVar> extends AbstractVariable implements IView, IntVar
"A view implements the same operations as a variable. A view stores a reference to a variable. Invoking an operation on the view executes the appropriate operation on the view's variable." Based on "Views and Iterators for Generic Constraint Implementations"
C. Shulte and G. Tack.
Eleventh International Conference on Principles and Practice of Constraint Programming- Since:
- 18/03/11
- Author:
- Charles Prud'homme
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.chocosolver.solver.expression.discrete.arithmetic.ArExpression
ArExpression.Operator
-
-
Field Summary
Fields Modifier and Type Field Description protected IntDeltadeltaTo store removed valuesprotected IvarObserved variable-
Fields inherited from class org.chocosolver.solver.variables.impl.AbstractVariable
mIdx, model, monitors, MSG_EMPTY, MSG_INST, name, propagators
-
Fields inherited from interface org.chocosolver.solver.expression.discrete.arithmetic.ArExpression
NO_CHILD
-
Fields inherited from interface org.chocosolver.solver.variables.IntVar
MAX_INT_BOUND, MIN_INT_BOUND
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intcompareTo(Variable o)voidcreateDelta()Create a delta, if necessary, in order to observe removed values of a this.protected booleandoInstantiateVar(int value)Action to execute onvarwhen this view requires to instantiate itprotected booleandoRemoveIntervalFromVar(int from, int to)Action to execute onvarwhen this view requires to remove an interval from itprotected booleandoRemoveValueFromVar(int value)Action to execute onvarwhen this view requires to remove a value from itprotected booleandoUpdateLowerBoundOfVar(int value)Action to execute onvarwhen this view requires to update its lower boundprotected booleandoUpdateUpperBoundOfVar(int value)Action to execute onvarwhen this view requires to update its upper boundIDeltagetDelta()Return the delta domain of thisintgetDomainSize()Returns the size of this domain, that is the number of elements in this domain.intgetRange()Returns the range of this domain, that is, the difference between the upper bound and the lower bound.DisposableRangeIteratorgetRangeIterator(boolean bottomUp)Retrieves an iterator over ranges (or intervals) ofthis.intgetTypeAndKind()Return a MASK composed of 2 main information: TYPE and KIND.DisposableValueIteratorgetValueIterator(boolean bottomUp)Retrieves an iterator over values ofthis.IntVargetVariable()Return the basis variablebooleanhasEnumeratedDomain()Indicates wether (or not)thishas an enumerated domain (represented in extension) or not (only bounds)booleaninstantiateTo(int value, ICause cause)Instantiates the domain ofthistovalue.booleanisInstantiated()Indicates whetherthisis instantiated (see implemtations to know what instantiation means).Iterator<Integer>iterator()voidnotify(IEventType event)To notify a view that the variable is observed has been modified.voidnotifyMonitors(IEventType event)Notify monitors of observed variable modificationsbooleanremoveAllValuesBut(IntIterableSet values, ICause cause)Removes all values from the domain ofthisexcept those invalues.booleanremoveInterval(int from, int to, ICause cause)Removes values between [from, to] from the domain ofthis.booleanremoveValue(int value, ICause cause)Removesvaluefrom the domain ofthis.booleanremoveValues(IntIterableSet values, ICause cause)Removes the value invaluesfrom the domain ofthis.IEventTypetransformEvent(IEventType evt)booleanupdateBounds(int lb, int ub, ICause cause)Updates the lower bound and the upper bound of the domain ofthisto, resp.booleanupdateLowerBound(int value, ICause cause)Updates the lower bound of the domain ofthistovalue.booleanupdateUpperBound(int value, ICause cause)Updates the upper bound of the domain ofthistovalue.booleanwhy(RuleStore ruleStore, IntVar modifiedVar, IEventType evt, int value)Add new rules to the rule store-
Methods inherited from class org.chocosolver.solver.variables.impl.AbstractVariable
addMonitor, asBoolVar, asIntVar, asRealVar, asSetVar, clearEvents, contradiction, createScheduler, getCause, getDindex, getEvtScheduler, getId, getIndexInPropagator, getMask, getModel, getName, getNbProps, getPIndices, getPropagator, getPropagators, getViews, isAConstant, isBool, link, notifyPropagators, notifyViews, removeMonitor, setPIndice, storeEvents, subscribeView, swapOnActivate, swapOnPassivate, toString, unlink
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.chocosolver.solver.expression.discrete.arithmetic.ArExpression
abs, add, add, add, dist, dist, div, div, eq, eq, eq, extractVar, ge, ge, getExpressionChild, getModel, gt, gt, ieval, le, le, lt, lt, max, max, max, min, min, min, mod, mod, mul, mul, mul, ne, ne, neg, pow, pow, sqr, sub, sub
-
Methods inherited from interface org.chocosolver.solver.variables.IntVar
contains, getLB, getNoChild, getUB, getValue, intVar, isBool, isExpressionLeaf, isInstantiatedTo, monitorDelta, nextValue, nextValueOut, previousValue, previousValueOut, reverseValue, transformValue
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Methods inherited from interface org.chocosolver.solver.variables.view.IView
justifyEvent
-
Methods inherited from interface org.chocosolver.solver.variables.Variable
addMonitor, asBoolVar, asIntVar, asRealVar, asSetVar, clearEvents, contradiction, getCause, getDindex, getEnvironment, getEvtScheduler, getIndexInPropagator, getMask, getModel, getName, getNbProps, getPIndices, getPropagator, getPropagators, getViews, isAConstant, link, notifyPropagators, notifyViews, removeMonitor, setPIndice, storeEvents, subscribeView, swapOnActivate, swapOnPassivate, unlink
-
-
-
-
Method Detail
-
doInstantiateVar
protected boolean doInstantiateVar(int value) throws ContradictionExceptionAction to execute onvarwhen this view requires to instantiate it- Parameters:
value- value before modification of the view- Returns:
- true if
varhas been modified - Throws:
ContradictionException- if modification fails
-
doUpdateLowerBoundOfVar
protected boolean doUpdateLowerBoundOfVar(int value) throws ContradictionExceptionAction to execute onvarwhen this view requires to update its lower bound- Parameters:
value- value before modification of the view- Returns:
- true if
varhas been modified - Throws:
ContradictionException- if modification fails
-
doUpdateUpperBoundOfVar
protected boolean doUpdateUpperBoundOfVar(int value) throws ContradictionExceptionAction to execute onvarwhen this view requires to update its upper bound- Parameters:
value- value before modification of the view- Returns:
- true if
varhas been modified - Throws:
ContradictionException- if modification fails
-
doRemoveValueFromVar
protected boolean doRemoveValueFromVar(int value) throws ContradictionExceptionAction to execute onvarwhen this view requires to remove a value from it- Parameters:
value- value before modification of the view- Returns:
- true if
varhas been modified - Throws:
ContradictionException- if modification fails
-
doRemoveIntervalFromVar
protected boolean doRemoveIntervalFromVar(int from, int to) throws ContradictionExceptionAction to execute onvarwhen this view requires to remove an interval from it- Parameters:
from- first value of the interval before modification of the viewto- last value of the interval before modification of the view- Returns:
- true if
varhas been modified - Throws:
ContradictionException- if modification fails
-
removeValue
public boolean removeValue(int value, ICause cause) throws ContradictionExceptionDescription copied from interface:IntVarRemovesvaluefrom the domain ofthis. The instruction comes frompropagator.- If
valueis out of the domain, nothing is done and the return value isfalse, - if removing
valueleads to a dead-end (domain wipe-out), aContradictionExceptionis thrown, - otherwise, if removing
valuefrom 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 istrue
- Specified by:
removeValuein interfaceIntVar- Parameters:
value- value to remove from the domain (int)cause- removal releaser- Returns:
- true if the value has been removed, false otherwise
- Throws:
ContradictionException- if the domain become empty due to this action
- If
-
removeValues
public boolean removeValues(IntIterableSet values, ICause cause) throws ContradictionException
Description copied from interface:IntVarRemoves the value invaluesfrom the domain ofthis. The instruction comes frompropagator.- If all values are out of the domain, nothing is done and the return value is
false, - if removing a value leads to a dead-end (domain wipe-out),
a
ContradictionExceptionis thrown, - otherwise, if removing the
valuesfrom 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 istrue
- Specified by:
removeValuesin interfaceIntVar- Parameters:
values- set of ordered values to removecause- removal release- Returns:
- true if at least a value has been removed, false otherwise
- Throws:
ContradictionException- if the domain become empty due to this action
- If all values are out of the domain, nothing is done and the return value is
-
removeInterval
public boolean removeInterval(int from, int to, ICause cause) throws ContradictionExceptionDescription copied from interface:IntVarRemoves values between [from, to] from the domain ofthis. The instruction comes frompropagator.- If union between values and the current domain is empty, nothing is done and the return value is
false, - if removing a
valueleads to a dead-end (domain wipe-out), aContradictionExceptionis thrown, - otherwise, if removing at least a
valuefrom 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 istrue
- Specified by:
removeIntervalin interfaceIntVar- Parameters:
from- lower bound of the interval to remove (int)to- upper bound of the interval to remove(int)cause- removal releaser- Returns:
- true if the value has been removed, false otherwise
- Throws:
ContradictionException- if the domain become empty due to this action
- If union between values and the current domain is empty, nothing is done and the return value is
-
removeAllValuesBut
public boolean removeAllValuesBut(IntIterableSet values, ICause cause) throws ContradictionException
Description copied from interface:IntVarRemoves all values from the domain ofthisexcept those invalues. The instruction comes frompropagator.- If all values are out of the domain,
a
ContradictionExceptionis thrown, - if the domain is a subset of values,
nothing is done and the return value is
false, - otherwise, if removing all values but
valuesfrom 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 istrue
- Specified by:
removeAllValuesButin interfaceIntVar- Parameters:
values- set of ordered values to keep in the domaincause- removal release- Returns:
- true if a at least a value has been removed, false otherwise
- Throws:
ContradictionException- if the domain become empty due to this action
- If all values are out of the domain,
a
-
instantiateTo
public boolean instantiateTo(int value, ICause cause) throws ContradictionExceptionDescription copied from interface:IntVarInstantiates the domain ofthistovalue. The instruction comes frompropagator.- If the domain of
thisis already instantiated tovalue, nothing is done and the return value isfalse, - If the domain of
thisis already instantiated to another value, then aContradictionExceptionis thrown, - Otherwise, the domain of
thisis restricted tovalueand the observers are notified and the return value istrue.
- Specified by:
instantiateToin interfaceIntVar- Parameters:
value- instantiation value (int)cause- instantiation releaser- Returns:
- true if the instantiation is done, false otherwise
- Throws:
ContradictionException- if the domain become empty due to this action
- If the domain of
-
updateLowerBound
public boolean updateLowerBound(int value, ICause cause) throws ContradictionExceptionDescription copied from interface:IntVarUpdates the lower bound of the domain ofthistovalue. The instruction comes frompropagator.- If
valueis smaller than the lower bound of the domain, nothing is done and the return value isfalse, - if updating the lower bound to
valueleads to a dead-end (domain wipe-out), aContradictionExceptionis thrown, - otherwise, if updating the lower bound to
valuecan be done safely, the event type is created (the original event can be promoted) and observers are notified and the return value istrue
- Specified by:
updateLowerBoundin interfaceIntVar- Parameters:
value- new lower bound (included)cause- updating releaser- Returns:
- true if the lower bound has been updated, false otherwise
- Throws:
ContradictionException- if the domain become empty due to this action
- If
-
updateUpperBound
public boolean updateUpperBound(int value, ICause cause) throws ContradictionExceptionDescription copied from interface:IntVarUpdates the upper bound of the domain ofthistovalue. The instruction comes frompropagator.- If
valueis greater than the upper bound of the domain, nothing is done and the return value isfalse, - if updating the upper bound to
valueleads to a dead-end (domain wipe-out), aContradictionExceptionis thrown, - otherwise, if updating the upper bound to
valuecan be done safely, the event type is created (the original event can be promoted) and observers are notified and the return value istrue
- Specified by:
updateUpperBoundin interfaceIntVar- Parameters:
value- new upper bound (included)cause- update releaser- Returns:
- true if the upper bound has been updated, false otherwise
- Throws:
ContradictionException- if the domain become empty due to this action
- If
-
updateBounds
public boolean updateBounds(int lb, int ub, ICause cause) throws ContradictionExceptionDescription copied from interface:IntVarUpdates the lower bound and the upper bound of the domain ofthisto, resp.lbandub. The instruction comes frompropagator.- If
lbis smaller than the lower bound of the domain andubis greater than the upper bound of the domain,nothing is done and the return value is
false, - if updating the lower bound to
lb, or updating the upper bound toubleads to a dead-end (domain wipe-out), or iflbis strictly greater thanub, aContradictionExceptionis thrown, - otherwise, if updating the lower bound to
lband/or the upper bound toubcan be done safely can be done safely, the event type is created (the original event can be promoted) and observers are notified and the return value istrue
- Specified by:
updateBoundsin interfaceIntVar- Parameters:
lb- new lower bound (included)ub- new upper bound (included)cause- update releaser- Returns:
- true if the upper bound has been updated, false otherwise
- Throws:
ContradictionException- if the domain become empty due to this action
- If
-
getTypeAndKind
public int getTypeAndKind()
Description copied from interface:VariableReturn a MASK composed of 2 main information: TYPE and KIND.
TYPE is defined in the 3 first bits : VAR ( 1 << 0), CSTE (1 << 1) or VIEW (1 << 2)
KIND is defined on the other bits : INT (1 << 3), BOOL (INT + 1 << 4), GRAPH (1 << 5) or META (1 << 6) To get the TYPE of a variable:int 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;- Specified by:
getTypeAndKindin interfaceVariable- Returns:
- an int representing the type and kind of the variable
-
getVariable
public IntVar getVariable()
Description copied from interface:IViewReturn the basis variable- Specified by:
getVariablein interfaceIView- Returns:
- variable observed
-
getDomainSize
public int getDomainSize()
Description copied from interface:IntVarReturns the size of this domain, that is the number of elements in this domain.- Specified by:
getDomainSizein interfaceIntVar- Returns:
- size of the domain
-
getRange
public int getRange()
Description copied from interface:IntVarReturns the range of this domain, that is, the difference between the upper bound and the lower bound.
-
hasEnumeratedDomain
public boolean hasEnumeratedDomain()
Description copied from interface:IntVarIndicates wether (or not)thishas an enumerated domain (represented in extension) or not (only bounds)- Specified by:
hasEnumeratedDomainin interfaceIntVar- Returns:
trueif the domain is enumerated,falseotherwise.
-
isInstantiated
public boolean isInstantiated()
Description copied from interface:VariableIndicates whetherthisis instantiated (see implemtations to know what instantiation means).- Specified by:
isInstantiatedin interfaceVariable- Returns:
trueifthisis instantiated
-
getDelta
public IDelta getDelta()
Description copied from interface:VariableReturn the delta domain of this
-
createDelta
public void createDelta()
Description copied from interface:VariableCreate a delta, if necessary, in order to observe removed values of a this. If the delta already exists, has no effect.- Specified by:
createDeltain interfaceVariable
-
compareTo
public int compareTo(Variable o)
- Specified by:
compareToin interfaceComparable<I extends IntVar>- Overrides:
compareToin classAbstractVariable
-
notifyMonitors
public void notifyMonitors(IEventType event) throws ContradictionException
Description copied from interface:VariableNotify monitors of observed variable modifications- Specified by:
notifyMonitorsin interfaceVariable- Parameters:
event- the event which occurred on the variable- Throws:
ContradictionException- if the monitor detects contradiction.
-
notify
public void notify(IEventType event) throws ContradictionException
Description copied from interface:IViewTo notify a view that the variable is observed has been modified.- Specified by:
notifyin interfaceIView- Parameters:
event- the event received by the observed variable- Throws:
ContradictionException- if a failure occurs
-
transformEvent
public IEventType transformEvent(IEventType evt)
- Specified by:
transformEventin interfaceIntVar- Parameters:
evt- original event- Returns:
- transforms the original event wrt this IntVar
-
getValueIterator
public DisposableValueIterator getValueIterator(boolean bottomUp)
Description copied from interface:IntVarRetrieves an iterator over values ofthis.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 aIntVar, 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.- Specified by:
getValueIteratorin interfaceIntVar- Parameters:
bottomUp- way to iterate over values.truemeans from lower bound to upper bound,falsemeans from upper bound to lower bound.- Returns:
- a disposable iterator over values of
this.
-
getRangeIterator
public DisposableRangeIterator getRangeIterator(boolean bottomUp)
Description copied from interface:IntVarRetrieves an iterator over ranges (or intervals) ofthis.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 aIntVar, 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.- Specified by:
getRangeIteratorin interfaceIntVar- Parameters:
bottomUp- way to iterate over ranges.truemeans from lower bound to upper bound,falsemeans from upper bound to lower bound.- Returns:
- a disposable iterator over ranges of
this.
-
why
public boolean why(RuleStore ruleStore, IntVar modifiedVar, IEventType evt, int value)
Description copied from interface:ICauseAdd new rules to the rule store
-
-