org.chocosolver.solver.variables.view

Class BoolEqView

java.lang.Object

org.chocosolver.solver.variables.impl.AbstractVariable

org.chocosolver.solver.variables.view.IntView

org.chocosolver.solver.variables.view.EqView

org.chocosolver.solver.variables.view.BoolEqView

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Variable>, ILogical, ICause, Identity, BoolVar, IntVar, Variable, IView

public final class BoolEqView
extends EqView
implements BoolVar

A specific view for equality on bool var

Since:

23/07/12

Author:

Charles Prud'homme

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected BoolVar	var

Fields inherited from class org.chocosolver.solver.variables.view.IntView

_riterator, _viterator, delta

Fields inherited from class org.chocosolver.solver.variables.impl.AbstractVariable

_plugexpl, mIdx, modificationEvents, monitors, MSG_BOUND, MSG_EMPTY, MSG_INST, MSG_LOW, MSG_REMOVE, MSG_UNKNOWN, MSG_UPP, name, solver

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

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

Constructor Summary

Constructors

Constructor and Description
BoolEqView(BoolVar var, Solver solver)

Method Summary

Methods

Modifier and Type	Method and Description
void	_setNot(BoolVar not)
BoolVar	duplicate() Duplicate this.
void	duplicate(Solver solver, gnu.trove.map.hash.THashMap<Object,Object> identitymap) Duplicate this (which naturally adds it into solver).
ESat	getBooleanValue()
int	getTypeAndKind() Return a MASK composed of 2 main information: TYPE and KIND.
boolean	hasNot()
boolean	isLit() Current tree is a literal
boolean	isNot() 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)...)
BoolVar	not()
void	setNot(boolean isNot) States whether or not this variable is the negation of another.
boolean	setToFalse(ICause cause)
boolean	setToTrue(ICause cause)

Methods inherited from class org.chocosolver.solver.variables.view.EqView

contains, getLB, getRangeIterator, getUB, getValue, getValueIterator, instantiateTo, isInstantiatedTo, monitorDelta, nextValue, previousValue, removeInterval, removeValue, toString, updateLowerBound, updateUpperBound

Methods inherited from class org.chocosolver.solver.variables.view.IntView

compareTo, contradiction, createDelta, getDelta, getDomainSize, getVariable, hasEnumeratedDomain, isInstantiated, notifyMonitors, recordMask, transformEvent, why

Methods inherited from class org.chocosolver.solver.variables.impl.AbstractVariable

addMonitor, getId, getIndexInPropagator, getName, getNbProps, getPIndices, getPropagator, getPropagators, getSolver, getViews, isBool, link, notifyPropagators, notifyViews, removeMonitor, subscribeView, 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.variables.IntVar

contains, getDomainSize, getLB, getRangeIterator, getUB, getValue, getValueIterator, hasEnumeratedDomain, instantiateTo, isBool, isInstantiatedTo, monitorDelta, nextValue, previousValue, removeInterval, removeValue, updateLowerBound, updateUpperBound

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

addMonitor, contradiction, createDelta, getDelta, getIndexInPropagator, getName, getNbProps, getPIndices, getPropagator, getPropagators, getSolver, getViews, isInstantiated, link, notifyMonitors, notifyPropagators, notifyViews, recordMask, removeMonitor, subscribeView, unlink

Methods inherited from interface org.chocosolver.solver.Identity

getId

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

var

protected final BoolVar var

Constructor Detail

BoolEqView

public BoolEqView(BoolVar var,
          Solver solver)

Method Detail

getBooleanValue

public ESat getBooleanValue()

Specified by:

getBooleanValue in interface BoolVar

setToTrue

public boolean setToTrue(ICause cause)
                  throws ContradictionException

Specified by:

setToTrue in interface BoolVar

Throws:

ContradictionException

setToFalse

public boolean setToFalse(ICause cause)
                   throws ContradictionException

Specified by:

setToFalse in interface BoolVar

Throws:

ContradictionException

duplicate

public BoolVar duplicate()

Description copied from interface: Variable

Duplicate this.

Specified by:

duplicate in interface Variable

Overrides:

duplicate in class EqView

Returns:

a copy of this

duplicate

public void duplicate(Solver solver,
             gnu.trove.map.hash.THashMap<Object,Object> identitymap)

Description copied from interface: Variable

Duplicate this (which naturally adds it into solver).

Specified by:

duplicate in interface Variable

Overrides:

duplicate in class EqView

Parameters:

solver - target solver

identitymap - a map to guarantee uniqueness of objects

not

public BoolVar not()

Specified by:

not in interface BoolVar

hasNot

public boolean hasNot()

Specified by:

hasNot in interface BoolVar

_setNot

public void _setNot(BoolVar not)

Specified by:

_setNot in interface BoolVar

isLit

public boolean isLit()

Description copied from interface: ILogical

Current tree is a literal

Specified by:

isLit in interface ILogical

Returns:

true if this is a literal

isNot

public boolean isNot()

Description copied from interface: ILogical

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)...)

Specified by:

isNot in interface ILogical

Returns:

true if this is NOT

setNot

public void setNot(boolean isNot)

Description copied from interface: ILogical

States 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)...)

Specified by:

setNot in interface ILogical

Parameters:

isNot - true iff this variable is the negation of another

getTypeAndKind

public int getTypeAndKind()

Description copied from interface: Variable

Return 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:

getTypeAndKind in interface Variable

Overrides:

getTypeAndKind in class IntView

Returns:

an int representing the type and kind of the variable