Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::internal::GraphObjectContainer< GraphObject > Class Template Reference

#include <ogdf/basic/GraphList.h>

+ Inheritance diagram for ogdf::internal::GraphObjectContainer< GraphObject >:

Public Types

using iterator = GraphIterator< GraphObject * >
 Provides a bidirectional iterator to an object in the container. More...
 
using reverse_iterator = GraphReverseIterator< GraphObject * >
 Provides a bidirectional reverse iterator to an object in the container. More...
 
using value_type = GraphObject *
 The value type (a pointer to a specific graph object) More...
 

Public Member Functions

iterator begin () const
 Returns an iterator to the first element in the container. More...
 
iterator end () const
 Returns an iterator to the one-past-last element in the container. More...
 
reverse_iterator rbegin () const
 Returns a reverse iterator to the last element in the container. More...
 
reverse_iterator rend () const
 Returns a reverse iterator to the one-before-first element in the container. More...
 

Friends

class ogdf::ClusterGraph
 
class ogdf::CombinatorialEmbedding
 
class ogdf::ConstCombinatorialEmbedding
 
class ogdf::Graph
 

Additional Inherited Members

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

Detailed Description

template<class GraphObject>
class ogdf::internal::GraphObjectContainer< GraphObject >

Definition at line 390 of file GraphList.h.

Member Typedef Documentation

◆ iterator

template<class GraphObject >
using ogdf::internal::GraphObjectContainer< GraphObject >::iterator = GraphIterator<GraphObject*>

Provides a bidirectional iterator to an object in the container.

Definition at line 405 of file GraphList.h.

◆ reverse_iterator

template<class GraphObject >
using ogdf::internal::GraphObjectContainer< GraphObject >::reverse_iterator = GraphReverseIterator<GraphObject*>

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

Definition at line 407 of file GraphList.h.

◆ value_type

template<class GraphObject >
using ogdf::internal::GraphObjectContainer< GraphObject >::value_type = GraphObject*

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

Definition at line 403 of file GraphList.h.

Member Function Documentation

◆ begin()

template<class GraphObject >
iterator ogdf::internal::GraphObjectContainer< GraphObject >::begin ( ) const
inline

Returns an iterator to the first element in the container.

Definition at line 410 of file GraphList.h.

◆ end()

template<class GraphObject >
iterator ogdf::internal::GraphObjectContainer< GraphObject >::end ( ) const
inline

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

Definition at line 413 of file GraphList.h.

◆ rbegin()

template<class GraphObject >
reverse_iterator ogdf::internal::GraphObjectContainer< GraphObject >::rbegin ( ) const
inline

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

Definition at line 416 of file GraphList.h.

◆ rend()

template<class GraphObject >
reverse_iterator ogdf::internal::GraphObjectContainer< GraphObject >::rend ( ) const
inline

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

Definition at line 419 of file GraphList.h.

Friends And Related Function Documentation

◆ ogdf::ClusterGraph

template<class GraphObject >
friend class ogdf::ClusterGraph
friend

Definition at line 393 of file GraphList.h.

◆ ogdf::CombinatorialEmbedding

template<class GraphObject >
friend class ogdf::CombinatorialEmbedding
friend

Definition at line 395 of file GraphList.h.

◆ ogdf::ConstCombinatorialEmbedding

template<class GraphObject >
friend class ogdf::ConstCombinatorialEmbedding
friend

Definition at line 394 of file GraphList.h.

◆ ogdf::Graph

template<class GraphObject >
friend class ogdf::Graph
friend

Definition at line 392 of file GraphList.h.


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