IntVarImpl (minicp 1.0 API)

java.lang.Object
- minicp.engine.core.IntVarImpl

All Implemented Interfaces:

IntVar

Direct Known Subclasses:

BoolVarImpl, BoolVarIsEqual
```
public class IntVarImpl
extends Object
implements IntVar
```
Implementation of a variable with a SparseSetDomain.

Constructor Summary

Constructors
Constructor and Description
`IntVarImpl(Solver cp, int n)` Creates a variable with the elements {@code {0,...
`IntVarImpl(Solver cp, int min, int max)` Creates a variable with the elements {@code {min,...
`IntVarImpl(Solver cp, Set<Integer> values)` Creates a variable with a given set of values as initial domain.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`assign(int v)` Assigns the specified value
`boolean`	`contains(int v)` Returns true if the domain contains the specified value.
`int`	`fillArray(int[] dest)` Copies the values of the domain into an array.
`Solver`	`getSolver()` Returns the solver in which this variable was created.
`boolean`	`isBound()` Returns true if the domain of the variable has a single value.
`int`	`max()` Returns the maximum of the domain of the variable
`int`	`min()` Returns the minimum of the domain of the variable
`void`	`propagateOnBind(Constraint c)` Asks that `Constraint.propagate()` is called whenever the domain of this variable is reduced to a singleton.
`void`	`propagateOnBoundChange(Constraint c)` Asks that `Constraint.propagate()` is called whenever the bound (maximum or minimum values) of the domain of this variable is changes.
`void`	`propagateOnDomainChange(Constraint c)` Asks that `Constraint.propagate()` is called whenever the domain of this variable changes.
`void`	`remove(int v)` Removes the specified value.
`void`	`removeAbove(int v)` Remove all the values above a given value
`void`	`removeBelow(int v)` Remove all the values less than a given value
`protected void`	`scheduleAll(StateStack<Constraint> constraints)`
`int`	`size()` Returns the size of the domain of the variable
`String`	`toString()`
`void`	`whenBind(Procedure f)` Asks that the closure is called whenever the domain of this variable is reduced to a single setValue
`void`	`whenBoundsChange(Procedure f)` Asks that the closure is called whenever the max or min setValue of the domain of this variable changes
`void`	`whenDomainChange(Procedure f)` Asks that the closure is called whenever the domain change of this variable changes

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IntVarImpl
```
public IntVarImpl(Solver cp,
                  int n)
```
    Creates a variable with the elements {0,...,n-1} as initial domain.
    
    Parameters:
    
    cp - the solver in which the variable is created
    
    n - the number of values with n > 0
  - IntVarImpl
```
public IntVarImpl(Solver cp,
                  int min,
                  int max)
```
    Creates a variable with the elements {min,...,max} as initial domain.
    
    Parameters:
    
    cp - the solver in which the variable is created
    
    min - the minimum value of the domain
    
    max - the maximum value of the domain with max >= min
  - IntVarImpl
```
public IntVarImpl(Solver cp,
                  Set<Integer> values)
```
    Creates a variable with a given set of values as initial domain.
    
    Parameters:
    
    cp - the solver in which the variable is created
    
    values - the initial values in the domain, it must be nonempty
- Method Detail
  - getSolver
```
public Solver getSolver()
```
    Description copied from interface: IntVar
    
    Returns the solver in which this variable was created.
    
    Specified by:
    
    getSolver in interface IntVar
    
    Returns:
    
    the solver in which this variable was created
  - isBound
```
public boolean isBound()
```
    Description copied from interface: IntVar
    
    Returns true if the domain of the variable has a single value.
    
    Specified by:
    
    isBound in interface IntVar
    
    Returns:
    
    true if the domain of the variable is a singleton.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - whenBind
```
public void whenBind(Procedure f)
```
    Description copied from interface: IntVar
    
    Asks that the closure is called whenever the domain of this variable is reduced to a single setValue
    
    Specified by:
    
    whenBind in interface IntVar
    
    Parameters:
    
    f - the closure
  - whenBoundsChange
```
public void whenBoundsChange(Procedure f)
```
    Description copied from interface: IntVar
    
    Asks that the closure is called whenever the max or min setValue of the domain of this variable changes
    
    Specified by:
    
    whenBoundsChange in interface IntVar
    
    Parameters:
    
    f - the closure
  - whenDomainChange
```
public void whenDomainChange(Procedure f)
```
    Description copied from interface: IntVar
    
    Asks that the closure is called whenever the domain change of this variable changes
    
    Specified by:
    
    whenDomainChange in interface IntVar
    
    Parameters:
    
    f - the closure
  - propagateOnDomainChange
```
public void propagateOnDomainChange(Constraint c)
```
    Description copied from interface: IntVar
    
    Asks that Constraint.propagate() is called whenever the domain of this variable changes. We say that a change event occurs.
    
    Specified by:
    
    propagateOnDomainChange in interface IntVar
    
    Parameters:
    
    c - the constraint for which the Constraint.propagate() method should be called on change events of this variable.
  - propagateOnBind
```
public void propagateOnBind(Constraint c)
```
    Description copied from interface: IntVar
    
    Asks that Constraint.propagate() is called whenever the domain of this variable is reduced to a singleton. In such a state the variable is bind and we say that a bind event occurs.
    
    Specified by:
    
    propagateOnBind in interface IntVar
    
    Parameters:
    
    c - the constraint for which the Constraint.propagate() method should be called on bind events of this variable.
  - propagateOnBoundChange
```
public void propagateOnBoundChange(Constraint c)
```
    Description copied from interface: IntVar
    
    Asks that Constraint.propagate() is called whenever the bound (maximum or minimum values) of the domain of this variable is changes. We say that a bound change event occurs in this case.
    
    Specified by:
    
    propagateOnBoundChange in interface IntVar
    
    Parameters:
    
    c - the constraint for which the Constraint.propagate() method should be called on bound change events of this variable.
  - scheduleAll
```
protected void scheduleAll(StateStack<Constraint> constraints)
```
  - min
```
public int min()
```
    Description copied from interface: IntVar
    
    Returns the minimum of the domain of the variable
    
    Specified by:
    
    min in interface IntVar
    
    Returns:
    
    the minimum of the domain of the variable
  - max
```
public int max()
```
    Description copied from interface: IntVar
    
    Returns the maximum of the domain of the variable
    
    Specified by:
    
    max in interface IntVar
    
    Returns:
    
    the maximum of the domain of the variable
  - size
```
public int size()
```
    Description copied from interface: IntVar
    
    Returns the size of the domain of the variable
    
    Specified by:
    
    size in interface IntVar
    
    Returns:
    
    the size of the domain of the variable
  - fillArray
```
public int fillArray(int[] dest)
```
    Description copied from interface: IntVar
    
    Copies the values of the domain into an array.
    
    Specified by:
    
    fillArray in interface IntVar
    
    Parameters:
    
    dest - an array large enough dest.length >= size()
    
    Returns:
    
    the size of the domain and dest[0,...,size-1] contains the values in the domain in an arbitrary order
  - contains
```
public boolean contains(int v)
```
    Description copied from interface: IntVar
    
    Returns true if the domain contains the specified value.
    
    Specified by:
    
    contains in interface IntVar
    
    Parameters:
    
    v - the value whose presence in the domain is to be tested
    
    Returns:
    
    true if the domain contains the specified value
  - remove
```
public void remove(int v)
```
    Description copied from interface: IntVar
    
    Removes the specified value.
    
    Specified by:
    
    remove in interface IntVar
    
    Parameters:
    
    v - the value to remove
  - assign
```
public void assign(int v)
```
    Description copied from interface: IntVar
    
    Assigns the specified value
    
    Specified by:
    
    assign in interface IntVar
    
    Parameters:
    
    v - the value to assign.
  - removeBelow
```
public void removeBelow(int v)
```
    Description copied from interface: IntVar
    
    Remove all the values less than a given value
    
    Specified by:
    
    removeBelow in interface IntVar
    
    Parameters:
    
    v - the value such that all the values less than v are removed
  - removeAbove
```
public void removeAbove(int v)
```
    Description copied from interface: IntVar
    
    Remove all the values above a given value
    
    Specified by:
    
    removeAbove in interface IntVar
    
    Parameters:
    
    v - the value such that all the values larger than v are removed

Class IntVarImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IntVarImpl

IntVarImpl

IntVarImpl

Method Detail

getSolver

isBound

toString

whenBind

whenBoundsChange

whenDomainChange

propagateOnDomainChange

propagateOnBind

propagateOnBoundChange

scheduleAll

min

max

size

fillArray

contains

remove

assign

removeBelow

removeAbove