RWTStack< T, C > Class Template Reference

Maintains a stack of values. More...

#include <rw/tstack.h>

Public Member Functions
	RWTStack ()
	RWTStack (const RWTStack &rhs)
	RWTStack (RWTStack &&rhs)
void	clear ()
size_t	entries () const
bool	isEmpty () const
RWTStack &	operator= (const RWTStack &rhs)
RWTStack &	operator= (RWTStack &&rhs)
T	pop ()
void	push (const T &a)
void	push (T &&a)
	More...
void	swap (RWTStack< T, C > &rhs)
T	top () const

Detailed Description

template<class T, class C>
class RWTStack< T, C >

Class RWTStack maintains a stack of values. Not only can the type of object inserted onto the stack be parameterized, but also the implementation of the stack.

Parameter T represents the type of object in the stack, either a class or built-in type. Class T must have:

• well-defined copy semantics (T::T(const T&) or equivalent)
• well-defined assignment semantics (T::operator=(const T&) or equivalent)
• any other semantics required by class C.

Parameter C represents the class used for implementation. Useful choices are RWTValOrderedVector<T,A> or RWTValDlist<T,A>. Class RWTValSlist<T,A> can also be used, but note that singly-linked lists are less efficient at removing the last item of a list (function pop()), because of the necessity of searching the list for the next-to-the-last item.

Synopsis

#include <rw/tstack.h>
RWTStack<T, C> stack;

Persistence

None

Example

#include <iostream>
#include <rw/tstack.h>
#include <rw/tvordvec.h>

int main()
{
    RWTStack<int, RWTValOrderedVector<int> > stack;

    stack.push(1);
    stack.push(5);
    stack.push(6);

    while (!stack.isEmpty())
        std::cout << stack.pop() << "\n";

    return 0;
}

Program output:

6
5
1

Constructor & Destructor Documentation

template<class T, class C>

RWTStack< T, C >::RWTStack ( )

inline

Constructs a stack.

template<class T, class C>

RWTStack< T, C >::RWTStack ( const RWTStack< T, C > &  rhs )

inline

Copy constructor. Constructs self as a copy of rhs.

template<class T, class C>

RWTStack< T, C >::RWTStack ( RWTStack< T, C > &&  rhs )

inline

Move constructor. Takes ownership of the data owned by rhs.

Condition:

This method is only available on platforms with rvalue reference support.

Member Function Documentation

template<class T, class C>

void RWTStack< T, C >::clear ( void  )

inline

Removes all items from the stack.

template<class T, class C>

size_t RWTStack< T, C >::entries ( void  ) const

inline

Returns the number of items currently on the stack.

template<class T, class C>

bool RWTStack< T, C >::isEmpty ( ) const

inline

Returns true if there are currently no items on the stack, otherwise false.

template<class T, class C>

RWTStack& RWTStack< T, C >::operator= ( const RWTStack< T, C > &  rhs )

inline

Assignment operator. Sets self to a copy of rhs.

template<class T, class C>

RWTStack& RWTStack< T, C >::operator= ( RWTStack< T, C > &&  rhs )

inline

Move assignment. Takes ownership of the data owned by rhs.

Condition:

This method is only available on platforms with rvalue reference support.

template<class T, class C>

T RWTStack< T, C >::pop ( )

inline

Pops (removes and returns) the item at the top of the stack.

Exceptions

RWBoundsErr

Thrown if there are no items on the stack.

template<class T, class C>

void RWTStack< T, C >::push ( const T &  a )

inline

Pushes the item a onto the top of the stack.

template<class T, class C>

void RWTStack< T, C >::push ( T &&  a )

inline

Pushes the item a onto the top of the stack.

template<class T, class C>

void RWTStack< T, C >::swap ( RWTStack< T, C > &  rhs )

inline

Swaps the data owned by self with the data owned by rhs.

template<class T, class C>

T RWTStack< T, C >::top ( ) const

inline

Returns (but does not remove) the item at the top of the stack.