org.jgrapht.graph

Class UndirectedSubgraph<V,E>

java.lang.Object

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

org.jgrapht.graph.Subgraph<V,E,UndirectedGraph<V,E>>

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

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

Serializable, Graph<V,E>, UndirectedGraph<V,E>

Direct Known Subclasses:

UndirectedWeightedSubgraph

public class UndirectedSubgraph<V,E>
extends Subgraph<V,E,UndirectedGraph<V,E>>
implements UndirectedGraph<V,E>

An undirected graph that is a subgraph of another graph.

See Also:

Subgraph, Serialized Form

Field Summary

Fields inherited from class org.jgrapht.graph.Subgraph

base, edgeSet, isInduced, vertexSet

Constructor Summary

Constructors

Constructor and Description
UndirectedSubgraph(UndirectedGraph<V,E> base) Creates a new undirected induced subgraph with all vertices included.
UndirectedSubgraph(UndirectedGraph<V,E> base, Set<? extends V> vertexSubset) Creates a new undirected induced subgraph.
UndirectedSubgraph(UndirectedGraph<V,E> base, Set<? extends V> vertexSubset, Set<? extends E> edgeSubset) Creates a new undirected subgraph.

Method Summary

Modifier and Type	Method and Description
int	degreeOf(V vertex) Returns the degree of the specified vertex.

Methods inherited from class org.jgrapht.graph.Subgraph

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

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

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

UndirectedSubgraph

public UndirectedSubgraph(UndirectedGraph<V,E> base,
                          Set<? extends V> vertexSubset,
                          Set<? extends E> edgeSubset)

Creates a new undirected subgraph.

Parameters:

base - the base (backing) graph on which the subgraph will be based.

vertexSubset - vertices to include in the subgraph. If null then all vertices are included.

edgeSubset - edges to in include in the subgraph. If null then all the edges whose vertices found in the graph are included.

UndirectedSubgraph

public UndirectedSubgraph(UndirectedGraph<V,E> base,
                          Set<? extends V> vertexSubset)

Creates a new undirected induced subgraph.

Parameters:

base - the base (backing) graph on which the subgraph will be based.

vertexSubset - vertices to include in the subgraph. If null then all vertices are included.

UndirectedSubgraph

public UndirectedSubgraph(UndirectedGraph<V,E> base)

Creates a new undirected induced subgraph with all vertices included.

Parameters:

base - the base (backing) graph on which the subgraph will be based.

Method Detail

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.

Specified by:

degreeOf in interface UndirectedGraph<V,E>

Parameters:

vertex - vertex whose degree is to be calculated.

Returns:

the degree of the specified vertex.