Stack< T > Class Template Reference

Search for all occurrences

---

Detailed Description

template<class T>
class Stack< T >

A simple stack implementation.

#include <stack.h>

Inheritance diagram for Stack< T >:

List of all members.

Public Member Functions
const T &	operator[] (const int i) const
T &	operator[] (const int i)
void	Push (T *el)
void	Pop (T *el)
void	Pop ()
void	GetTop (T *el)
void	Clear ()
int	Count () const
int	Remove (int i)

---

Member Function Documentation

const T& operator[]

(

const int

i

)

const [inline]

                                               { 
            DbgAssert(s.Count()-i>0);
            return s[s.Count()-i-1];
            }

T& operator[]

(

const int

i

)

[inline]

                                   { 
            DbgAssert(s.Count()-i>0);
            return s[s.Count()-i-1];
        }

void Push

(

T *

el

)

[inline]

Search for all occurrences

Remarks:

Pushes the specified element on the stack.

Parameters:

T *el

The item to push.

                           { 
            s.Append( 1, el );          
            }

void Pop

(

T *

el

)

[inline]

Search for all occurrences

Remarks:

Pops an item off the stack.

Parameters:

T *el

The item popped off the stack is returned here.

                          { 
            DbgAssert( s.Count() ); 
            *el = s[s.Count()-1];
            s.Delete( s.Count()-1, 1 );         
            }

void Pop

(

)

[inline]

Search for all occurrences

Remarks:

Pops an item off the stack and discards it. The item is not returned.

                   { 
            DbgAssert( s.Count() );             
            s.Delete( s.Count()-1, 1 );         
            }

void GetTop

(

T *

el

)

[inline]

Search for all occurrences

Remarks:

Retrieves the item on top of the stack without altering the stack.

Parameters:

T *el

The top item is returned here.

                             {
            DbgAssert( s.Count() ); 
            *el = s[s.Count()-1];
            }

void Clear

(

)

[inline]

Search for all occurrences

Remarks:

Clears the stack. All items are deleted.

                     {
            s.Delete(0,s.Count());          
            }

int Count

(

)

const [inline]

Search for all occurrences

Remarks:

Returns the number of item currently on the stack.

                          {
            return s.Count(); 
            }

int Remove

(

int

i

)

[inline]

Search for all occurrences

Remarks:

Removes the 'i-th' item from the stack.

Parameters:

int i

The item to remove from the stack.

Returns:

Returns the number of items left in the stack.

                            {
            assert(i<s.Count());
            return s.Delete(s.Count()-1-i,1);
            }