FloatCollection (float-common 8.5.13-SNAPSHOT API)

All Superinterfaces:

java.util.Collection<java.lang.Float>, FloatIterable, java.lang.Iterable<java.lang.Float>

All Known Subinterfaces:

FloatList

All Known Implementing Classes:

AbstractFloatCollection, AbstractFloatList, AbstractFloatList.FloatRandomAccessSubList, AbstractFloatList.FloatSubList, FloatArrayList, FloatCollections.EmptyCollection, FloatCollections.IterableCollection, FloatImmutableList, FloatLists.EmptyList, FloatLists.Singleton, FloatLists.SynchronizedList, FloatLists.SynchronizedRandomAccessList, FloatLists.UnmodifiableList, FloatLists.UnmodifiableRandomAccessList
```
public interface FloatCollection
extends java.util.Collection<java.lang.Float>, FloatIterable
```
A type-specific Collection; provides some additional methods that use polymorphism to avoid (un)boxing.
Additionally, this class defines strengthens (again) iterator().
This interface specifies reference equality semantics (members will be compared equal with == instead of equals), which may result in breaks in contract if attempted to be used with non reference-equality semantics based Collections. For example, a aReferenceCollection.equals(aObjectCollection) may return different a different result then aObjectCollection.equals(aReferenceCollection), in violation of equals's contract requiring it being symmetric.

See Also:

Collection

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`add(float key)` Ensures that this collection contains the specified element (optional operation).
`default boolean`	`add(java.lang.Float key)` Deprecated. Please use the corresponding type-specific method instead.
`boolean`	`addAll(FloatCollection c)` Adds all elements of the given type-specific collection to this collection.
`boolean`	`contains(float key)` Returns `true` if this collection contains the specified element.
`default boolean`	`contains(java.lang.Object key)` Deprecated. Please use the corresponding type-specific method instead.
`boolean`	`containsAll(FloatCollection c)` Checks whether this collection contains all elements from the given type-specific collection.
`default it.unimi.dsi.fastutil.doubles.DoubleIterator`	`doubleIterator()` Returns a widened primitive iterator on the elements of this collection.
`default java.util.stream.DoubleStream`	`doubleParallelStream()` Return a parallel primitive stream over the elements, performing widening casts if needed.
`default it.unimi.dsi.fastutil.doubles.DoubleSpliterator`	`doubleSpliterator()` Returns widened primitive spliterator on the elements of this collection.
`default java.util.stream.DoubleStream`	`doubleStream()` Return a primitive stream over the elements, performing widening casts if needed.
`it.unimi.dsi.fastutil.floats.FloatIterator`	`iterator()` Returns a type-specific iterator on the elements of this collection.
`default java.util.stream.Stream<java.lang.Float>`	`parallelStream()` Deprecated. Please use the corresponding type-specific method instead.
`boolean`	`rem(float key)` Removes a single instance of the specified element from this collection, if it is present (optional operation).
`default boolean`	`remove(java.lang.Object key)` Deprecated. Please use (and implement) the `rem()` method instead.
`boolean`	`removeAll(FloatCollection c)` Remove from this collection all elements in the given type-specific collection.
`default boolean`	`removeIf(java.util.function.DoublePredicate filter)` Remove from this collection all elements which satisfy the given predicate.
`default boolean`	`removeIf(FloatPredicate filter)` Remove from this collection all elements which satisfy the given predicate.
`default boolean`	`removeIf(java.util.function.Predicate<? super java.lang.Float> filter)` Deprecated. Please use the corresponding type-specific method instead.
`boolean`	`retainAll(FloatCollection c)` Retains in this collection only elements from the given type-specific collection.
`default it.unimi.dsi.fastutil.floats.FloatSpliterator`	`spliterator()` Returns a type-specific spliterator on the elements of this collection.
`default java.util.stream.Stream<java.lang.Float>`	`stream()` Deprecated. Please use the corresponding type-specific method instead.
`float[]`	`toArray(float[] a)` Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.
`float[]`	`toFloatArray()` Returns a primitive type array containing the items of this collection.
`default float[]`	`toFloatArray(float[] a)` Deprecated. Please use `toArray()` instead—this method is redundant and will be removed in the future.

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

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

- Method Detail
  - iterator
```
it.unimi.dsi.fastutil.floats.FloatIterator iterator()
```
    Returns a type-specific iterator on the elements of this collection.
    
    Specified by:
    
    iterator in interface java.util.Collection<java.lang.Float>
    
    Specified by:
    
    iterator in interface FloatIterable
    
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.Float>
    
    Returns:
    
    a type-specific iterator on the elements of this collection.
    
    See Also:
    
    Iterable.iterator()
  - doubleIterator
```
default it.unimi.dsi.fastutil.doubles.DoubleIterator doubleIterator()
```
    Returns a widened primitive iterator on the elements of this collection.
    
    This method is provided for the purpose of APIs that expect only the JDK's primitive iterators, of which there are only int, long, and double.
    
    Specified by:
    
    doubleIterator in interface FloatIterable
    
    Returns:
    
    a widened primitive iterator on the elements of this collection.
    
    Since:
    
    8.5.0
  - spliterator
```
default it.unimi.dsi.fastutil.floats.FloatSpliterator spliterator()
```
    Returns a type-specific spliterator on the elements of this collection.
    See Collection.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 FloatIterable
    
    Specified by:
    
    spliterator in interface java.lang.Iterable<java.lang.Float>
    
    Returns:
    
    a type-specific spliterator on the elements of this collection.
    
    Since:
    
    8.5.0
  - doubleSpliterator
```
default it.unimi.dsi.fastutil.doubles.DoubleSpliterator doubleSpliterator()
```
    Returns widened primitive spliterator on the elements of this collection.
    
    This method is provided for the purpose of APIs that expect only the JDK's primitive spliterators, of which there are only int, long, and double.
    
    Specified by:
    
    doubleSpliterator in interface FloatIterable
    
    Returns:
    
    a widened primitive spliterator on the elements of this collection.
    
    Since:
    
    8.5.0
  - add
```
boolean add(float key)
```
    Ensures that this collection contains the specified element (optional operation).
    
    See Also:
    
    Collection.add(Object)
  - contains
```
boolean contains(float key)
```
    Returns true if this collection contains the specified element.
    
    See Also:
    
    Collection.contains(Object)
  - rem
```
boolean rem(float key)
```
    Removes a single instance of the specified element from this collection, if it is present (optional operation).
    Note that this method should be called remove(), but the clash with the similarly named index-based method in the List interface forces us to use a distinguished name. For simplicity, the set interfaces reinstates remove().
    
    See Also:
    
    Collection.remove(Object)
  - add
```
@Deprecated
default boolean add(java.lang.Float key)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    add in interface java.util.Collection<java.lang.Float>
  - contains
```
@Deprecated
default boolean contains(java.lang.Object key)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    contains in interface java.util.Collection<java.lang.Float>
  - remove
```
@Deprecated
default boolean remove(java.lang.Object key)
```
    Deprecated. Please use (and implement) the rem() method instead.
    
    Specified by:
    
    remove in interface java.util.Collection<java.lang.Float>
  - toFloatArray
```
float[] toFloatArray()
```
    Returns a primitive type array containing the items of this collection.
    
    Returns:
    
    a primitive type array containing the items of this collection.
    
    See Also:
    
    Collection.toArray()
  - toFloatArray
```
@Deprecated
default float[] toFloatArray(float[] a)
```
    Deprecated. Please use toArray() instead—this method is redundant and will be removed in the future.
    
    Returns a primitive type array containing the items of this collection.
    Note that, contrarily to Collection.toArray(Object[]), this methods just writes all elements of this collection: no special value will be added after the last one.
    
    Parameters:
    
    a - if this array is big enough, it will be used to store this collection.
    
    Returns:
    
    a primitive type array containing the items of this collection.
    
    See Also:
    
    Collection.toArray(Object[])
  - toArray
```
float[] toArray(float[] a)
```
    Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.
    Note that, contrarily to Collection.toArray(Object[]), this methods just writes all elements of this collection: no special value will be added after the last one.
    
    Parameters:
    
    a - if this array is big enough, it will be used to store this collection.
    
    Returns:
    
    a primitive type array containing the items of this collection.
    
    See Also:
    
    Collection.toArray(Object[])
  - addAll
```
boolean addAll(FloatCollection c)
```
    Adds all elements of the given type-specific collection to this collection.
    
    Parameters:
    
    c - a type-specific collection.
    
    Returns:
    
    true if this collection changed as a result of the call.
    
    See Also:
    
    Collection.addAll(Collection)
  - containsAll
```
boolean containsAll(FloatCollection c)
```
    Checks whether this collection contains all elements from the given type-specific collection.
    
    Parameters:
    
    c - a type-specific collection.
    
    Returns:
    
    true if this collection contains all elements of the argument.
    
    See Also:
    
    Collection.containsAll(Collection)
  - removeAll
```
boolean removeAll(FloatCollection c)
```
    Remove from this collection all elements in the given type-specific collection.
    
    Parameters:
    
    c - a type-specific collection.
    
    Returns:
    
    true if this collection changed as a result of the call.
    
    See Also:
    
    Collection.removeAll(Collection)
  - removeIf
```
@Deprecated
default boolean removeIf(java.util.function.Predicate<? super java.lang.Float> filter)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    removeIf in interface java.util.Collection<java.lang.Float>
  - removeIf
```
default boolean removeIf(FloatPredicate filter)
```
    Remove from this collection all elements which satisfy the given predicate.
    
    Parameters:
    
    filter - a predicate which returns true for elements to be removed.
    
    Returns:
    
    true if any elements were removed.
    
    See Also:
    
    Collection.removeIf(java.util.function.Predicate)
  - removeIf
```
default boolean removeIf(java.util.function.DoublePredicate filter)
```
    Remove from this collection all elements which satisfy the given predicate.
    
    Parameters:
    
    filter - a predicate which returns true for elements to be removed.
    
    Returns:
    
    true if any elements were removed.
    
    See Also:
    
    Collection.removeIf(java.util.function.Predicate)
  - retainAll
```
boolean retainAll(FloatCollection c)
```
    Retains in this collection only elements from the given type-specific collection.
    
    Parameters:
    
    c - a type-specific collection.
    
    Returns:
    
    true if this collection changed as a result of the call.
    
    See Also:
    
    Collection.retainAll(Collection)
  - stream
```
@Deprecated
default java.util.stream.Stream<java.lang.Float> stream()
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    stream in interface java.util.Collection<java.lang.Float>
  - doubleStream
```
default java.util.stream.DoubleStream doubleStream()
```
    Return a primitive stream over the elements, performing widening casts if needed.
    
    Returns:
    
    a primitive stream over the elements.
    
    See Also:
    
    Collection.stream(), IntStream
  - parallelStream
```
@Deprecated
default java.util.stream.Stream<java.lang.Float> parallelStream()
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    parallelStream in interface java.util.Collection<java.lang.Float>
  - doubleParallelStream
```
default java.util.stream.DoubleStream doubleParallelStream()
```
    Return a parallel primitive stream over the elements, performing widening casts if needed.
    
    Returns:
    
    a parallel primitive stream over the elements.
    
    See Also:
    
    Collection.parallelStream(), IntStream

Interface FloatCollection

Method Summary

Methods inherited from interface java.util.Collection

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

Method Detail

iterator

doubleIterator

spliterator

doubleSpliterator

add

contains

rem

add

contains

remove

toFloatArray

toFloatArray

toArray

addAll

containsAll

removeAll

removeIf

removeIf

removeIf

retainAll

stream

doubleStream

parallelStream

doubleParallelStream