Variable (org.choco-solver-choco-solver 3.3.1-j7 API)

All Superinterfaces:

Comparable<Variable>, Identity, Serializable

All Known Subinterfaces:

BoolVar, IntVar, IView, RealVar, SetVar

All Known Implementing Classes:

AbstractVariable, BitsetArrayIntVarImpl, BitsetIntVarImpl, BoolEqView, BoolNotView, BoolVarImpl, EqView, FixedBoolVarImpl, FixedIntVarImpl, FixedSetVarImpl, IntervalIntVarImpl, IntView, MinusView, OffsetView, RealVarImpl, RealView, ScaleView, SetVarImpl
```
public interface Variable
extends Identity, Serializable, Comparable<Variable>
```
Created by IntelliJ IDEA. User: xlorca

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BOOL`
`static int`	`CSTE`
`static int`	`INT`
`static int`	`KIND`
`static int`	`REAL`
`static int`	`SET`
`static int`	`TYPE`
`static int`	`VAR`
`static int`	`VIEW`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addMonitor(IVariableMonitor monitor)` Build and add a monitor to the monitor list 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.
`<V extends Variable> V`	`duplicate()` Duplicate `this`.
`void`	`duplicate(Solver solver, gnu.trove.map.hash.THashMap<Object,Object> identitymap)` Duplicate `this` (which naturally adds it into `solver`).
`IDelta`	`getDelta()` Return the delta domain of this
`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
`int`	`getTypeAndKind()` Return a MASK composed of 2 main information: TYPE and KIND.
`IView[]`	`getViews()` Get the views observing this variables
`boolean`	`isInstantiated()` Indicates whether `this` is instantiated (see implemtations to know what instantiation means).
`int`	`link(Propagator propagator, int idxInProp)` Link the propagator to 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
`void`	`recordMask(int mask)` Analysis propagator event reaction on this, and adapt this
`void`	`removeMonitor(IVariableMonitor monitor)`
`void`	`subscribeView(IView view)`
`void`	`unlink(Propagator propagator)` Remove a propagator from the list of propagator of `this`.

Methods inherited from interface org.chocosolver.solver.Identity
getId

Methods inherited from interface java.lang.Comparable
compareTo

- Field Detail
  - VAR
```
static final int VAR
```
    See Also:
    Constant Field Values
  - CSTE
```
static final int CSTE
```
    See Also:
    Constant Field Values
  - VIEW
```
static final int VIEW
```
    See Also:
    Constant Field Values
  - TYPE
```
static final int TYPE
```
    See Also:
    Constant Field Values
  - INT
```
static final int INT
```
    See Also:
    Constant Field Values
  - BOOL
```
static final int BOOL
```
    See Also:
    Constant Field Values
  - SET
```
static final int SET
```
    See Also:
    Constant Field Values
  - REAL
```
static final int REAL
```
    See Also:
    Constant Field Values
  - KIND
```
static final int KIND
```
    See Also:
    Constant Field Values
- Method Detail
  - isInstantiated
```
boolean isInstantiated()
```
    Indicates whether this is instantiated (see implemtations to know what instantiation means).
    
    Returns:
    true if this is instantiated
  - getName
```
String getName()
```
    Returns the name of this
    
    Returns:
    a String representing the name of this
  - getPropagators
```
Propagator[] getPropagators()
```
    Return the array of propagators this
    
    Returns:
    the array of proapgators of this
  - getPropagator
```
Propagator getPropagator(int idx)
```
    Return the "idx" th propagator of this
    
    Parameters:
    idx - position of the propagator
    
    Returns:
    a propagator
  - getNbProps
```
int getNbProps()
```
    Return the number of propagators
    
    Returns:
    number of propagators of this
  - getPIndices
```
int[] getPIndices()
```
  - getIndexInPropagator
```
int getIndexInPropagator(int pidx)
```
    Return the position of the variable in the propagator at position pidx
    
    Parameters:
    pidx - index of the propagator within the list of propagators of this
    
    Returns:
    position of this in the propagator pidx
  - addMonitor
```
void addMonitor(IVariableMonitor monitor)
```
    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).
    
    Parameters:
    monitor - a variable monitor
  - removeMonitor
```
void removeMonitor(IVariableMonitor monitor)
```
  - subscribeView
```
void subscribeView(IView view)
```
  - getDelta
```
IDelta getDelta()
```
    Return the delta domain of this
    
    Returns:
    the delta domain of the variable
  - createDelta
```
void createDelta()
```
    Create a delta, if necessary, in order to observe removed values of a this. If the delta already exists, has no effect.
  - link
```
int link(Propagator propagator,
       int idxInProp)
```
    Link the propagator to this
    
    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
```
void recordMask(int mask)
```
    Analysis propagator event reaction on this, and adapt this
    
    Parameters:
    mask - event mask
  - unlink
```
void unlink(Propagator propagator)
```
    Remove a propagator from the list of propagator of this. SHOULD BE CONTAINED IN THIS.
    
    Parameters:
    propagator - the propagator to remove
  - notifyPropagators
```
void notifyPropagators(IEventType event,
                     ICause cause)
                       throws ContradictionException
```
    If this has changed, then notify all of its observers.
    Each observer has its update method.
    
    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
```
void notifyViews(IEventType event,
               ICause cause)
                 throws ContradictionException
```
    Notify views of observed variable modifications
    
    Parameters:
    event - the event which occurred on the variable
    
    Throws:
    
    ContradictionException
  - getViews
```
IView[] getViews()
```
    Get the views observing this variables
    
    Returns:
    views observing this variables
  - notifyMonitors
```
void notifyMonitors(IEventType event)
                    throws ContradictionException
```
    Notify monitors of observed variable modifications
    
    Parameters:
    event - the event which occurred on the variable
    
    Throws:
    
    ContradictionException
  - contradiction
```
void contradiction(ICause cause,
                 IEventType event,
                 String message)
                   throws ContradictionException
```
    Throws a contradiction exception based on
    
    Parameters:
    cause - ICause causing the exception
    event - event causing the contradiction
    message - the detailed message @throws ContradictionException expected behavior
    
    Throws:
    
    ContradictionException
  - getSolver
```
Solver getSolver()
```
    Return the associated solver
    
    Returns:
    a Solver object
  - getTypeAndKind
```
int getTypeAndKind()
```
    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;
 
```
    Returns:
    an int representing the type and kind of the variable
  - duplicate
```
<V extends Variable> V duplicate()
```
    Duplicate this.
    
    Type Parameters:
    V - the copy
    
    Returns:
    a copy of this
  - duplicate
```
void duplicate(Solver solver,
             gnu.trove.map.hash.THashMap<Object,Object> identitymap)
```
    Duplicate this (which naturally adds it into solver).
    
    Parameters:
    solver - target solver
    identitymap - a map to guarantee uniqueness of objects

Interface Variable

Field Summary

Method Summary

Methods inherited from interface org.chocosolver.solver.Identity

Methods inherited from interface java.lang.Comparable

Field Detail

VAR

CSTE

VIEW

TYPE

INT

BOOL

SET

REAL

KIND

Method Detail

isInstantiated

getName

getPropagators

getPropagator

getNbProps

getPIndices

getIndexInPropagator

addMonitor

removeMonitor

subscribeView

getDelta

createDelta

link

recordMask

unlink

notifyPropagators

notifyViews

getViews

notifyMonitors

contradiction

getSolver

getTypeAndKind

duplicate

duplicate