Class BoolNotView
- java.lang.Object
-
- org.chocosolver.solver.variables.impl.AbstractVariable
-
- org.chocosolver.solver.variables.view.IntView<BoolVar>
-
- org.chocosolver.solver.variables.view.BoolNotView
-
- All Implemented Interfaces:
Cloneable,Comparable<Variable>,Iterable<Integer>,ILogical,ArExpression,ReExpression,ICause,Identity,BoolVar,IntVar,Variable,IView
public final class BoolNotView extends IntView<BoolVar> implements BoolVar
A view for boolean variable, that enforce not(b).- Since:
- 31/07/12
- Author:
- Charles Prud'homme
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.chocosolver.solver.expression.discrete.arithmetic.ArExpression
ArExpression.Operator
-
Nested classes/interfaces inherited from interface org.chocosolver.solver.expression.discrete.relational.ReExpression
ReExpression.Operator
-
-
Field Summary
-
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
-
-
Constructor Summary
Constructors Constructor Description BoolNotView(BoolVar var)Create a not view based on var
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void_setNot(BoolVar not)booleancontains(int value)Checks if a valuevbelongs to the domain ofthisprotected EvtSchedulercreateScheduler()ESatgetBooleanValue()intgetLB()Retrieves the lower bound of the variableintgetTypeAndKind()Return a MASK composed of 2 main information: TYPE and KIND.intgetUB()Retrieves the upper bound of the variableintgetValue()Retrieves the current value of the variable if instantiated, otherwier the lower bound.booleanhasNot()booleaninstantiateTo(int value, ICause cause)Instantiates the domain ofthistovalue.booleanisInstantiatedTo(int value)Checks wetherthisis instantiated tovalbooleanisLit()Current tree is a literalbooleanisNot()Current tree is rooted with NOT logical operator This is a one way relationship: in case a = not(b) a.isNot() returns true whereas b.isNot() returns false (unless b = not(c)...)voidjustifyEvent(IntVar var, ICause cause, IntEventType mask, int one, int two, int three)This methods is related to explanations, it binds an event occurring on the observed variable to the view.IIntDeltaMonitormonitorDelta(ICause propagator)Allow to monitor removed values ofthis.intnextValue(int v)Returns the first value just after v inthiswhich is in the domain.intnextValueOut(int v)Returns the first value just after v inthiswhich is out of the domain.BoolVarnot()intpreviousValue(int v)Returns the previous value just before v inthis.intpreviousValueOut(int v)Returns the first value just before v inthiswhich is out of the domain.booleanremoveAllValuesBut(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.voidsetNot(boolean isNot)States whether or not this variable is the negation of another.booleansetToFalse(ICause cause)booleansetToTrue(ICause cause)StringtoString()inttransformValue(int value)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.view.IntView
compareTo, createDelta, doInstantiateVar, doRemoveIntervalFromVar, doRemoveValueFromVar, doUpdateLowerBoundOfVar, doUpdateUpperBoundOfVar, getDelta, getDomainSize, getRange, getRangeIterator, getValueIterator, getVariable, hasEnumeratedDomain, isInstantiated, iterator, notify, notifyMonitors, transformEvent
-
Methods inherited from class org.chocosolver.solver.variables.impl.AbstractVariable
addMonitor, asBoolVar, asIntVar, asRealVar, asSetVar, clearEvents, contradiction, getCause, getDindex, getEvtScheduler, getId, getIndexInPropagator, getMask, getModel, getName, getNbProps, getPIndices, getPropagator, getPropagators, getViews, isAConstant, isBool, link, notifyPropagators, notifyViews, removeMonitor, setPIndice, storeEvents, subscribeView, swapOnActivate, swapOnPassivate, 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, ge, ge, getExpressionChild, gt, gt, 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.BoolVar
boolVar, extractVar, intVar
-
Methods inherited from interface java.lang.Comparable
compareTo
-
Methods inherited from interface org.chocosolver.solver.variables.IntVar
getDomainSize, getNoChild, getRange, getRangeIterator, getValueIterator, hasEnumeratedDomain, isBool, isExpressionLeaf, reverseValue, transformEvent
-
Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator
-
Methods inherited from interface org.chocosolver.solver.expression.discrete.relational.ReExpression
and, beval, decompose, extension, getModel, ieval, iff, ift, ift, ift, ift, imp, or, post, xor
-
Methods inherited from interface org.chocosolver.solver.variables.Variable
addMonitor, asBoolVar, asIntVar, asRealVar, asSetVar, clearEvents, contradiction, createDelta, getCause, getDelta, getDindex, getEnvironment, getEvtScheduler, getIndexInPropagator, getMask, getModel, getName, getNbProps, getPIndices, getPropagator, getPropagators, getViews, isAConstant, isInstantiated, link, notifyMonitors, notifyPropagators, notifyViews, removeMonitor, setPIndice, storeEvents, subscribeView, swapOnActivate, swapOnPassivate, unlink
-
-
-
-
Constructor Detail
-
BoolNotView
public BoolNotView(BoolVar var)
Create a not view based on var- Parameters:
var- a boolean variable
-
-
Method Detail
-
getBooleanValue
public ESat getBooleanValue()
- Specified by:
getBooleanValuein interfaceBoolVar
-
setToTrue
public boolean setToTrue(ICause cause) throws ContradictionException
- Specified by:
setToTruein interfaceBoolVar- Throws:
ContradictionException
-
setToFalse
public boolean setToFalse(ICause cause) throws ContradictionException
- Specified by:
setToFalsein interfaceBoolVar- Throws:
ContradictionException
-
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- Overrides:
removeValuein classIntView<BoolVar>- 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- Overrides:
removeValuesin classIntView<BoolVar>- 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
-
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- Overrides:
removeAllValuesButin classIntView<BoolVar>- 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
-
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- Overrides:
removeIntervalin classIntView<BoolVar>- 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
-
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- Overrides:
instantiateToin classIntView<BoolVar>- 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- Overrides:
updateLowerBoundin classIntView<BoolVar>- 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- Overrides:
updateUpperBoundin classIntView<BoolVar>- 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- Overrides:
updateBoundsin classIntView<BoolVar>- 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
-
contains
public boolean contains(int value)
Description copied from interface:IntVarChecks if a valuevbelongs to the domain ofthis
-
isInstantiatedTo
public boolean isInstantiatedTo(int value)
Description copied from interface:IntVarChecks wetherthisis instantiated toval- Specified by:
isInstantiatedToin interfaceIntVar- Parameters:
value- int- Returns:
- true if
thisis instantiated toval, false otherwise
-
getValue
public int getValue()
Description copied from interface:IntVarRetrieves the current value of the variable if instantiated, otherwier the lower bound.
-
getLB
public int getLB()
Description copied from interface:IntVarRetrieves the lower bound of the variable
-
getUB
public int getUB()
Description copied from interface:IntVarRetrieves the upper bound of the variable
-
nextValue
public int nextValue(int v)
Description copied from interface:IntVarReturns the first value just after v inthiswhich is in the domain. 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 }
-
nextValueOut
public int nextValueOut(int v)
Description copied from interface:IntVarReturns the first value just after v inthiswhich is out of the domain. If v is less than or equal toIntVar.getLB()-2, returns v + 1, if v is greater than or equal toIntVar.getUB(), returns v + 1.- Specified by:
nextValueOutin interfaceIntVar- Parameters:
v- the value to start checking (exclusive)- Returns:
- the next value out of the domain
-
previousValue
public int previousValue(int v)
Description copied from interface:IntVarReturns the previous value just before v inthis. 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 }- Specified by:
previousValuein interfaceIntVar- Parameters:
v- the value to start checking (exclusive)- Returns:
- the previous value in the domain
-
previousValueOut
public int previousValueOut(int v)
Description copied from interface:IntVarReturns the first value just before v inthiswhich is out of the domain. If v is greater than or equal toIntVar.getUB()+2, returns v - 1, if v is less than or equal toIntVar.getLB(), returns v - 1.- Specified by:
previousValueOutin interfaceIntVar- Parameters:
v- the value to start checking (exclusive)- Returns:
- the previous value out of the domain
-
monitorDelta
public IIntDeltaMonitor monitorDelta(ICause propagator)
Description copied from interface:IntVarAllow to monitor removed values ofthis.- Specified by:
monitorDeltain interfaceIntVar- Parameters:
propagator- the cause that requires to monitor delta- Returns:
- a delta monitor
-
createScheduler
protected EvtScheduler createScheduler()
- Specified by:
createSchedulerin classAbstractVariable
-
toString
public String toString()
- Overrides:
toStringin classAbstractVariable
-
not
public BoolVar not()
- Specified by:
notin interfaceBoolVar- Specified by:
notin interfaceReExpression- Returns:
- return the expression "¬x" where this is "x"
-
isLit
public boolean isLit()
Description copied from interface:ILogicalCurrent tree is a literal
-
isNot
public boolean isNot()
Description copied from interface:ILogicalCurrent tree is rooted with NOT logical operator This is a one way relationship: in case a = not(b) a.isNot() returns true whereas b.isNot() returns false (unless b = not(c)...)
-
setNot
public void setNot(boolean isNot)
Description copied from interface:ILogicalStates whether or not this variable is the negation of another. This is a one way relationship: in case a = not(b) a.isNot() returns true whereas b.isNot() returns false (unless b = not(c)...)
-
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- Overrides:
getTypeAndKindin classIntView<BoolVar>- Returns:
- an int representing the type and kind of the variable
-
why
public boolean why(RuleStore ruleStore, IntVar modifiedVar, IEventType evt, int value)
Description copied from interface:ICauseAdd new rules to the rule store- Specified by:
whyin interfaceICause- Specified by:
whyin interfaceIntVar- Overrides:
whyin classIntView<BoolVar>- Parameters:
ruleStore- the rule storemodifiedVar- the modified variableevt- the undergoing eventvalue- the value (for REMOVE only)- Returns:
- true if at least one rule has been added to the rule store
-
transformValue
public int transformValue(int value)
- Specified by:
transformValuein interfaceIntVar- Parameters:
value- original value- Returns:
- transforms the original value wrt this IntVar
-
justifyEvent
public void justifyEvent(IntVar var, ICause cause, IntEventType mask, int one, int two, int three)
Description copied from interface:IViewThis methods is related to explanations, it binds an event occurring on the observed variable to the view.- Specified by:
justifyEventin interfaceIView- Parameters:
var- modified variablecause- cause of the modificationmask- type of modificationone- an inttwo- an intthree- an int
-
-