Class ShortArrayList

All Implemented Interfaces:
Preallocable, ShortCollection, ShortContainer, ShortIndexedContainer, Cloneable, Iterable<ShortCursor>, RandomAccess
Direct Known Subclasses:
ShortStack

@Generated(date="2024-02-21T10:44:44+0000", value="KTypeArrayList.java") public class ShortArrayList extends AbstractShortCollection implements ShortIndexedContainer, Preallocable, Cloneable
An array-backed list of shorts.
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    (package private) static final class 
    An iterator implementation for iterator().
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    short[]
    Internal array for storing the list.
    int
    Current number of elements stored in buffer.
    static final short[]
    An immutable empty buffer (array).
    protected final ArraySizingStrategy
    Buffer resizing strategy.
  • Constructor Summary

    Constructors
    Constructor
    Description
    New instance with sane defaults.
    ShortArrayList(int expectedElements)
    New instance with sane defaults.
    ShortArrayList(int expectedElements, ArraySizingStrategy resizer)
    New instance with sane defaults.
    Creates a new list from the elements of another container in its iteration order.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(short e1)
    Adds an element to the end of this container (the last index is incremented by one).
    final void
    add(short... elements)
    Vararg-signature method for adding elements at the end of the list.
    void
    add(short[] elements, int start, int length)
    Add all elements from a range of given array to the list.
    void
    add(short e1, short e2)
    Appends two elements at the end of the list.
    int
    Adds all elements from another container.
    int
    addAll(Iterable<? extends ShortCursor> iterable)
    Adds all elements from another iterable.
    void
    Sets the number of stored elements to zero.
    Clone this object.
    boolean
    contains(short e1)
    Lookup a given element in the container.
    protected void
    ensureBufferSpace(int expectedAdditions)
    Ensures the internal buffer has enough free slots to store expectedAdditions.
    void
    ensureCapacity(int expectedElements)
    Ensure this container can hold at least the given number of elements without resizing its buffers.
    protected boolean
    Compare index-aligned elements against another ShortIndexedContainer.
    boolean
    Returns true only if the other object is an instance of the same class and with the same elements.
    <T extends ShortProcedure>
    T
    forEach(T procedure)
    Applies a procedure to all container elements.
    <T extends ShortProcedure>
    T
    forEach(T procedure, int fromIndex, int toIndex)
    Applies procedure to a slice of the list, fromIndex, inclusive, to toIndex, exclusive.
    from(short... elements)
    Create a list from a variable number of arguments or an array of short.
    short
    get(int index)
    int
    int
    indexOf(short e1)
    Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
    void
    insert(int index, short e1)
    Inserts the specified element at the specified position in this list.
    boolean
    Shortcut for size() == 0.
    Returns an iterator to a cursor traversing the collection.
    int
    lastIndexOf(short e1)
    Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
    void
    Sets the number of stored elements to zero and releases the internal storage array.
    short
    remove(int index)
    Removes the element at the specified position in this container and returns it.
    int
    removeAll(short e1)
    Removes all occurrences of e from this collection.
    int
    Removes all elements in this collection for which the given predicate returns true.
    int
    removeFirst(short e1)
    Removes the first element that equals e1, returning its deleted position or -1 if the element was not found.
    int
    removeLast(short e1)
    Removes the last element that equals e1, returning its deleted position or -1 if the element was not found.
    void
    removeRange(int fromIndex, int toIndex)
    Removes from this container all of the elements with indexes between fromIndex, inclusive, and toIndex, exclusive.
    void
    resize(int newSize)
    Truncate or expand the list to the new size.
    short
    set(int index, short e1)
    Replaces the element at the specified position in this list with the specified element.
    int
    Return the current number of elements in this container.
    short[]
    Default implementation of copying to an array.
    void
    Trim the internal buffer to the current size.

    Methods inherited from class com.carrotsearch.hppc.AbstractShortCollection

    removeAll, retainAll, retainAll, toString

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

    Methods inherited from interface com.carrotsearch.hppc.ShortCollection

    removeAll, retainAll, retainAll
  • Field Details

    • EMPTY_ARRAY

      public static final short[] EMPTY_ARRAY
      An immutable empty buffer (array).
    • buffer

      public short[] buffer
      Internal array for storing the list. The array may be larger than the current size (size()).
    • elementsCount

      public int elementsCount
      Current number of elements stored in buffer.
    • resizer

      protected final ArraySizingStrategy resizer
      Buffer resizing strategy.
  • Constructor Details

    • ShortArrayList

      public ShortArrayList()
      New instance with sane defaults.
    • ShortArrayList

      public ShortArrayList(int expectedElements)
      New instance with sane defaults.
      Parameters:
      expectedElements - The expected number of elements guaranteed not to cause buffer expansion (inclusive).
    • ShortArrayList

      public ShortArrayList(int expectedElements, ArraySizingStrategy resizer)
      New instance with sane defaults.
      Parameters:
      expectedElements - The expected number of elements guaranteed not to cause buffer expansion (inclusive).
      resizer - Underlying buffer sizing strategy.
    • ShortArrayList

      public ShortArrayList(ShortContainer container)
      Creates a new list from the elements of another container in its iteration order.
  • Method Details

    • add

      public void add(short e1)
      Adds an element to the end of this container (the last index is incremented by one).
      Specified by:
      add in interface ShortIndexedContainer
    • add

      public void add(short e1, short e2)
      Appends two elements at the end of the list. To add more than two elements, use add (vararg-version) or access the buffer directly (tight loop).
    • add

      public void add(short[] elements, int start, int length)
      Add all elements from a range of given array to the list.
    • add

      public final void add(short... elements)
      Vararg-signature method for adding elements at the end of the list.

      This method is handy, but costly if used in tight loops (anonymous array passing)

    • addAll

      public int addAll(ShortContainer container)
      Adds all elements from another container.
    • addAll

      public int addAll(Iterable<? extends ShortCursor> iterable)
      Adds all elements from another iterable.
    • insert

      public void insert(int index, short e1)
      Inserts the specified element at the specified position in this list.
      Specified by:
      insert in interface ShortIndexedContainer
      Parameters:
      index - The index at which the element should be inserted, shifting any existing and subsequent elements to the right.
    • get

      public short get(int index)
      Specified by:
      get in interface ShortIndexedContainer
      Returns:
      Returns the element at index index from the list.
    • set

      public short set(int index, short e1)
      Replaces the element at the specified position in this list with the specified element.
      Specified by:
      set in interface ShortIndexedContainer
      Returns:
      Returns the previous value in the list.
    • remove

      public short remove(int index)
      Removes the element at the specified position in this container and returns it.
      Specified by:
      remove in interface ShortIndexedContainer
      See Also:
    • removeRange

      public void removeRange(int fromIndex, int toIndex)
      Removes from this container all of the elements with indexes between fromIndex, inclusive, and toIndex, exclusive.
      Specified by:
      removeRange in interface ShortIndexedContainer
    • removeFirst

      public int removeFirst(short e1)
      Removes the first element that equals e1, returning its deleted position or -1 if the element was not found.
      Specified by:
      removeFirst in interface ShortIndexedContainer
    • removeLast

      public int removeLast(short e1)
      Removes the last element that equals e1, returning its deleted position or -1 if the element was not found.
      Specified by:
      removeLast in interface ShortIndexedContainer
    • removeAll

      public int removeAll(short e1)
      Removes all occurrences of e from this collection.
      Specified by:
      removeAll in interface ShortCollection
      Parameters:
      e1 - Element to be removed from this collection, if present.
      Returns:
      The number of removed elements as a result of this call.
    • contains

      public boolean contains(short e1)
      Lookup a given element in the container. This operation has no speed guarantees (may be linear with respect to the size of this container).
      Specified by:
      contains in interface ShortContainer
      Returns:
      Returns true if this container has an element equal to e.
    • indexOf

      public int indexOf(short e1)
      Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
      Specified by:
      indexOf in interface ShortIndexedContainer
    • lastIndexOf

      public int lastIndexOf(short e1)
      Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
      Specified by:
      lastIndexOf in interface ShortIndexedContainer
    • isEmpty

      public boolean isEmpty()
      Shortcut for size() == 0.
      Specified by:
      isEmpty in interface ShortContainer
    • ensureCapacity

      public void ensureCapacity(int expectedElements)
      Ensure this container can hold at least the given number of elements without resizing its buffers.
      Specified by:
      ensureCapacity in interface Preallocable
      Parameters:
      expectedElements - The total number of elements, inclusive.
    • ensureBufferSpace

      protected void ensureBufferSpace(int expectedAdditions)
      Ensures the internal buffer has enough free slots to store expectedAdditions. Increases internal buffer size if needed.
    • resize

      public void resize(int newSize)
      Truncate or expand the list to the new size. If the list is truncated, the buffer will not be reallocated (use trimToSize() if you need a truncated buffer), but the truncated values will be reset to the default value (zero). If the list is expanded, the elements beyond the current size are initialized with JVM-defaults (zero or null values).
    • size

      public int size()
      Return the current number of elements in this container. The time for calculating the container's size may take O(n) time, although implementing classes should try to maintain the current size and return in constant time.
      Specified by:
      size in interface ShortContainer
    • trimToSize

      public void trimToSize()
      Trim the internal buffer to the current size.
    • clear

      public void clear()
      Sets the number of stored elements to zero. Releases and initializes the internal storage array to default values. To clear the list without cleaning the buffer, simply set the elementsCount field to zero.
      Specified by:
      clear in interface ShortCollection
      See Also:
    • release

      public void release()
      Sets the number of stored elements to zero and releases the internal storage array.
      Specified by:
      release in interface ShortCollection
      See Also:
    • toArray

      public short[] toArray()
      Default implementation of copying to an array.

      The returned array is sized to match exactly the number of elements of the stack.

      Specified by:
      toArray in interface ShortContainer
      Overrides:
      toArray in class AbstractShortCollection
    • clone

      public ShortArrayList clone()
      Clone this object. The returned clone will reuse the same hash function and array resizing strategy.
      Overrides:
      clone in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object obj)
      Returns true only if the other object is an instance of the same class and with the same elements.
      Overrides:
      equals in class Object
    • equalElements

      protected boolean equalElements(ShortArrayList other)
      Compare index-aligned elements against another ShortIndexedContainer.
    • iterator

      public Iterator<ShortCursor> iterator()
      Returns an iterator to a cursor traversing the collection. The order of traversal is not defined. More than one cursor may be active at a time. The behavior of iterators is undefined if structural changes are made to the underlying collection.

      The iterator is implemented as a cursor and it returns the same cursor instance on every call to Iterator.next() (to avoid boxing of primitive types). To read the current list's value (or index in the list) use the cursor's public fields. An example is shown below.

       for (ShortCursor<short> c : container) {
         System.out.println("index=" + c.index + " value=" + c.value);
       }
       
      Specified by:
      iterator in interface Iterable<ShortCursor>
      Specified by:
      iterator in interface ShortContainer
    • forEach

      public <T extends ShortProcedure> T forEach(T procedure)
      Applies a procedure to all container elements. Returns the argument (any subclass of ShortProcedure. This lets the caller to call methods of the argument by chaining the call (even if the argument is an anonymous type) to retrieve computed values, for example (IntContainer):
       int count = container.forEach(new IntProcedure() {
         int count; // this is a field declaration in an anonymous class.
       
         public void apply(int value) {
           count++;
         }
       }).count;
       
      Specified by:
      forEach in interface ShortContainer
    • forEach

      public <T extends ShortProcedure> T forEach(T procedure, int fromIndex, int toIndex)
      Applies procedure to a slice of the list, fromIndex, inclusive, to toIndex, exclusive.
    • removeAll

      public int removeAll(ShortPredicate predicate)
      Removes all elements in this collection for which the given predicate returns true.
      Specified by:
      removeAll in interface ShortCollection
      Returns:
      Returns the number of removed elements.
    • forEach

      public <T extends ShortPredicate> T forEach(T predicate)
      Applies a predicate to container elements as long, as the predicate returns true. The iteration is interrupted otherwise.
      Specified by:
      forEach in interface ShortContainer
    • forEach

      public <T extends ShortPredicate> T forEach(T predicate, int fromIndex, int toIndex)
      Applies predicate to a slice of the list, fromIndex, inclusive, to toIndex, exclusive, or until predicate returns false.
    • from

      public static ShortArrayList from(short... elements)
      Create a list from a variable number of arguments or an array of short. The elements are copied from the argument to the internal buffer.