TIntSet (Trove 3.0.3)

All Superinterfaces:

TIntCollection

All Known Implementing Classes:

TIntByteHashMap.TKeyView, TIntCharHashMap.TKeyView, TIntDoubleHashMap.TKeyView, TIntFloatHashMap.TKeyView, TIntHashSet, TIntIntHashMap.TKeyView, TIntLongHashMap.TKeyView, TIntShortHashMap.TKeyView
```
public interface TIntSet
extends TIntCollection
```
An implementation of the Set interface that uses an open-addressed hash table to store its contents. Created: Sat Nov 3 10:38:17 2001

Field Summary
- Fields inherited from interface gnu.trove.TIntCollection
  serialVersionUID

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`add(int entry)` Inserts a value into the set.
`boolean`	`addAll(java.util.Collection<? extends java.lang.Integer> collection)` Adds all of the elements in `collection` to the set.
`boolean`	`addAll(int[] array)` Adds all of the elements in the `array` to the set.
`boolean`	`addAll(TIntCollection collection)` Adds all of the elements in the `TIntCollection` to the set.
`void`	`clear()` Empties the set.
`boolean`	`contains(int entry)` Returns `true` if this set contains the specified element.
`boolean`	`containsAll(java.util.Collection<?> collection)` Tests the set to determine if all of the elements in `collection` are present.
`boolean`	`containsAll(int[] array)` Tests the set to determine if all of the elements in `array` are present.
`boolean`	`containsAll(TIntCollection collection)` Tests the set to determine if all of the elements in `TIntCollection` are present.
`boolean`	`equals(java.lang.Object o)` Compares the specified object with this set for equality.
`boolean`	`forEach(TIntProcedure procedure)` Executes `procedure` for each element in the set.
`int`	`getNoEntryValue()` Returns the value that is used to represent null.
`int`	`hashCode()` Returns the hash code value for this set.
`boolean`	`isEmpty()` Returns `true` if this set contains no elements.
`TIntIterator`	`iterator()` Creates an iterator over the values of the set.
`boolean`	`remove(int entry)` Removes `entry` from the set.
`boolean`	`removeAll(java.util.Collection<?> collection)` Removes all of the elements in `collection` from the set.
`boolean`	`removeAll(int[] array)` Removes all of the elements in `array` from the set.
`boolean`	`removeAll(TIntCollection collection)` Removes all of the elements in `TIntCollection` from the set.
`boolean`	`retainAll(java.util.Collection<?> collection)` Removes any values in the set which are not contained in `collection`.
`boolean`	`retainAll(int[] array)` Removes any values in the set which are not contained in `array`.
`boolean`	`retainAll(TIntCollection collection)` Removes any values in the set which are not contained in `TIntCollection`.
`int`	`size()` Returns the number of elements in this set (its cardinality).
`int[]`	`toArray()` Returns an array containing all of the elements in this set.
`int[]`	`toArray(int[] dest)` Returns an array containing elements in this set.

- Method Detail
  - getNoEntryValue
```
int getNoEntryValue()
```
    Returns the value that is used to represent null. The default value is generally zero, but can be changed during construction of the collection.
    
    Specified by:
    
    getNoEntryValue in interface TIntCollection
    
    Returns:
    
    the value that represents null
  - size
```
int size()
```
    Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
    
    Specified by:
    
    size in interface TIntCollection
    
    Returns:
    
    the number of elements in this set (its cardinality)
  - isEmpty
```
boolean isEmpty()
```
    Returns true if this set contains no elements.
    
    Specified by:
    
    isEmpty in interface TIntCollection
    
    Returns:
    
    true if this set contains no elements
  - contains
```
boolean contains(int entry)
```
    Returns true if this set contains the specified element.
    
    Specified by:
    
    contains in interface TIntCollection
    
    Parameters:
    
    entry - an int value
    
    Returns:
    
    true if the set contains the specified element.
  - iterator
```
TIntIterator iterator()
```
    Creates an iterator over the values of the set. The iterator supports element deletion.
    
    Specified by:
    
    iterator in interface TIntCollection
    
    Returns:
    
    an TIntIterator value
  - toArray
```
int[] toArray()
```
    Returns an array containing all of the elements in this set. If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.
    The returned array will be "safe" in that no references to it are maintained by this set. (In other words, this method must allocate a new array even if this set is backed by an array). The caller is thus free to modify the returned array.
    This method acts as bridge between array-based and collection-based APIs.
    
    Specified by:
    
    toArray in interface TIntCollection
    
    Returns:
    
    an array containing all the elements in this set
  - toArray
```
int[] toArray(int[] dest)
```
    Returns an array containing elements in this set.
    If this set fits in the specified array with room to spare (i.e., the array has more elements than this set), the element in the array immediately following the end of the set is set to getNoEntryValue(). (This is useful in determining the length of this set only if the caller knows that this set does not contain any elements representing null.)
    If the native array is smaller than the set size, the array will be filled with elements in Iterator order until it is full and exclude the remainder.
    If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.
    
    Specified by:
    
    toArray in interface TIntCollection
    
    Parameters:
    
    dest - the array into which the elements of this set are to be stored.
    
    Returns:
    
    an int[] containing all the elements in this set
    
    Throws:
    
    java.lang.NullPointerException - if the specified array is null
  - add
```
boolean add(int entry)
```
    Inserts a value into the set.
    
    Specified by:
    
    add in interface TIntCollection
    
    Parameters:
    
    entry - a int value
    
    Returns:
    
    true if the set was modified by the add operation
  - remove
```
boolean remove(int entry)
```
    Removes entry from the set.
    
    Specified by:
    
    remove in interface TIntCollection
    
    Parameters:
    
    entry - an int value
    
    Returns:
    
    true if the set was modified by the remove operation.
  - containsAll
```
boolean containsAll(java.util.Collection<?> collection)
```
    Tests the set to determine if all of the elements in collection are present.
    
    Specified by:
    
    containsAll in interface TIntCollection
    
    Parameters:
    
    collection - a Collection value
    
    Returns:
    
    true if all elements were present in the set.
  - containsAll
```
boolean containsAll(TIntCollection collection)
```
    Tests the set to determine if all of the elements in TIntCollection are present.
    
    Specified by:
    
    containsAll in interface TIntCollection
    
    Parameters:
    
    collection - a TIntCollection value
    
    Returns:
    
    true if all elements were present in the set.
  - containsAll
```
boolean containsAll(int[] array)
```
    Tests the set to determine if all of the elements in array are present.
    
    Specified by:
    
    containsAll in interface TIntCollection
    
    Parameters:
    
    array - as array of int primitives.
    
    Returns:
    
    true if all elements were present in the set.
  - addAll
```
boolean addAll(java.util.Collection<? extends java.lang.Integer> collection)
```
    Adds all of the elements in collection to the set.
    
    Specified by:
    
    addAll in interface TIntCollection
    
    Parameters:
    
    collection - a Collection value
    
    Returns:
    
    true if the set was modified by the add all operation.
  - addAll
```
boolean addAll(TIntCollection collection)
```
    Adds all of the elements in the TIntCollection to the set.
    
    Specified by:
    
    addAll in interface TIntCollection
    
    Parameters:
    
    collection - a TIntCollection value
    
    Returns:
    
    true if the set was modified by the add all operation.
  - addAll
```
boolean addAll(int[] array)
```
    Adds all of the elements in the array to the set.
    
    Specified by:
    
    addAll in interface TIntCollection
    
    Parameters:
    
    array - a array of int primitives.
    
    Returns:
    
    true if the set was modified by the add all operation.
  - retainAll
```
boolean retainAll(java.util.Collection<?> collection)
```
    Removes any values in the set which are not contained in collection.
    
    Specified by:
    
    retainAll in interface TIntCollection
    
    Parameters:
    
    collection - a Collection value
    
    Returns:
    
    true if the set was modified by the retain all operation
  - retainAll
```
boolean retainAll(TIntCollection collection)
```
    Removes any values in the set which are not contained in TIntCollection.
    
    Specified by:
    
    retainAll in interface TIntCollection
    
    Parameters:
    
    collection - a TIntCollection value
    
    Returns:
    
    true if the set was modified by the retain all operation
  - retainAll
```
boolean retainAll(int[] array)
```
    Removes any values in the set which are not contained in array.
    
    Specified by:
    
    retainAll in interface TIntCollection
    
    Parameters:
    
    array - an array of int primitives.
    
    Returns:
    
    true if the set was modified by the retain all operation
  - removeAll
```
boolean removeAll(java.util.Collection<?> collection)
```
    Removes all of the elements in collection from the set.
    
    Specified by:
    
    removeAll in interface TIntCollection
    
    Parameters:
    
    collection - a Collection value
    
    Returns:
    
    true if the set was modified by the remove all operation.
  - removeAll
```
boolean removeAll(TIntCollection collection)
```
    Removes all of the elements in TIntCollection from the set.
    
    Specified by:
    
    removeAll in interface TIntCollection
    
    Parameters:
    
    collection - a TIntCollection value
    
    Returns:
    
    true if the set was modified by the remove all operation.
  - removeAll
```
boolean removeAll(int[] array)
```
    Removes all of the elements in array from the set.
    
    Specified by:
    
    removeAll in interface TIntCollection
    
    Parameters:
    
    array - an array of int primitives.
    
    Returns:
    
    true if the set was modified by the remove all operation.
  - clear
```
void clear()
```
    Empties the set.
    
    Specified by:
    
    clear in interface TIntCollection
  - forEach
```
boolean forEach(TIntProcedure procedure)
```
    Executes procedure for each element in the set.
    
    Specified by:
    
    forEach in interface TIntCollection
    
    Parameters:
    
    procedure - a TIntProcedure value
    
    Returns:
    
    false if the loop over the set terminated because the procedure returned false for some value.
  - equals
```
boolean equals(java.lang.Object o)
```
    Compares the specified object with this set for equality. Returns true if the specified object is also a set, 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 set interface.
    
    Specified by:
    
    equals in interface TIntCollection
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    o - object to be compared for equality with this set
    
    Returns:
    
    true if the specified object is equal to this set
  - hashCode
```
int hashCode()
```
    Returns the hash code value for this set. The hash code of a set is defined to be the sum of the hash codes of the elements in the set. This ensures that s1.equals(s2) implies that s1.hashCode()==s2.hashCode() for any two sets s1 and s2, as required by the general contract of Object.hashCode().
    
    Specified by:
    
    hashCode in interface TIntCollection
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    the hash code value for this set
    
    See Also:
    
    Object.equals(Object), Set.equals(Object)

Interface TIntSet

Field Summary

Fields inherited from interface gnu.trove.TIntCollection

Method Summary

Method Detail

getNoEntryValue

size

isEmpty

contains

iterator

toArray

toArray

add

remove

containsAll

containsAll

containsAll

addAll

addAll

addAll

retainAll

retainAll

retainAll

removeAll

removeAll

removeAll

clear

forEach

equals

hashCode