Package gnu.trove

Interface TFloatCollection

All Known Subinterfaces:
TFloatList, TFloatQueue, TFloatSet
All Known Implementing Classes:
TByteFloatHashMap.TValueView, TCharFloatHashMap.TValueView, TDoubleFloatHashMap.TValueView, TFloatArrayList, TFloatByteHashMap.TKeyView, TFloatCharHashMap.TKeyView, TFloatDoubleHashMap.TKeyView, TFloatFloatHashMap.TKeyView, TFloatFloatHashMap.TValueView, TFloatHashSet, TFloatIntHashMap.TKeyView, TFloatLongHashMap.TKeyView, TFloatShortHashMap.TKeyView, TIntFloatHashMap.TValueView, TLongFloatHashMap.TValueView, TShortFloatHashMap.TValueView, TSynchronizedFloatCollection, TSynchronizedFloatList, TSynchronizedFloatSet, TSynchronizedRandomAccessFloatList, TUnmodifiableFloatCollection, TUnmodifiableFloatList, TUnmodifiableFloatSet, TUnmodifiableRandomAccessFloatList
public interface TFloatCollection
An interface that mimics the Collection interface.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final long
    serialVersionUID
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    add(float entry)
    Inserts a value into the collection.
    boolean
    addAll(float[] array)
    Adds all of the elements in the array to the collection.
    boolean
    addAll(TFloatCollection collection)
    Adds all of the elements in the TFloatCollection to the collection.
    boolean
    addAll(Collection<? extends Float> collection)
    Adds all of the elements in collection to the collection.
    void
    clear()
    Empties the collection.
    boolean
    contains(float entry)
    Returns true if this collection contains the specified element.
    boolean
    containsAll(float[] array)
    Tests the collection to determine if all of the elements in array are present.
    boolean
    containsAll(TFloatCollection collection)
    Tests the collection to determine if all of the elements in TFloatCollection are present.
    boolean
    containsAll(Collection<?> collection)
    Tests the collection to determine if all of the elements in collection are present.
    boolean
    equals(Object o)
    Compares the specified object with this collection for equality.
    boolean
    forEach(TFloatProcedure procedure)
    Executes procedure for each element in the collection.
    float
    getNoEntryValue()
    Returns the value that is used to represent null.
    int
    hashCode()
    Returns the hash code value for this collection.
    boolean
    isEmpty()
    Returns true if this collection contains no elements.
    TFloatIterator
    iterator()
    Creates an iterator over the values of the collection.
    boolean
    remove(float entry)
    Removes entry from the collection.
    boolean
    removeAll(float[] array)
    Removes all of the elements in array from the collection.
    boolean
    removeAll(TFloatCollection collection)
    Removes all of the elements in TFloatCollection from the collection.
    boolean
    removeAll(Collection<?> collection)
    Removes all of the elements in collection from the collection.
    boolean
    retainAll(float[] array)
    Removes any values in the collection which are not contained in array.
    boolean
    retainAll(TFloatCollection collection)
    Removes any values in the collection which are not contained in TFloatCollection.
    boolean
    retainAll(Collection<?> collection)
    Removes any values in the collection which are not contained in collection.
    int
    size()
    Returns the number of elements in this collection (its cardinality).
    float[]
    toArray()
    Returns an array containing all of the elements in this collection.
    float[]
    toArray(float[] dest)
    Returns an array containing elements in this collection.

  • Field Details

  • 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.
      Returns:
      the value that represents null

    • size

      int size()
      Returns the number of elements in this collection (its cardinality). If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
      Returns:
      the number of elements in this collection (its cardinality)

    • isEmpty

      boolean isEmpty()
      Returns true if this collection contains no elements.
      Returns:
      true if this collection contains no elements

    • contains

      boolean contains(float entry)
      Returns true if this collection contains the specified element.
      Parameters:
      entry - an float value
      Returns:
      true if the collection contains the specified element.

    • iterator

      TFloatIterator iterator()
      Creates an iterator over the values of the collection. The iterator supports element deletion.
      Returns:
      an TFloatIterator value

    • toArray

      float[] toArray()
      Returns an array containing all of the elements in this collection. If this collection 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 collection. (In other words, this method must allocate a new array even if this collection 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:
      an array containing all the elements in this collection

    • toArray

      float[] toArray(float[] dest)
      Returns an array containing elements in this collection.

      If this collection fits in the specified array with room to spare (i.e., the array has more elements than this collection), the element in the array immediately following the end of the collection is collection to getNoEntryValue(). (This is useful in determining the length of this collection only if the caller knows that this collection does not contain any elements representing null.)

      If the native array is smaller than the collection size, the array will be filled with elements in Iterator order until it is full and exclude the remainder.

      If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

      Parameters:
      dest - the array into which the elements of this collection are to be stored.
      Returns:
      an float[] containing all the elements in this collection
      Throws:
      NullPointerException - if the specified array is null

    • add

      boolean add(float entry)
      Inserts a value into the collection.
      Parameters:
      entry - a float value
      Returns:
      true if the collection was modified by the add operation

    • remove

      boolean remove(float entry)
      Removes entry from the collection.
      Parameters:
      entry - an float value
      Returns:
      true if the collection was modified by the remove operation.

    • containsAll

      boolean containsAll(Collection<?> collection)
      Tests the collection to determine if all of the elements in collection are present.
      Parameters:
      collection - a Collection value
      Returns:
      true if all elements were present in the collection.

    • containsAll

      boolean containsAll(TFloatCollection collection)
      Tests the collection to determine if all of the elements in TFloatCollection are present.
      Parameters:
      collection - a TFloatCollection value
      Returns:
      true if all elements were present in the collection.

    • containsAll

      boolean containsAll(float[] array)
      Tests the collection to determine if all of the elements in array are present.
      Parameters:
      array - as array of float primitives.
      Returns:
      true if all elements were present in the collection.

    • addAll

      boolean addAll(Collection<? extends Float> collection)
      Adds all of the elements in collection to the collection.
      Parameters:
      collection - a Collection value
      Returns:
      true if the collection was modified by the add all operation.

    • addAll

      boolean addAll(TFloatCollection collection)
      Adds all of the elements in the TFloatCollection to the collection.
      Parameters:
      collection - a TFloatCollection value
      Returns:
      true if the collection was modified by the add all operation.

    • addAll

      boolean addAll(float[] array)
      Adds all of the elements in the array to the collection.
      Parameters:
      array - a array of float primitives.
      Returns:
      true if the collection was modified by the add all operation.

    • retainAll

      boolean retainAll(Collection<?> collection)
      Removes any values in the collection which are not contained in collection.
      Parameters:
      collection - a Collection value
      Returns:
      true if the collection was modified by the retain all operation

    • retainAll

      boolean retainAll(TFloatCollection collection)
      Removes any values in the collection which are not contained in TFloatCollection.
      Parameters:
      collection - a TFloatCollection value
      Returns:
      true if the collection was modified by the retain all operation

    • retainAll

      boolean retainAll(float[] array)
      Removes any values in the collection which are not contained in array.
      Parameters:
      array - an array of float primitives.
      Returns:
      true if the collection was modified by the retain all operation

    • removeAll

      boolean removeAll(Collection<?> collection)
      Removes all of the elements in collection from the collection.
      Parameters:
      collection - a Collection value
      Returns:
      true if the collection was modified by the remove all operation.

    • removeAll

      boolean removeAll(TFloatCollection collection)
      Removes all of the elements in TFloatCollection from the collection.
      Parameters:
      collection - a TFloatCollection value
      Returns:
      true if the collection was modified by the remove all operation.

    • removeAll

      boolean removeAll(float[] array)
      Removes all of the elements in array from the collection.
      Parameters:
      array - an array of float primitives.
      Returns:
      true if the collection was modified by the remove all operation.

    • clear

      void clear()
      Empties the collection.

    • forEach

      boolean forEach(TFloatProcedure procedure)
      Executes procedure for each element in the collection.
      Parameters:
      procedure - a TFloatProcedure value
      Returns:
      false if the loop over the collection terminated because the procedure returned false for some value.

    • equals

      boolean equals(Object o)
      Compares the specified object with this collection for equality. Returns true if the specified object is also a collection, the two collection have the same size, and every member of the specified collection is contained in this collection (or equivalently, every member of this collection is contained in the specified collection). This definition ensures that the equals method works properly across different implementations of the collection interface.
      Overrides:
      equals in class Object
      Parameters:
      o - object to be compared for equality with this collection
      Returns:
      true if the specified object is equal to this collection

    • hashCode

      int hashCode()
      Returns the hash code value for this collection. The hash code of a collection is defined to be the sum of the hash codes of the elements in the collection. This ensures that s1.equals(s2) implies that s1.hashCode()==s2.hashCode() for any two collection s1 and s2, as required by the general contract of Object.hashCode().
      Overrides:
      hashCode in class Object
      Returns:
      the hash code value for this collection
      See Also: