org.jgrapht.graph

Class DirectedGraphUnion<V,E>

java.lang.Object

org.jgrapht.graph.AbstractGraph<V,E>

org.jgrapht.graph.GraphUnion<V,E,DirectedGraph<V,E>>

org.jgrapht.graph.DirectedGraphUnion<V,E>

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

java.io.Serializable, DirectedGraph<V,E>, Graph<V,E>

public class DirectedGraphUnion<V,E>
extends GraphUnion<V,E,DirectedGraph<V,E>>
implements DirectedGraph<V,E>

A union of directed graphs.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DirectedGraphUnion(DirectedGraph<V,E> g1, DirectedGraph<V,E> g2) Construct a new directed graph union.
DirectedGraphUnion(DirectedGraph<V,E> g1, DirectedGraph<V,E> g2, WeightCombiner operator) Construct a new directed graph union.

Method Summary

Modifier and Type	Method and Description
java.util.Set<E>	incomingEdgesOf(V vertex) Returns a set of all edges incoming into the specified vertex.
int	inDegreeOf(V vertex) Returns the "in degree" of the specified vertex.
int	outDegreeOf(V vertex) Returns the "out degree" of the specified vertex.
java.util.Set<E>	outgoingEdgesOf(V vertex) Returns a set of all edges outgoing from the specified vertex.

Methods inherited from class org.jgrapht.graph.GraphUnion

addEdge, addEdge, addVertex, containsEdge, containsVertex, edgeSet, edgesOf, getAllEdges, getEdge, getEdgeFactory, getEdgeSource, getEdgeTarget, getEdgeWeight, getG1, getG2, removeEdge, removeEdge, removeVertex, vertexSet

Methods inherited from class org.jgrapht.graph.AbstractGraph

containsEdge, equals, hashCode, removeAllEdges, removeAllEdges, removeAllVertices, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jgrapht.Graph

addEdge, addEdge, addVertex, containsEdge, containsEdge, containsVertex, edgeSet, edgesOf, getAllEdges, getEdge, getEdgeFactory, getEdgeSource, getEdgeTarget, getEdgeWeight, removeAllEdges, removeAllEdges, removeAllVertices, removeEdge, removeEdge, removeVertex, vertexSet

Constructor Detail

DirectedGraphUnion

public DirectedGraphUnion(DirectedGraph<V,E> g1,
                          DirectedGraph<V,E> g2,
                          WeightCombiner operator)

Construct a new directed graph union.

Parameters:

g1 - the first graph

g2 - the second graph

operator - the weight combiner (policy for edge weight calculation)

DirectedGraphUnion

public DirectedGraphUnion(DirectedGraph<V,E> g1,
                          DirectedGraph<V,E> g2)

Construct a new directed graph union. The union will use the WeightCombiner.SUM weight combiner.

Parameters:

g1 - the first graph

g2 - the second graph

Method Detail

inDegreeOf

public int inDegreeOf(V vertex)

Description copied from interface: DirectedGraph

Returns the "in degree" of the specified vertex. An in degree of a vertex in a directed graph is the number of inward directed edges from that vertex. See http://mathworld.wolfram.com/Indegree.html.

Specified by:

inDegreeOf in interface DirectedGraph<V,E>

Parameters:

vertex - vertex whose degree is to be calculated.

Returns:

the degree of the specified vertex.

incomingEdgesOf

public java.util.Set<E> incomingEdgesOf(V vertex)

Description copied from interface: DirectedGraph

Returns a set of all edges incoming into the specified vertex.

Specified by:

incomingEdgesOf in interface DirectedGraph<V,E>

Parameters:

vertex - the vertex for which the list of incoming edges to be returned.

Returns:

a set of all edges incoming into the specified vertex.

outDegreeOf

public int outDegreeOf(V vertex)

Description copied from interface: DirectedGraph

Returns the "out degree" of the specified vertex. An out degree of a vertex in a directed graph is the number of outward directed edges from that vertex. See http://mathworld.wolfram.com/Outdegree.html.

Specified by:

outDegreeOf in interface DirectedGraph<V,E>

Parameters:

vertex - vertex whose degree is to be calculated.

Returns:

the degree of the specified vertex.

outgoingEdgesOf

public java.util.Set<E> outgoingEdgesOf(V vertex)

Description copied from interface: DirectedGraph

Returns a set of all edges outgoing from the specified vertex.

Specified by:

outgoingEdgesOf in interface DirectedGraph<V,E>

Parameters:

vertex - the vertex for which the list of outgoing edges to be returned.

Returns:

a set of all edges outgoing from the specified vertex.