IrDomain (chocosolver 0.1-SNAPSHOT API)

All Known Implementing Classes:

IrBoolDomain, IrBoundDomain, IrEmptyDomain, IrEnumDomain
```
public interface IrDomain
```
Integer domain.

Author:

jimmy

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`contains(int value)` Checks if a value is within this domain.
`int`	`getHighBound()` Returns the largest integer contained in this domain.
`int`	`getLowBound()` Returns the smallest integer contained in this domain.
`int[]`	`getValues()` Returns all the values contained in this domain.
`boolean`	`isBounded()` Checks if this domain is defined as a lower and upper bound.
`boolean`	`isEmpty()` Checks if this domain contains any values.
`gnu.trove.iterator.TIntIterator`	`iterator()` Iterate over the domain in increasing order.
`gnu.trove.iterator.TIntIterator`	`iterator(boolean increasing)` Iterate over the domain in the specified order.
`int`	`size()` Returns how many values are contained in this domain.
`void`	`transferTo(gnu.trove.TIntCollection collection)` Put the contents of this domain inside the collection.

- Method Detail
  - isBounded
```
boolean isBounded()
```
    Checks if this domain is defined as a lower and upper bound. If the domain is bounded then it contains every value between its lower and upper bound.
    
    Returns:
    true if and only if this domain is a contiguous interval, false otherwise
  - contains
```
boolean contains(int value)
```
    Checks if a value is within this domain.
    
    Parameters:
    value - test this value
    
    Returns:
    true if and only if this domain contains the value, false otherwise
  - getLowBound
```
int getLowBound()
```
    Returns the smallest integer contained in this domain. Undefined if this domain is empty.
    
    Returns:
    the smallest integer contained in this domain
  - getHighBound
```
int getHighBound()
```
    Returns the largest integer contained in this domain. Undefined if this domain is empty.
    
    Returns:
    the largest integer contained in this domain
  - isEmpty
```
boolean isEmpty()
```
    Checks if this domain contains any values.
    
    Returns:
    true if and only if the size of this domain is zero, false otherwise
  - size
```
int size()
```
    Returns how many values are contained in this domain.
    
    Returns:
    the size of this domain
  - getValues
```
int[] getValues()
```
    Returns all the values contained in this domain.
    
    Returns:
    values contained in this domain
  - iterator
```
gnu.trove.iterator.TIntIterator iterator()
```
    Iterate over the domain in increasing order.
    
    Returns:
    an iterator over the values in this domain in increasing order
  - iterator
```
gnu.trove.iterator.TIntIterator iterator(boolean increasing)
```
    Iterate over the domain in the specified order.
    
    Parameters:
    increasing - increasing or decreasing order
    
    Returns:
    an iterator over the values in this domain in the order specified
  - transferTo
```
void transferTo(gnu.trove.TIntCollection collection)
```
    Put the contents of this domain inside the collection.
    
    Parameters:
    collection - the collection

Interface IrDomain

Method Summary

Method Detail

isBounded

contains

getLowBound

getHighBound

isEmpty

size

getValues

iterator

iterator

transferTo