Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::internal::GraphList< T > Class Template Reference

Lists of graph objects (like nodes, edges, etc.). More...

#include <ogdf/basic/GraphList.h>

+ Inheritance diagram for ogdf::internal::GraphList< T >:

Public Member Functions

 GraphList ()
 Constructs an empty list. More...
 
 ~GraphList ()
 Destruction: deletes all elements. More...
 
void clear ()
 Removes all elements from the list and deletes them. More...
 
void del (T *pX)
 Removes element pX from the list and deletes it. More...
 
void delPure (T *pX)
 Only removes element pX from the list; does not delete it. More...
 
bool empty () const
 Returns true iff the list is empty. More...
 
T * head () const
 Returns the first element in the list. More...
 
void insertAfter (T *pX, T *pY)
 Inserts element pX after element pY. More...
 
void insertBefore (T *pX, T *pY)
 Inserts element pX before element pY. More...
 
void move (T *pX, GraphList< T > &L)
 Moves element pX to list L and inserts it at the end. More...
 
void move (T *pX, GraphList< T > &L, T *pY, Direction dir)
 Moves element pX to list L and inserts it before or after pY. More...
 
void moveAfter (T *pX, T *pY)
 Moves element pX from its current position to a position after pY. More...
 
void moveBefore (T *pX, T *pY)
 Moves element pX from its current position to a position before pY. More...
 
void permute ()
 Permutes all list elements. More...
 
template<class RNG >
void permute (RNG &rng)
 Permutes all list elements. More...
 
void pushBack (T *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 T_LIST >
void sort (const T_LIST &newOrder)
 Sorts all elements according to newOrder. More...
 
void swap (T *pX, T *pY)
 Exchanges the positions of pX and pY in the list. More...
 
T * tail () const
 Returns the last element in the list. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ogdf::internal::GraphListBase
 GraphListBase ()
 Constructs an empty list. More...
 
 ~GraphListBase ()
 Destruction. More...
 
void del (GraphElement *pX)
 Removes element pX from the list. 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...
 
void swap (GraphElement *pX, GraphElement *pY)
 Exchanges the positions of pX and pY in the list. More...
 
- Protected Attributes inherited from ogdf::internal::GraphListBase
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

template<class T>
class ogdf::internal::GraphList< T >

Lists of graph objects (like nodes, edges, etc.).

The template type T must be a class derived from GraphElement.

Definition at line 277 of file GraphList.h.

Constructor & Destructor Documentation

◆ GraphList()

template<class T >
ogdf::internal::GraphList< T >::GraphList ( )
inline

Constructs an empty list.

Definition at line 282 of file GraphList.h.

◆ ~GraphList()

template<class T >
ogdf::internal::GraphList< T >::~GraphList ( )
inline

Destruction: deletes all elements.

Definition at line 285 of file GraphList.h.

Member Function Documentation

◆ clear()

template<class T >
void ogdf::internal::GraphList< T >::clear ( )
inline

Removes all elements from the list and deletes them.

Definition at line 356 of file GraphList.h.

◆ del()

template<class T >
void ogdf::internal::GraphList< T >::del ( T *  pX)
inline

Removes element pX from the list and deletes it.

Definition at line 345 of file GraphList.h.

◆ delPure()

template<class T >
void ogdf::internal::GraphList< T >::delPure ( T *  pX)
inline

Only removes element pX from the list; does not delete it.

Definition at line 351 of file GraphList.h.

◆ empty()

template<class T >
bool ogdf::internal::GraphList< T >::empty ( ) const
inline

Returns true iff the list is empty.

Definition at line 300 of file GraphList.h.

◆ head()

template<class T >
T* ogdf::internal::GraphList< T >::head ( ) const
inline

Returns the first element in the list.

Definition at line 294 of file GraphList.h.

◆ insertAfter()

template<class T >
void ogdf::internal::GraphList< T >::insertAfter ( T *  pX,
T *  pY 
)
inline

Inserts element pX after element pY.

Definition at line 308 of file GraphList.h.

◆ insertBefore()

template<class T >
void ogdf::internal::GraphList< T >::insertBefore ( T *  pX,
T *  pY 
)
inline

Inserts element pX before element pY.

Definition at line 313 of file GraphList.h.

◆ move() [1/2]

template<class T >
void ogdf::internal::GraphList< T >::move ( T *  pX,
GraphList< T > &  L 
)
inline

Moves element pX to list L and inserts it at the end.

Definition at line 327 of file GraphList.h.

◆ move() [2/2]

template<class T >
void ogdf::internal::GraphList< T >::move ( T *  pX,
GraphList< T > &  L,
T *  pY,
Direction  dir 
)
inline

Moves element pX to list L and inserts it before or after pY.

Definition at line 318 of file GraphList.h.

◆ moveAfter()

template<class T >
void ogdf::internal::GraphList< T >::moveAfter ( T *  pX,
T *  pY 
)
inline

Moves element pX from its current position to a position after pY.

Definition at line 333 of file GraphList.h.

◆ moveBefore()

template<class T >
void ogdf::internal::GraphList< T >::moveBefore ( T *  pX,
T *  pY 
)
inline

Moves element pX from its current position to a position before pY.

Definition at line 339 of file GraphList.h.

◆ permute() [1/2]

template<class T >
void ogdf::internal::GraphListBase::permute
inline

Permutes all list elements.

Definition at line 239 of file GraphList.h.

◆ permute() [2/2]

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

Permutes all list elements.

Definition at line 212 of file GraphList.h.

◆ pushBack()

template<class T >
void ogdf::internal::GraphList< T >::pushBack ( T *  pX)
inline

Adds element pX at the end of the list.

Definition at line 303 of file GraphList.h.

◆ reverse()

template<class T >
void ogdf::internal::GraphList< T >::reverse ( )
inline

Reverses the order of the list elements.

Definition at line 372 of file GraphList.h.

◆ size()

template<class T >
int ogdf::internal::GraphList< T >::size ( ) const
inline

Returns the size of the list.

Definition at line 291 of file GraphList.h.

◆ sort()

template<class T >
template<class T_LIST >
void ogdf::internal::GraphList< T >::sort ( const T_LIST &  newOrder)
inline

Sorts all elements according to newOrder.

Definition at line 366 of file GraphList.h.

◆ swap()

template<class T >
void ogdf::internal::GraphList< T >::swap ( T *  pX,
T *  pY 
)
inline

Exchanges the positions of pX and pY in the list.

Definition at line 377 of file GraphList.h.

◆ tail()

template<class T >
T* ogdf::internal::GraphList< T >::tail ( ) const
inline

Returns the last element in the list.

Definition at line 297 of file GraphList.h.


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