Module com.carrotsearch.hppc

Package com.carrotsearch.hppc

Class LongStack

java.lang.Object

com.carrotsearch.hppc.LongArrayList

com.carrotsearch.hppc.LongStack

All Implemented Interfaces:

Accountable, LongCollection, LongContainer, LongIndexedContainer, Preallocable, Cloneable, Iterable<LongCursor>, RandomAccess

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

Modifier and Type	Method	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 e1)	Adds one long to the stack.
final void	push(long... elements)	Vararg-signature method for pushing elements at the top of 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(LongContainer container)	Pushes all elements from another container to the top of the stack.
int	pushAll(Iterable<? extends LongCursor> iterable)	Pushes all elements from another iterable 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.
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, 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 java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.carrotsearch.hppc.LongCollection

removeAll, retainAll, retainAll

Constructor Details

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 Details

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

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

Overrides:

toString in class Object