aud.example.VerboseStack< T > Class Template Reference

A stack that outputs messages on push and pop. More...

Inheritance diagram for aud.example.VerboseStack< T >:

Collaboration diagram for aud.example.VerboseStack< T >:

Public Member Functions
	VerboseStack ()
T	pop () throws NoSuchElementException
	Pop element from stack. More...
void	push (T x)
	Push x onto stack. More...
String	toString ()
	Get string representation "|a|b|c". More...
Public Member Functions inherited from aud.Stack< T >
	Stack ()
boolean	is_empty ()
	Is stack empty? More...
T	top () throws NoSuchElementException
	Get stack top. More...
T	pop () throws NoSuchElementException
	Pop element from stack. More...
void	push (T x)
	Push x onto stack. More...
abstract boolean	is_empty ()
	Is stack empty? More...
abstract T	top ()
	Get stack top. More...
abstract T	pop ()
	Pop element from stack. More...
abstract void	push (T x)
	Push x onto stack. More...
String	toString ()
	Get string representation "|a|b|c". More...

Additional Inherited Members
Protected Member Functions inherited from aud.adt.AbstractStack< T >
	AbstractStack ()
	create empty stack More...

Detailed Description

A stack that outputs messages on push and pop.

On push (pop) print the pushed (popped) entry to System.err. The printed message is indented by the height of the stack.

You can replace Stack in any class by VerboseStack to trace modifications of the stack. This is useful, e.g., for comparing iterative and recursive implementations of algorithms.

Definition at line 15 of file VerboseStack.java.

Constructor & Destructor Documentation

VerboseStack()

aud.example.VerboseStack< T >.VerboseStack

(

)

Definition at line 19 of file VerboseStack.java.

{}

Member Function Documentation

pop()

T aud.example.VerboseStack< T >.pop

(

)

throws NoSuchElementException

Pop element from stack.

Requires !is_empty().

Exceptions

NoSuchElementException

Returns

removed element

Reimplemented from aud.Stack< T >.

Definition at line 21 of file VerboseStack.java.

                                                         {
    T x=super.pop();
    --height_;
    print("pop "+x);
    return x;
  }

Referenced by aud.example.IterativePreorderTraversal.iterative_traversal().

Here is the caller graph for this function:

push()

void aud.example.VerboseStack< T >.push

(

T

x

)

Push x onto stack.

Parameters

x	new element

Reimplemented from aud.Stack< T >.

Definition at line 28 of file VerboseStack.java.

                                  {
    super.push(x);
    print("push "+x);
    ++height_;
  }

Referenced by aud.example.IterativePreorderTraversal.iterative_traversal().

Here is the caller graph for this function:

toString()

String aud.example.VerboseStack< T >.toString

(

)

Get string representation "|a|b|c".

(Here, "c" is stack top. "|" denotes empty stack.)

Reimplemented from aud.adt.AbstractStack< T >.

Definition at line 41 of file VerboseStack.java.

                           {
    if (!is_empty()) {
      T x=super.pop();
      String bottom=toString();
      super.push(x);
      return (bottom+(bottom.length()>1 ? "|":""))+x;
    }
    else
      return "|";
  }

References aud.Stack< T >.is_empty(), and aud.example.VerboseStack< T >.toString().

Referenced by aud.example.VerboseStack< T >.toString().

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• VerboseStack.java