Open
Graph Drawing
Framework

 v. 2023.09 (Elderberry)
 

ogdf::internal::GraphListBase Class Reference

Base class for GraphElement lists. More...

#include <ogdf/basic/GraphList.h>

+ Inheritance diagram for ogdf::internal::GraphListBase:

Public Member Functions

 GraphListBase ()
 Constructs an empty list. More...
 
 ~GraphListBase ()
 Destruction. More...
 
void consistencyCheck () const
 Asserts consistency of this list. More...
 
void del (GraphElement *pX)
 Removes element pX from the list. More...
 
bool empty () const
 Returns true iff the list is empty. More...
 
void insertAfter (GraphElement *pX, GraphElement *pY)
 Inserts element pX after element pY. More...
 
void insertBefore (GraphElement *pX, GraphElement *pY)
 Inserts element pX before element pY. More...
 
void permute ()
 Permutes all list elements. More...
 
template<class RNG >
void permute (RNG &rng)
 Permutes all list elements. More...
 
void pushBack (GraphElement *pX)
 Adds element pX at the end of the list. More...
 
void reverse ()
 Reverses the order of the list elements. More...
 
int size () const
 Returns the size of the list. More...
 
template<class LIST >
void sort (const LIST &newOrder)
 Sorts the list according to newOrder. More...
 
template<class IT >
void sort (IT begin, IT end)
 Sorts the list according to the range defined by two iterators. More...
 
void swap (GraphElement *pX, GraphElement *pY)
 Exchanges the positions of pX and pY in the list. More...
 

Protected Attributes

GraphElementm_head
 Pointer to the first element in the list. More...
 
int m_size
 The size of the list. More...
 
GraphElementm_tail
 Pointer to the last element in the list. More...
 

Detailed Description

Base class for GraphElement lists.

Definition at line 72 of file GraphList.h.

Constructor & Destructor Documentation

◆ GraphListBase()

ogdf::internal::GraphListBase::GraphListBase ( )
inline

Constructs an empty list.

Definition at line 80 of file GraphList.h.

◆ ~GraphListBase()

ogdf::internal::GraphListBase::~GraphListBase ( )
inline

Destruction.

Definition at line 86 of file GraphList.h.

Member Function Documentation

◆ consistencyCheck()

void ogdf::internal::GraphListBase::consistencyCheck ( ) const
inline

Asserts consistency of this list.

Definition at line 269 of file GraphList.h.

◆ del()

void ogdf::internal::GraphListBase::del ( GraphElement pX)
inline

Removes element pX from the list.

Definition at line 133 of file GraphList.h.

◆ empty()

bool ogdf::internal::GraphListBase::empty ( ) const
inline

Returns true iff the list is empty.

Definition at line 92 of file GraphList.h.

◆ insertAfter()

void ogdf::internal::GraphListBase::insertAfter ( GraphElement pX,
GraphElement pY 
)
inline

Inserts element pX after element pY.

Definition at line 107 of file GraphList.h.

◆ insertBefore()

void ogdf::internal::GraphListBase::insertBefore ( GraphElement pX,
GraphElement pY 
)
inline

Inserts element pX before element pY.

Definition at line 120 of file GraphList.h.

◆ permute() [1/2]

void ogdf::internal::GraphListBase::permute ( )
inline

Permutes all list elements.

Definition at line 262 of file GraphList.h.

◆ permute() [2/2]

template<class RNG >
void ogdf::internal::GraphListBase::permute ( RNG &  rng)
inline

Permutes all list elements.

Definition at line 235 of file GraphList.h.

◆ pushBack()

void ogdf::internal::GraphListBase::pushBack ( GraphElement pX)
inline

Adds element pX at the end of the list.

Definition at line 95 of file GraphList.h.

◆ reverse()

void ogdf::internal::GraphListBase::reverse ( )
inline

Reverses the order of the list elements.

Definition at line 176 of file GraphList.h.

◆ size()

int ogdf::internal::GraphListBase::size ( ) const
inline

Returns the size of the list.

Definition at line 89 of file GraphList.h.

◆ sort() [1/2]

template<class LIST >
void ogdf::internal::GraphListBase::sort ( const LIST &  newOrder)
inline

Sorts the list according to newOrder.

Definition at line 151 of file GraphList.h.

◆ sort() [2/2]

template<class IT >
void ogdf::internal::GraphListBase::sort ( IT  begin,
IT  end 
)
inline

Sorts the list according to the range defined by two iterators.

Definition at line 159 of file GraphList.h.

◆ swap()

void ogdf::internal::GraphListBase::swap ( GraphElement pX,
GraphElement pY 
)
inline

Exchanges the positions of pX and pY in the list.

Definition at line 188 of file GraphList.h.

Member Data Documentation

◆ m_head

GraphElement* ogdf::internal::GraphListBase::m_head
protected

Pointer to the first element in the list.

Definition at line 75 of file GraphList.h.

◆ m_size

int ogdf::internal::GraphListBase::m_size
protected

The size of the list.

Definition at line 74 of file GraphList.h.

◆ m_tail

GraphElement* ogdf::internal::GraphListBase::m_tail
protected

Pointer to the last element in the list.

Definition at line 76 of file GraphList.h.


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