gnu.trove.stack.array
Class TDoubleArrayStack

java.lang.Object
  gnu.trove.stack.array.TDoubleArrayStack

All Implemented Interfaces:

TDoubleStack, java.io.Externalizable, java.io.Serializable

public class TDoubleArrayStack
extends java.lang.Object
implements TDoubleStack, java.io.Externalizable

A stack of double primitives, backed by a TDoubleArrayList

See Also:

Serialized Form

Field Summary

protected TDoubleArrayList	_list the list used to hold the stack values.
static int	DEFAULT_CAPACITY

Constructor Summary

TDoubleArrayStack()
Creates a new TDoubleArrayStack instance with the default capacity.

TDoubleArrayStack(int capacity)
Creates a new TDoubleArrayStack instance with the specified capacity.

TDoubleArrayStack(int capacity, double no_entry_value)
Creates a new TDoubleArrayStack instance with the specified capacity.

TDoubleArrayStack(TDoubleStack stack)
Creates a new TDoubleArrayStack instance that is a copy of the instanced passed to us.

Method Summary

void	clear() Clears the stack.
boolean	equals(java.lang.Object o)
double	getNoEntryValue() Returns the value that is used to represent null.
int	hashCode()
double	peek() Returns the value at the top of the stack.
double	pop() Removes and returns the value at the top of the stack.
void	push(double val) Pushes the value onto the top of the stack.
void	readExternal(java.io.ObjectInput in)
int	size() Returns the current depth of the stack.
double[]	toArray() Copies the contents of the stack into a native array.
void	toArray(double[] dest) Copies a slice of the list into a native array.
java.lang.String	toString() Returns a String representation of the list, top to bottom.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

_list

protected TDoubleArrayList _list

the list used to hold the stack values.

DEFAULT_CAPACITY

public static final int DEFAULT_CAPACITY

See Also:

Constant Field Values

Constructor Detail

TDoubleArrayStack

public TDoubleArrayStack()

Creates a new TDoubleArrayStack instance with the default capacity.

TDoubleArrayStack

public TDoubleArrayStack(int capacity)

Creates a new TDoubleArrayStack instance with the specified capacity.

Parameters:

capacity - the initial depth of the stack

TDoubleArrayStack

public TDoubleArrayStack(int capacity,
                         double no_entry_value)

Creates a new TDoubleArrayStack instance with the specified capacity.

Parameters:

capacity - the initial depth of the stack

no_entry_value - value that represents null

TDoubleArrayStack

public TDoubleArrayStack(TDoubleStack stack)

Creates a new TDoubleArrayStack instance that is a copy of the instanced passed to us.

Parameters:

stack - the instance to copy

Method Detail

getNoEntryValue

public double getNoEntryValue()

Returns the value that is used to represent null. The default value is generally zero, but can be changed during construction of the collection.

Specified by:

getNoEntryValue in interface TDoubleStack

Returns:

the value that represents null

push

public void push(double val)

Pushes the value onto the top of the stack.

Specified by:

push in interface TDoubleStack

Parameters:

val - an double value

pop

public double pop()

Removes and returns the value at the top of the stack.

Specified by:

pop in interface TDoubleStack

Returns:

an double value

peek

public double peek()

Returns the value at the top of the stack.

Specified by:

peek in interface TDoubleStack

Returns:

an double value

size

public int size()

Returns the current depth of the stack.

Specified by:

size in interface TDoubleStack

clear

public void clear()

Clears the stack.

Specified by:

clear in interface TDoubleStack

toArray

public double[] toArray()

Copies the contents of the stack into a native array. Note that this will NOT pop them out of the stack. The front of the list will be the top of the stack.

Specified by:

toArray in interface TDoubleStack

Returns:

an double[] value

toArray

public void toArray(double[] dest)

Copies a slice of the list into a native array. Note that this will NOT pop them out of the stack. The front of the list will be the top of the stack.

If the native array is smaller than the stack depth, the native array will be filled with the elements from the top of the array until it is full and exclude the remainder.

Specified by:

toArray in interface TDoubleStack

Parameters:

dest - the array to copy into.

toString

public java.lang.String toString()

Returns a String representation of the list, top to bottom.

Overrides:

toString in class java.lang.Object

Returns:

a String value

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException