ANTLR 4 Runtime 4.13.1 · org.antlr.v4.runtime.misc.Array2DHashSet

Modifier and Type	Class and Description
protected class	Array2DHashSet.SetIterator

Modifier and Type	Field and Description
protected T[][]	buckets
protected final AbstractEqualityComparator<? super T>	comparator
protected int	currentPrime
public static final int	INITAL_BUCKET_CAPACITY
public static final int	INITAL_CAPACITY
protected final int	initialBucketCapacity
protected final int	initialCapacity
public static final double	LOAD_FACTOR
protected int	n How many elements in set
protected int	threshold when to expand

Access	Constructor and Description
public	Array2DHashSet()
public	Array2DHashSet(AbstractEqualityComparator<? super T> comparator)
public	Array2DHashSet(AbstractEqualityComparator<? super T> comparator, int initialCapacity, int initialBucketCapacity)

Method Summary

Modifier and Type	Method and Description
public final boolean	add(T element to be added to this set t) Implements java.util.Set.add. Adds the specified element to this set if it is not already present (optional operation).
public boolean	addAll(Collection<? extends T> collection containing elements to be added to this set c) Implements java.util.Set.addAll. Adds all of the elements in the specified collection to this set if they're not already present (optional operation).
protected T	Returns: `o` if it could be an instance of `T`, otherwise `null`. asElementType(Object the object to try and cast to the element type of the set o) Return `o` as an instance of the element type `T`.
public void	clear() Implements java.util.Set.clear. Removes all of the elements from this set (optional operation).
public final boolean	contains(Object element whose presence in this set is to be tested o) Implements java.util.Set.contains. Returns `true` if this set contains the specified element.
public boolean	containsAll(Collection<?> collection to be checked for containment in this set collection) Implements java.util.Set.containsAll. Returns `true` if this set contains all of the elements of the specified collection.
public boolean	containsFast(T obj)
protected T[]	Returns: the newly constructed array createBucket(int the length of the array to return capacity) Return an array of `T` with length `capacity`.
protected T[][]	Returns: the newly constructed array createBuckets(int the length of the array to return capacity) Return an array of `T[]` with length `capacity`.
public boolean	equals(Object object to be compared for equality with this set o) Overrides java.lang.Object.equals. Implements java.util.Set.equals. Compares the specified object with this set for equality.
protected void	expand()
public T	get(T o)
protected final int	getBucket(T o)
public final T	getOrAdd(T o) Add `o` to set if not there; return existing value if already there.
protected T	getOrAddImpl(T o)
public int	hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Set.hashCode. Returns the hash code value for this set.
public final boolean	isEmpty() Implements java.util.Set.isEmpty. Returns `true` if this set contains no elements.
public Iterator<T>	iterator() Implements java.util.Set.iterator. Returns an iterator over the elements in this set.
public final boolean	remove(Object object to be removed from this set, if present o) Implements java.util.Set.remove. Removes the specified element from this set if it is present (optional operation).
public boolean	removeAll(Collection<?> collection containing elements to be removed from this set c) Implements java.util.Set.removeAll. Removes from this set all of its elements that are contained in the specified collection (optional operation).
public boolean	removeFast(T obj)
public boolean	retainAll(Collection<?> collection containing elements to be retained in this set c) Implements java.util.Set.retainAll. Retains only the elements in this set that are contained in the specified collection (optional operation).
public final int	size() Implements java.util.Set.size. Returns the number of elements in this set (its cardinality).
public T[]	toArray() Implements java.util.Set.toArray. Returns an array containing all of the elements in this set.
public <U> U[]	toArray(U[] the array into which the elements of this set are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose. a) Implements java.util.Set.toArray. Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public String	toTableString()

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

buckets	back to summary
protected T[][] buckets

comparator	back to summary
protected final AbstractEqualityComparator<? super T> comparator

currentPrime	back to summary
protected int currentPrime

INITAL_BUCKET_CAPACITY	back to summary
public static final int INITAL_BUCKET_CAPACITY

INITAL_CAPACITY	back to summary
public static final int INITAL_CAPACITY

initialBucketCapacity	back to summary
protected final int initialBucketCapacity

initialCapacity	back to summary
protected final int initialCapacity

LOAD_FACTOR	back to summary
public static final double LOAD_FACTOR

n	back to summary
protected int n How many elements in set

threshold	back to summary
protected int threshold when to expand

Array2DHashSet	back to summary
public Array2DHashSet()

Array2DHashSet	back to summary
public Array2DHashSet(AbstractEqualityComparator<? super T> comparator)

Array2DHashSet	back to summary
public Array2DHashSet(AbstractEqualityComparator<? super T> comparator, int initialCapacity, int initialBucketCapacity)

Method Detail

add back to summary

add	back to summary
public final boolean add(T t) Implements java.util.Set.add. Doc from java.util.Set.add. Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element `e` to this set if the set contains no element `e2` such that `Objects.equals(e, e2)`. If this set already contains the element, the call leaves the set unchanged and returns `false`. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements. The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including `null`, and throw an exception, as described in the specification for `Collection.add`. Individual set implementations should clearly document any restrictions on the elements that they may contain. Parameters t:T element to be added to this set Returns:boolean `true` if this set did not already contain the specified element Annotations @Override

public final boolean add(T t)

Implements java.util.Set.add.

Doc from java.util.Set.add.

Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element e to this set if the set contains no element e2 such that Objects.equals(e, e2). If this set already contains the element, the call leaves the set unchanged and returns false. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements.

The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including null, and throw an exception, as described in the specification for Collection.add. Individual set implementations should clearly document any restrictions on the elements that they may contain.

Parameters

t:T: element to be added to this set

Returns:boolean

true if this set did not already contain the specified element

Annotations

@Override

addAll back to summary

addAll	back to summary
public boolean addAll(Collection<? extends T> c) Implements java.util.Set.addAll. Doc from java.util.Set.addAll. Adds all of the elements in the specified collection to this set if they're not already present (optional operation). If the specified collection is also a set, the `addAll` operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. Parameters c:Collection<? extends T> collection containing elements to be added to this set Returns:boolean `true` if this set changed as a result of the call Annotations @Override

public boolean addAll(Collection<? extends T> c)

Implements java.util.Set.addAll.

Doc from java.util.Set.addAll.

Adds all of the elements in the specified collection to this set if they're not already present (optional operation). If the specified collection is also a set, the addAll operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

Parameters

c:Collection<? extends T>: collection containing elements to be added to this set

Returns:boolean

true if this set changed as a result of the call

Annotations

@Override

asElementType back to summary

asElementType	back to summary
protected T asElementType(Object o) Return `o` as an instance of the element type `T`. If `o` is non-null but known to not be an instance of `T`, this method returns `null`. The base implementation does not perform any type checks; override this method to provide strong type checks for the `contains` and `remove` methods to ensure the arguments to the `EqualityComparator` for the set always have the expected types. Parameters o:Object the object to try and cast to the element type of the set Returns:T `o` if it could be an instance of `T`, otherwise `null`. Annotations @SuppressWarnings:unchecked

protected T asElementType(Object o)

Return o as an instance of the element type T. If o is non-null but known to not be an instance of T, this method returns null. The base implementation does not perform any type checks; override this method to provide strong type checks for the contains and remove methods to ensure the arguments to the EqualityComparator for the set always have the expected types.

Parameters

o:Object: the object to try and cast to the element type of the set

Returns:T

o if it could be an instance of T, otherwise null.

Annotations

@SuppressWarnings:unchecked

clear	back to summary
public void clear() Implements java.util.Set.clear. Doc from java.util.Set.clear. Removes all of the elements from this set (optional operation). The set will be empty after this call returns. Annotations @Override

clear

back to summary

public void clear()

Implements java.util.Set.clear.

Doc from java.util.Set.clear.

Removes all of the elements from this set (optional operation). The set will be empty after this call returns.

Annotations

@Override

contains back to summary

contains	back to summary
public final boolean contains(Object o) Implements java.util.Set.contains. Doc from java.util.Set.contains. Returns `true` if this set contains the specified element. More formally, returns `true` if and only if this set contains an element `e` such that `Objects.equals(o, e)`. Parameters o:Object element whose presence in this set is to be tested Returns:boolean `true` if this set contains the specified element Annotations @Override

public final boolean contains(Object o)

Implements java.util.Set.contains.

Doc from java.util.Set.contains.

Returns true if this set contains the specified element. More formally, returns true if and only if this set contains an element e such that Objects.equals(o, e).

Parameters

o:Object: element whose presence in this set is to be tested

Returns:boolean

true if this set contains the specified element

Annotations

@Override

containsAll back to summary

containsAll	back to summary
public boolean containsAll(Collection<?> collection) Implements java.util.Set.containsAll. Doc from java.util.Set.containsAll. Returns `true` if this set contains all of the elements of the specified collection. If the specified collection is also a set, this method returns `true` if it is a subset of this set. Parameters collection:Collection<?> collection to be checked for containment in this set Returns:boolean `true` if this set contains all of the elements of the specified collection Annotations @Override

public boolean containsAll(Collection<?> collection)

Implements java.util.Set.containsAll.

Doc from java.util.Set.containsAll.

Returns true if this set contains all of the elements of the specified collection. If the specified collection is also a set, this method returns true if it is a subset of this set.

Parameters

collection:Collection<?>: collection to be checked for containment in this set

Returns:boolean

true if this set contains all of the elements of the specified collection

Annotations

@Override

containsFast	back to summary
public boolean containsFast(T obj)

createBucket back to summary

createBucket	back to summary
protected T[] createBucket(int capacity) Return an array of `T` with length `capacity`. Parameters capacity:int the length of the array to return Returns:T[] the newly constructed array Annotations @SuppressWarnings:unchecked

protected T[] createBucket(int capacity)

Return an array of T with length capacity.

Parameters

capacity:int: the length of the array to return

Returns:T[]

the newly constructed array

Annotations

@SuppressWarnings:unchecked

createBuckets back to summary

createBuckets	back to summary
protected T[][] createBuckets(int capacity) Return an array of `T[]` with length `capacity`. Parameters capacity:int the length of the array to return Returns:T[][] the newly constructed array Annotations @SuppressWarnings:unchecked

protected T[][] createBuckets(int capacity)

Return an array of T[] with length capacity.

Parameters

capacity:int: the length of the array to return

Returns:T[][]

the newly constructed array

Annotations

@SuppressWarnings:unchecked

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Implements java.util.Set.equals. Doc from java.util.Set.equals. 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. Parameters o:Object object to be compared for equality with this set Returns:boolean `true` if the specified object is equal to this set Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Implements java.util.Set.equals.

Doc from java.util.Set.equals.

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.

Parameters

o:Object: object to be compared for equality with this set

Returns:boolean

true if the specified object is equal to this set

Annotations

@Override

expand	back to summary
protected void expand()

get	back to summary
public T get(T o)

getBucket	back to summary
protected final int getBucket(T o)

getOrAdd	back to summary
public final T getOrAdd(T o) Add `o` to set if not there; return existing value if already there. This method performs the same operation as `add` aside from the return value.

getOrAddImpl	back to summary
protected T getOrAddImpl(T o)

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Set.hashCode. Doc from java.util.Set.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, where the hash code of a `null` element is defined to be zero. 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`. Returns:int the hash code value for this set Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Implements java.util.Set.hashCode.

Doc from java.util.Set.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, where the hash code of a null element is defined to be zero. 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.

Returns:int

the hash code value for this set

Annotations

@Override

isEmpty back to summary

isEmpty	back to summary
public final boolean isEmpty() Implements java.util.Set.isEmpty. Doc from java.util.Set.isEmpty. Returns `true` if this set contains no elements. Returns:boolean `true` if this set contains no elements Annotations @Override

public final boolean isEmpty()

Implements java.util.Set.isEmpty.

Doc from java.util.Set.isEmpty.

Returns true if this set contains no elements.

Returns:boolean

true if this set contains no elements

Annotations

@Override

iterator	back to summary
public Iterator<T> iterator() Implements java.util.Set.iterator. Doc from java.util.Set.iterator. Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee). Returns:Iterator<T> an iterator over the elements in this set Annotations @Override

iterator

back to summary

public Iterator<T> iterator()

Implements java.util.Set.iterator.

Doc from java.util.Set.iterator.

Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee).

Returns:Iterator<T>

an iterator over the elements in this set

Annotations

@Override

remove back to summary

remove	back to summary
public final boolean remove(Object o) Implements java.util.Set.remove. Doc from java.util.Set.remove. Removes the specified element from this set if it is present (optional operation). More formally, removes an element `e` such that `Objects.equals(o, e)`, if this set contains such an element. Returns `true` if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.) Parameters o:Object object to be removed from this set, if present Returns:boolean `true` if this set contained the specified element Annotations @Override

public final boolean remove(Object o)

Implements java.util.Set.remove.

Doc from java.util.Set.remove.

Removes the specified element from this set if it is present (optional operation). More formally, removes an element e such that Objects.equals(o, e), if this set contains such an element. Returns true if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.)

Parameters

o:Object: object to be removed from this set, if present

Returns:boolean

true if this set contained the specified element

Annotations

@Override

removeAll back to summary

removeAll	back to summary
public boolean removeAll(Collection<?> c) Implements java.util.Set.removeAll. Doc from java.util.Set.removeAll. Removes from this set all of its elements that are contained in the specified collection (optional operation). If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets. Parameters c:Collection<?> collection containing elements to be removed from this set Returns:boolean `true` if this set changed as a result of the call Annotations @Override

public boolean removeAll(Collection<?> c)

Implements java.util.Set.removeAll.

Doc from java.util.Set.removeAll.

Removes from this set all of its elements that are contained in the specified collection (optional operation). If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.

Parameters

c:Collection<?>: collection containing elements to be removed from this set

Returns:boolean

true if this set changed as a result of the call

Annotations

@Override

removeFast	back to summary
public boolean removeFast(T obj)

retainAll back to summary

retainAll	back to summary
public boolean retainAll(Collection<?> c) Implements java.util.Set.retainAll. Doc from java.util.Set.retainAll. Retains only the elements in this set that are contained in the specified collection (optional operation). In other words, removes from this set all of its elements that are not contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the intersection of the two sets. Parameters c:Collection<?> collection containing elements to be retained in this set Returns:boolean `true` if this set changed as a result of the call Annotations @Override

public boolean retainAll(Collection<?> c)

Implements java.util.Set.retainAll.

Doc from java.util.Set.retainAll.

Retains only the elements in this set that are contained in the specified collection (optional operation). In other words, removes from this set all of its elements that are not contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the intersection of the two sets.

Parameters

c:Collection<?>: collection containing elements to be retained in this set

Returns:boolean

true if this set changed as a result of the call

Annotations

@Override

size back to summary

size	back to summary
public final int size() Implements java.util.Set.size. Doc from java.util.Set.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`. Returns:int the number of elements in this set (its cardinality) Annotations @Override

public final int size()

Implements java.util.Set.size.

Doc from java.util.Set.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.

Returns:int

the number of elements in this set (its cardinality)

Annotations

@Override

toArray	back to summary
public T[] toArray() Implements java.util.Set.toArray. Doc from java.util.Set.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. Returns:T[] an array containing all the elements in this set Annotations @Override

toArray

back to summary

public T[] toArray()

Implements java.util.Set.toArray.

Doc from java.util.Set.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.

Returns:T[]

an array containing all the elements in this set

Annotations

@Override

toArray back to summary

toArray	back to summary
public <U> U[] toArray(U[] a) Implements java.util.Set.toArray. Doc from java.util.Set.toArray. Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array. If the set fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of 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 `null`. (This is useful in determining the length of this set only if the caller knows that this set does not contain any null elements.) 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. Like the `toArray()` method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs. Suppose `x` is a set known to contain only strings. The following code can be used to dump the set into a newly allocated array of `String`: String[] y = x.toArray(new String[0]); Note that `toArray(new Object[0])` is identical in function to `toArray()`. Parameters <U> Doc from java.util.Collection.toArray. the component type of the array to contain the collection a:U[] the array into which the elements of this set are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose. Returns:U[] an array containing all the elements in this set Annotations @Override

public <U> U[] toArray(U[] a)

Implements java.util.Set.toArray.

Doc from java.util.Set.toArray.

Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array. If the set fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of 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 null. (This is useful in determining the length of this set only if the caller knows that this set does not contain any null elements.)

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.

Like the toArray() method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.

Suppose x is a set known to contain only strings. The following code can be used to dump the set into a newly allocated array of String:

    String[] y = x.toArray(new String[0]);

Note that toArray(new Object[0]) is identical in function to toArray().

Parameters

<U>: Doc from java.util.Collection.toArray. the component type of the array to contain the collection
a:U[]: the array into which the elements of this set are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:U[]

an array containing all the elements in this set

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

toTableString	back to summary
public String toTableString()

Modifier and Type	Field and Description
pack-priv final T[]	data
pack-priv int	nextIndex
pack-priv boolean	removed

public Class Array2DHashSet<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class Array2DHashSet.SetIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public T	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).