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

#include <ogdf/basic/GraphList.h>

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

Public Types
using	iterator = GraphIterator< T * >
	Provides a bidirectional iterator to an object in the container.

using	reverse_iterator = GraphReverseIterator< T * >
	Provides a bidirectional reverse iterator to an object in the container.

using	value_type = T *
	The value type (a pointer to a specific graph object)

Public Member Functions
	GraphList ()
	Constructs an empty list.

	~GraphList ()
	Destruction: deletes all elements.

iterator	begin () const
	Returns an iterator to the first element in the container.

void	clear ()
	Removes all elements from the list and deletes them.

void	consistencyCheck () const
	Asserts consistency of this list.

void	del (T *pX)
	Removes element `pX` from the list and deletes it.

void	delPure (T *pX)
	Only removes element `pX` from the list; does not delete it.

bool	empty () const
	Returns true iff the list is empty.

iterator	end () const
	Returns an iterator to the one-past-last element in the container.

T *	head () const
	Returns the first element in the list.

void	insertAfter (T pX, T pY)
	Inserts element `pX` after element `pY`.

void	insertBefore (T pX, T pY)
	Inserts element `pX` before element `pY`.

void	move (T *pX, GraphList< T > &L)
	Moves element `pX` to list `L` and inserts it at the end.

void	move (T pX, GraphList< T > &L, T pY, Direction dir)
	Moves element `pX` to list `L` and inserts it before or after `pY`.

void	moveAfter (T pX, T pY)
	Moves element `pX` from its current position to a position after `pY`.

void	moveBefore (T pX, T pY)
	Moves element `pX` from its current position to a position before `pY`.

void	permute ()
	Permutes all list elements.

template<class RNG >
void	permute (RNG &rng)
	Permutes all list elements.

void	pushBack (T *pX)
	Adds element `pX` at the end of the list.

reverse_iterator	rbegin () const
	Returns a reverse iterator to the last element in the container.

reverse_iterator	rend () const
	Returns a reverse iterator to the one-before-first element in the container.

void	reverse ()
	Reverses the order of the list elements.

int	size () const
	Returns the size of the list.

template<class LIST >
void	sort (const LIST &newOrder)
	Sorts the list according to `newOrder`.

template<class IT >
void	sort (IT begin, IT end)
	Sorts the list according to the range defined by two iterators.

void	swap (T pX, T pY)
	Exchanges the positions of `pX` and `pY` in the list.

T *	tail () const
	Returns the last element in the list.

Additional Inherited Members
Protected Member Functions inherited from ogdf::internal::GraphListBase
	GraphListBase ()
	Constructs an empty list.

	~GraphListBase ()
	Destruction.

void	consistencyCheck () const
	Asserts consistency of this list.

void	del (GraphElement *pX)
	Removes element `pX` from the list.

bool	empty () const
	Returns true iff the list is empty.

void	insertAfter (GraphElement pX, GraphElement pY)
	Inserts element `pX` after element `pY`.

void	insertBefore (GraphElement pX, GraphElement pY)
	Inserts element `pX` before element `pY`.

void	permute ()
	Permutes all list elements.

template<class RNG >
void	permute (RNG &rng)
	Permutes all list elements.

void	pushBack (GraphElement *pX)
	Adds element `pX` at the end of the list.

void	reverse ()
	Reverses the order of the list elements.

int	size () const
	Returns the size of the list.

template<class LIST >
void	sort (const LIST &newOrder)
	Sorts the list according to `newOrder`.

template<class IT >
void	sort (IT begin, IT end)
	Sorts the list according to the range defined by two iterators.

void	swap (GraphElement pX, GraphElement pY)
	Exchanges the positions of `pX` and `pY` in the list.

Protected Attributes inherited from ogdf::internal::GraphListBase
GraphElement *	m_head
	Pointer to the first element in the list.

int	m_size
	The size of the list.

GraphElement *	m_tail
	Pointer to the last element in the list.

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 301 of file GraphList.h.

Member Typedef Documentation

◆ iterator

template<class T >

using ogdf::internal::GraphList< T >::iterator = GraphIterator<T*>

Provides a bidirectional iterator to an object in the container.

Definition at line 306 of file GraphList.h.

◆ reverse_iterator

template<class T >

using ogdf::internal::GraphList< T >::reverse_iterator = GraphReverseIterator<T*>

Provides a bidirectional reverse iterator to an object in the container.

Definition at line 308 of file GraphList.h.

◆ value_type

template<class T >

using ogdf::internal::GraphList< T >::value_type = T*

The value type (a pointer to a specific graph object)

Definition at line 304 of file GraphList.h.

Constructor & Destructor Documentation

◆ GraphList()

template<class T >

ogdf::internal::GraphList< T >::GraphList ( )

inline

Constructs an empty list.

Definition at line 311 of file GraphList.h.

◆ ~GraphList()

template<class T >

ogdf::internal::GraphList< T >::~GraphList ( )

inline

Destruction: deletes all elements.

Definition at line 314 of file GraphList.h.

Member Function Documentation

◆ begin()

template<class T >

iterator ogdf::internal::GraphList< T >::begin ( ) const

inline

Returns an iterator to the first element in the container.

Definition at line 385 of file GraphList.h.

◆ clear()

template<class T >

void ogdf::internal::GraphList< T >::clear ( )

inline

Removes all elements from the list and deletes them.

Definition at line 376 of file GraphList.h.

◆ consistencyCheck()

template<class T >

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

inline

Asserts consistency of this list.

Definition at line 269 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 367 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 373 of file GraphList.h.

◆ empty()

template<class T >

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

inline

Returns true iff the list is empty.

Definition at line 92 of file GraphList.h.

◆ end()

template<class T >

iterator ogdf::internal::GraphList< T >::end ( ) const

inline

Returns an iterator to the one-past-last element in the container.

Definition at line 388 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 324 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 333 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 336 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 349 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 339 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 355 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 361 of file GraphList.h.

◆ permute() [1/2]

template<class T >

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

inline

Permutes all list elements.

Definition at line 262 of file GraphList.h.

◆ permute() [2/2]

template<class T >

template<class RNG >

void ogdf::internal::GraphListBase::permute ( RNG & rng )

inline

Permutes all list elements.

Definition at line 235 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 330 of file GraphList.h.

◆ rbegin()

template<class T >

reverse_iterator ogdf::internal::GraphList< T >::rbegin ( ) const

inline

Returns a reverse iterator to the last element in the container.

Definition at line 391 of file GraphList.h.

◆ rend()

template<class T >

reverse_iterator ogdf::internal::GraphList< T >::rend ( ) const

inline

Returns a reverse iterator to the one-before-first element in the container.

Definition at line 394 of file GraphList.h.

◆ reverse()

template<class T >

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

inline

Reverses the order of the list elements.

Definition at line 176 of file GraphList.h.

◆ size()

template<class T >

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 T >

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 T >

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()

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 401 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 327 of file GraphList.h.

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

include/ogdf/basic/GraphList.h

OpenGraph DrawingFramework

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ iterator

◆ reverse_iterator

◆ value_type

Constructor & Destructor Documentation

◆ GraphList()

◆ ~GraphList()

Member Function Documentation

◆ begin()

◆ clear()

◆ consistencyCheck()

◆ del()

◆ delPure()

◆ empty()

◆ end()

◆ head()

◆ insertAfter()

◆ insertBefore()

◆ move() [1/2]

◆ move() [2/2]

◆ moveAfter()

◆ moveBefore()

◆ permute() [1/2]

◆ permute() [2/2]

◆ pushBack()

◆ rbegin()

◆ rend()

◆ reverse()

◆ size()

◆ sort() [1/2]

◆ sort() [2/2]

◆ swap()

◆ tail()

Open
Graph Drawing
Framework