Interface TFloatSet
- All Superinterfaces:
TFloatCollection
- All Known Implementing Classes:
TFloatByteHashMap.TKeyView
,TFloatCharHashMap.TKeyView
,TFloatDoubleHashMap.TKeyView
,TFloatFloatHashMap.TKeyView
,TFloatHashSet
,TFloatIntHashMap.TKeyView
,TFloatLongHashMap.TKeyView
,TFloatShortHashMap.TKeyView
-
Field Summary
Fields inherited from interface gnu.trove.TFloatCollection
serialVersionUID
-
Method Summary
Modifier and TypeMethodDescriptionboolean
add
(float entry) Inserts a value into the set.boolean
addAll
(float[] array) Adds all of the elements in the array to the set.boolean
addAll
(TFloatCollection collection) Adds all of the elements in the TFloatCollection to the set.boolean
addAll
(Collection<? extends Float> collection) Adds all of the elements in collection to the set.void
clear()
Empties the set.boolean
contains
(float entry) Returns true if this set contains the specified element.boolean
containsAll
(float[] array) Tests the set to determine if all of the elements in array are present.boolean
containsAll
(TFloatCollection collection) Tests the set to determine if all of the elements in TFloatCollection are present.boolean
containsAll
(Collection<?> collection) Tests the set to determine if all of the elements in collection are present.boolean
Compares the specified object with this set for equality.boolean
forEach
(TFloatProcedure procedure) Executes procedure for each element in the set.float
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.iterator()
Creates an iterator over the values of the set.boolean
remove
(float entry) Removes entry from the set.boolean
removeAll
(float[] array) Removes all of the elements in array from the set.boolean
removeAll
(TFloatCollection collection) Removes all of the elements in TFloatCollection from the set.boolean
removeAll
(Collection<?> collection) Removes all of the elements in collection from the set.boolean
retainAll
(float[] array) Removes any values in the set which are not contained in array.boolean
retainAll
(TFloatCollection collection) Removes any values in the set which are not contained in TFloatCollection.boolean
retainAll
(Collection<?> collection) Removes any values in the set which are not contained in collection.int
size()
Returns the number of elements in this set (its cardinality).float[]
toArray()
Returns an array containing all of the elements in this set.float[]
toArray
(float[] dest) Returns an array containing elements in this set.
-
Method Details
-
getNoEntryValue
float 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 interfaceTFloatCollection
- 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 interfaceTFloatCollection
- 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 interfaceTFloatCollection
- Returns:
- true if this set contains no elements
-
contains
boolean contains(float entry) Returns true if this set contains the specified element.- Specified by:
contains
in interfaceTFloatCollection
- Parameters:
entry
- anfloat
value- Returns:
- true if the set contains the specified element.
-
iterator
TFloatIterator iterator()Creates an iterator over the values of the set. The iterator supports element deletion.- Specified by:
iterator
in interfaceTFloatCollection
- Returns:
- an
TFloatIterator
value
-
toArray
float[] 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 interfaceTFloatCollection
- Returns:
- an array containing all the elements in this set
-
toArray
float[] toArray(float[] 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 interfaceTFloatCollection
- Parameters:
dest
- the array into which the elements of this set are to be stored.- Returns:
- an float[] containing all the elements in this set
- Throws:
NullPointerException
- if the specified array is null
-
add
boolean add(float entry) Inserts a value into the set.- Specified by:
add
in interfaceTFloatCollection
- Parameters:
entry
- afloat
value- Returns:
- true if the set was modified by the add operation
-
remove
boolean remove(float entry) Removes entry from the set.- Specified by:
remove
in interfaceTFloatCollection
- Parameters:
entry
- anfloat
value- Returns:
- true if the set was modified by the remove operation.
-
containsAll
Tests the set to determine if all of the elements in collection are present.- Specified by:
containsAll
in interfaceTFloatCollection
- Parameters:
collection
- aCollection
value- Returns:
- true if all elements were present in the set.
-
containsAll
Tests the set to determine if all of the elements in TFloatCollection are present.- Specified by:
containsAll
in interfaceTFloatCollection
- Parameters:
collection
- aTFloatCollection
value- Returns:
- true if all elements were present in the set.
-
containsAll
boolean containsAll(float[] array) Tests the set to determine if all of the elements in array are present.- Specified by:
containsAll
in interfaceTFloatCollection
- Parameters:
array
- asarray
of float primitives.- Returns:
- true if all elements were present in the set.
-
addAll
Adds all of the elements in collection to the set.- Specified by:
addAll
in interfaceTFloatCollection
- Parameters:
collection
- aCollection
value- Returns:
- true if the set was modified by the add all operation.
-
addAll
Adds all of the elements in the TFloatCollection to the set.- Specified by:
addAll
in interfaceTFloatCollection
- Parameters:
collection
- aTFloatCollection
value- Returns:
- true if the set was modified by the add all operation.
-
addAll
boolean addAll(float[] array) Adds all of the elements in the array to the set.- Specified by:
addAll
in interfaceTFloatCollection
- Parameters:
array
- aarray
of float primitives.- Returns:
- true if the set was modified by the add all operation.
-
retainAll
Removes any values in the set which are not contained in collection.- Specified by:
retainAll
in interfaceTFloatCollection
- Parameters:
collection
- aCollection
value- Returns:
- true if the set was modified by the retain all operation
-
retainAll
Removes any values in the set which are not contained in TFloatCollection.- Specified by:
retainAll
in interfaceTFloatCollection
- Parameters:
collection
- aTFloatCollection
value- Returns:
- true if the set was modified by the retain all operation
-
retainAll
boolean retainAll(float[] array) Removes any values in the set which are not contained in array.- Specified by:
retainAll
in interfaceTFloatCollection
- Parameters:
array
- anarray
of float primitives.- Returns:
- true if the set was modified by the retain all operation
-
removeAll
Removes all of the elements in collection from the set.- Specified by:
removeAll
in interfaceTFloatCollection
- Parameters:
collection
- aCollection
value- Returns:
- true if the set was modified by the remove all operation.
-
removeAll
Removes all of the elements in TFloatCollection from the set.- Specified by:
removeAll
in interfaceTFloatCollection
- Parameters:
collection
- aTFloatCollection
value- Returns:
- true if the set was modified by the remove all operation.
-
removeAll
boolean removeAll(float[] array) Removes all of the elements in array from the set.- Specified by:
removeAll
in interfaceTFloatCollection
- Parameters:
array
- anarray
of float primitives.- Returns:
- true if the set was modified by the remove all operation.
-
clear
void clear()Empties the set.- Specified by:
clear
in interfaceTFloatCollection
-
forEach
Executes procedure for each element in the set.- Specified by:
forEach
in interfaceTFloatCollection
- Parameters:
procedure
- aTFloatProcedure
value- Returns:
- false if the loop over the set terminated because the procedure returned false for some value.
-
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.- Specified by:
equals
in interfaceTFloatCollection
- Overrides:
equals
in classObject
- 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 ofObject.hashCode()
.- Specified by:
hashCode
in interfaceTFloatCollection
- Overrides:
hashCode
in classObject
- Returns:
- the hash code value for this set
- See Also:
-