Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::BoundedQueue< E, INDEX > Class Template Reference

The parameterized class BoundedQueue implements queues with bounded size. More...

#include <ogdf/basic/BoundedQueue.h>

Public Member Functions

 BoundedQueue ()
 Pointer to first element of total array. More...
 
 BoundedQueue (BoundedQueue< E > &&Q)
 Constructs a bounded queue containing the elements of Q (move semantics). More...
 
 BoundedQueue (const BoundedQueue< E > &Q)
 Constructs a bounded queue that is a copy of Q. More...
 
 BoundedQueue (INDEX n)
 Constructs an empty bounded queue for at most n elements. More...
 
 ~BoundedQueue ()
 Destruction. More...
 
void append (const E &x)
 Adds x at the end of queue. More...
 
E & bottom ()
 Returns back element. More...
 
const E & bottom () const
 Returns back element. More...
 
INDEX capacity () const
 Returns the capacity of the bounded queue. More...
 
void clear ()
 Makes the queue empty. More...
 
bool empty ()
 Returns true iff the queue is empty. More...
 
bool full ()
 Returns true iff the queue is full. More...
 
void init ()
 Reinitializes the bounded queue to a non-valid bounded queue. More...
 
void init (INDEX n)
 Reinitializes the bounded queue to a bounded queue for at most n elements. More...
 
BoundedQueue< E > & operator= (BoundedQueue< E > &&Q)
 Assignment operator (move semantics). More...
 
BoundedQueue< E > & operator= (const BoundedQueue< E > &Q)
 Assignment operator. More...
 
pop ()
 Removes front element and returns it. More...
 
void print (std::ostream &os, char delim=' ') const
 Prints the queue to output stream os with the seperator delim. More...
 
INDEX size () const
 Returns current size of the queue. More...
 
E & top ()
 Returns front element. More...
 
const E & top () const
 Returns front element. More...
 

Private Member Functions

void copy (const BoundedQueue< E > &Q)
 

Private Attributes

E * m_pEnd
 Pointer to first element of current sequence. More...
 
E * m_pFirst
 Pointer to one past last element of total array. More...
 
E * m_pStart
 
E * m_pStop
 Pointer to one past last element of current sequence. More...
 

Detailed Description

template<class E, class INDEX = int>
class ogdf::BoundedQueue< E, INDEX >

The parameterized class BoundedQueue implements queues with bounded size.

Template Parameters
Eis the element type.
INDEXis the index type. The default index type is int, other possible types are short and long long (on 64-bit systems).

Definition at line 46 of file BoundedQueue.h.

Constructor & Destructor Documentation

◆ BoundedQueue() [1/4]

template<class E , class INDEX = int>
ogdf::BoundedQueue< E, INDEX >::BoundedQueue ( )
inline

Pointer to first element of total array.

Creates a non-valid bounded queue. Needs to be reinitialized first.

Definition at line 55 of file BoundedQueue.h.

◆ BoundedQueue() [2/4]

template<class E , class INDEX = int>
ogdf::BoundedQueue< E, INDEX >::BoundedQueue ( INDEX  n)
inlineexplicit

Constructs an empty bounded queue for at most n elements.

Definition at line 60 of file BoundedQueue.h.

◆ BoundedQueue() [3/4]

template<class E , class INDEX = int>
ogdf::BoundedQueue< E, INDEX >::BoundedQueue ( const BoundedQueue< E > &  Q)
inline

Constructs a bounded queue that is a copy of Q.

Definition at line 69 of file BoundedQueue.h.

◆ BoundedQueue() [4/4]

template<class E , class INDEX = int>
ogdf::BoundedQueue< E, INDEX >::BoundedQueue ( BoundedQueue< E > &&  Q)
inline

Constructs a bounded queue containing the elements of Q (move semantics).

The queue Q is non valid afterwards, i.e., its capacity is zero. It has to be reinitialized if new elements shall be appended.

Definition at line 78 of file BoundedQueue.h.

◆ ~BoundedQueue()

template<class E , class INDEX = int>
ogdf::BoundedQueue< E, INDEX >::~BoundedQueue ( )
inline

Destruction.

Definition at line 87 of file BoundedQueue.h.

Member Function Documentation

◆ append()

template<class E , class INDEX = int>
void ogdf::BoundedQueue< E, INDEX >::append ( const E &  x)
inline

Adds x at the end of queue.

Definition at line 177 of file BoundedQueue.h.

◆ bottom() [1/2]

template<class E , class INDEX = int>
E& ogdf::BoundedQueue< E, INDEX >::bottom ( )
inline

Returns back element.

Definition at line 126 of file BoundedQueue.h.

◆ bottom() [2/2]

template<class E , class INDEX = int>
const E& ogdf::BoundedQueue< E, INDEX >::bottom ( ) const
inline

Returns back element.

Definition at line 119 of file BoundedQueue.h.

◆ capacity()

template<class E , class INDEX = int>
INDEX ogdf::BoundedQueue< E, INDEX >::capacity ( ) const
inline

Returns the capacity of the bounded queue.

Definition at line 140 of file BoundedQueue.h.

◆ clear()

template<class E , class INDEX = int>
void ogdf::BoundedQueue< E, INDEX >::clear ( )
inline

Makes the queue empty.

Definition at line 192 of file BoundedQueue.h.

◆ copy()

template<class E , class INDEX = int>
void ogdf::BoundedQueue< E, INDEX >::copy ( const BoundedQueue< E > &  Q)
inlineprivate

Definition at line 205 of file BoundedQueue.h.

◆ empty()

template<class E , class INDEX = int>
bool ogdf::BoundedQueue< E, INDEX >::empty ( )
inline

Returns true iff the queue is empty.

Definition at line 143 of file BoundedQueue.h.

◆ full()

template<class E , class INDEX = int>
bool ogdf::BoundedQueue< E, INDEX >::full ( )
inline

Returns true iff the queue is full.

Definition at line 146 of file BoundedQueue.h.

◆ init() [1/2]

template<class E , class INDEX = int>
void ogdf::BoundedQueue< E, INDEX >::init ( )
inline

Reinitializes the bounded queue to a non-valid bounded queue.

Definition at line 90 of file BoundedQueue.h.

◆ init() [2/2]

template<class E , class INDEX = int>
void ogdf::BoundedQueue< E, INDEX >::init ( INDEX  n)
inline

Reinitializes the bounded queue to a bounded queue for at most n elements.

Definition at line 96 of file BoundedQueue.h.

◆ operator=() [1/2]

template<class E , class INDEX = int>
BoundedQueue<E>& ogdf::BoundedQueue< E, INDEX >::operator= ( BoundedQueue< E > &&  Q)
inline

Assignment operator (move semantics).

The queue Q is non valid afterwards, i.e., its capacity is zero. It has to be reinitialized if new elements shall be appended.

Definition at line 163 of file BoundedQueue.h.

◆ operator=() [2/2]

template<class E , class INDEX = int>
BoundedQueue<E>& ogdf::BoundedQueue< E, INDEX >::operator= ( const BoundedQueue< E > &  Q)
inline

Assignment operator.

Definition at line 152 of file BoundedQueue.h.

◆ pop()

template<class E , class INDEX = int>
E ogdf::BoundedQueue< E, INDEX >::pop ( )
inline

Removes front element and returns it.

Definition at line 184 of file BoundedQueue.h.

◆ print()

template<class E , class INDEX = int>
void ogdf::BoundedQueue< E, INDEX >::print ( std::ostream &  os,
char  delim = ' ' 
) const
inline

Prints the queue to output stream os with the seperator delim.

Definition at line 195 of file BoundedQueue.h.

◆ size()

template<class E , class INDEX = int>
INDEX ogdf::BoundedQueue< E, INDEX >::size ( ) const
inline

Returns current size of the queue.

Definition at line 133 of file BoundedQueue.h.

◆ top() [1/2]

template<class E , class INDEX = int>
E& ogdf::BoundedQueue< E, INDEX >::top ( )
inline

Returns front element.

Definition at line 113 of file BoundedQueue.h.

◆ top() [2/2]

template<class E , class INDEX = int>
const E& ogdf::BoundedQueue< E, INDEX >::top ( ) const
inline

Returns front element.

Definition at line 107 of file BoundedQueue.h.

Member Data Documentation

◆ m_pEnd

template<class E , class INDEX = int>
E* ogdf::BoundedQueue< E, INDEX >::m_pEnd
private

Pointer to first element of current sequence.

Definition at line 49 of file BoundedQueue.h.

◆ m_pFirst

template<class E , class INDEX = int>
E* ogdf::BoundedQueue< E, INDEX >::m_pFirst
private

Pointer to one past last element of total array.

Definition at line 51 of file BoundedQueue.h.

◆ m_pStart

template<class E , class INDEX = int>
E* ogdf::BoundedQueue< E, INDEX >::m_pStart
private

Definition at line 48 of file BoundedQueue.h.

◆ m_pStop

template<class E , class INDEX = int>
E* ogdf::BoundedQueue< E, INDEX >::m_pStop
private

Pointer to one past last element of current sequence.

Definition at line 50 of file BoundedQueue.h.


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