com.carrotsearch.hppc
Class DoubleStack

java.lang.Object
  extended by com.carrotsearch.hppc.DoubleArrayList
      extended by com.carrotsearch.hppc.DoubleStack
All Implemented Interfaces:
DoubleCollection, DoubleContainer, DoubleIndexedContainer, java.lang.Cloneable, java.lang.Iterable<DoubleCursor>, java.util.RandomAccess

@Generated(date="2011-07-12T16:58:49+0200",
           value="HPPC generated from: DoubleStack.java")
public class DoubleStack
extends DoubleArrayList

An extension to ObjectArrayList adding stack-related utility methods. The top of the stack is at the DoubleArrayList.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.DoubleArrayList
buffer, DEFAULT_CAPACITY, elementsCount, resizer
 
Constructor Summary
DoubleStack()
          Create with default sizing strategy and initial capacity.
DoubleStack(DoubleContainer container)
          Create a stack by pushing all elements of another container to it.
DoubleStack(int initialCapacity)
          Create with default sizing strategy and the given initial capacity.
DoubleStack(int initialCapacity, ArraySizingStrategy resizer)
          Create with a custom buffer resizing strategy.
 
Method Summary
 DoubleStack 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 DoubleStack from(double... elements)
          Create a stack by pushing a variable number of arguments to it.
static DoubleStack from(DoubleContainer container)
          Create a stack by pushing all elements of another container to it.
static DoubleStack newInstance()
          Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
static DoubleStack newInstanceWithCapacity(int initialCapacity)
          Returns a new object of this list with no need to declare generic type (shortcut instead of using a constructor).
 double peek()
          Peek at the top element on the stack.
 double pop()
          Remove the top element from the stack and return it.
 void push(double... elements)
          Vararg-signature method for pushing elements at the top of the stack.
 void push(double e1)
          Adds one double to the stack.
 void push(double[] elements, int start, int len)
          Add a range of array elements to the stack.
 void push(double e1, double e2)
          Adds two doubles to the stack.
 void push(double e1, double e2, double e3)
          Adds three doubles to the stack.
 void push(double e1, double e2, double e3, double e4)
          Adds four doubles to the stack.
 int pushAll(DoubleContainer container)
          Pushes all elements from another container to the top of the stack.
 int pushAll(java.lang.Iterable<? extends DoubleCursor> iterable)
          Pushes all elements from another iterable to the top of the stack.
 int removeAll(DoubleLookupContainer c)
          Default implementation uses a predicate for removal.
 int retainAll(DoubleLookupContainer c)
          Default implementation uses a predicate for retaining.
 int retainAll(DoublePredicate predicate)
          Default implementation redirects to DoubleCollection.removeAll(DoublePredicate) 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.DoubleArrayList
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.DoubleCollection
removeAll, retainAll, retainAll
 

Constructor Detail

DoubleStack

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

See Also:
BoundedProportionalArraySizingStrategy

DoubleStack

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

See Also:
BoundedProportionalArraySizingStrategy

DoubleStack

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


DoubleStack

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

Method Detail

push

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


push

public final void push(double e1,
                       double e2)
Adds two doubles to the stack.


push

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


push

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


push

public final void push(double[] elements,
                       int start,
                       int len)
Add a range of array elements to the stack.


push

public final void push(double... 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(DoubleContainer container)
Pushes all elements from another container to the top of the stack.


pushAll

public final int pushAll(java.lang.Iterable<? extends DoubleCursor> 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 double pop()
Remove the top element from the stack and return it.


peek

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


newInstance

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


newInstanceWithCapacity

public static DoubleStack 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 DoubleStack from(double... elements)
Create a stack by pushing a variable number of arguments to it.


from

public static DoubleStack from(DoubleContainer container)
Create a stack by pushing all elements of another container to it.


clone

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

Overrides:
clone in class DoubleArrayList

removeAll

public int removeAll(DoubleLookupContainer c)
Default implementation uses a predicate for removal.

Specified by:
removeAll in interface DoubleCollection
Returns:
Returns the number of removed elements.

retainAll

public int retainAll(DoubleLookupContainer c)
Default implementation uses a predicate for retaining.

Specified by:
retainAll in interface DoubleCollection
Returns:
Returns the number of removed elements.

retainAll

public int retainAll(DoublePredicate predicate)
Default implementation redirects to DoubleCollection.removeAll(DoublePredicate) and negates the predicate.

Specified by:
retainAll in interface DoubleCollection

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.