com.carrotsearch.hppc

Class ShortStack

java.lang.Object

com.carrotsearch.hppc.AbstractShortCollection

com.carrotsearch.hppc.ShortArrayList

com.carrotsearch.hppc.ShortStack

All Implemented Interfaces:

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

@Generated(date="2023-04-24T17:14:50+0800",
           value="KTypeStack.java")
public class ShortStack
extends ShortArrayList

A subclass of ShortArrayList adding stack-related utility methods. The top of the stack is at the ShortArrayList.size() - 1 element.

Nested Class Summary

Nested classes/interfaces inherited from class com.carrotsearch.hppc.ShortArrayList

ShortArrayList.ValueIterator

Field Summary

Fields inherited from class com.carrotsearch.hppc.ShortArrayList

buffer, elementsCount, EMPTY_ARRAY, resizer

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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.
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.

Methods inherited from class com.carrotsearch.hppc.ShortArrayList

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 com.carrotsearch.hppc.AbstractShortCollection

removeAll, retainAll, retainAll, toString

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ShortStack

public ShortStack()

New instance with sane defaults.

ShortStack

public ShortStack(int expectedElements)

New instance with sane defaults.

Parameters:

expectedElements - The expected number of elements guaranteed not to cause buffer expansion (inclusive).

ShortStack

public ShortStack(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.

ShortStack

public ShortStack(ShortContainer container)

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

Method Detail

push

public void push(short e1)

Adds one short to the stack.

push

public void push(short e1,
                 short e2)

Adds two shorts to the stack.

push

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

Adds three shorts to the stack.

push

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

Adds four shorts to the stack.

push

public 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 int pushAll(ShortContainer container)

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

pushAll

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

Remove the top element from the stack and return it.

peek

public short peek()

Peek at the top element on the stack.

from

public static ShortStack from(short... elements)

Create a stack by pushing a variable number of arguments 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