Module com.carrotsearch.hppc

Package com.carrotsearch.hppc

Class FloatStack

java.lang.Object

com.carrotsearch.hppc.FloatArrayList

com.carrotsearch.hppc.FloatStack

All Implemented Interfaces:

Accountable, FloatCollection, FloatContainer, FloatIndexedContainer, Preallocable, Cloneable, Iterable<FloatCursor>, RandomAccess

@Generated(date="2024-06-04T15:20:17+0200",
           value="KTypeStack.java")
public class FloatStack
extends FloatArrayList

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

Field Summary

Fields inherited from class com.carrotsearch.hppc.FloatArrayList

buffer, elementsCount, EMPTY_ARRAY, resizer

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
FloatStack	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 FloatStack	from(float... elements)	Create a stack by pushing a variable number of arguments to it.
float	peek()	Peek at the top element on the stack.
float	pop()	Remove the top element from the stack and return it.
void	push(float e1)	Adds one float to the stack.
final void	push(float... elements)	Vararg-signature method for pushing elements at the top of the stack.
void	push(float[] elements, int start, int len)	Add a range of array elements to the stack.
void	push(float e1, float e2)	Adds two floats to the stack.
void	push(float e1, float e2, float e3)	Adds three floats to the stack.
void	push(float e1, float e2, float e3, float e4)	Adds four floats to the stack.
int	pushAll(FloatContainer container)	Pushes all elements from another container to the top of the stack.
int	pushAll(Iterable<? extends FloatCursor> iterable)	Pushes all elements from another iterable to the top of the stack.
int	removeAll(FloatLookupContainer c)	Default implementation uses a predicate for removal.
int	retainAll(FloatLookupContainer c)	Default implementation uses a predicate for retaining.
int	retainAll(FloatPredicate predicate)	Default implementation redirects to FloatCollection.removeAll(FloatPredicate) and negates the predicate.
String	toString()	Convert the contents of this container to a human-friendly string.

Methods inherited from class com.carrotsearch.hppc.FloatArrayList

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, toArray, trimToSize

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.carrotsearch.hppc.FloatCollection

removeAll, retainAll, retainAll

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

FloatStack

public FloatStack()

New instance with sane defaults.

FloatStack

public FloatStack(int expectedElements)

New instance with sane defaults.

Parameters:

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

FloatStack

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

FloatStack

public FloatStack(FloatContainer container)

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

Method Details

push

public void push(float e1)

Adds one float to the stack.

push

public void push(float e1,
 float e2)

Adds two floats to the stack.

push

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

Adds three floats to the stack.

push

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

Adds four floats to the stack.

push

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

Add a range of array elements to the stack.

push

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

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

pushAll

public int pushAll(Iterable<? extends FloatCursor> 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 float pop()

Remove the top element from the stack and return it.

peek

public float peek()

Peek at the top element on the stack.

from

public static FloatStack from(float... elements)

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

clone

public FloatStack clone()

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

Overrides:

clone in class FloatArrayList

removeAll

public int removeAll(FloatLookupContainer c)

Default implementation uses a predicate for removal.

Specified by:

removeAll in interface FloatCollection

Returns:

Returns the number of removed elements.

retainAll

public int retainAll(FloatLookupContainer c)

Default implementation uses a predicate for retaining.

Specified by:

retainAll in interface FloatCollection

Returns:

Returns the number of removed elements.

retainAll

public int retainAll(FloatPredicate predicate)

Default implementation redirects to FloatCollection.removeAll(FloatPredicate) and negates the predicate.

Specified by:

retainAll in interface FloatCollection

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