com.carrotsearch.hppc
Class LongArrayList

java.lang.Object
  extended by com.carrotsearch.hppc.LongArrayList
All Implemented Interfaces:
LongCollection, LongContainer, LongIndexedContainer, java.lang.Cloneable, java.lang.Iterable<LongCursor>, java.util.RandomAccess
Direct Known Subclasses:
LongStack

@Generated(date="2011-07-12T16:58:49+0200",
           value="HPPC generated from: LongArrayList.java")
public class LongArrayList
extends java.lang.Object
implements LongIndexedContainer, java.lang.Cloneable

An array-backed list of longs. A single array is used to store and manipulate all elements. Reallocations are governed by a ArraySizingStrategy and may be expensive if they move around really large chunks of memory.

See ObjectArrayList class for API similarities and differences against Java Collections.


Field Summary
 long[] buffer
          Internal array for storing the list.
static int DEFAULT_CAPACITY
          Default capacity if no other capacity is given in the constructor.
 int elementsCount
          Current number of elements stored in buffer.
protected  ArraySizingStrategy resizer
          Buffer resizing strategy.
 
Constructor Summary
LongArrayList()
          Create with default sizing strategy and initial capacity for storing 5 elements.
LongArrayList(int initialCapacity)
          Create with default sizing strategy and the given initial capacity.
LongArrayList(int initialCapacity, ArraySizingStrategy resizer)
          Create with a custom buffer resizing strategy.
LongArrayList(LongContainer container)
          Creates a new list from elements of another container.
 
Method Summary
 void add(long... elements)
          Vararg-signature method for adding elements at the end of the list.
 void add(long e1)
          Adds an element to the end of this container (the last index is incremented by one).
 void add(long[] elements, int start, int length)
          Add all elements from a range of given array to the list.
 void add(long e1, long e2)
          Appends two elements at the end of the list.
 int addAll(java.lang.Iterable<? extends LongCursor> iterable)
          Adds all elements from another iterable.
 int addAll(LongContainer container)
          Adds all elements from another container.
 void clear()
          Sets the number of stored elements to zero.
 LongArrayList clone()
          Clone this object.
 boolean contains(long 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 minCapacity)
          Increases the capacity of this instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
 boolean equals(java.lang.Object obj)
          Compares the specified object with this container for equality.
<T extends LongPredicate>
T
forEach(T predicate)
          Applies a predicate to container elements as long, as the predicate returns true.
<T extends LongProcedure>
T
forEach(T procedure)
          Applies a procedure to all container elements.
<T extends LongPredicate>
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.
<T extends LongProcedure>
T
forEach(T procedure, int fromIndex, int toIndex)
          Applies procedure to a slice of the list, fromIndex, inclusive, to toIndex, exclusive.
static LongArrayList from(long... elements)
          Create a list from a variable number of arguments or an array of long.
static LongArrayList from(LongContainer container)
          Create a list from elements of another container.
 long get(int index)
          
 int hashCode()
          
 int indexOf(long 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, long e1)
          Inserts the specified element at the specified position in this list.
 boolean isEmpty()
          Shortcut for size() == 0.
 java.util.Iterator<LongCursor> iterator()
          Returns an iterator to a cursor traversing the collection.
 int lastIndexOf(long 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.
static LongArrayList newInstance()
          Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
static LongArrayList newInstanceWithCapacity(int initialCapacity)
          Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
 void release()
          Sets the number of stored elements to zero and releases the internal storage array.
 long remove(int index)
          Removes the element at the specified position in this list and returns it.
 int removeAll(LongLookupContainer c)
          Default implementation uses a predicate for removal.
 int removeAll(LongPredicate predicate)
          Removes all elements in this collection for which the given predicate returns true.
 int removeAllOccurrences(long e1)
          Removes all occurrences of e from this collection.
 int removeFirstOccurrence(long e1)
          Removes the first element that equals e1, returning its deleted position or -1 if the element was not found.
 int removeLastOccurrence(long 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 list all of the elements whose index is between fromIndex, inclusive, and toIndex, exclusive.
 void resize(int newSize)
          Truncate or expand the list to the new size.
 int retainAll(LongLookupContainer c)
          Default implementation uses a predicate for retaining.
 int retainAll(LongPredicate predicate)
          Default implementation redirects to LongCollection.removeAll(LongPredicate) and negates the predicate.
 long set(int index, long e1)
          Replaces the element at the specified position in this list with the specified element.
 int size()
          Return the current number of elements in this container.
 long[] toArray()
          Default implementation of copying to an array.
 java.lang.String toString()
          Convert the contents of this container to a human-friendly string.
 void trimToSize()
          Trim the internal buffer to the current size.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.carrotsearch.hppc.LongCollection
removeAll, retainAll, retainAll
 

Field Detail

DEFAULT_CAPACITY

public static final int DEFAULT_CAPACITY
Default capacity if no other capacity is given in the constructor.

See Also:
Constant Field Values

buffer

public long[] 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 Detail

LongArrayList

public LongArrayList()
Create with default sizing strategy and initial capacity for storing 5 elements.

See Also:
BoundedProportionalArraySizingStrategy

LongArrayList

public LongArrayList(int initialCapacity)
Create with default sizing strategy and the given initial capacity.

See Also:
BoundedProportionalArraySizingStrategy

LongArrayList

public LongArrayList(int initialCapacity,
                     ArraySizingStrategy resizer)
Create with a custom buffer resizing strategy.


LongArrayList

public LongArrayList(LongContainer container)
Creates a new list from elements of another container.

Method Detail

add

public void add(long e1)
Adds an element to the end of this container (the last index is incremented by one).

Specified by:
add in interface LongIndexedContainer

add

public final void add(long e1,
                      long 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 final void add(long[] elements,
                      int start,
                      int length)
Add all elements from a range of given array to the list.


add

public final void add(long... 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 final int addAll(LongContainer container)
Adds all elements from another container.


addAll

public final int addAll(java.lang.Iterable<? extends LongCursor> iterable)
Adds all elements from another iterable.


insert

public final void insert(int index,
                         long e1)
Inserts the specified element at the specified position in this list.

Specified by:
insert in interface LongIndexedContainer
Parameters:
index - The index at which the element should be inserted, shifting any existing and subsequent elements to the right.

get

public final long get(int index)

Specified by:
get in interface LongIndexedContainer
Returns:
Returns the element at index index from the list.

set

public final long set(int index,
                      long e1)
Replaces the element at the specified position in this list with the specified element.

Specified by:
set in interface LongIndexedContainer
Returns:
Returns the previous value in the list.

remove

public final long remove(int index)
Removes the element at the specified position in this list and returns it.

Careful. Do not confuse this method with the overridden signature in Java Collections (List.remove(Object)). Use: LongCollection.removeAll(com.carrotsearch.hppc.LongLookupContainer), LongIndexedContainer.removeFirstOccurrence(long) or LongIndexedContainer.removeLastOccurrence(long) depending on the actual need.

Specified by:
remove in interface LongIndexedContainer

removeRange

public final void removeRange(int fromIndex,
                              int toIndex)
Removes from this list all of the elements whose index is between fromIndex, inclusive, and toIndex, exclusive.

Specified by:
removeRange in interface LongIndexedContainer

removeFirstOccurrence

public final int removeFirstOccurrence(long e1)
Removes the first element that equals e1, returning its deleted position or -1 if the element was not found.

Specified by:
removeFirstOccurrence in interface LongIndexedContainer

removeLastOccurrence

public final int removeLastOccurrence(long e1)
Removes the last element that equals e1, returning its deleted position or -1 if the element was not found.

Specified by:
removeLastOccurrence in interface LongIndexedContainer

removeAllOccurrences

public final int removeAllOccurrences(long e1)
Removes all occurrences of e from this collection.

Specified by:
removeAllOccurrences in interface LongCollection
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 final boolean contains(long 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 LongContainer
Returns:
Returns true if this container has an element equal to e.

indexOf

public final int indexOf(long 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 LongIndexedContainer

lastIndexOf

public final int lastIndexOf(long 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 LongIndexedContainer

isEmpty

public final boolean isEmpty()
Shortcut for size() == 0.

Specified by:
isEmpty in interface LongContainer

ensureCapacity

public final void ensureCapacity(int minCapacity)
Increases the capacity of this instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.


ensureBufferSpace

protected final 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 final 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 LongContainer

trimToSize

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


clear

public final 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 LongCollection

release

public final void release()
Sets the number of stored elements to zero and releases the internal storage array.


toArray

public final long[] 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 LongContainer

clone

public LongArrayList clone()
Clone this object. The returned clone will reuse the same hash function and array resizing strategy.

Overrides:
clone in class java.lang.Object

hashCode

public int hashCode()

Specified by:
hashCode in interface LongIndexedContainer
Overrides:
hashCode in class java.lang.Object
Returns:
A hash code of elements stored in the container. The hash code is defined identically to List.hashCode() (should be implemented with the same algorithm).

equals

public boolean equals(java.lang.Object obj)
Compares the specified object with this container for equality. Returns true if and only if the specified object is also a LongIndexedContainer, both have the same size, and all corresponding pairs of elements at the same index are equal. In other words, two indexed containers are defined to be equal if they contain the same elements in the same order.

Note that, unlike in List, containers may be of different types and still return true from LongIndexedContainer.equals(java.lang.Object). This may be dangerous if you use different hash functions in two containers, but don't override the default implementation of LongIndexedContainer.equals(java.lang.Object). It is the programmer's responsibility to enforcing these contracts properly.

Specified by:
equals in interface LongIndexedContainer
Overrides:
equals in class java.lang.Object

iterator

public java.util.Iterator<LongCursor> 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 (LongCursor<long> c : container) {
   System.out.println("index=" + c.index + " value=" + c.value);
 }
 

Specified by:
iterator in interface LongContainer
Specified by:
iterator in interface java.lang.Iterable<LongCursor>

forEach

public <T extends LongProcedure> T forEach(T procedure)
Applies a procedure to all container elements. Returns the argument (any subclass of LongProcedure. 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 LongContainer

forEach

public <T extends LongProcedure> 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(LongPredicate predicate)
Removes all elements in this collection for which the given predicate returns true.

Specified by:
removeAll in interface LongCollection

forEach

public <T extends LongPredicate> 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 LongContainer

forEach

public <T extends LongPredicate> 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.


newInstance

public static LongArrayList newInstance()
Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).


newInstanceWithCapacity

public static LongArrayList newInstanceWithCapacity(int initialCapacity)
Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).


from

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


from

public static LongArrayList from(LongContainer container)
Create a list from elements of another container.


removeAll

public int removeAll(LongLookupContainer c)
Default implementation uses a predicate for removal.

Specified by:
removeAll in interface LongCollection
Returns:
Returns the number of removed elements.

retainAll

public int retainAll(LongLookupContainer c)
Default implementation uses a predicate for retaining.

Specified by:
retainAll in interface LongCollection
Returns:
Returns the number of removed elements.

retainAll

public int retainAll(LongPredicate predicate)
Default implementation redirects to LongCollection.removeAll(LongPredicate) and negates the predicate.

Specified by:
retainAll in interface LongCollection

toString

public java.lang.String toString()
Convert the contents of this container to a human-friendly string.

Overrides:
toString in class java.lang.Object


Copyright © 2011 Carrot Search s.c.. All Rights Reserved.