|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg._3pq.jgrapht.graph.AbstractGraph
org._3pq.jgrapht.graph.GraphDelegator
org._3pq.jgrapht.graph.AsUndirectedGraph
public class AsUndirectedGraph
An undirected view of the backing directed graph specified in the
constructor. This graph allows modules to apply algorithms designed for
undirected graphs to a directed graph by simply ignoring edge direction. If
the backing directed graph is an oriented graph,
then the view will be a simple graph; otherwise, it will be a multigraph.
Query operations on this graph "read through" to the backing graph.
Attempts to add edges will result in an
UnsupportedOperationException, but vertex addition/removal and
edge removal are all supported (and immediately reflected in the backing
graph).
Note that edges returned by this graph's accessors are really just the edges of the underlying directed graph. Since there is no interface distinction between directed and undirected edges, this detail should be irrelevant to algorithms.
This graph does not pass the hashCode and equals operations through to the backing graph, but relies on Object's equals and hashCode methods. This graph will be serializable if the backing graph is serializable.
| Constructor Summary | |
|---|---|
AsUndirectedGraph(DirectedGraph g)
Constructor for AsUndirectedGraph. |
|
| Method Summary | |
|---|---|
boolean |
addAllEdges(java.util.Collection edges)
Adds all of the specified edges to this graph. |
boolean |
addEdge(Edge e)
Adds the specified edge to this graph. |
Edge |
addEdge(java.lang.Object sourceVertex,
java.lang.Object targetVertex)
Creates a new edge in this graph, going from the source vertex to the target vertex, and returns the created edge. |
int |
degreeOf(java.lang.Object vertex)
Returns the degree of the specified vertex. |
java.util.List |
getAllEdges(java.lang.Object sourceVertex,
java.lang.Object targetVertex)
Returns a list of all edges connecting source vertex to target vertex if such vertices exist in this graph. |
Edge |
getEdge(java.lang.Object sourceVertex,
java.lang.Object targetVertex)
Returns an edge connecting source vertex to target vertex if such vertices and such edge exist in this graph. |
java.util.List |
incomingEdgesOf(java.lang.Object vertex)
|
int |
inDegreeOf(java.lang.Object vertex)
|
int |
outDegreeOf(java.lang.Object vertex)
|
java.util.List |
outgoingEdgesOf(java.lang.Object vertex)
|
java.lang.String |
toString()
Returns a string of the parenthesized pair (V, E) representing this G=(V,E) graph. |
| Methods inherited from class org._3pq.jgrapht.graph.GraphDelegator |
|---|
addVertex, containsEdge, containsVertex, edgeSet, edgesOf, getEdgeFactory, removeEdge, removeEdge, removeVertex, vertexSet |
| Methods inherited from class org._3pq.jgrapht.graph.AbstractGraph |
|---|
addAllVertices, assertVertexExist, containsEdge, removeAllEdges, removeAllEdges, removeAllEdges, removeAllVertices, toStringFromSets |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org._3pq.jgrapht.Graph |
|---|
addAllVertices, addVertex, containsEdge, containsEdge, containsVertex, edgeSet, edgesOf, getEdgeFactory, removeAllEdges, removeAllEdges, removeAllVertices, removeEdge, removeEdge, removeVertex, vertexSet |
| Constructor Detail |
|---|
public AsUndirectedGraph(DirectedGraph g)
g - the backing directed graph over which an undirected view is to
be created.| Method Detail |
|---|
public java.util.List getAllEdges(java.lang.Object sourceVertex,
java.lang.Object targetVertex)
Graphnull, returns null. If both
vertices exist but no edges found, returns an empty list.
In undirected graphs, some of the returned edges may have their source and target vertices in the opposite order. In simple graphs the returned list is either singleton list or empty list.
getAllEdges in interface GraphgetAllEdges in class GraphDelegatorsourceVertex - source vertex of the edge.targetVertex - target vertex of the edge.
Graph.getAllEdges(Object, Object)
public Edge getEdge(java.lang.Object sourceVertex,
java.lang.Object targetVertex)
Graphnull. 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.
getEdge in interface GraphgetEdge in class GraphDelegatorsourceVertex - source vertex of the edge.targetVertex - target vertex of the edge.
Graph.getEdge(Object, Object)public boolean addAllEdges(java.util.Collection edges)
GraphGraph.addEdge(Edge) method.
addAllEdges in interface GraphaddAllEdges in class AbstractGraphedges - the edges to be added to this graph.
Graph.addAllEdges(Collection)public boolean addEdge(Edge e)
Graphe, to this graph if this graph contains no edge
e2 such that e2.equals(e). If this graph
already contains such edge, the call leaves this graph unchanged and
returns false. If the edge was added to the graph, returns
true.
Some graphs do not allow edge-multiplicity. In such cases, if the graph
already contains an edge going from e.getSource() vertex
to e.getTarget() vertex, than this method does not change
the graph and returns false.
The source and target vertices of the specified edge must already be in this graph. If this is not the case, IllegalArgumentException is thrown. The edge must also be assignment compatible with the class of the edges produced by the edge factory of this graph. If this is not the case ClassCastException is thrown.
addEdge in interface GraphaddEdge in class GraphDelegatore - edge to be added to this graph.
Graph.addEdge(Edge)
public Edge addEdge(java.lang.Object sourceVertex,
java.lang.Object targetVertex)
Graphnull.
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.
addEdge in interface GraphaddEdge in class GraphDelegatorsourceVertex - source vertex of the edge.targetVertex - target vertex of the edge.
null.Graph.addEdge(Object, Object)public int degreeOf(java.lang.Object vertex)
UndirectedGraph
degreeOf in interface UndirectedGraphdegreeOf in class GraphDelegatorvertex - vertex whose degree is to be calculated.
UndirectedGraph.degreeOf(Object)public int inDegreeOf(java.lang.Object vertex)
inDegreeOf in class GraphDelegatorDirectedGraph.inDegreeOf(Object)public java.util.List incomingEdgesOf(java.lang.Object vertex)
incomingEdgesOf in class GraphDelegatorDirectedGraph.incomingEdgesOf(Object)public int outDegreeOf(java.lang.Object vertex)
outDegreeOf in class GraphDelegatorDirectedGraph.outDegreeOf(Object)public java.util.List outgoingEdgesOf(java.lang.Object vertex)
outgoingEdgesOf in class GraphDelegatorDirectedGraph.outgoingEdgesOf(Object)public java.lang.String toString()
AbstractGraph
toString in class GraphDelegatorAbstractGraph.toString()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||