com.carrotsearch.hppc
Class LongStack

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

@Generated(date="2011-11-28T23:36:05+0000",
           value="HPPC generated from: LongStack.java")
public class LongStack
extends LongArrayList

An extension to ObjectArrayList adding stack-related utility methods. The top of the stack is at the LongArrayList.size() - 1 element. A brief comparison of the API against the Java Collections framework:

Java Collections Stack and HPPC ObjectStack, related methods.
java.util.Stack ObjectStack
push push
pop pop, discard
peek peek
removeRange, removeElementAtremoveRange, remove, discard
size size
clear clear, release
+ other methods from ObjectArrayList


Field Summary
 
Fields inherited from class com.carrotsearch.hppc.LongArrayList
buffer, DEFAULT_CAPACITY, elementsCount, resizer
 
Constructor Summary
LongStack()
          Create with default sizing strategy and initial capacity.
LongStack(int initialCapacity)
          Create with default sizing strategy and the given initial capacity.
LongStack(int initialCapacity, ArraySizingStrategy resizer)
          Create with a custom buffer resizing strategy.
LongStack(LongContainer container)
          Create a stack by pushing all elements of another container to it.
 
Method Summary
 LongStack clone()
          Clone this object.
 void discard()
          Discard the top element from the stack.
 void discard(int count)
          Discard an arbitrary number of elements from the top of the stack.
static LongStack from(long... elements)
          Create a stack by pushing a variable number of arguments to it.
static LongStack from(LongContainer container)
          Create a stack by pushing all elements of another container to it.
static LongStack newInstance()
          Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
static LongStack newInstanceWithCapacity(int initialCapacity)
          Returns a new object of this list with no need to declare generic type (shortcut instead of using a constructor).
 long peek()
          Peek at the top element on the stack.
 long pop()
          Remove the top element from the stack and return it.
 void push(long... elements)
          Vararg-signature method for pushing elements at the top of the stack.
 void push(long e1)
          Adds one long to the stack.
 void push(long[] elements, int start, int len)
          Add a range of array elements to the stack.
 void push(long e1, long e2)
          Adds two longs to the stack.
 void push(long e1, long e2, long e3)
          Adds three longs to the stack.
 void push(long e1, long e2, long e3, long e4)
          Adds four longs to the stack.
 int pushAll(java.lang.Iterable<? extends LongCursor> iterable)
          Pushes all elements from another iterable to the top of the stack.
 int pushAll(LongContainer container)
          Pushes all elements from another container to the top of the stack.
 int removeAll(LongLookupContainer c)
          Default implementation uses a predicate for removal.
 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.
 java.lang.String toString()
          Convert the contents of this container to a human-friendly string.
 
Methods inherited from class com.carrotsearch.hppc.LongArrayList
add, add, add, add, addAll, addAll, clear, contains, ensureBufferSpace, ensureCapacity, equals, forEach, forEach, forEach, forEach, get, hashCode, indexOf, insert, isEmpty, iterator, lastIndexOf, release, remove, removeAll, removeAllOccurrences, removeFirstOccurrence, removeLastOccurrence, removeRange, resize, set, size, toArray, trimToSize
 
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
 

Constructor Detail

LongStack

public LongStack()
Create with default sizing strategy and initial capacity.

See Also:
BoundedProportionalArraySizingStrategy

LongStack

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

See Also:
BoundedProportionalArraySizingStrategy

LongStack

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


LongStack

public LongStack(LongContainer container)
Create a stack by pushing all elements of another container to it.

Method Detail

push

public final void push(long e1)
Adds one long to the stack.


push

public final void push(long e1,
                       long e2)
Adds two longs to the stack.


push

public final void push(long e1,
                       long e2,
                       long e3)
Adds three longs to the stack.


push

public final void push(long e1,
                       long e2,
                       long e3,
                       long e4)
Adds four longs to the stack.


push

public final void push(long[] elements,
                       int start,
                       int len)
Add a range of array elements to the stack.


push

public final void push(long... elements)
Vararg-signature method for pushing elements at the top of the stack.

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


pushAll

public final int pushAll(LongContainer container)
Pushes all elements from another container to the top of the stack.


pushAll

public final int pushAll(java.lang.Iterable<? extends LongCursor> iterable)
Pushes all elements from another iterable to the top of the stack.


discard

public final void discard(int count)
Discard an arbitrary number of elements from the top of the stack.


discard

public final void discard()
Discard the top element from the stack.


pop

public final long pop()
Remove the top element from the stack and return it.


peek

public final long peek()
Peek at the top element on the stack.


newInstance

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


newInstanceWithCapacity

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


from

public static LongStack from(long... elements)
Create a stack by pushing a variable number of arguments to it.


from

public static LongStack from(LongContainer container)
Create a stack by pushing all elements of another container to it.


clone

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

Overrides:
clone in class LongArrayList

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.