FloatSet (float-sets 8.5.13-SNAPSHOT API)

All Superinterfaces:

java.util.Collection<java.lang.Float>, it.unimi.dsi.fastutil.floats.FloatCollection, it.unimi.dsi.fastutil.floats.FloatIterable, java.lang.Iterable<java.lang.Float>, java.util.Set<java.lang.Float>

All Known Subinterfaces:

FloatSortedSet

All Known Implementing Classes:

AbstractFloatSet, AbstractFloatSortedSet, FloatArraySet, FloatAVLTreeSet, FloatLinkedOpenCustomHashSet, FloatLinkedOpenHashSet, FloatOpenCustomHashSet, FloatOpenHashSet, FloatRBTreeSet, FloatSets.EmptySet, FloatSets.Singleton, FloatSets.SynchronizedSet, FloatSets.UnmodifiableSet, FloatSortedSets.EmptySet, FloatSortedSets.Singleton, FloatSortedSets.SynchronizedSortedSet, FloatSortedSets.UnmodifiableSortedSet
```
public interface FloatSet
extends it.unimi.dsi.fastutil.floats.FloatCollection, java.util.Set<java.lang.Float>
```
A type-specific Set; provides some additional methods that use polymorphism to avoid (un)boxing.
Additionally, this interface strengthens (again) iterator().

See Also:

Set

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default boolean`	`add(java.lang.Float o)` Deprecated. Please use the corresponding type-specific method instead.
`default boolean`	`contains(java.lang.Object o)` Deprecated. Please use the corresponding type-specific method instead.
`it.unimi.dsi.fastutil.floats.FloatIterator`	`iterator()` Returns a type-specific iterator on the elements of this set.
`static FloatSet`	`of()` Returns an immutable empty set.
`static FloatSet`	`of(float... a)` Returns an immutable list with the elements given.
`static FloatSet`	`of(float e)` Returns an immutable set with the element given.
`static FloatSet`	`of(float e0, float e1)` Returns an immutable set with the elements given.
`static FloatSet`	`of(float e0, float e1, float e2)` Returns an immutable set with the elements given.
`default boolean`	`rem(float k)` Deprecated. Please use `remove()` instead.
`boolean`	`remove(float k)` Removes an element from this set.
`default boolean`	`remove(java.lang.Object o)` Deprecated. Please use the corresponding type-specific method instead.
`default it.unimi.dsi.fastutil.floats.FloatSpliterator`	`spliterator()` Returns a type-specific spliterator on the elements of this set.

Methods inherited from interface it.unimi.dsi.fastutil.floats.FloatCollection
add, addAll, contains, containsAll, doubleIterator, doubleParallelStream, doubleSpliterator, doubleStream, parallelStream, removeAll, removeIf, removeIf, removeIf, retainAll, stream, toArray, toFloatArray, toFloatArray

Methods inherited from interface it.unimi.dsi.fastutil.floats.FloatIterable
forEach, forEach, forEach

Methods inherited from interface java.util.Set
addAll, clear, containsAll, equals, hashCode, isEmpty, removeAll, retainAll, size, toArray, toArray

- Method Detail
  - iterator
```
it.unimi.dsi.fastutil.floats.FloatIterator iterator()
```
    Returns a type-specific iterator on the elements of this set.
    
    Specified by:
    
    iterator in interface java.util.Collection<java.lang.Float>
    
    Specified by:
    
    iterator in interface it.unimi.dsi.fastutil.floats.FloatCollection
    
    Specified by:
    
    iterator in interface it.unimi.dsi.fastutil.floats.FloatIterable
    
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.Float>
    
    Specified by:
    
    iterator in interface java.util.Set<java.lang.Float>
    
    Returns:
    
    a type-specific iterator on the elements of this set.
  - spliterator
```
default it.unimi.dsi.fastutil.floats.FloatSpliterator spliterator()
```
    Returns a type-specific spliterator on the elements of this set.
    Set spliterators must report at least Spliterator.DISTINCT.
    See Set.spliterator() for more documentation on the requirements of the returned spliterator.
    
    Specified by:
    
    spliterator in interface java.util.Collection<java.lang.Float>
    
    Specified by:
    
    spliterator in interface it.unimi.dsi.fastutil.floats.FloatCollection
    
    Specified by:
    
    spliterator in interface it.unimi.dsi.fastutil.floats.FloatIterable
    
    Specified by:
    
    spliterator in interface java.lang.Iterable<java.lang.Float>
    
    Specified by:
    
    spliterator in interface java.util.Set<java.lang.Float>
    
    Returns:
    
    Since:
    
    8.5.0
  - remove
```
boolean remove(float k)
```
    Removes an element from this set.
    
    See Also:
    
    Collection.remove(Object)
  - remove
```
@Deprecated
default boolean remove(java.lang.Object o)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    remove in interface java.util.Collection<java.lang.Float>
    
    Specified by:
    
    remove in interface it.unimi.dsi.fastutil.floats.FloatCollection
    
    Specified by:
    
    remove in interface java.util.Set<java.lang.Float>
  - add
```
@Deprecated
default boolean add(java.lang.Float o)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    add in interface java.util.Collection<java.lang.Float>
    
    Specified by:
    
    add in interface it.unimi.dsi.fastutil.floats.FloatCollection
    
    Specified by:
    
    add in interface java.util.Set<java.lang.Float>
  - contains
```
@Deprecated
default boolean contains(java.lang.Object o)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    contains in interface java.util.Collection<java.lang.Float>
    
    Specified by:
    
    contains in interface it.unimi.dsi.fastutil.floats.FloatCollection
    
    Specified by:
    
    contains in interface java.util.Set<java.lang.Float>
  - rem
```
@Deprecated
default boolean rem(float k)
```
    Deprecated. Please use remove() instead.
    
    Removes an element from this set.
    This method is inherited from the type-specific collection this type-specific set is based on, but it should not used as this interface reinstates remove() as removal method.
    
    Specified by:
    
    rem in interface it.unimi.dsi.fastutil.floats.FloatCollection
  - of
```
static FloatSet of()
```
    Returns an immutable empty set.
    
    Returns:
    
    an immutable empty set.
  - of
```
static FloatSet of(float e)
```
    Returns an immutable set with the element given.
    
    Parameters:
    
    e - an element.
    
    Returns:
    
    an immutable set containing e.
  - of
```
static FloatSet of(float e0,
                   float e1)
```
    Returns an immutable set with the elements given.
    
    Parameters:
    
    e0 - the first element.
    
    e1 - the second element.
    
    Returns:
    
    an immutable set containing e0 and e1.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there were duplicate entries.
  - of
```
static FloatSet of(float e0,
                   float e1,
                   float e2)
```
    Returns an immutable set with the elements given.
    
    Parameters:
    
    e0 - the first element.
    
    e1 - the second element.
    
    e2 - the third element.
    
    Returns:
    
    an immutable set containing e0, e1, and e2.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there were duplicate entries.
  - of
```
static FloatSet of(float... a)
```
    Returns an immutable list with the elements given.
    
    Parameters:
    
    a - the list of elements that will be in the final set.
    
    Returns:
    
    an immutable set containing the elements in a.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there are any duplicate entries.

Interface FloatSet

Method Summary

Methods inherited from interface it.unimi.dsi.fastutil.floats.FloatCollection

Methods inherited from interface it.unimi.dsi.fastutil.floats.FloatIterable

Methods inherited from interface java.util.Set

Method Detail

iterator

spliterator

remove

remove

add

contains

rem

of

of

of

of

of