public class SimpleSparseVertex extends AbstractSparseVertex
Vertex
that resides in a
sparse graph which may contain both directed and undirected edges.
It does not support parallel edges.
This implementation stores hash tables that map the successors
of this vertex to its outgoing edges, and its predecessors to
its incoming edges. This enables an efficient implementation of
findEdge(Vertex)
, but causes the routines that
return the sets of neighbors and of incident edges to require
time proportional to the number of neighbors.
UserDataContainer.CopyAction
Modifier and Type | Field and Description |
---|---|
protected java.util.Map |
mNeighborsToEdges
A map of the vertices connected to this vertex by undirected
edges to the corresponding sets of edges.
|
protected java.util.Map |
mPredsToInEdges
A map of the predecessors of this vertex to the corresponding
sets of incoming edges.
|
protected java.util.Map |
mSuccsToOutEdges
A map of the successors of this vertex to the corresponding
sets of outgoing edges.
|
id, m_Graph
factory, udc_delegate
Constructor and Description |
---|
SimpleSparseVertex()
Creates a new instance of a vertex for inclusion in a
sparse graph.
|
Modifier and Type | Method and Description |
---|---|
protected void |
addNeighbor_internal(Edge e,
Vertex v)
Adds the specified edge
e and vertex v
to the internal data structures of this vertex. |
Edge |
findEdge(Vertex v)
Returns the edge that connects this vertex to the specified
vertex
v . |
java.util.Set |
findEdgeSet(Vertex v)
Returns the set of all edges that connect this vertex
with the specified vertex
v . |
protected java.util.Collection |
getEdges_internal()
Returns a set containing all the incident edges of this vertex.
|
java.util.Set |
getInEdges()
Returns the set of incoming edges of this vertex.
|
protected java.util.Collection |
getNeighbors_internal()
Returns a set of all neighbors attached to this vertex.
|
protected java.util.Map |
getNeighborsToEdges()
Returns a map from the successors of this vertex to its outgoing
edges.
|
java.util.Set |
getOutEdges()
Returns the set of outgoing edges of this vertex.
|
java.util.Set |
getPredecessors()
Returns the set of predecessors of this vertex.
|
protected java.util.Map |
getPredsToInEdges()
Returns a map from the predecessors of this vertex to its incoming
edges.
|
java.util.Set |
getSuccessors()
Returns the set of successors of this vertex.
|
protected java.util.Map |
getSuccsToOutEdges()
Returns a map from the successors of this vertex to its outgoing
edges.
|
int |
inDegree()
Returns the number of incoming edges that are incident to this
vertex.
|
protected void |
initialize()
Initializes the internal data structures of this vertex.
|
boolean |
isDest(Edge e)
Returns
true if this vertex is a destination of
the specified edge e , and false otherwise. |
boolean |
isPredecessorOf(Vertex v)
Returns
true if this vertex is a predecessor of
the specified vertex v , and false otherwise. |
boolean |
isSource(Edge e)
Returns
true if this vertex is a source of
the specified edge e , and false otherwise. |
boolean |
isSuccessorOf(Vertex v)
Returns
true if this vertex is a successor of
the specified vertex v , and false otherwise. |
int |
numPredecessors()
Returns the number of predecessors of this vertex.
|
int |
numSuccessors()
Returns the number of successors of this vertex.
|
int |
outDegree()
Returns the number of outgoing edges that are incident to this
vertex.
|
protected void |
removeNeighbor_internal(Edge e,
Vertex v)
Removes the specified edge
e and vertex v
from the internal data structures of this vertex. |
protected void |
setNeighborsToEdges(java.util.Map neighborsToEdges)
Sets this vertex's internal successor -> out-edge map to
the specified map
succsToOutEdges . |
protected void |
setPredsToInEdges(java.util.Map predsToInEdges)
Sets this vertex's internal predecessor -> in-edge map to
the specified map
predsToInEdges . |
protected void |
setSuccsToOutEdges(java.util.Map succsToOutEdges)
Sets this vertex's internal successor -> out-edge map to
the specified map
succsToOutEdges . |
copy, findEdge, findEdgeSet, toString
degree, equals, getEqualVertex, getEquivalentVertex, getIncidentEdges, getIncidentElements, getNeighbors, isIncident, isNeighborOf, numNeighbors
addGraph_internal, getGraph, hashCode, removeGraph_internal
addUserDatum, clone, containsUserDatumKey, getUserDatum, getUserDatumCopyAction, getUserDatumKeyIterator, importUserData, removeUserDatum, setUserDataFactory, setUserDatum
finalize, getClass, notify, notifyAll, wait, wait, wait
degree, getEqualVertex, getEquivalentVertex, getIncidentEdges, getNeighbors, isIncident, isNeighborOf, numNeighbors
getGraph, getIncidentElements
addUserDatum, clone, containsUserDatumKey, getUserDatum, getUserDatumCopyAction, getUserDatumKeyIterator, importUserData, removeUserDatum, setUserDatum
protected java.util.Map mPredsToInEdges
findEdge(Vertex)
.protected java.util.Map mSuccsToOutEdges
findEdge(Vertex)
.protected java.util.Map mNeighborsToEdges
findEdge(Vertex)
.public SimpleSparseVertex()
public java.util.Set getPredecessors()
Vertex
v
is a predecessor of this vertex if and only if
v.isPredecessorOf(this)
returns true
.
Each element of the set returned should implement Vertex
.Vertex.getPredecessors()
public java.util.Set getSuccessors()
Vertex
v
is a successor of this vertex if and only if
v.isSuccessorOf(this)
returns true
.
Each element of the set returned should implement Vertex
.Vertex.getSuccessors()
public int inDegree()
Vertex
Vertex.inDegree()
public int outDegree()
Vertex
Vertex.outDegree()
public int numPredecessors()
Vertex
Vertex.numPredecessors()
public int numSuccessors()
Vertex
Vertex.numSuccessors()
public boolean isSuccessorOf(Vertex v)
Vertex
true
if this vertex is a successor of
the specified vertex v
, and false
otherwise.
This vertex is a successor of v
if and only if
there exists an edge e
such that
v.isSource(e) == true
and
this.isDest(e) == true
.
The behavior of this method is undefined if v
is not
an element of this vertex's graph.Vertex.isSuccessorOf(Vertex)
public boolean isPredecessorOf(Vertex v)
Vertex
true
if this vertex is a predecessor of
the specified vertex v
, and false
otherwise.
This vertex is a predecessor of v
if and only if
there exists an edge e
such that
this.isSource(e) == true
and
v.isDest(e) == true
.
The behavior of this method is undefined if v
is not
an element of this vertex's graph.Vertex.isPredecessorOf(Vertex)
public boolean isSource(Edge e)
Vertex
true
if this vertex is a source of
the specified edge e
, and false
otherwise.
A vertex v
is a source of e
if e
is an outgoing edge of v
.
The behavior of this method is undefined if e
is not
an element of this vertex's graph.Vertex.isSource(Edge)
public boolean isDest(Edge e)
Vertex
true
if this vertex is a destination of
the specified edge e
, and false
otherwise.
A vertex v
is a destination of e
if e
is an incoming edge of v
.
The behavior of this method is undefined if e
is not
an element of this vertex's graph.Vertex.isDest(Edge)
public java.util.Set getInEdges()
Vertex
e
is an incoming edge of this vertex if and only if
this.isDest(e)
returns true
.
Each element of the set returned should implement Edge
.Vertex.getInEdges()
public java.util.Set getOutEdges()
Vertex
e
is an outgoing edge of this vertex if and only if
this.isSource(e)
returns true
.
Each element of the set returned should implement Edge
.Vertex.getOutEdges()
public Edge findEdge(Vertex v)
AbstractSparseVertex
v
. This is a
simple implementation which checks the opposite vertex of
each outgoing edge of this vertex; this solution is general,
but not efficient.findEdge
in interface Vertex
findEdge
in class AbstractSparseVertex
AbstractSparseVertex.findEdge(Vertex)
public java.util.Set findEdgeSet(Vertex v)
Vertex
v
. Each edge in this set
will be either a directed outgoing edge from this vertex to
v
, or an undirected edge connecting this vertex to
v
. findEdge(v)
may be used to return
a single (arbitrary) element of this set.
If v
is not connected to this vertex, returns an empty Set
.findEdgeSet
in interface Vertex
findEdgeSet
in class AbstractSparseVertex
AbstractSparseVertex.findEdgeSet(Vertex)
protected java.util.Collection getNeighbors_internal()
getNeighbors_internal
in class AbstractArchetypeVertex
AbstractArchetypeVertex.getNeighbors_internal()
protected java.util.Map getPredsToInEdges()
protected void setPredsToInEdges(java.util.Map predsToInEdges)
predsToInEdges
.
This method should not be directly accessed by users.protected java.util.Map getSuccsToOutEdges()
protected void setSuccsToOutEdges(java.util.Map succsToOutEdges)
succsToOutEdges
.
This method should not be directly accessed by users.protected java.util.Map getNeighborsToEdges()
protected void setNeighborsToEdges(java.util.Map neighborsToEdges)
succsToOutEdges
.
This method should not be directly accessed by users.protected void initialize()
initialize
in class AbstractElement
AbstractElement.initialize()
protected java.util.Collection getEdges_internal()
AbstractArchetypeVertex
getEdges_internal
in class AbstractArchetypeVertex
AbstractArchetypeVertex.getEdges_internal()
protected void addNeighbor_internal(Edge e, Vertex v)
AbstractSparseVertex
e
and vertex v
to the internal data structures of this vertex.addNeighbor_internal
in class AbstractSparseVertex
e
- the new incident edge of this vertexv
- the new neighbor of this vertexAbstractSparseVertex.addNeighbor_internal(edu.uci.ics.jung.graph.Edge, edu.uci.ics.jung.graph.Vertex)
protected void removeNeighbor_internal(Edge e, Vertex v)
AbstractSparseVertex
e
and vertex v
from the internal data structures of this vertex.removeNeighbor_internal
in class AbstractSparseVertex
e
- the incident edge of this vertex which is being removedv
- the neighbor of this vertex which is being removedAbstractSparseVertex.removeNeighbor_internal(edu.uci.ics.jung.graph.Edge, edu.uci.ics.jung.graph.Vertex)