IntSet (Kodkod API)

All Superinterfaces:

Cloneable, IntCollection

All Known Implementing Classes:

AbstractIntSet, ArrayIntSet, IntBitSet, IntTreeSet
```
public interface IntSet
extends IntCollection, Cloneable
```
An ordered set of integers.

Author:

Emina Torlak

Specfields:

ints: set int

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`add(int i)` Adds the given integer to this set if not already present and returns true.
`boolean`	`addAll(IntCollection c)` Adds all of the elements in the specified collection to this set if they're not already present.
`int`	`ceil(int i)` Returns the smallest element in this set that is greater than or equal to i.
`void`	`clear()` Removes all elements from this set.
`IntSet`	`clone()` Returns a copy of this IntSet.
`boolean`	`contains(int i)` Returns true if i is in this set.
`boolean`	`containsAll(IntCollection c)` Returns true if the elements of c are a subset of this set.
`boolean`	`equals(Object o)` Compares the specified object with this set for equality.
`int`	`floor(int i)` Returns the largest element in this set that is smaller than or equal to i.
`int`	`hashCode()` Returns the hash code value for this set.
`boolean`	`isEmpty()` Returns true if this set has no elements; otherwise returns false.
`IntIterator`	`iterator()` Returns an iterator over the integers in this set, in the ascending element order.
`IntIterator`	`iterator(int from, int to)` Returns an iterator over the elements of this set that are in the closed range [from..to].
`int`	`max()` Returns the largest element in this set.
`int`	`min()` Returns the smallest element in this set.
`boolean`	`remove(int i)` Removes the given integer from this set if already present and returns true.
`boolean`	`removeAll(IntCollection c)` Removes from this set all of its elements that are contained in the specified set.
`boolean`	`retainAll(IntCollection c)` Retains only the elements in this set that are contained in the specified set.
`int`	`size()` Returns the cardinality of this set.
`int[]`	`toArray()` Returns an array containing all of the elements in this set in the ascending order.
`int[]`	`toArray(int[] array)` Copies the elements of this set into the specified array, in the ascending order, provided that the array is large enough.

- Method Detail
  - add
```
boolean add(int i)
```
    Adds the given integer to this set if not already present and returns true. Otherwise does nothing and returns false.
    
    Specified by:
    
    add in interface IntCollection
    
    Ensures:
    
    this.ints' = this.ints + i
    
    Returns:
    
    i in this.ints'
    
    Throws:
    
    IllegalArgumentException - this is a bounded set and i is out of bounds
  - addAll
```
boolean addAll(IntCollection c)
```
    Adds all of the elements in the specified collection to this set if they're not already present.
    
    Specified by:
    
    addAll in interface IntCollection
    
    Ensures:
    
    this.ints' = this.ints + { i: int | c.contains(i) }
    
    Returns:
    
    this.ints' != this.ints
    
    Throws:
    
    NullPointerException - c = null
    
    UnsupportedOperationException - this is an unmodifiable set
    
    IllegalArgumentException - some aspect of an element of the specified collection prevents it from being added to this collection.
  - ceil
```
int ceil(int i)
```
    Returns the smallest element in this set that is greater than or equal to i. If this is emtpy or i is greater than this.max(), NoSuchElementException is thrown.
    
    Returns:
    
    {j: this.ints | j >= i && no k: this.ints - j | k < j && k >= i}
    
    Throws:
    
    NoSuchElementException - no this.ints || i > this.max()
  - clear
```
void clear()
```
    Removes all elements from this set.
    
    Specified by:
    
    clear in interface IntCollection
    
    Ensures:
    
    no this.ints'
  - clone
```
IntSet clone()
      throws CloneNotSupportedException
```
    Returns a copy of this IntSet. The copy is independent of this IntSet unless this is a singleton or an immutable set, in which case clone() may return this. An implementing class that does not support cloning may throw a CloneNotSupportedException.
    
    Returns:
    
    a copy of this IntSet.
    
    Throws:
    
    CloneNotSupportedException - this is not cloneable
  - contains
```
boolean contains(int i)
```
    Returns true if i is in this set.
    
    Specified by:
    
    contains in interface IntCollection
    
    Returns:
    
    i in this.ints
  - containsAll
```
boolean containsAll(IntCollection c)
```
    Returns true if the elements of c are a subset of this set.
    
    Specified by:
    
    containsAll in interface IntCollection
    
    Returns:
    
    { i: int | c.contains(i) } in this.ints
    
    Throws:
    
    NullPointerException - c = null
  - equals
```
boolean equals(Object o)
```
    Compares the specified object with this set for equality. Returns true if the specified object is also an IntSet, the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set). This definition ensures that the equals method works properly across different implementations of the IntSet interface.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    o instanceof IntSet and o.size() = this.size() and this.containsAll(o)
  - floor
```
int floor(int i)
```
    Returns the largest element in this set that is smaller than or equal to i. If this is emtpy or i is less than this.min(), NoSuchElementException is thrown.
    
    Returns:
    
    {j: this.ints | j <= i && no k: this.ints - j | k > j && k <= i}
    
    Throws:
    
    NoSuchElementException - no this.ints || i < this.min()
  - hashCode
```
int hashCode()
```
    Returns the hash code value for this set. The hash code of a set is defined to be the Ints.superFastHash(int[]) of the elements in the set, taken in the ascending order of values. This ensures that s1.equals(s2) implies that s1.hashCode()==s2.hashCode() for any two IntSets s1 and s2, as required by the general contract of the Object.hashCode method.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    Ints.superFastHash(this.toArray())
  - isEmpty
```
boolean isEmpty()
```
    Returns true if this set has no elements; otherwise returns false.
    
    Specified by:
    
    isEmpty in interface IntCollection
    
    Returns:
    
    no this.ints
  - iterator
```
IntIterator iterator()
```
    Returns an iterator over the integers in this set, in the ascending element order.
    
    Specified by:
    
    iterator in interface IntCollection
    
    Returns:
    
    an IntIterator over the integers in this set.
  - iterator
```
IntIterator iterator(int from,
                     int to)
```
    Returns an iterator over the elements of this set that are in the closed range [from..to]. If from < to, the elements are returned in the ascending order. Otherwise, they are returned in the descending order.
    
    Returns:
    
    an iterator over the elements in this set that are in the closed range [from..to].
  - max
```
int max()
```
    Returns the largest element in this set. Throws a NoSuchElementException if this set is empty.
    
    Returns:
    
    max(this.ints)
    
    Throws:
    
    NoSuchElementException - no this.ints
  - min
```
int min()
```
    Returns the smallest element in this set. Throws a NoSuchElementException if this set is empty.
    
    Returns:
    
    min(this.ints)
    
    Throws:
    
    NoSuchElementException - no this.ints
  - remove
```
boolean remove(int i)
```
    Removes the given integer from this set if already present and returns true. Otherwise does nothing and returns false.
    
    Specified by:
    
    remove in interface IntCollection
    
    Ensures:
    
    this.ints' = this.ints - i
    
    Returns:
    
    i !in this.ints'
  - removeAll
```
boolean removeAll(IntCollection c)
```
    Removes from this set all of its elements that are contained in the specified set.
    
    Specified by:
    
    removeAll in interface IntCollection
    
    Ensures:
    
    this.ints' = this.ints - { i: int | c.contains(i) }
    
    Returns:
    
    this.ints' != this.ints
    
    Throws:
    
    NullPointerException - s = null
    
    UnsupportedOperationException - this is an unmodifiable set
  - retainAll
```
boolean retainAll(IntCollection c)
```
    Retains only the elements in this set that are contained in the specified set.
    
    Specified by:
    
    retainAll in interface IntCollection
    
    Ensures:
    
    this.ints' = this.ints & { i: int | c.contains(i) }
    
    Returns:
    
    this.ints' != this.ints
    
    Throws:
    
    NullPointerException - s = null
    
    UnsupportedOperationException - this is an unmodifiable set
  - size
```
int size()
```
    Returns the cardinality of this set.
    
    Specified by:
    
    size in interface IntCollection
    
    Returns:
    
    #this.ints
  - toArray
```
int[] toArray()
```
    Returns an array containing all of the elements in this set in the ascending order.
    
    Specified by:
    
    toArray in interface IntCollection
    
    Returns:
    
    an array containing all of the elements in this set in the ascending order.
  - toArray
```
int[] toArray(int[] array)
```
    Copies the elements of this set into the specified array, in the ascending order, provided that the array is large enough. If the array is not large enough, the effect of this method is the same as calling toArray().
    
    Specified by:
    
    toArray in interface IntCollection
    
    Ensures:
    
    array.length>=this.size() => all i: [0..this.size()) | array'[i] in this.ints and #{e: this.ints | e < array'[i]} = i
    
    Returns:
    
    array.length>=this.size() => array' else this.toArray()
    
    Throws:
    
    NullPointerException - array = null

Interface IntSet

Method Summary

Method Detail

add

addAll

ceil

clear

clone

contains

containsAll

equals

floor

hashCode

isEmpty

iterator

iterator

max

min

remove

removeAll

retainAll

size

toArray

toArray