# OpenGraph DrawingFramework

v. 2023.09 (Elderberry)

Searching...
No Matches
ogdf::EdgeElement Class Reference

Class for the representation of edges. More...

#include <ogdf/basic/Graph_d.h>

Inheritance diagram for ogdf::EdgeElement:

## Public Member Functions

Returns the corresponding adjacancy entry at source node.

Returns the corresponding adjacancy entry at target node.

node commonNode (edge e) const
Returns the common node of the edge and e. Returns nullptr if the two edges are not adjacent.

Returns an adjacency entry of this edge at node v. If this is a self-loop the source adjacency entry will always be returned.

int index () const
Returns the index of the edge.

Returns true iff e is adjacent to the edge.

bool isIncident (node v) const
Returns true iff v is incident to the edge.

bool isInvertedDirected (edge e) const
Returns true iff edge e is an inverted edge to this (directed) edge.

bool isParallelDirected (edge e) const
Returns true iff edge e is parallel to this (directed) edge (or if it is the same edge)

bool isParallelUndirected (edge e) const
Returns true iff edge e is parallel to this (undirected) edge (or if it is the same edge)

bool isSelfLoop () const
Returns true iff the edge is a self-loop (source node = target node).

std::array< node, 2 > nodes () const
Returns a list of adjacent nodes. If this edge is a self-loop, both entries will be the same node.

node opposite (node v) const
Returns the adjacent node different from v.

edge pred () const
Returns the predecessor in the list of all edges.

node source () const
Returns the source node of the edge.

edge succ () const
Returns the successor in the list of all edges.

node target () const
Returns the target node of the edge.

## Static Public Member Functions

static int compare (const EdgeElement &x, const EdgeElement &y)
Standard Comparer.

## Private Member Functions

Constructs an edge element (src,tgt).

EdgeElement (node src, node tgt, int id)
Constructs an edge element (src,tgt).

## Private Attributes

Corresponding adjacancy entry at source node.

Corresponding adjacancy entry at target node.

int m_id

node m_src
The source node of the edge.

node m_tgt
The target node of the edge.

Private Attributes inherited from ogdf::internal::GraphElement
GraphElementm_next = nullptr
The successor in the list.

GraphElementm_prev = nullptr
The predecessor in the list.

## Friends

class Graph

class internal::GraphList< EdgeElement >

## Detailed Description

Class for the representation of edges.

Definition at line 300 of file Graph_d.h.

## ◆ EdgeElement() [1/2]

inlineprivate

Constructs an edge element (src,tgt).

Parameters
 src is the source node of the edge. tgt is the target node of the edge. adjSrc is the corresponding adjacency entry at source node. adjTgt is the corresponding adjacency entry at target node. id is the index of the edge.

Definition at line 318 of file Graph_d.h.

## ◆ EdgeElement() [2/2]

 ogdf::EdgeElement::EdgeElement ( node src, node tgt, int id )
inlineprivate

Constructs an edge element (src,tgt).

Parameters
 src is the source node of the edge. tgt is the target node of the edge. id is the index of the edge.

Definition at line 327 of file Graph_d.h.

## Member Function Documentation

inline

Returns the corresponding adjacancy entry at source node.

Definition at line 344 of file Graph_d.h.

inline

Returns the corresponding adjacancy entry at target node.

Definition at line 347 of file Graph_d.h.

## ◆ commonNode()

 node ogdf::EdgeElement::commonNode ( edge e ) const
inline

Returns the common node of the edge and e. Returns nullptr if the two edges are not adjacent.

Definition at line 387 of file Graph_d.h.

## ◆ compare()

 static int ogdf::EdgeElement::compare ( const EdgeElement & x, const EdgeElement & y )
inlinestatic

Standard Comparer.

Definition at line 401 of file Graph_d.h.

inline

Returns an adjacency entry of this edge at node v. If this is a self-loop the source adjacency entry will always be returned.

Definition at line 395 of file Graph_d.h.

## ◆ index()

 int ogdf::EdgeElement::index ( ) const
inline

Returns the index of the edge.

Definition at line 332 of file Graph_d.h.

 bool ogdf::EdgeElement::isAdjacent ( edge e ) const
inline

Returns true iff e is adjacent to the edge.

Definition at line 384 of file Graph_d.h.

## ◆ isIncident()

 bool ogdf::EdgeElement::isIncident ( node v ) const
inline

Returns true iff v is incident to the edge.

Definition at line 381 of file Graph_d.h.

## ◆ isInvertedDirected()

 bool ogdf::EdgeElement::isInvertedDirected ( edge e ) const
inline

Returns true iff edge e is an inverted edge to this (directed) edge.

Definition at line 359 of file Graph_d.h.

## ◆ isParallelDirected()

 bool ogdf::EdgeElement::isParallelDirected ( edge e ) const
inline

Returns true iff edge e is parallel to this (directed) edge (or if it is the same edge)

Definition at line 362 of file Graph_d.h.

## ◆ isParallelUndirected()

 bool ogdf::EdgeElement::isParallelUndirected ( edge e ) const
inline

Returns true iff edge e is parallel to this (undirected) edge (or if it is the same edge)

Definition at line 365 of file Graph_d.h.

## ◆ isSelfLoop()

 bool ogdf::EdgeElement::isSelfLoop ( ) const
inline

Returns true iff the edge is a self-loop (source node = target node).

Definition at line 356 of file Graph_d.h.

## ◆ nodes()

 std::array< node, 2 > ogdf::EdgeElement::nodes ( ) const
inline

Returns a list of adjacent nodes. If this edge is a self-loop, both entries will be the same node.

Definition at line 341 of file Graph_d.h.

## ◆ opposite()

 node ogdf::EdgeElement::opposite ( node v ) const
inline

Returns the adjacent node different from v.

Definition at line 350 of file Graph_d.h.

## ◆ pred()

 edge ogdf::EdgeElement::pred ( ) const
inline

Returns the predecessor in the list of all edges.

Definition at line 373 of file Graph_d.h.

## ◆ source()

 node ogdf::EdgeElement::source ( ) const
inline

Returns the source node of the edge.

Definition at line 335 of file Graph_d.h.

## ◆ succ()

 edge ogdf::EdgeElement::succ ( ) const
inline

Returns the successor in the list of all edges.

Definition at line 370 of file Graph_d.h.

## ◆ target()

 node ogdf::EdgeElement::target ( ) const
inline

Returns the target node of the edge.

Definition at line 338 of file Graph_d.h.

## ◆ Graph

 friend

Definition at line 301 of file Graph_d.h.

## ◆ internal::GraphList< EdgeElement >

 friend

Definition at line 301 of file Graph_d.h.

## Member Data Documentation

private

Corresponding adjacancy entry at source node.

Definition at line 306 of file Graph_d.h.

private

Corresponding adjacancy entry at target node.

Definition at line 307 of file Graph_d.h.

## ◆ m_id

 int ogdf::EdgeElement::m_id
private

Definition at line 308 of file Graph_d.h.

## ◆ m_src

 node ogdf::EdgeElement::m_src
private

The source node of the edge.

Definition at line 304 of file Graph_d.h.

## ◆ m_tgt

 node ogdf::EdgeElement::m_tgt
private

The target node of the edge.

Definition at line 305 of file Graph_d.h.

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