org.jgrapht.graph

## Class AsGraphUnion<V,E>

• Type Parameters:
V - the vertex type
E - the edge type
All Implemented Interfaces:
Serializable, Graph<V,E>

public class AsGraphUnion<V,E>
extends AbstractGraph<V,E>
implements Serializable

Read-only union of two graphs: G1 and G2. If G1 = (V1, E1) and G2 = (V2, E2) then their union G = (V, E), where V is the union of V1 and V2, and E is the union of E1 and E1. A WeightCombiner in order to calculate edge weights.

Author:
Ilya Razenshteyn
Serialized Form

• ### Fields inherited from interface org.jgrapht.Graph

DEFAULT_EDGE_WEIGHT
• ### Constructor Summary

Constructors
Constructor and Description
AsGraphUnion(Graph<V,E> g1, Graph<V,E> g2)
Construct a new graph union.
AsGraphUnion(Graph<V,E> g1, Graph<V,E> g2, WeightCombiner operator)
Construct a new graph union.
• ### Method Summary

All Methods
Modifier and Type Method and Description
E addEdge(V sourceVertex, V targetVertex)
Creates a new edge in this graph, going from the source vertex to the target vertex, and returns the created edge.
boolean addEdge(V sourceVertex, V targetVertex, E e)
Adds the specified edge to this graph, going from the source vertex to the target vertex.
boolean addVertex(V v)
boolean containsEdge(E e)
Returns true if this graph contains the specified edge.
boolean containsVertex(V v)
Returns true if this graph contains the specified vertex.
int degreeOf(V vertex)
Returns the degree of the specified vertex.
Set<E> edgeSet()
Returns a set of the edges contained in this graph.
Set<E> edgesOf(V vertex)
Returns a set of all edges touching the specified vertex.
Set<E> getAllEdges(V sourceVertex, V targetVertex)
Returns a set of all edges connecting source vertex to target vertex if such vertices exist in this graph.
E getEdge(V sourceVertex, V targetVertex)
Returns an edge connecting source vertex to target vertex if such vertices and such edge exist in this graph.
EdgeFactory<V,E> getEdgeFactory()
Returns the edge factory using which this graph creates new edges.
V getEdgeSource(E e)
Returns the source vertex of an edge.
V getEdgeTarget(E e)
Returns the target vertex of an edge.
double getEdgeWeight(E e)
Returns the weight assigned to a given edge.
GraphType getType()
Get the graph type.
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.
Set<E> outgoingEdgesOf(V vertex)
Returns a set of all edges outgoing from the specified vertex.
boolean removeEdge(E e)
Removes the specified edge from the graph.
E removeEdge(V sourceVertex, V targetVertex)
Removes an edge going from source vertex to target vertex, if such vertices and such edge exist in this graph.
boolean removeVertex(V v)
Removes the specified vertex from this graph including all its touching edges if present.
void setEdgeWeight(E e, double weight)
Throws UnsupportedOperationException since graph union is read-only.
Set<V> vertexSet()
Returns a set of the vertices contained in this graph.
• ### Methods inherited from class org.jgrapht.graph.AbstractGraph

assertVertexExist, containsEdge, equals, hashCode, removeAllEdges, removeAllEdges, removeAllEdges, removeAllVertices, toString, toStringFromSets
• ### Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait
• ### Constructor Detail

• #### AsGraphUnion

public AsGraphUnion(Graph<V,E> g1,
Graph<V,E> g2,
WeightCombiner operator)
Construct a new graph union.
Parameters:
g1 - the first graph
g2 - the second graph
operator - the weight combiner (policy for edge weight calculation)
• #### AsGraphUnion

public AsGraphUnion(Graph<V,E> g1,
Graph<V,E> g2)
Construct a new graph union. The union will use the WeightCombiner.SUM weight combiner.
Parameters:
g1 - the first graph
g2 - the second graph
• ### Method Detail

• #### getAllEdges

public Set<E> getAllEdges(V sourceVertex,
V targetVertex)
Returns a set of all edges connecting source vertex to target vertex if such vertices exist in this graph. If any of the vertices does not exist or is null, returns null. If both vertices exist but no edges found, returns an empty set.

In undirected graphs, some of the returned edges may have their source and target vertices in the opposite order. In simple graphs the returned set is either singleton set or empty set.

Specified by:
getAllEdges in interface Graph<V,E>
Parameters:
sourceVertex - source vertex of the edge.
targetVertex - target vertex of the edge.
Returns:
a set of all edges connecting source vertex to target vertex.
• #### getEdge

public E getEdge(V sourceVertex,
V targetVertex)
Returns an edge connecting source vertex to target vertex if such vertices and such edge exist in this graph. Otherwise returns  null. If any of the specified vertices is null returns null

In undirected graphs, the returned edge may have its source and target vertices in the opposite order.

Specified by:
getEdge in interface Graph<V,E>
Parameters:
sourceVertex - source vertex of the edge.
targetVertex - target vertex of the edge.
Returns:
an edge connecting source vertex to target vertex.
• #### getEdgeFactory

public EdgeFactory<V,E> getEdgeFactory()
Returns the edge factory using which this graph creates new edges. The edge factory is defined when the graph is constructed and must not be modified.
Specified by:
getEdgeFactory in interface Graph<V,E>
Returns:
the edge factory using which this graph creates new edges.
Throws:
UnsupportedOperationException - always, since operation is unsupported

public E addEdge(V sourceVertex,
V targetVertex)
Creates a new edge in this graph, going from the source vertex to the target vertex, and returns the created edge. Some graphs do not allow edge-multiplicity. In such cases, if the graph already contains an edge from the specified source to the specified target, than this method does not change the graph and returns null.

The source and target vertices must already be contained in this graph. If they are not found in graph IllegalArgumentException is thrown.

This method creates the new edge e using this graph's EdgeFactory. For the new edge to be added e must not be equal to any other edge the graph (even if the graph allows edge-multiplicity). More formally, the graph must not contain any edge e2 such that e2.equals(e). If such  e2 is found then the newly created edge e is abandoned, the method leaves this graph unchanged returns  null.

Specified by:
addEdge in interface Graph<V,E>
Parameters:
sourceVertex - source vertex of the edge.
targetVertex - target vertex of the edge.
Returns:
The newly created edge if added to the graph, otherwise  null.
Throws:
UnsupportedOperationException - always, since operation is unsupported
Graph.getEdgeFactory()

public boolean addEdge(V sourceVertex,
V targetVertex,
E e)
Adds the specified edge to this graph, going from the source vertex to the target vertex. More formally, adds the specified edge,  e, to this graph if this graph contains no edge e2 such that e2.equals(e). If this graph already contains such an edge, the call leaves this graph unchanged and returns false. Some graphs do not allow edge-multiplicity. In such cases, if the graph already contains an edge from the specified source to the specified target, than this method does not change the graph and returns  false. If the edge was added to the graph, returns  true.

The source and target vertices must already be contained in this graph. If they are not found in graph IllegalArgumentException is thrown.

Specified by:
addEdge in interface Graph<V,E>
Parameters:
sourceVertex - source vertex of the edge.
targetVertex - target vertex of the edge.
e - edge to be added to this graph.
Returns:
true if this graph did not already contain the specified edge.
Throws:
UnsupportedOperationException - always, since operation is unsupported
Graph.addEdge(Object, Object), Graph.getEdgeFactory()

public boolean addVertex(V v)
Adds the specified vertex to this graph if not already present. More formally, adds the specified vertex, v, to this graph if this graph contains no vertex u such that  u.equals(v). If this graph already contains such vertex, the call leaves this graph unchanged and returns false. In combination with the restriction on constructors, this ensures that graphs never contain duplicate vertices.
Specified by:
addVertex in interface Graph<V,E>
Parameters:
v - vertex to be added to this graph.
Returns:
true if this graph did not already contain the specified vertex.
Throws:
UnsupportedOperationException - always, since operation is unsupported
• #### containsEdge

public boolean containsEdge(E e)
Returns true if this graph contains the specified edge. More formally, returns true if and only if this graph contains an edge e2 such that e.equals(e2). If the specified edge is null returns false.
Specified by:
containsEdge in interface Graph<V,E>
Parameters:
e - edge whose presence in this graph is to be tested.
Returns:
true if this graph contains the specified edge.
• #### containsVertex

public boolean containsVertex(V v)
Returns true if this graph contains the specified vertex. More formally, returns true if and only if this graph contains a vertex u such that u.equals(v). If the specified vertex is null returns false.
Specified by:
containsVertex in interface Graph<V,E>
Parameters:
v - vertex whose presence in this graph is to be tested.
Returns:
true if this graph contains the specified vertex.
• #### edgeSet

public Set<E> edgeSet()
Returns a set of the edges contained in this graph. The set is backed by the graph, so changes to the graph are reflected in the set. If the graph is modified while an iteration over the set is in progress, the results of the iteration are undefined.

The graph implementation may maintain a particular set ordering (e.g. via LinkedHashSet) for deterministic iteration, but this is not required. It is the responsibility of callers who rely on this behavior to only use graph implementations which support it.

Note that this operation might by expensive as it involves copying the edge sets of the two underlying graphs.

Specified by:
edgeSet in interface Graph<V,E>
Returns:
a set of the edges contained in this graph.
• #### edgesOf

public Set<E> edgesOf(V vertex)
Returns a set of all edges touching the specified vertex. If no edges are touching the specified vertex returns an empty set.

Note that this operation might by expensive as it involves copying the edge sets of the two underlying graphs.

Specified by:
edgesOf in interface Graph<V,E>
Parameters:
vertex - the vertex for which a set of touching edges is to be returned.
Returns:
a set of all edges touching the specified vertex.
• #### incomingEdgesOf

public Set<E> incomingEdgesOf(V vertex)
Returns a set of all edges incoming into the specified vertex.

In the case of undirected graphs this method returns all edges touching the vertex, thus, some of the returned edges may have their source and target vertices in the opposite order.

Note that this operation might by expensive as it involves copying the edge sets of the two underlying graphs.

Specified by:
incomingEdgesOf in interface Graph<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.
• #### outgoingEdgesOf

public Set<E> outgoingEdgesOf(V vertex)
Returns a set of all edges outgoing from the specified vertex.

In the case of undirected graphs this method returns all edges touching the vertex, thus, some of the returned edges may have their source and target vertices in the opposite order.

Note that this operation might by expensive as it involves copying the edge sets of the two underlying graphs.

Specified by:
outgoingEdgesOf in interface Graph<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.
• #### degreeOf

public int degreeOf(V vertex)
Returns the degree of the specified vertex.

A degree of a vertex in an undirected graph is the number of edges touching that vertex. Edges with same source and target vertices (self-loops) are counted twice.

In directed graphs this method returns the sum of the "in degree" and the "out degree".

Specified by:
degreeOf in interface Graph<V,E>
Parameters:
vertex - vertex whose degree is to be calculated.
Returns:
the degree of the specified vertex.
• #### inDegreeOf

public int inDegreeOf(V vertex)
Returns the "in degree" of the specified vertex.

The "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.

In the case of undirected graphs this method returns the number of edges touching the vertex. Edges with same source and target vertices (self-loops) are counted twice.

Specified by:
inDegreeOf in interface Graph<V,E>
Parameters:
vertex - vertex whose degree is to be calculated.
Returns:
the degree of the specified vertex.
• #### outDegreeOf

public int outDegreeOf(V vertex)
Returns the "out degree" of the specified vertex.

The "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.

In the case of undirected graphs this method returns the number of edges touching the vertex. Edges with same source and target vertices (self-loops) are counted twice.

Specified by:
outDegreeOf in interface Graph<V,E>
Parameters:
vertex - vertex whose degree is to be calculated.
Returns:
the degree of the specified vertex.
• #### removeEdge

public E removeEdge(V sourceVertex,
V targetVertex)
Removes an edge going from source vertex to target vertex, if such vertices and such edge exist in this graph. Returns the edge if removed or null otherwise.
Specified by:
removeEdge in interface Graph<V,E>
Parameters:
sourceVertex - source vertex of the edge.
targetVertex - target vertex of the edge.
Returns:
The removed edge, or null if no edge removed.
Throws:
UnsupportedOperationException - always, since operation is unsupported
• #### removeEdge

public boolean removeEdge(E e)
Removes the specified edge from the graph. Removes the specified edge from this graph if it is present. More formally, removes an edge  e2 such that e2.equals(e), if the graph contains such edge. Returns true if the graph contained the specified edge. (The graph will not contain the specified edge once the call returns).

If the specified edge is null returns  false.

Specified by:
removeEdge in interface Graph<V,E>
Parameters:
e - edge to be removed from this graph, if present.
Returns:
true if and only if the graph contained the specified edge.
Throws:
UnsupportedOperationException - always, since operation is unsupported
• #### removeVertex

public boolean removeVertex(V v)
Removes the specified vertex from this graph including all its touching edges if present. More formally, if the graph contains a vertex  u such that u.equals(v), the call removes all edges that touch u and then removes u itself. If no such u is found, the call leaves the graph unchanged. Returns true if the graph contained the specified vertex. (The graph will not contain the specified vertex once the call returns).

If the specified vertex is null returns  false.

Specified by:
removeVertex in interface Graph<V,E>
Parameters:
v - vertex to be removed from this graph, if present.
Returns:
true if the graph contained the specified vertex; false otherwise.
Throws:
UnsupportedOperationException - always, since operation is unsupported
• #### vertexSet

public Set<V> vertexSet()
Returns a set of the vertices contained in this graph. The set is backed by the graph, so changes to the graph are reflected in the set. If the graph is modified while an iteration over the set is in progress, the results of the iteration are undefined.

The graph implementation may maintain a particular set ordering (e.g. via LinkedHashSet) for deterministic iteration, but this is not required. It is the responsibility of callers who rely on this behavior to only use graph implementations which support it.

Note that this operation might by expensive as it currently involves copying the vertex sets of the two underlying graphs.

Specified by:
vertexSet in interface Graph<V,E>
Returns:
a set view of the vertices contained in this graph.
• #### getEdgeSource

public V getEdgeSource(E e)
Returns the source vertex of an edge. For an undirected graph, source and target are distinguishable designations (but without any mathematical meaning).
Specified by:
getEdgeSource in interface Graph<V,E>
Parameters:
e - edge of interest
Returns:
source vertex
• #### getEdgeTarget

public V getEdgeTarget(E e)
Returns the target vertex of an edge. For an undirected graph, source and target are distinguishable designations (but without any mathematical meaning).
Specified by:
getEdgeTarget in interface Graph<V,E>
Parameters:
e - edge of interest
Returns:
target vertex
• #### getEdgeWeight

public double getEdgeWeight(E e)
Returns the weight assigned to a given edge. Unweighted graphs return 1.0 (as defined by Graph.DEFAULT_EDGE_WEIGHT), allowing weighted-graph algorithms to apply to them when meaningful.
Specified by:
getEdgeWeight in interface Graph<V,E>
Parameters:
e - edge of interest
Returns:
edge weight
• #### getType

public GraphType getType()
Get the graph type. The graph type can be used to query for additional metadata such as whether the graph supports directed or undirected edges, self-loops, parallel-edges, weights, etc.
Specified by:
getType in interface Graph<V,E>
Returns:
the graph type
• #### setEdgeWeight

public void setEdgeWeight(E e,
double weight)
Throws UnsupportedOperationException since graph union is read-only.
Specified by:
setEdgeWeight in interface Graph<V,E>
Parameters:
e - edge on which to set weight
weight - new weight for edge