bak.pcj.list
Class ShortArrayStack

java.lang.Object
  bak.pcj.AbstractShortCollection
      bak.pcj.list.AbstractShortList
          bak.pcj.list.ShortArrayList
              bak.pcj.list.ShortArrayStack

All Implemented Interfaces:

Cloneable, Serializable, ShortCollection, ShortList, ShortStack

public class ShortArrayStack

extends ShortArrayList

implements ShortStack

This class represents an array implemenation of stacks of short values.

Since:

1.0

See Also:

ArrayList, Serialized Form

Field Summary

Fields inherited from class bak.pcj.list.ShortArrayList

DEFAULT_CAPACITY, DEFAULT_GROWTH_CHUNK, DEFAULT_GROWTH_FACTOR

Constructor Summary

ShortArrayStack()
Creates a new array stack with capacity 10 and a relative growth factor of 1.0.

ShortArrayStack(int capacity)
Creates a new array stack with a specified capacity and a relative growth factor of 1.0.

ShortArrayStack(int capacity, double growthFactor)
Creates a new array stack with a specified capacity and relative growth factor.

ShortArrayStack(int capacity, int growthChunk)
Creates a new array stack with a specified capacity and absolute growth factor.

ShortArrayStack(short[] a)
Creates a new array stack with the same elements as a specified array.

ShortArrayStack(ShortCollection c)
Creates a new array stack with the same elements as a specified collection.

Method Summary

short	peek() Returns the top element of this stack.
short	pop() Pops an element off this stack.
void	push(short v) Pushes a specified element onto this stack.

Methods inherited from class bak.pcj.list.ShortArrayList

add, capacity, clear, clone, contains, ensureCapacity, equals, get, hashCode, indexOf, indexOf, isEmpty, lastIndexOf, remove, removeElementAt, set, size, toArray, toArray, trimToSize

Methods inherited from class bak.pcj.list.AbstractShortList

add, addAll, iterator, lastIndexOf, listIterator, listIterator

Methods inherited from class bak.pcj.AbstractShortCollection

addAll, containsAll, removeAll, retainAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface bak.pcj.list.ShortList

add, addAll, get, indexOf, indexOf, lastIndexOf, lastIndexOf, listIterator, listIterator, removeElementAt, set

Methods inherited from interface bak.pcj.ShortCollection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, trimToSize

Constructor Detail

ShortArrayStack

public ShortArrayStack()

Creates a new array stack with capacity 10 and a relative growth factor of 1.0.

See Also:

ShortArrayStack(int,double)

ShortArrayStack

public ShortArrayStack(ShortCollection c)

Creates a new array stack with the same elements as a specified collection. The elements of the specified collection are pushed in the collection's iteration order.

Parameters:

c - the collection whose elements to add to the new stack.

Throws:

NullPointerException - if c is null.

ShortArrayStack

public ShortArrayStack(short[] a)

Creates a new array stack with the same elements as a specified array. The elements of the specified array are pushed in the order of the array.

Parameters:

a - the array whose elements to add to the new stack.

Throws:

NullPointerException - if a is null.

Since:

1.1

ShortArrayStack

public ShortArrayStack(int capacity)

Creates a new array stack with a specified capacity and a relative growth factor of 1.0.

Parameters:

capacity - the initial capacity of the stack.

Throws:

IllegalArgumentException - if capacity is negative.

See Also:

ShortArrayStack(int,double)

ShortArrayStack

public ShortArrayStack(int capacity,
                       double growthFactor)

Creates a new array stack with a specified capacity and relative growth factor.

The array capacity increases to capacity()*(1+growthFactor). This strategy is good for avoiding many capacity increases, but the amount of wasted memory is approximately the size of the stack.

Parameters:

capacity - the initial capacity of the stack.

growthFactor - the relative amount with which to increase the the capacity when a capacity increase is needed.

Throws:

IllegalArgumentException - if capacity is negative; if growthFactor is negative.

ShortArrayStack

public ShortArrayStack(int capacity,
                       int growthChunk)

Creates a new array stack with a specified capacity and absolute growth factor.

The array capacity increases to capacity()+growthChunk. This strategy is good for avoiding wasting memory. However, an overhead is potentially introduced by frequent capacity increases.

Parameters:

capacity - the initial capacity of the stack.

growthChunk - the absolute amount with which to increase the the capacity when a capacity increase is needed.

Throws:

IllegalArgumentException - if capacity is negative; if growthChunk is negative.

Method Detail

push

public void push(short v)

Description copied from interface: ShortStack

Pushes a specified element onto this stack.

Specified by:

push in interface ShortStack

Parameters:

v - the element to push onto this stack.

pop

public short pop()

Description copied from interface: ShortStack

Pops an element off this stack.

Specified by:

pop in interface ShortStack

Returns:

the element that was popped off this stack.

See Also:

ShortStack.peek()

peek

public short peek()

Description copied from interface: ShortStack

Returns the top element of this stack.

Specified by:

peek in interface ShortStack

Returns:

the top element of this stack.

See Also:

ShortStack.pop()