broadwick.graph
Class UndirectedGraph<V extends Vertex,E extends Edge<V>>
V - the vertex type.E - the edge type.public class UndirectedGraph<V extends Vertex,E extends Edge<V>> extends Object implements Graph<V,E>
DirectedGraph, suitable for sparse graphs, that permits parallel edges..
The implementation here is backed by the DelegateTree implementation in the JUNG library.| Modifier and Type | Field and Description |
|---|---|
private Collection<EdgeAttribute> |
edgeAttributes |
private HashMap<String,E> |
edgemaps |
private edu.uci.ics.jung.graph.UndirectedSparseMultigraph<V,E> |
graph |
private Collection<VertexAttribute> |
vertexAttributes |
private HashMap<String,V> |
vertexmaps |
| Constructor and Description |
|---|
UndirectedGraph()
Creates an instance of the graph.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
addEdge(E e,
V v1,
V v2)
Adds edge
e to this graph such that it connects vertex
v1 to
v2. |
boolean |
addEdge(E e,
V v1,
V v2,
EdgeType edgeType)
Adds edge
e to this graph such that it connects vertex
v1 to
v2. |
void |
addEdgeAttribute(String name,
Class type,
String defaultValue)
Add a new node attribute to the network.
|
boolean |
addVertex(V vertex)
Adds a vertex to the graph.
|
void |
addVertexAttribute(String name,
Class type,
String defaultValue)
Add a new node attribute to the network.
|
protected void |
finalize() |
V |
getDest(E directedEdge)
If
directed_edge is a directed edge in this graph, returns the destination; otherwise returns
null. |
E |
getEdge(String id)
Returns a view the edges in this graph with the given id.
|
Collection<E> |
getEdges()
Returns a view of all edges in this graph.
|
EdgeType |
getEdgeType()
Get the type of edge (directed/undirected employed in the graph.
|
Pair<V,V> |
getEndpoints(E edge)
Returns the endpoints of
edge as a
Pair. |
Collection<E> |
getInEdges(V vertex)
Returns a
Collection view of the incoming edges incident to
vertex in this graph. |
V |
getOpposite(V vertex,
E edge)
Returns the vertex at the other end of
edge from
vertex. |
Collection<E> |
getOutEdges(V vertex)
Returns a
Collection view of the outgoing edges incident to
vertex in this graph. |
int |
getPredecessorCount(V vertex)
Returns the number of predecessors that
vertex has in this graph. |
Collection<V> |
getPredecessors(V vertex)
Returns a
Collection view of the predecessors of
vertex in this graph. |
V |
getSource(E directedEdge)
If
directed_edge is a directed edge in this graph, returns the source; otherwise returns
null. |
int |
getSuccessorCount(V vertex)
Returns the number of successors that
vertex has in this graph. |
Collection<V> |
getSuccessors(V vertex)
Returns a
Collection view of the successors of
vertex in this graph. |
V |
getVertex(String id)
Returns a view the vertex in this graph with a given id.Returns null if the edge does not exist.
|
int |
getVertexCount()
Returns the number of vertices in this graph.
|
Collection<V> |
getVertices()
Returns a view of all vertices in this graph.
|
int |
inDegree(V vertex)
Returns the number of incoming edges incident to
vertex. |
boolean |
isDest(V vertex,
E edge)
Returns
true if
vertex is the destination of
edge. |
boolean |
isPredecessor(V v1,
V v2)
Returns
true if
v1 is a predecessor of
v2 in this graph. |
boolean |
isSource(V vertex,
E edge)
Returns
true if
vertex is the source of
edge. |
boolean |
isSuccessor(V v1,
V v2)
Returns
true if
v1 is a successor of
v2 in this graph. |
int |
outDegree(V vertex)
Returns the number of outgoing edges incident to
vertex. |
boolean |
removeEdge(E edge)
Removes
edge from this graph. |
boolean |
removeVertex(V vertex)
Remove the passed node, and, in the case of a tree, all nodes that are descendants of the passed node.
|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetEdgeAttributes, getVertexAttributesprivate final Collection<VertexAttribute> vertexAttributes
private final Collection<EdgeAttribute> edgeAttributes
private final edu.uci.ics.jung.graph.UndirectedSparseMultigraph<V extends Vertex,E extends Edge<V>> graph
public final Collection<E> getInEdges(V vertex)
GraphCollection view of the incoming edges incident to
vertex in this graph.public final Collection<E> getOutEdges(V vertex)
GraphCollection view of the outgoing edges incident to
vertex in this graph.public final Collection<V> getPredecessors(V vertex)
GraphCollection view of the predecessors of
vertex in this graph. A predecessor of
vertex is defined as a vertex
v which is connected to
vertex by an edge
e, where
e is an outgoing edge of
v and an incoming edge of
vertex.public final Collection<V> getSuccessors(V vertex)
GraphCollection view of the successors of
vertex in this graph. A successor of
vertex is defined as a vertex
v which is connected to
vertex by an edge
e, where
e is an incoming edge of
v and an outgoing edge of
vertex.public final int inDegree(V vertex)
Graphvertex. Equivalent to
getInEdges(vertex).size().public final int outDegree(V vertex)
Graphvertex. Equivalent to
getOutEdges(vertex).size().public final boolean isPredecessor(V v1, V v2)
Graphtrue if
v1 is a predecessor of
v2 in this graph. Equivalent to
v1.getPredecessors().contains(v2).public final boolean isSuccessor(V v1, V v2)
Graphtrue if
v1 is a successor of
v2 in this graph. Equivalent to
v1.getSuccessors().contains(v2).public final int getPredecessorCount(V vertex)
Graphvertex has in this graph. Equivalent to
vertex.getPredecessors().size().public final int getSuccessorCount(V vertex)
Graphvertex has in this graph. Equivalent to
vertex.getSuccessors().size().public final V getSource(E directedEdge)
Graphdirected_edge is a directed edge in this graph, returns the source; otherwise returns
null. The source of a directed edge
d is defined to be the vertex for which
d is an outgoing edge.
directed_edge is guaranteed to be a directed edge if its
EdgeType is
DIRECTED.public final V getDest(E directedEdge)
Graphdirected_edge is a directed edge in this graph, returns the destination; otherwise returns
null. The destination of a directed edge
d is defined to be the vertex incident to
d for which
d is an incoming edge.
directed_edge is guaranteed to be a directed edge if its
EdgeType is
DIRECTED.public final boolean isSource(V vertex, E edge)
Graphtrue if
vertex is the source of
edge. Equivalent to
getSource(edge).equals(vertex).public final boolean isDest(V vertex, E edge)
Graphtrue if
vertex is the destination of
edge. Equivalent to
getDest(edge).equals(vertex).public final boolean addVertex(V vertex)
Graphpublic final boolean addEdge(E e, V v1, V v2)
Graphe to this graph such that it connects vertex
v1 to
v2. Equivalent to
addEdge(e, new Pair(v1, v2)) . If this graph does not contain
v1,
v2, or both, implementations may choose to either silently add the vertices to the graph or throw an
IllegalArgumentException. If this graph assigns edge types to its edges, the edge type of
e will be the default for this graph. See
Hypergraph.addEdge() for a listing of possible reasons for failure.addEdge in interface Graph<V extends Vertex,E extends Edge<V>>e - the edge to be addedv1 - the first vertex to be connectedv2 - the second vertex to be connectedtrue if the add is successful, false otherwiseHypergraph#addEdge(Object, Collection),
#addEdge(Object, Object, Object, EdgeType)public final boolean addEdge(E e, V v1, V v2, EdgeType edgeType)
Graphe to this graph such that it connects vertex
v1 to
v2. Equivalent to
addEdge(e, new Pair(v1, v2)) . If this graph does not contain
v1,
v2, or both, implementations may choose to either silently add the vertices to the graph or throw an
IllegalArgumentException. If
edgeType is not legal for this graph, this method will throw
IllegalArgumentException. See
Hypergraph.addEdge() for a listing of possible reasons for failure.addEdge in interface Graph<V extends Vertex,E extends Edge<V>>e - the edge to be addedv1 - the first vertex to be connectedv2 - the second vertex to be connectededgeType - the type to be assigned to the edgetrue if the add is successful, false otherwiseHypergraph#addEdge(Object, Collection),
#addEdge(Object, Object, Object)public final Pair<V,V> getEndpoints(E edge)
Graphedge as a
Pair.public final V getOpposite(V vertex, E edge)
Graphedge from
vertex. (That is, returns the vertex incident to
edge which is not
vertex.)public final int getVertexCount()
Graphpublic final Collection<V> getVertices()
GraphCollection contract, and therefore makes no guarantees about the ordering of the vertices within the
set.public final V getVertex(String id)
Graphpublic final E getEdge(String id)
Graphpublic final Collection<E> getEdges()
GraphCollection contract, and therefore makes no guarantees about the ordering of the edges within the
set.public final boolean removeVertex(V vertex)
Graphpublic final boolean removeEdge(E edge)
Graphedge from this graph.
Fails if edge is null, or is otherwise not an element of this graph.public final EdgeType getEdgeType()
Graphpublic final void addVertexAttribute(String name, Class type, String defaultValue)
Graphpublic final void addEdgeAttribute(String name, Class type, String defaultValue)
GraphCopyright © 2015 University of Glasgow. All rights reserved.