hlt.language.util

Class IntStack

java.lang.Object

hlt.language.util.IntArrayList

hlt.language.util.IntStack

public class IntStack
extends IntArrayList

This class implements a stack of ints (as opposed to Integers). It uses the same API as java.util.Stack except that the primitive type int is used instead of Object.

Version:

Last modified on Tue Jun 19 17:37:40 2012 by hak

Author:

Hassan Aït-Kaci

Copyright:

© Hassan Aït-Kaci

Constructor Summary

Constructors

Constructor and Description
IntStack() Constructs a new empty IntStack.
IntStack(int initialCapacity) Constructs an empty stack with the specified initial capacity and with its capacity increment equal to zero.
IntStack(int initialCapacity, int capacityIncrement) Constructs an empty stack with the specified initial capacity and capacity increment.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	empty() Tests if this stack is empty.
int	peek() Looks at the object at the top of this stack without removing it from the stack.
int	peek(int n) Peeks at n positions from the top of the stack.
int	pop() Removes the integer at the top of this stack and returns it.
int	push(int item) Pushes an item onto the top of this stack.
int	replace(int n, int e) Replaces the element at n positions from the top of the stack with a new one; returns the old element.
int	search(int n) Returns the 1-based position wherethe specified int is on this stack.
java.lang.String	toString() Returns a string representation of this Stack.

Methods inherited from class hlt.language.util.IntArrayList

add, add, addAll, addAll, addAll, addAll, addElement, capacity, clear, clear, clone, contains, containsAll, containsAll, copyInto, elementAt, ensureCapacity, equals, firstElement, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, lastElement, lastIndexOf, lastIndexOf, removeAll, removeAll, removeAllElements, removeAllFirst, removeAllFirst, removeElement, removeElementAt, removeIndex, removeRange, retainAll, set, setElementAt, setIncrementFactor, setLast, setSize, size, toArray, trimToSize

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IntStack

public IntStack()

Constructs a new empty IntStack.

IntStack

public IntStack(int initialCapacity,
        int capacityIncrement)

Constructs an empty stack with the specified initial capacity and capacity increment.

Parameters:

initialCapacity - the initial capacity of the stack.

capacityIncrement - amount by which the capacity is increased on overflow.

Throws:

java.lang.IllegalArgumentException - if the specified initial capacity is negative.

IntStack

public IntStack(int initialCapacity)

Constructs an empty stack with the specified initial capacity and with its capacity increment equal to zero.

Parameters:

initialCapacity - the initial capacity of the stack.

Throws:

java.lang.IllegalArgumentException - if the specified initial capacity is negative.

Method Detail

push

public final int push(int item)

Pushes an item onto the top of this stack.

Parameters:

item - the item to be pushed onto this stack.

Returns:

the item argument.

pop

public final int pop()

Removes the integer at the top of this stack and returns it.

Returns:

the integer at the top of this stack.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if this stack is empty.

peek

public final int peek()

Looks at the object at the top of this stack without removing it from the stack.

Returns:

the object at the top of this stack.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if this stack is empty.

peek

public final int peek(int n)

Peeks at n positions from the top of the stack.

Parameters:

n - the offset from the top (0 -> top, 1 -> top-1,...)

Throws:

java.lang.ArrayIndexOutOfBoundsException - if index out of range.

replace

public final int replace(int n,
          int e)

Replaces the element at n positions from the top of the stack with a new one; returns the old element.

Parameters:

n - the offset from the top (0 -> top, 1 -> top-1,...)

e - the new element

Throws:

java.lang.ArrayIndexOutOfBoundsException - if index out of range.

empty

public final boolean empty()

Tests if this stack is empty.

Returns:

true if this stack contains no items; false otherwise.

search

public final int search(int n)

Returns the 1-based position wherethe specified int is on this stack. If the int occurs as an item in this stack, this method returns the distance from the top of the stack of the occurrence nearest the top of the stack; the topmost item on the stack is considered to be at distance 1.

Parameters:

n - the desired int.

Returns:

the offset from top where the object is located; -1 if not found.

toString

public java.lang.String toString()

Returns a string representation of this Stack. Note that a stack is written top-first!

Overrides:

toString in class IntArrayList

Returns:

a string representation of this collection.