/************************************************************************* * Compilation: javac LinkedStack.java * Execution: java LinkedStack < input.txt * * A generic stack, implemented using a linked list. Each stack * element is of type Item. * * % more tobe.txt * to be or not to - be - - that - - - is * * % java LinkedStack < tobe.txt * to be not that or be (2 left on stack) * *************************************************************************/ import java.util.Iterator; import java.util.NoSuchElementException; import edu.princeton.cs.introcs.StdIn; import edu.princeton.cs.introcs.StdOut; /** * The LinkedStack class represents a last-in-first-out (LIFO) stack of * generic items. * It supports the usual push and pop operations, along with methods * for peeking at the top item, testing if the stack is empty, and iterating through * the items in LIFO order. * * This implementation uses a singly-linked list with a non-static nested class for * linked-list nodes. See {@link Stack} for a version that uses a static nested class. * The push , pop , peek , size , and is-empty * operations all take constant time in the worst case. * * For additional documentation, see Section 1.3 of * Algorithms, 4th Edition by Robert Sedgewick and Kevin Wayne. * * @author Robert Sedgewick * @author Kevin Wayne */ public class LinkedStack implements Iterable { private int N; // size of the stack private Node first; // top of stack // helper linked list class private class Node { private Item item; private Node next; } /** * Initializes an empty stack. */ public LinkedStack() { first = null; N = 0; assert check(); } /** * Is this stack empty? * @return true if this stack is empty; false otherwise */ public boolean isEmpty() { return first == null; } /** * Returns the number of items in the stack. * @return the number of items in the stack */ public int size() { return N; } /** * Adds the item to this stack. * @param item the item to add */ public void push(Item item) { Node oldfirst = first; first = new Node(); first.item = item; first.next = oldfirst; N++; assert check(); } /** * Removes and returns the item most recently added to this stack. * @return the item most recently added * @throws java.util.NoSuchElementException if this stack is empty */ public Item pop() { if (isEmpty()) throw new NoSuchElementException("Stack underflow"); Item item = first.item; // save item to return first = first.next; // delete first node N--; assert check(); return item; // return the saved item } /** * Returns (but does not remove) the item most recently added to this stack. * @return the item most recently added to this stack * @throws java.util.NoSuchElementException if this stack is empty */ public Item peek() { if (isEmpty()) throw new NoSuchElementException("Stack underflow"); return first.item; } /** * Returns a string representation of this stack. * @return the sequence of items in the stack in LIFO order, separated by spaces */ @Override public String toString() { StringBuilder s = new StringBuilder(); for (Item item : this) s.append(item + " "); return s.toString(); } /** * Returns an iterator to this stack that iterates through the items in LIFO order. * @return an iterator to this stack that iterates through the items in LIFO order. */ public Iterator iterator() { return new ListIterator(); } // an iterator, doesn't implement remove() since it's optional private class ListIterator implements Iterator { private Node current = first; public boolean hasNext() { return current != null; } public void remove() { throw new UnsupportedOperationException(); } public Item next() { if (!hasNext()) throw new NoSuchElementException(); Item item = current.item; current = current.next; return item; } } // check internal invariants private boolean check() { if (N == 0) { if (first != null) return false; } else if (N == 1) { if (first == null) return false; if (first.next != null) return false; } else { if (first.next == null) return false; } // check internal consistency of instance variable N int numberOfNodes = 0; for (Node x = first; x != null; x = x.next) { numberOfNodes++; } if (numberOfNodes != N) return false; return true; } /** * Unit tests the LinkedStack data type. */ public static void main(String[] args) { LinkedStack s = new LinkedStack(); while (!StdIn.isEmpty()) { String item = StdIn.readString(); if (!item.equals("-")) s.push(item); else if (!s.isEmpty()) StdOut.print(s.pop() + " "); } StdOut.println("(" + s.size() + " left on stack)"); } }