com.carrotsearch.hppc
Class IntStack

java.lang.Object
  extended by com.carrotsearch.hppc.IntArrayList
      extended by com.carrotsearch.hppc.IntStack
All Implemented Interfaces:
IntCollection, IntContainer, IntIndexedContainer, java.lang.Cloneable, java.lang.Iterable<IntCursor>, java.util.RandomAccess

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

An extension to ObjectArrayList adding stack-related utility methods. The top of the stack is at the IntArrayList.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.IntArrayList
buffer, DEFAULT_CAPACITY, elementsCount, resizer
 
Constructor Summary
IntStack()
          Create with default sizing strategy and initial capacity.
IntStack(int initialCapacity)
          Create with default sizing strategy and the given initial capacity.
IntStack(int initialCapacity, ArraySizingStrategy resizer)
          Create with a custom buffer resizing strategy.
IntStack(IntContainer container)
          Create a stack by pushing all elements of another container to it.
 
Method Summary
 IntStack 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 IntStack from(int... elements)
          Create a stack by pushing a variable number of arguments to it.
static IntStack from(IntContainer container)
          Create a stack by pushing all elements of another container to it.
static IntStack newInstance()
          Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
static IntStack newInstanceWithCapacity(int initialCapacity)
          Returns a new object of this list with no need to declare generic type (shortcut instead of using a constructor).
 int peek()
          Peek at the top element on the stack.
 int pop()
          Remove the top element from the stack and return it.
 void push(int... elements)
          Vararg-signature method for pushing elements at the top of the stack.
 void push(int e1)
          Adds one int to the stack.
 void push(int[] elements, int start, int len)
          Add a range of array elements to the stack.
 void push(int e1, int e2)
          Adds two ints to the stack.
 void push(int e1, int e2, int e3)
          Adds three ints to the stack.
 void push(int e1, int e2, int e3, int e4)
          Adds four ints to the stack.
 int pushAll(IntContainer container)
          Pushes all elements from another container to the top of the stack.
 int pushAll(java.lang.Iterable<? extends IntCursor> iterable)
          Pushes all elements from another iterable to the top of the stack.
 int removeAll(IntLookupContainer c)
          Default implementation uses a predicate for removal.
 int retainAll(IntLookupContainer c)
          Default implementation uses a predicate for retaining.
 int retainAll(IntPredicate predicate)
          Default implementation redirects to IntCollection.removeAll(IntPredicate) 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.IntArrayList
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.IntCollection
removeAll, retainAll, retainAll
 

Constructor Detail

IntStack

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

See Also:
BoundedProportionalArraySizingStrategy

IntStack

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

See Also:
BoundedProportionalArraySizingStrategy

IntStack

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


IntStack

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

Method Detail

push

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


push

public final void push(int e1,
                       int e2)
Adds two ints to the stack.


push

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


push

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


push

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


push

public final void push(int... 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(IntContainer container)
Pushes all elements from another container to the top of the stack.


pushAll

public final int pushAll(java.lang.Iterable<? extends IntCursor> 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 int pop()
Remove the top element from the stack and return it.


peek

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


newInstance

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


newInstanceWithCapacity

public static IntStack 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 IntStack from(int... elements)
Create a stack by pushing a variable number of arguments to it.


from

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


clone

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

Overrides:
clone in class IntArrayList

removeAll

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

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

retainAll

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

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

retainAll

public int retainAll(IntPredicate predicate)
Default implementation redirects to IntCollection.removeAll(IntPredicate) and negates the predicate.

Specified by:
retainAll in interface IntCollection

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.