AbstractFloatCollection (fastutil 8.1.0)

java.lang.Object
- java.util.AbstractCollection<Float>
- - it.unimi.dsi.fastutil.floats.AbstractFloatCollection

All Implemented Interfaces:

FloatCollection, FloatIterable, Iterable<Float>, Collection<Float>

Direct Known Subclasses:

AbstractFloatBigList, AbstractFloatList, AbstractFloatSet, FloatCollections.EmptyCollection, FloatCollections.IterableCollection
```
public abstract class AbstractFloatCollection
extends AbstractCollection<Float>
implements FloatCollection
```
An abstract class providing basic methods for collections implementing a type-specific interface.
In particular, this class provide iterator(), add(), remove(Object) and contains(Object) methods that just call the type-specific counterpart.
Warning: Because of a name clash between the list and collection interfaces the type-specific deletion method of a type-specific abstract collection is rem(), rather then remove(). A subclass must thus override rem(), rather than remove(), to make all inherited methods work properly.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`add(float k)` Ensures that this collection contains the specified element (optional operation).
`boolean`	`add(Float o)` 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 k)` Returns `true` if this collection contains the specified element.
`boolean`	`contains(Object o)` 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.
`abstract FloatIterator`	`iterator()` Returns an iterator over the elements contained in this collection.
`boolean`	`rem(float k)` Removes a single instance of the specified element from this collection, if it is present (optional operation).
`boolean`	`remove(Object o)` 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.
`boolean`	`retainAll(FloatCollection c)` Retains in this collection only elements from the given type-specific collection.
`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.
`float[]`	`toFloatArray(float[] a)` Deprecated. Please use `toArray()` instead—this method is redundant and will be removed in the future.
`String`	`toString()` Returns a string representation of this collection.

Methods inherited from class java.util.AbstractCollection
addAll, clear, containsAll, isEmpty, removeAll, retainAll, size, toArray, toArray

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

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

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

- Method Detail
  - iterator
```
public abstract FloatIterator iterator()
```
    Description copied from class: java.util.AbstractCollection
    
    Returns an iterator over the elements contained in this collection.
    
    Specified by:
    
    iterator in interface FloatCollection
    
    Specified by:
    
    iterator in interface FloatIterable
    
    Specified by:
    
    iterator in interface Iterable<Float>
    
    Specified by:
    
    iterator in interface Collection<Float>
    
    Specified by:
    
    iterator in class AbstractCollection<Float>
    
    Returns:
    
    an iterator over the elements contained in this collection
    
    See Also:
    
    Iterable.iterator()
  - add
```
public boolean add(float k)
```
    Ensures that this collection contains the specified element (optional operation).
    This implementation always throws an UnsupportedOperationException.
    
    Specified by:
    
    add in interface FloatCollection
    
    See Also:
    
    Collection.add(Object)
  - contains
```
public boolean contains(float k)
```
    Returns true if this collection contains the specified element.
    This implementation iterates over the elements in the collection, looking for the specified element.
    
    Specified by:
    
    contains in interface FloatCollection
    
    See Also:
    
    Collection.contains(Object)
  - rem
```
public boolean rem(float k)
```
    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().
    This implementation iterates over the elements in the collection, looking for the specified element and tries to remove it.
    
    Specified by:
    
    rem in interface FloatCollection
    
    See Also:
    
    Collection.remove(Object)
  - add
```
@Deprecated
public boolean add(Float o)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Ensures that this collection contains the specified element (optional operation). Returns true if this collection changed as a result of the call. (Returns false if this collection does not permit duplicates and already contains the specified element.)
    Collections that support this operation may place limitations on what elements may be added to this collection. In particular, some collections will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.
    If a collection refuses to add a particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning false). This preserves the invariant that a collection always contains the specified element after this call returns.
    This implementation always throws an UnsupportedOperationException.
    This implementation delegates to the corresponding type-specific method.
    
    Specified by:
    
    add in interface FloatCollection
    
    Specified by:
    
    add in interface Collection<Float>
    
    Overrides:
    
    add in class AbstractCollection<Float>
    
    Parameters:
    
    o - element whose presence in this collection is to be ensured
    
    Returns:
    
    true if this collection changed as a result of the call
  - contains
```
@Deprecated
public boolean contains(Object o)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that (o==null ? e==null : o.equals(e)).
    This implementation iterates over the elements in the collection, checking each element in turn for equality with the specified element.
    This implementation delegates to the corresponding type-specific method.
    
    Specified by:
    
    contains in interface FloatCollection
    
    Specified by:
    
    contains in interface Collection<Float>
    
    Overrides:
    
    contains in class AbstractCollection<Float>
    
    Parameters:
    
    o - element whose presence in this collection is to be tested
    
    Returns:
    
    true if this collection contains the specified element
  - remove
```
@Deprecated
public boolean remove(Object o)
```
    Deprecated. Please use (and implement) the rem() method instead.
    
    Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).
    This implementation iterates over the collection looking for the specified element. If it finds the element, it removes the element from the collection using the iterator's remove method.
    Note that this implementation throws an UnsupportedOperationException if the iterator returned by this collection's iterator method does not implement the remove method and this collection contains the specified object.
    This implementation delegates to the rem() method.
    
    Specified by:
    
    remove in interface FloatCollection
    
    Specified by:
    
    remove in interface Collection<Float>
    
    Overrides:
    
    remove in class AbstractCollection<Float>
    
    Parameters:
    
    o - element to be removed from this collection, if present
    
    Returns:
    
    true if an element was removed as a result of this call
  - toArray
```
public float[] toArray(float[] a)
```
    Description copied from interface: FloatCollection
    
    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.
    
    Specified by:
    
    toArray in interface FloatCollection
    
    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[])
  - toFloatArray
```
public float[] toFloatArray()
```
    Description copied from interface: FloatCollection
    
    Returns a primitive type array containing the items of this collection.
    
    Specified by:
    
    toFloatArray in interface FloatCollection
    
    Returns:
    
    a primitive type array containing the items of this collection.
    
    See Also:
    
    Collection.toArray()
  - toFloatArray
```
@Deprecated
public 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.
    
    Specified by:
    
    toFloatArray in interface FloatCollection
    
    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
```
public boolean addAll(FloatCollection c)
```
    Description copied from interface: FloatCollection
    
    Adds all elements of the given type-specific collection to this collection.
    
    Specified by:
    
    addAll in interface FloatCollection
    
    Parameters:
    
    c - a type-specific collection.
    
    Returns:
    
    true if this collection changed as a result of the call.
    
    See Also:
    
    Collection.addAll(Collection)
  - containsAll
```
public boolean containsAll(FloatCollection c)
```
    Description copied from interface: FloatCollection
    
    Checks whether this collection contains all elements from the given type-specific collection.
    
    Specified by:
    
    containsAll in interface FloatCollection
    
    Parameters:
    
    c - a type-specific collection.
    
    Returns:
    
    true if this collection contains all elements of the argument.
    
    See Also:
    
    Collection.containsAll(Collection)
  - removeAll
```
public boolean removeAll(FloatCollection c)
```
    Description copied from interface: FloatCollection
    
    Remove from this collection all elements in the given type-specific collection.
    
    Specified by:
    
    removeAll in interface FloatCollection
    
    Parameters:
    
    c - a type-specific collection.
    
    Returns:
    
    true if this collection changed as a result of the call.
    
    See Also:
    
    Collection.removeAll(Collection)
  - retainAll
```
public boolean retainAll(FloatCollection c)
```
    Description copied from interface: FloatCollection
    
    Retains in this collection only elements from the given type-specific collection.
    
    Specified by:
    
    retainAll in interface FloatCollection
    
    Parameters:
    
    c - a type-specific collection.
    
    Returns:
    
    true if this collection changed as a result of the call.
    
    See Also:
    
    Collection.retainAll(Collection)
  - toString
```
public String toString()
```
    Description copied from class: java.util.AbstractCollection
    
    Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space). Elements are converted to strings as by String.valueOf(Object).
    
    Overrides:
    
    toString in class AbstractCollection<Float>
    
    Returns:
    
    a string representation of this collection

Class AbstractFloatCollection

Method Summary

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

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

Method Detail

iterator

add

contains

rem

add

contains

remove

toArray

toFloatArray

toFloatArray

addAll

containsAll

removeAll

retainAll

toString