Open
Graph Drawing
Framework

 v.2010.10
 

Public Member Functions

ogdf::Queue< E > Class Template Reference

The parameterized class Queue<E> implements list-based queues. More...

#include <ogdf/basic/Queue.h>

Inheritance diagram for ogdf::Queue< E >:
ogdf::SList< E >

List of all members.

Public Member Functions

 Queue ()
 Constructs an empty queue.
 Queue (const Queue< E > &Q)
 Constructs a queue that is a copy of Q.
 ~Queue ()
bool empty () const
 Returns true iff the queue is empty.
int size () const
 Returns the number of elements in the queue.
const E & top () const
 Returns a reference to the front element.
E & top ()
 Returns a reference to the front element.
const E & bottom () const
 Returns a reference to the back element.
E & bottom ()
 Returns a reference to the back element.
Queue< E > & operator= (const Queue< E > &Q)
 Assignment operator.
SListIterator< E > append (const E &x)
 Adds x at the end of queue.
pop ()
 Removes front element and returns it.
void clear ()
 Makes the queue empty.
const SList< E > & getList () const
 Conversion to const SList.
const SListPure< E > & getListPure () const
 Conversion to const SListPure.
void * operator new (size_t nBytes)
void * operator new (size_t, void *p)
void operator delete (void *p, size_t nBytes)

Detailed Description

template<class E>
class ogdf::Queue< E >

The parameterized class Queue<E> implements list-based queues.

In contrast to QueuePure<E>, instances of Queue<E> store the number of elements contained in the queue.

Definition at line 140 of file Queue.h.


Constructor & Destructor Documentation

template<class E>
ogdf::Queue< E >::Queue (  )  [inline]

Constructs an empty queue.

Definition at line 143 of file Queue.h.

template<class E>
ogdf::Queue< E >::Queue ( const Queue< E > &  Q  )  [inline]

Constructs a queue that is a copy of Q.

Definition at line 146 of file Queue.h.

template<class E>
ogdf::Queue< E >::~Queue (  )  [inline]

Definition at line 149 of file Queue.h.


Member Function Documentation

template<class E>
SListIterator<E> ogdf::Queue< E >::append ( const E &  x  )  [inline]

Adds x at the end of queue.

Definition at line 184 of file Queue.h.

template<class E>
const E& ogdf::Queue< E >::bottom (  )  const [inline]

Returns a reference to the back element.

Definition at line 168 of file Queue.h.

template<class E>
E& ogdf::Queue< E >::bottom (  )  [inline]

Returns a reference to the back element.

Definition at line 173 of file Queue.h.

template<class E>
void ogdf::Queue< E >::clear (  )  [inline]

Makes the queue empty.

Reimplemented from ogdf::SList< E >.

Definition at line 196 of file Queue.h.

template<class E>
bool ogdf::Queue< E >::empty (  )  const [inline]

Returns true iff the queue is empty.

Reimplemented from ogdf::SList< E >.

Definition at line 152 of file Queue.h.

template<class E>
const SList<E>& ogdf::Queue< E >::getList (  )  const [inline]

Conversion to const SList.

Definition at line 199 of file Queue.h.

template<class E>
const SListPure<E>& ogdf::Queue< E >::getListPure (  )  const [inline]

Conversion to const SListPure.

Reimplemented from ogdf::SList< E >.

Definition at line 201 of file Queue.h.

template<class E>
void ogdf::Queue< E >::operator delete ( void *  p,
size_t  nBytes 
) [inline]

Reimplemented from ogdf::SList< E >.

Definition at line 203 of file Queue.h.

template<class E>
void* ogdf::Queue< E >::operator new ( size_t  ,
void *  p 
) [inline]

Reimplemented from ogdf::SList< E >.

Definition at line 203 of file Queue.h.

template<class E>
void* ogdf::Queue< E >::operator new ( size_t  nBytes  )  [inline]

Reimplemented from ogdf::SList< E >.

Definition at line 203 of file Queue.h.

template<class E>
Queue<E>& ogdf::Queue< E >::operator= ( const Queue< E > &  Q  )  [inline]

Assignment operator.

Definition at line 178 of file Queue.h.

template<class E>
E ogdf::Queue< E >::pop (  )  [inline]

Removes front element and returns it.

Definition at line 189 of file Queue.h.

template<class E>
int ogdf::Queue< E >::size (  )  const [inline]

Returns the number of elements in the queue.

Reimplemented from ogdf::SList< E >.

Definition at line 155 of file Queue.h.

template<class E>
const E& ogdf::Queue< E >::top (  )  const [inline]

Returns a reference to the front element.

Definition at line 158 of file Queue.h.

template<class E>
E& ogdf::Queue< E >::top (  )  [inline]

Returns a reference to the front element.

Definition at line 163 of file Queue.h.


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