IntStack (HPPC v0.7.0 API Documentation)

java.lang.Object
- com.carrotsearch.hppc.IntArrayList
- - com.carrotsearch.hppc.IntStack

All Implemented Interfaces:

IntCollection, IntContainer, IntIndexedContainer, Preallocable, java.lang.Cloneable, java.lang.Iterable<IntCursor>, java.util.RandomAccess
```
@Generated(date="2015-05-05T11:00:01+0200",
           value="KTypeStack.java")
public class IntStack
extends IntArrayList
```
A subclass of IntArrayList adding stack-related utility methods. The top of the stack is at the IntArrayList.size() - 1 element.

Field Summary
- Fields inherited from class com.carrotsearch.hppc.IntArrayList
  buffer, elementsCount, EMPTY_ARRAY, resizer

Constructor Summary

Constructors
Constructor and Description
`IntStack()` New instance with sane defaults.
`IntStack(int expectedElements)` New instance with sane defaults.
`IntStack(int expectedElements, ArraySizingStrategy resizer)` New instance with sane defaults.
`IntStack(IntContainer container)` Create a stack by pushing all elements of another container to it.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`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, equalElements, equals, forEach, forEach, forEach, forEach, get, hashCode, indexOf, insert, isEmpty, iterator, lastIndexOf, release, remove, removeAll, removeAll, removeFirst, removeLast, 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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - IntStack
```
public IntStack()
```
    New instance with sane defaults.
  - IntStack
```
public IntStack(int expectedElements)
```
    New instance with sane defaults.
    
    Parameters:
    
    expectedElements - The expected number of elements guaranteed not to cause buffer expansion (inclusive).
  - IntStack
```
public IntStack(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.
  - IntStack
```
public IntStack(IntContainer container)
```
    Create a stack by pushing all elements of another container to it.
- Method Detail
  - push
```
public void push(int e1)
```
    Adds one int to the stack.
  - push
```
public void push(int e1,
                 int e2)
```
    Adds two ints to the stack.
  - push
```
public void push(int e1,
                 int e2,
                 int e3)
```
    Adds three ints to the stack.
  - push
```
public void push(int e1,
                 int e2,
                 int e3,
                 int e4)
```
    Adds four ints to the stack.
  - push
```
public 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 int pushAll(IntContainer container)
```
    Pushes all elements from another container to the top of the stack.
  - pushAll
```
public int pushAll(java.lang.Iterable<? extends IntCursor> iterable)
```
    Pushes all elements from another iterable to the top of the stack.
  - discard
```
public void discard(int count)
```
    Discard an arbitrary number of elements from the top of the stack.
  - discard
```
public void discard()
```
    Discard the top element from the stack.
  - pop
```
public int pop()
```
    Remove the top element from the stack and return it.
  - peek
```
public int peek()
```
    Peek at the top element on the stack.
  - from
```
public static IntStack from(int... elements)
```
    Create a stack by pushing a variable number of arguments 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
    
    Returns:
    
    Returns the number of removed elements.
  - toString
```
public java.lang.String toString()
```
    Convert the contents of this container to a human-friendly string.
    
    Overrides:
    
    toString in class java.lang.Object

Class IntStack

Field Summary

Fields inherited from class com.carrotsearch.hppc.IntArrayList

Constructor Summary

Method Summary

Methods inherited from class com.carrotsearch.hppc.IntArrayList

Methods inherited from class java.lang.Object

Methods inherited from interface com.carrotsearch.hppc.IntCollection

Methods inherited from interface java.lang.Iterable

Constructor Detail

IntStack

IntStack

IntStack

IntStack

Method Detail

push

push

push

push

push

push

pushAll

pushAll

discard

discard

pop

peek

from

clone

removeAll

retainAll

retainAll

toString