DoubleStack (HPPC v0.7.0 API Documentation)

java.lang.Object
- com.carrotsearch.hppc.DoubleArrayList
- - com.carrotsearch.hppc.DoubleStack

All Implemented Interfaces:

DoubleCollection, DoubleContainer, DoubleIndexedContainer, Preallocable, java.lang.Cloneable, java.lang.Iterable<DoubleCursor>, java.util.RandomAccess
```
@Generated(date="2015-05-05T11:00:01+0200",
           value="KTypeStack.java")
public class DoubleStack
extends DoubleArrayList
```
A subclass of DoubleArrayList adding stack-related utility methods. The top of the stack is at the DoubleArrayList.size() - 1 element.

Field Summary
- Fields inherited from class com.carrotsearch.hppc.DoubleArrayList
  buffer, elementsCount, EMPTY_ARRAY, resizer

Constructor Summary

Constructors
Constructor and Description
`DoubleStack()` New instance with sane defaults.
`DoubleStack(DoubleContainer container)` Create a stack by pushing all elements of another container to it.
`DoubleStack(int expectedElements)` New instance with sane defaults.
`DoubleStack(int expectedElements, ArraySizingStrategy resizer)` New instance with sane defaults.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`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, equalElements, equals, forEach, forEach, forEach, forEach, get, hashCode, indexOf, insert, isEmpty, iterator, lastIndexOf, release, remove, removeAll, removeAll, removeFirst, removeLast, 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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - DoubleStack
```
public DoubleStack()
```
    New instance with sane defaults.
  - DoubleStack
```
public DoubleStack(int expectedElements)
```
    New instance with sane defaults.
    
    Parameters:
    
    expectedElements - The expected number of elements guaranteed not to cause buffer expansion (inclusive).
  - DoubleStack
```
public DoubleStack(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.
  - DoubleStack
```
public DoubleStack(DoubleContainer container)
```
    Create a stack by pushing all elements of another container to it.
- Method Detail
  - push
```
public void push(double e1)
```
    Adds one double to the stack.
  - push
```
public void push(double e1,
                 double e2)
```
    Adds two doubles to the stack.
  - push
```
public void push(double e1,
                 double e2,
                 double e3)
```
    Adds three doubles to the stack.
  - push
```
public void push(double e1,
                 double e2,
                 double e3,
                 double e4)
```
    Adds four doubles to the stack.
  - push
```
public 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 int pushAll(DoubleContainer container)
```
    Pushes all elements from another container to the top of the stack.
  - pushAll
```
public int pushAll(java.lang.Iterable<? extends DoubleCursor> 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 double pop()
```
    Remove the top element from the stack and return it.
  - peek
```
public double peek()
```
    Peek at the top element on the stack.
  - from
```
public static DoubleStack from(double... elements)
```
    Create a stack by pushing a variable number of arguments 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
    
    Returns:
    
    Returns the number of removed elements.
  - toString
```
public java.lang.String toString()
```
    Convert the contents of this container to a human-friendly string.
    
    Overrides:
    
    toString in class java.lang.Object

Class DoubleStack

Field Summary

Fields inherited from class com.carrotsearch.hppc.DoubleArrayList

Constructor Summary

Method Summary

Methods inherited from class com.carrotsearch.hppc.DoubleArrayList

Methods inherited from class java.lang.Object

Methods inherited from interface com.carrotsearch.hppc.DoubleCollection

Methods inherited from interface java.lang.Iterable

Constructor Detail

DoubleStack

DoubleStack

DoubleStack

DoubleStack

Method Detail

push

push

push

push

push

push

pushAll

pushAll

discard

discard

pop

peek

from

clone

removeAll

retainAll

retainAll

toString