Top Description Fields Constructors Methods
com.carrotsearch.hppc

public Class ByteStack

extends ByteArrayList
Class Inheritance
Annotations
@Generated:KTypeStack.java
date:2024-06-04T15:20:17+0200
Imports
com.carrotsearch.hppc.cursors.ByteCursor
A subclass of ByteArrayList adding stack-related utility methods. The top of the stack is at the size() - 1 element.

Field Summary

Inherited from com.carrotsearch.hppc.ByteArrayList:
bufferelementsCountEMPTY_ARRAYresizer

Constructor Summary

AccessConstructor and Description
public
ByteStack()

New instance with sane defaults.

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

New instance with sane defaults.

public
ByteStack(int
The expected number of elements guaranteed not to cause buffer expansion (inclusive).
expectedElements, ArraySizingStrategy
Underlying buffer sizing strategy.
resizer)

New instance with sane defaults.

public
ByteStack(ByteContainer container)

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

Method Summary

Modifier and TypeMethod and Description
public ByteStack
clone()

Overrides com.carrotsearch.hppc.ByteArrayList.clone.

Clone this object.

public void
discard(int count)

Discard an arbitrary number of elements from the top of the stack.

public void
discard()

Discard the top element from the stack.

public static ByteStack
from(byte... elements)

Hides com.carrotsearch.hppc.ByteArrayList.from.

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

public byte
peek()

Peek at the top element on the stack.

public byte
pop()

Remove the top element from the stack and return it.

public void
push(byte e1)

Adds one byte to the stack.

public void
push(byte e1, byte e2)

Adds two bytes to the stack.

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

Adds three bytes to the stack.

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

Adds four bytes to the stack.

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

Add a range of array elements to the stack.

public final void
push(byte... elements)

Vararg-signature method for pushing elements at the top of the stack.

public int
pushAll(ByteContainer container)

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

public int
pushAll(Iterable<? extends ByteCursor> iterable)

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

Inherited from com.carrotsearch.hppc.ByteArrayList:
addaddaddaddaddAlladdAllclearcontainsensureBufferSpaceensureCapacityequalElementsequalsforEachforEachforEachforEachgethashCodeindexOfinsertisEmptyiteratorlastIndexOframBytesAllocatedramBytesUsedreleaseremoveAllremoveAllremoveAtremoveElementremoveFirstremoveLastremoveLastremoveRangeresizereversesetsizesorttoArraytrimToSize

Constructor Detail

ByteStackback to summary
public ByteStack()

New instance with sane defaults.

ByteStackback to summary
public ByteStack(int expectedElements)

New instance with sane defaults.

Parameters
expectedElements:int

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

ByteStackback to summary
public ByteStack(int expectedElements, ArraySizingStrategy resizer)

New instance with sane defaults.

Parameters
expectedElements:int

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

resizer:ArraySizingStrategy

Underlying buffer sizing strategy.

ByteStackback to summary
public ByteStack(ByteContainer container)

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

Method Detail

cloneback to summary
public ByteStack clone()

Overrides com.carrotsearch.hppc.ByteArrayList.clone.

Doc from com.carrotsearch.hppc.ByteArrayList.clone.

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

Returns:ByteStack

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations
@Override
discardback to summary
public void discard(int count)

Discard an arbitrary number of elements from the top of the stack.

discardback to summary
public void discard()

Discard the top element from the stack.

fromback to summary
public static ByteStack from(byte... elements)

Hides com.carrotsearch.hppc.ByteArrayList.from.

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

peekback to summary
public byte peek()

Peek at the top element on the stack.

popback to summary
public byte pop()

Remove the top element from the stack and return it.

pushback to summary
public void push(byte e1)

Adds one byte to the stack.

pushback to summary
public void push(byte e1, byte e2)

Adds two bytes to the stack.

pushback to summary
public void push(byte e1, byte e2, byte e3)

Adds three bytes to the stack.

pushback to summary
public void push(byte e1, byte e2, byte e3, byte e4)

Adds four bytes to the stack.

pushback to summary
public void push(byte[] elements, int start, int len)

Add a range of array elements to the stack.

pushback to summary
public final void push(byte... 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)

pushAllback to summary
public int pushAll(ByteContainer container)

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

pushAllback to summary
public int pushAll(Iterable<? extends ByteCursor> iterable)

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