com.carrotsearch.hppc
Class ShortStack

java.lang.Object
  com.carrotsearch.hppc.ShortArrayList
      com.carrotsearch.hppc.ShortStack

All Implemented Interfaces:

ShortCollection, ShortContainer, ShortIndexedContainer, java.lang.Cloneable, java.lang.Iterable<ShortCursor>, java.util.RandomAccess

@Generated(date="2011-07-12T16:58:49+0200",
           value="HPPC generated from: ShortStack.java")
public class ShortStack
extends ShortArrayList

An extension to ObjectArrayList adding stack-related utility methods. The top of the stack is at the ShortArrayList.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, removeElementAt	removeRange, remove, discard
size	size
clear	clear, release
	+ other methods from ObjectArrayList

Field Summary

Fields inherited from class com.carrotsearch.hppc.ShortArrayList

buffer, DEFAULT_CAPACITY, elementsCount, resizer

Constructor Summary

ShortStack()
Create with default sizing strategy and initial capacity.

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

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

ShortStack(ShortContainer container)
Create a stack by pushing all elements of another container to it.

Method Summary

ShortStack	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 ShortStack	from(short... elements) Create a stack by pushing a variable number of arguments to it.
static ShortStack	from(ShortContainer container) Create a stack by pushing all elements of another container to it.
static ShortStack	newInstance() Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
static ShortStack	newInstanceWithCapacity(int initialCapacity) Returns a new object of this list with no need to declare generic type (shortcut instead of using a constructor).
short	peek() Peek at the top element on the stack.
short	pop() Remove the top element from the stack and return it.
void	push(short... elements) Vararg-signature method for pushing elements at the top of the stack.
void	push(short e1) Adds one short to the stack.
void	push(short[] elements, int start, int len) Add a range of array elements to the stack.
void	push(short e1, short e2) Adds two shorts to the stack.
void	push(short e1, short e2, short e3) Adds three shorts to the stack.
void	push(short e1, short e2, short e3, short e4) Adds four shorts to the stack.
int	pushAll(java.lang.Iterable<? extends ShortCursor> iterable) Pushes all elements from another iterable to the top of the stack.
int	pushAll(ShortContainer container) Pushes all elements from another container to the top of the stack.
int	removeAll(ShortLookupContainer c) Default implementation uses a predicate for removal.
int	retainAll(ShortLookupContainer c) Default implementation uses a predicate for retaining.
int	retainAll(ShortPredicate predicate) Default implementation redirects to ShortCollection.removeAll(ShortPredicate) 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.ShortArrayList

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.ShortCollection

removeAll, retainAll, retainAll

Constructor Detail

ShortStack

public ShortStack()

Create with default sizing strategy and initial capacity.

See Also:

BoundedProportionalArraySizingStrategy

ShortStack

public ShortStack(int initialCapacity)

Create with default sizing strategy and the given initial capacity.

See Also:

BoundedProportionalArraySizingStrategy

ShortStack

public ShortStack(int initialCapacity,
                  ArraySizingStrategy resizer)

Create with a custom buffer resizing strategy.

ShortStack

public ShortStack(ShortContainer container)

Create a stack by pushing all elements of another container to it.

Method Detail

push

public final void push(short e1)

Adds one short to the stack.

push

public final void push(short e1,
                       short e2)

Adds two shorts to the stack.

push

public final void push(short e1,
                       short e2,
                       short e3)

Adds three shorts to the stack.

push

public final void push(short e1,
                       short e2,
                       short e3,
                       short e4)

Adds four shorts to the stack.

push

public final void push(short[] elements,
                       int start,
                       int len)

Add a range of array elements to the stack.

push

public final void push(short... 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(ShortContainer container)

Pushes all elements from another container to the top of the stack.

pushAll

public final int pushAll(java.lang.Iterable<? extends ShortCursor> 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 short pop()

Remove the top element from the stack and return it.

peek

public final short peek()

Peek at the top element on the stack.

newInstance

public static ShortStack newInstance()

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

newInstanceWithCapacity

public static ShortStack 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 ShortStack from(short... elements)

Create a stack by pushing a variable number of arguments to it.

from

public static ShortStack from(ShortContainer container)

Create a stack by pushing all elements of another container to it.

clone

public ShortStack clone()

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

Overrides:

clone in class ShortArrayList

removeAll

public int removeAll(ShortLookupContainer c)

Default implementation uses a predicate for removal.

Specified by:

removeAll in interface ShortCollection

Returns:

Returns the number of removed elements.

retainAll

public int retainAll(ShortLookupContainer c)

Default implementation uses a predicate for retaining.

Specified by:

retainAll in interface ShortCollection

Returns:

Returns the number of removed elements.

retainAll

public int retainAll(ShortPredicate predicate)

Default implementation redirects to ShortCollection.removeAll(ShortPredicate) and negates the predicate.

Specified by:

retainAll in interface ShortCollection

toString

public java.lang.String toString()

Convert the contents of this container to a human-friendly string.

Overrides:

toString in class java.lang.Object