Module com.carrotsearch.hppc

Package com.carrotsearch.hppc

Class IntStack

java.lang.Object

com.carrotsearch.hppc.IntArrayList

com.carrotsearch.hppc.IntStack

All Implemented Interfaces:

Accountable, IntCollection, IntContainer, IntIndexedContainer, Preallocable, Cloneable, Iterable<IntCursor>, RandomAccess

@Generated(date="2024-06-04T15:20:17+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	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

Modifier and Type	Method	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 e1)	Adds one int to the stack.
final void	push(int... elements)	Vararg-signature method for pushing elements at the top of 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(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.
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, get, hashCode, indexOf, insert, isEmpty, iterator, lastIndexOf, ramBytesAllocated, ramBytesUsed, release, removeAll, removeAll, removeAt, removeElement, removeFirst, removeLast, removeLast, removeRange, resize, reverse, set, size, sort, stream, 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 Details

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 Details

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(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 String toString()

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

Overrides:

toString in class Object