com.carrotsearch.hppc
Class FloatStack

java.lang.Object
  extended by com.carrotsearch.hppc.FloatArrayList
      extended by com.carrotsearch.hppc.FloatStack
All Implemented Interfaces:
FloatCollection, FloatContainer, FloatIndexedContainer, java.lang.Cloneable, java.lang.Iterable<FloatCursor>, java.util.RandomAccess

@Generated(date="2011-11-28T23:36:05+0000",
           value="HPPC generated from: FloatStack.java")
public class FloatStack
extends FloatArrayList

An extension to ObjectArrayList adding stack-related utility methods. The top of the stack is at the FloatArrayList.size() - 1 element. A brief comparison of the API against the Java Collections framework:

Java Collections Stack and HPPC ObjectStack, related methods.
java.util.Stack ObjectStack
push push
pop pop, discard
peek peek
removeRange, removeElementAtremoveRange, remove, discard
size size
clear clear, release
+ other methods from ObjectArrayList


Field Summary
 
Fields inherited from class com.carrotsearch.hppc.FloatArrayList
buffer, DEFAULT_CAPACITY, elementsCount, resizer
 
Constructor Summary
FloatStack()
          Create with default sizing strategy and initial capacity.
FloatStack(FloatContainer container)
          Create a stack by pushing all elements of another container to it.
FloatStack(int initialCapacity)
          Create with default sizing strategy and the given initial capacity.
FloatStack(int initialCapacity, ArraySizingStrategy resizer)
          Create with a custom buffer resizing strategy.
 
Method Summary
 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.
static FloatStack from(FloatContainer container)
          Create a stack by pushing all elements of another container to it.
static FloatStack newInstance()
          Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
static FloatStack newInstanceWithCapacity(int initialCapacity)
          Returns a new object of this list with no need to declare generic type (shortcut instead of using a constructor).
 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... elements)
          Vararg-signature method for pushing elements at the top of the stack.
 void push(float e1)
          Adds one float to 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(java.lang.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.
 java.lang.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, equals, forEach, forEach, forEach, forEach, get, hashCode, indexOf, insert, isEmpty, iterator, lastIndexOf, release, remove, removeAll, removeAllOccurrences, removeFirstOccurrence, removeLastOccurrence, removeRange, resize, set, size, 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
 

Constructor Detail

FloatStack

public FloatStack()
Create with default sizing strategy and initial capacity.

See Also:
BoundedProportionalArraySizingStrategy

FloatStack

public FloatStack(int initialCapacity)
Create with default sizing strategy and the given initial capacity.

See Also:
BoundedProportionalArraySizingStrategy

FloatStack

public FloatStack(int initialCapacity,
                  ArraySizingStrategy resizer)
Create with a custom buffer resizing strategy.


FloatStack

public FloatStack(FloatContainer container)
Create a stack by pushing all elements of another container to it.

Method Detail

push

public final void push(float e1)
Adds one float to the stack.


push

public final void push(float e1,
                       float e2)
Adds two floats to the stack.


push

public final void push(float e1,
                       float e2,
                       float e3)
Adds three floats to the stack.


push

public final void push(float e1,
                       float e2,
                       float e3,
                       float e4)
Adds four floats to the stack.


push

public final 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 final int pushAll(FloatContainer container)
Pushes all elements from another container to the top of the stack.


pushAll

public final int pushAll(java.lang.Iterable<? extends FloatCursor> iterable)
Pushes all elements from another iterable to the top of the stack.


discard

public final void discard(int count)
Discard an arbitrary number of elements from the top of the stack.


discard

public final void discard()
Discard the top element from the stack.


pop

public final float pop()
Remove the top element from the stack and return it.


peek

public final float peek()
Peek at the top element on the stack.


newInstance

public static FloatStack newInstance()
Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).


newInstanceWithCapacity

public static FloatStack newInstanceWithCapacity(int initialCapacity)
Returns a new object of this list with no need to declare generic type (shortcut instead of using a constructor).


from

public static FloatStack from(float... elements)
Create a stack by pushing a variable number of arguments to it.


from

public static FloatStack from(FloatContainer container)
Create a stack by pushing all elements of another container 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

toString

public java.lang.String toString()
Convert the contents of this container to a human-friendly string.

Overrides:
toString in class java.lang.Object


Copyright © 2011 Carrot Search s.c.. All Rights Reserved.