LongStack (HPPC v0.7.2 API Documentation)

java.lang.Object
- com.carrotsearch.hppc.LongArrayList
- - com.carrotsearch.hppc.LongStack

All Implemented Interfaces:

LongCollection, LongContainer, LongIndexedContainer, Preallocable, java.lang.Cloneable, java.lang.Iterable<LongCursor>, java.util.RandomAccess
```
@Generated(date="2016-10-25T13:31:56+0200",
           value="KTypeStack.java")
public class LongStack
extends LongArrayList
```
A subclass of LongArrayList adding stack-related utility methods. The top of the stack is at the LongArrayList.size() - 1 element.

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

Constructor Summary

Constructors
Constructor and Description
`LongStack()` New instance with sane defaults.
`LongStack(int expectedElements)` New instance with sane defaults.
`LongStack(int expectedElements, ArraySizingStrategy resizer)` New instance with sane defaults.
`LongStack(LongContainer 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
`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.
`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, 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.LongCollection
removeAll, retainAll, retainAll

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

- Constructor Detail
  - LongStack
```
public LongStack()
```
    New instance with sane defaults.
  - LongStack
```
public LongStack(int expectedElements)
```
    New instance with sane defaults.
    
    Parameters:
    
    expectedElements - The expected number of elements guaranteed not to cause buffer expansion (inclusive).
  - LongStack
```
public LongStack(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.
  - LongStack
```
public LongStack(LongContainer container)
```
    Create a stack by pushing all elements of another container to it.
- Method Detail
  - push
```
public void push(long e1)
```
    Adds one long to the stack.
  - push
```
public void push(long e1,
                 long e2)
```
    Adds two longs to the stack.
  - push
```
public void push(long e1,
                 long e2,
                 long e3)
```
    Adds three longs to the stack.
  - push
```
public void push(long e1,
                 long e2,
                 long e3,
                 long e4)
```
    Adds four longs to the stack.
  - push
```
public 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 int pushAll(LongContainer container)
```
    Pushes all elements from another container to the top of the stack.
  - pushAll
```
public int pushAll(java.lang.Iterable<? extends LongCursor> 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 long pop()
```
    Remove the top element from the stack and return it.
  - peek
```
public long peek()
```
    Peek at the top element on the stack.
  - from
```
public static LongStack from(long... elements)
```
    Create a stack by pushing a variable number of arguments 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
    
    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 LongStack

Field Summary

Fields inherited from class com.carrotsearch.hppc.LongArrayList

Constructor Summary

Method Summary

Methods inherited from class com.carrotsearch.hppc.LongArrayList

Methods inherited from class java.lang.Object

Methods inherited from interface com.carrotsearch.hppc.LongCollection

Methods inherited from interface java.lang.Iterable

Constructor Detail

LongStack

LongStack

LongStack

LongStack

Method Detail

push

push

push

push

push

push

pushAll

pushAll

discard

discard

pop

peek

from

clone

removeAll

retainAll

retainAll

toString