IntSet (de.mpg.mpi-inf:javatools 1.1 API)

java.lang.Object
- javatools.datatypes.IntSet

All Implemented Interfaces:

Iterable<Integer>, Collection<Integer>, Set<Integer>

Direct Known Subclasses:

IdPriorityQueue
```
public class IntSet
extends Object
implements Set<Integer>
```
Copyright 2016 Fabian M. Suchanek Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. This class implements a space-efficient integer set. All operations are linear time, though...

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`addIndex` Index pointing to an empty position.
`protected int[]`	`data` Holds the integers
`protected BitSet`	`isThere` Tells whether the int is there
`protected int`	`lastIndex` Last index that contains a value
`protected int`	`numElements` Number of integers in data
`protected int`	`pollIndex` Index that can be polled next.

Constructor Summary

Constructors
Constructor and Description
`IntSet()` Creates a new IntSet
`IntSet(BitSet copy)` Creates a new IntSet by copying the given bit set
`IntSet(int capacity)` Creates a new IntSet with an initial capacity
`IntSet(IntSet copy)` Creates a new IntSet by copying the given set

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(int v)` Adds the element
`boolean`	`add(Integer e)` Adds the element
`boolean`	`add(long i)` Adds this element
`boolean`	`add(Number e)` Adds this element
`boolean`	`addAll(BitSet s)` Adds all elements
`boolean`	`addAll(Collection<? extends Integer> c)` Adds all elements
`boolean`	`addAll(IntSet s)` Adds all elements
`void`	`addTo(BitSet s)` Adds all elements of this set to s
`void`	`clear()` Removes all elements
`void`	`clear(int capacity)`
`boolean`	`contains(int i)` TRUE if the set contains i
`boolean`	`contains(long i)` TRUE if the set contains i
`boolean`	`contains(Object o)` TRUE if the set contains o
`boolean`	`containsAll(Collection<?> c)` TRUE if the set contains all elements of c
`IntSet`	`enhancedBy(int addMe)` Adds addMe, returns THIS
`IntSet`	`enhancedBy(IntSet addMe)` Adds all elements, returns THIS
`protected int`	`indexOf(int v)` Finds the element, sets addIndex to a free position
`boolean`	`isEmpty()` TRUE if the set is empty
`PeekIterator<Integer>`	`iterator()`
`static void`	`main(String[] args)` Test method
`static IntSet`	`of(int... initial)` Creates a new IntSet from initial values.
`int`	`poll()`
`boolean`	`remove(int i)` Removes one element, returns TRUE if the set was modified
`boolean`	`remove(long i)` Removes one element, returns TRUE if the set was modified
`boolean`	`remove(Object o)` Removes one element (has to be a number), returns TRUE if the set was modified
`boolean`	`removeAll(BitSet s)` Removes all elements of s from this set
`boolean`	`removeAll(Collection<?> c)` Removes all elements in c
`boolean`	`removeAll(IntSet c)` Removes all elements in c
`protected int`	`removeIndex(int index)` Removes an item
`boolean`	`retainAll(Collection<?> c)` Removes all elements that are not in c
`void`	`setTo(IntSet copy)` Overwrites the current IntSet with the given one
`protected void`	`shrink()` Deletes empty space if necessary
`IntSet`	`shrunkBy(int addMe)` Removes the given element, returns THIS
`IntSet`	`shrunkBy(IntSet addMe)` Removes the given elements, returns THIS
`int`	`size()`
`Object[]`	`toArray()` Returns an array of the elements of this set
`<T> T[]`	`toArray(T[] a)` Not supported
`String`	`toString()`

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

Methods inherited from interface java.util.Set
equals, hashCode, spliterator

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Field Detail
  - data
```
protected int[] data
```
    Holds the integers
  - isThere
```
protected BitSet isThere
```
    Tells whether the int is there
  - numElements
```
protected int numElements
```
    Number of integers in data
  - pollIndex
```
protected int pollIndex
```
    Index that can be polled next. Handled exclusively by poll()
  - addIndex
```
protected int addIndex
```
    Index pointing to an empty position. Handled exclusively by indexOf()
  - lastIndex
```
protected int lastIndex
```
    Last index that contains a value
- Constructor Detail
  - IntSet
```
public IntSet(IntSet copy)
```
    Creates a new IntSet by copying the given set
  - IntSet
```
public IntSet(BitSet copy)
```
    Creates a new IntSet by copying the given bit set
  - IntSet
```
public IntSet()
```
    Creates a new IntSet
  - IntSet
```
public IntSet(int capacity)
```
    Creates a new IntSet with an initial capacity
- Method Detail
  - iterator
```
public PeekIterator<Integer> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Integer>
    
    Specified by:
    
    iterator in interface Collection<Integer>
    
    Specified by:
    
    iterator in interface Set<Integer>
  - add
```
public boolean add(int v)
```
    Adds the element
  - clear
```
public void clear(int capacity)
```
  - poll
```
public int poll()
```
  - indexOf
```
protected int indexOf(int v)
```
    Finds the element, sets addIndex to a free position
  - shrink
```
protected void shrink()
```
    Deletes empty space if necessary
  - removeIndex
```
protected int removeIndex(int index)
```
    Removes an item
  - of
```
public static IntSet of(int... initial)
```
    Creates a new IntSet from initial values.
  - setTo
```
public void setTo(IntSet copy)
```
    Overwrites the current IntSet with the given one
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Removes all elements that are not in c
    
    Specified by:
    
    retainAll in interface Collection<Integer>
    
    Specified by:
    
    retainAll in interface Set<Integer>
  - remove
```
public boolean remove(int i)
```
    Removes one element, returns TRUE if the set was modified
  - remove
```
public boolean remove(long i)
```
    Removes one element, returns TRUE if the set was modified
  - remove
```
public boolean remove(Object o)
```
    Removes one element (has to be a number), returns TRUE if the set was modified
    
    Specified by:
    
    remove in interface Collection<Integer>
    
    Specified by:
    
    remove in interface Set<Integer>
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Removes all elements in c
    
    Specified by:
    
    removeAll in interface Collection<Integer>
    
    Specified by:
    
    removeAll in interface Set<Integer>
  - removeAll
```
public boolean removeAll(IntSet c)
```
    Removes all elements in c
  - toArray
```
public Object[] toArray()
```
    Returns an array of the elements of this set
    
    Specified by:
    
    toArray in interface Collection<Integer>
    
    Specified by:
    
    toArray in interface Set<Integer>
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Not supported
    
    Specified by:
    
    toArray in interface Collection<Integer>
    
    Specified by:
    
    toArray in interface Set<Integer>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<Integer>
    
    Specified by:
    
    size in interface Set<Integer>
  - add
```
public boolean add(long i)
```
    Adds this element
  - add
```
public boolean add(Number e)
```
    Adds this element
  - addAll
```
public boolean addAll(Collection<? extends Integer> c)
```
    Adds all elements
    
    Specified by:
    
    addAll in interface Collection<Integer>
    
    Specified by:
    
    addAll in interface Set<Integer>
  - addAll
```
public boolean addAll(IntSet s)
```
    Adds all elements
  - addAll
```
public boolean addAll(BitSet s)
```
    Adds all elements
  - removeAll
```
public boolean removeAll(BitSet s)
```
    Removes all elements of s from this set
  - addTo
```
public void addTo(BitSet s)
```
    Adds all elements of this set to s
  - enhancedBy
```
public IntSet enhancedBy(IntSet addMe)
```
    Adds all elements, returns THIS
  - enhancedBy
```
public IntSet enhancedBy(int addMe)
```
    Adds addMe, returns THIS
  - shrunkBy
```
public IntSet shrunkBy(IntSet addMe)
```
    Removes the given elements, returns THIS
  - shrunkBy
```
public IntSet shrunkBy(int addMe)
```
    Removes the given element, returns THIS
  - contains
```
public boolean contains(int i)
```
    TRUE if the set contains i
  - contains
```
public boolean contains(long i)
```
    TRUE if the set contains i
  - contains
```
public boolean contains(Object o)
```
    TRUE if the set contains o
    
    Specified by:
    
    contains in interface Collection<Integer>
    
    Specified by:
    
    contains in interface Set<Integer>
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    TRUE if the set contains all elements of c
    
    Specified by:
    
    containsAll in interface Collection<Integer>
    
    Specified by:
    
    containsAll in interface Set<Integer>
  - isEmpty
```
public boolean isEmpty()
```
    TRUE if the set is empty
    
    Specified by:
    
    isEmpty in interface Collection<Integer>
    
    Specified by:
    
    isEmpty in interface Set<Integer>
  - clear
```
public void clear()
```
    Removes all elements
    
    Specified by:
    
    clear in interface Collection<Integer>
    
    Specified by:
    
    clear in interface Set<Integer>
  - add
```
public boolean add(Integer e)
```
    Adds the element
    
    Specified by:
    
    add in interface Collection<Integer>
    
    Specified by:
    
    add in interface Set<Integer>
  - main
```
public static void main(String[] args)
```
    Test method

Class IntSet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Set

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Field Detail

data

isThere

numElements

pollIndex

addIndex

lastIndex

Constructor Detail

IntSet

IntSet

IntSet

IntSet

Method Detail

iterator

add

clear

poll

indexOf

shrink

removeIndex

of

setTo

retainAll

remove

remove

remove

removeAll

removeAll

toArray

toArray

toString

size

add

add

addAll

addAll

addAll

removeAll

addTo

enhancedBy

enhancedBy

shrunkBy

shrunkBy

contains

contains

contains

containsAll

isEmpty

clear

add

main