Module org.jgrapht.core

Package org.jgrapht.alg.planar

Class BoyerMyrvoldPlanarityInspector.Edge

java.lang.Object

org.jgrapht.alg.planar.BoyerMyrvoldPlanarityInspector.Edge

Enclosing class:

BoyerMyrvoldPlanarityInspector<V,E>

private class BoyerMyrvoldPlanarityInspector.Edge
extends Object

Internal representation of the edges of the input graph.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) boolean	embedded	Whether the edge is embedded or not.
(package private) E	graphEdge	The counterpart of this edge in the graph.
(package private) boolean	shortCircuit	Whether the edge is real or short-circuit.
(package private) int	sign	Either $+1$ or $-1$ for regular and inverted edges respectively.
(package private) BoyerMyrvoldPlanarityInspector<V,E>.Node	source	The source node of this edge.
(package private) BoyerMyrvoldPlanarityInspector<V,E>.Node	target	The target of this edge

Constructor Summary

Constructors

Constructor	Description
Edge(E graphEdge, BoyerMyrvoldPlanarityInspector<V,E>.Node source)	Creates a new tree edge.
Edge(E graphEdge, BoyerMyrvoldPlanarityInspector<V,E>.Node source, BoyerMyrvoldPlanarityInspector<V,E>.Node target)	Creates a new edge.
Edge(BoyerMyrvoldPlanarityInspector<V,E>.Node source, BoyerMyrvoldPlanarityInspector<V,E>.Node target)	Creates a new short-circuit edge with no counterpart in graph.

Method Summary

Modifier and Type	Method	Description
(package private) BoyerMyrvoldPlanarityInspector<V,E>.Node	getOpposite(BoyerMyrvoldPlanarityInspector<V,E>.Node node)	Returns the opposite node of the node
(package private) boolean	isIncidentTo(BoyerMyrvoldPlanarityInspector<V,E>.Node node)	True if this edge is incident to the node node, false otherwise
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

graphEdge

E graphEdge

The counterpart of this edge in the graph. This value can be null if the edge was created as a short-circuit edge.

source

BoyerMyrvoldPlanarityInspector<V,E>.Node source

The source node of this edge. For tree edges the source is lower than the target, for back edges the target is lower (having smaller height)

target

BoyerMyrvoldPlanarityInspector<V,E>.Node target

The target of this edge

sign

int sign

Either $+1$ or $-1$ for regular and inverted edges respectively. This value is set to $-1$ to flip a biconnected component in $\mathcal{O}(1)$ time. Note: this operation doesn't flip any of the child biconnected components of this biconnected component

embedded

boolean embedded

Whether the edge is embedded or not. This value is important for

shortCircuit

boolean shortCircuit

Whether the edge is real or short-circuit. See the original paper for the definition of the short-circuit edges.

Constructor Details

Edge

Edge(BoyerMyrvoldPlanarityInspector<V,E>.Node source,
 BoyerMyrvoldPlanarityInspector<V,E>.Node target)

Creates a new short-circuit edge with no counterpart in graph. The source of this edge is always a real node on the boundary of some biconnected component, and the target node is the parent node of the biconnected component the source node belongs to, so the edge resembles a regular back edge except for that it doesn't have a counterpart in the graph

Parameters:

source - the source of the short-circuit edge

target - the target of the short-circuit edge

Edge

Edge(E graphEdge,
 BoyerMyrvoldPlanarityInspector<V,E>.Node source)

Creates a new tree edge.

Parameters:

graphEdge - the counterpart of this edge in the graph

source - the source node of this edge

Edge

Edge(E graphEdge,
 BoyerMyrvoldPlanarityInspector<V,E>.Node source,
 BoyerMyrvoldPlanarityInspector<V,E>.Node target)

Creates a new edge. This constructor is used directly for the creation of the back edges

Parameters:

graphEdge - the counterpart of this edge in the graph

source - the source node of this edge

target - the target node of this edge

Method Details

isIncidentTo

boolean isIncidentTo(BoyerMyrvoldPlanarityInspector<V,E>.Node node)

True if this edge is incident to the node node, false otherwise

Parameters:

node - the node to test

Returns:

true if this edge is incident to the node node, false otherwise

getOpposite

BoyerMyrvoldPlanarityInspector<V,E>.Node getOpposite(BoyerMyrvoldPlanarityInspector<V,E>.Node node)

Returns the opposite node of the node

Parameters:

node - an endpoint of this edge

Returns:

the other endpoint of this edge

toString

public String toString()

Overrides:

toString in class Object