Class AggregateGraph<V,E>
java.lang.Object
edu.uci.ics.jung.visualization.spatial.AggregateGraph<V,E>
- All Implemented Interfaces:
Graph<V,E>, Hypergraph<V, E>
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanaddEdge(E edge, Collection<? extends V> vertices) Addsedgeto this graph.booleanaddEdge(E edge, Collection<? extends V> vertices, EdgeType edgeType) Addsedgeto this graph with typeedge_type.booleanAdds edgeeto this graph such that it connects vertexv1tov2.booleanAdds edgeeto this graph such that it connects vertexv1tov2.booleanAddsvertexto this graph.booleancontainsEdge(E edge) Returns true if this graph's edge collection containsedge.booleancontainsVertex(V vertex) Returns true if this graph's vertex collection containsvertex.intReturns the number of edges incident tovertex.Returns an edge that connects this vertex tov.findEdgeSet(V v1, V v2) Returns all edges that connects this vertex tov.Returns the default edge type for this graph.Ifdirected_edgeis a directed edge in this graph, returns the destination; otherwise returnsnull.intReturns the number of edges in this graph.intgetEdgeCount(EdgeType edgeType) Returns the number of edges of typeedge_typein this graph.getEdges()Returns a view of all edges in this graph.Returns the collection of edges in this graph which are of typeedge_type.getEdgeType(E edge) Returns the edge type ofedgein this graph.getEndpoints(E edge) Returns the endpoints ofedgeas aPair.intgetIncidentCount(E edge) Returns the number of vertices that are incident toedge.getIncidentEdges(V vertex) Returns the collection of edges in this graph which are connected tovertex.getIncidentVertices(E edge) Returns the collection of vertices in this graph which are connected toedge.getInEdges(V vertex) Returns aCollectionview of the incoming edges incident tovertexin this graph.intgetNeighborCount(V vertex) Returns the number of vertices that are adjacent tovertex(that is, the number of vertices that are incident to edges invertex's incident edge set).getNeighbors(V vertex) Returns the collection of vertices which are connected tovertexvia any edges in this graph.getOpposite(V vertex, E edge) Returns the vertex at the other end ofedgefromvertex.getOutEdges(V vertex) Returns aCollectionview of the outgoing edges incident tovertexin this graph.intgetPredecessorCount(V vertex) Returns the number of predecessors thatvertexhas in this graph.getPredecessors(V vertex) Returns aCollectionview of the predecessors ofvertexin this graph.Ifdirected_edgeis a directed edge in this graph, returns the source; otherwise returnsnull.intgetSuccessorCount(V vertex) Returns the number of successors thatvertexhas in this graph.getSuccessors(V vertex) Returns aCollectionview of the successors ofvertexin this graph.intReturns the number of vertices in this graph.Returns a view of all vertices in this graph.intReturns the number of incoming edges incident tovertex.booleanReturnstrueifvertexis the destination ofedge.booleanisIncident(V vertex, E edge) Returnstrueifvertexandedgeare incident to each other.booleanisNeighbor(V v1, V v2) Returnstrueifv1andv2share an incident edge.booleanisPredecessor(V v1, V v2) Returnstrueifv1is a predecessor ofv2in this graph.booleanReturnstrueifvertexis the source ofedge.booleanisSuccessor(V v1, V v2) Returnstrueifv1is a successor ofv2in this graph.intReturns the number of outgoing edges incident tovertex.booleanremoveEdge(E edge) Removesedgefrom this graph.booleanremoveVertex(V vertex) Removesvertexfrom this graph.
-
Constructor Details
-
AggregateGraph
public AggregateGraph()
-
-
Method Details
-
addEdge
Description copied from interface:GraphAdds edgeeto this graph such that it connects vertexv1tov2. Equivalent toaddEdge(e, new Pair(v1, v2)). If this graph does not containv1,v2, or both, implementations may choose to either silently add the vertices to the graph or throw anIllegalArgumentException. If this graph assigns edge types to its edges, the edge type ofewill be the default for this graph. SeeHypergraph.addEdge()for a listing of possible reasons for failure. -
addEdge
Description copied from interface:GraphAdds edgeeto this graph such that it connects vertexv1tov2. Equivalent toaddEdge(e, new Pair(v1, v2)). If this graph does not containv1,v2, or both, implementations may choose to either silently add the vertices to the graph or throw anIllegalArgumentException. IfedgeTypeis not legal for this graph, this method will throwIllegalArgumentException. SeeHypergraph.addEdge()for a listing of possible reasons for failure. -
getDest
Description copied from interface:GraphIfdirected_edgeis a directed edge in this graph, returns the destination; otherwise returnsnull. The destination of a directed edgedis defined to be the vertex incident todfor whichdis an incoming edge.directed_edgeis guaranteed to be a directed edge if itsEdgeTypeisDIRECTED. -
getEndpoints
-
getInEdges
Description copied from interface:GraphReturns aCollectionview of the incoming edges incident tovertexin this graph.- Specified by:
getInEdgesin interfaceGraph<V,E> - Specified by:
getInEdgesin interfaceHypergraph<V,E> - Parameters:
vertex- the vertex whose incoming edges are to be returned- Returns:
- a
Collectionview of the incoming edges incident tovertexin this graph
-
getOpposite
Description copied from interface:GraphReturns the vertex at the other end ofedgefromvertex. (That is, returns the vertex incident toedgewhich is notvertex.)- Specified by:
getOppositein interfaceGraph<V,E> - Parameters:
vertex- the vertex to be queriededge- the edge to be queried- Returns:
- the vertex at the other end of
edgefromvertex
-
getOutEdges
Description copied from interface:GraphReturns aCollectionview of the outgoing edges incident tovertexin this graph.- Specified by:
getOutEdgesin interfaceGraph<V,E> - Specified by:
getOutEdgesin interfaceHypergraph<V,E> - Parameters:
vertex- the vertex whose outgoing edges are to be returned- Returns:
- a
Collectionview of the outgoing edges incident tovertexin this graph
-
getPredecessorCount
Description copied from interface:GraphReturns the number of predecessors thatvertexhas in this graph. Equivalent tovertex.getPredecessors().size().- Specified by:
getPredecessorCountin interfaceGraph<V,E> - Parameters:
vertex- the vertex whose predecessor count is to be returned- Returns:
- the number of predecessors that
vertexhas in this graph
-
getPredecessors
Description copied from interface:GraphReturns aCollectionview of the predecessors ofvertexin this graph. A predecessor ofvertexis defined as a vertexvwhich is connected tovertexby an edgee, whereeis an outgoing edge ofvand an incoming edge ofvertex.- Specified by:
getPredecessorsin interfaceGraph<V,E> - Specified by:
getPredecessorsin interfaceHypergraph<V,E> - Parameters:
vertex- the vertex whose predecessors are to be returned- Returns:
- a
Collectionview of the predecessors ofvertexin this graph
-
getSource
Description copied from interface:GraphIfdirected_edgeis a directed edge in this graph, returns the source; otherwise returnsnull. The source of a directed edgedis defined to be the vertex for whichdis an outgoing edge.directed_edgeis guaranteed to be a directed edge if itsEdgeTypeisDIRECTED. -
getSuccessorCount
Description copied from interface:GraphReturns the number of successors thatvertexhas in this graph. Equivalent tovertex.getSuccessors().size().- Specified by:
getSuccessorCountin interfaceGraph<V,E> - Parameters:
vertex- the vertex whose successor count is to be returned- Returns:
- the number of successors that
vertexhas in this graph
-
getSuccessors
Description copied from interface:GraphReturns aCollectionview of the successors ofvertexin this graph. A successor ofvertexis defined as a vertexvwhich is connected tovertexby an edgee, whereeis an incoming edge ofvand an outgoing edge ofvertex.- Specified by:
getSuccessorsin interfaceGraph<V,E> - Specified by:
getSuccessorsin interfaceHypergraph<V,E> - Parameters:
vertex- the vertex whose predecessors are to be returned- Returns:
- a
Collectionview of the successors ofvertexin this graph
-
inDegree
Description copied from interface:GraphReturns the number of incoming edges incident tovertex. Equivalent togetInEdges(vertex).size(). -
isDest
Description copied from interface:GraphReturnstrueifvertexis the destination ofedge. Equivalent togetDest(edge).equals(vertex). -
isPredecessor
Description copied from interface:GraphReturnstrueifv1is a predecessor ofv2in this graph. Equivalent tov1.getPredecessors().contains(v2).- Specified by:
isPredecessorin interfaceGraph<V,E> - Parameters:
v1- the first vertex to be queriedv2- the second vertex to be queried- Returns:
trueifv1is a predecessor ofv2, and false otherwise.
-
isSource
Description copied from interface:GraphReturnstrueifvertexis the source ofedge. Equivalent togetSource(edge).equals(vertex). -
isSuccessor
Description copied from interface:GraphReturnstrueifv1is a successor ofv2in this graph. Equivalent tov1.getSuccessors().contains(v2).- Specified by:
isSuccessorin interfaceGraph<V,E> - Parameters:
v1- the first vertex to be queriedv2- the second vertex to be queried- Returns:
trueifv1is a successor ofv2, and false otherwise.
-
outDegree
Description copied from interface:GraphReturns the number of outgoing edges incident tovertex. Equivalent togetOutEdges(vertex).size(). -
addEdge
Description copied from interface:HypergraphAddsedgeto this graph. Fails under the following circumstances:edgeis already an element of the graph- either
edgeorverticesisnull verticeshas the wrong number of vertices for the graph typeverticesare already connected by another edge in this graph, and this graph does not accept parallel edges
- Specified by:
addEdgein interfaceHypergraph<V,E> - Parameters:
edge- the edge to addvertices- the vertices to which the edge will be connected- Returns:
trueif the add is successful, andfalseotherwise
-
addEdge
Description copied from interface:HypergraphAddsedgeto this graph with typeedge_type. Fails under the following circumstances:edgeis already an element of the graph- either
edgeorverticesisnull verticeshas the wrong number of vertices for the graph typeverticesare already connected by another edge in this graph, and this graph does not accept parallel edgesedge_typeis not legal for this graph
- Specified by:
addEdgein interfaceHypergraph<V,E> - Parameters:
edge- edge to add to this graphvertices- vertices which are to be connected by this edgeedgeType- type of edge to add- Returns:
trueif the add is successful, andfalseotherwise
-
addVertex
Description copied from interface:HypergraphAddsvertexto this graph. Fails ifvertexis null or already in the graph.- Specified by:
addVertexin interfaceHypergraph<V,E> - Parameters:
vertex- the vertex to add- Returns:
trueif the add is successful, andfalseotherwise
-
containsEdge
Description copied from interface:HypergraphReturns true if this graph's edge collection containsedge. Equivalent togetEdges().contains(edge).- Specified by:
containsEdgein interfaceHypergraph<V,E> - Parameters:
edge- the edge whose presence is being queried- Returns:
- true iff this graph contains an edge
edge
-
containsVertex
Description copied from interface:HypergraphReturns true if this graph's vertex collection containsvertex. Equivalent togetVertices().contains(vertex).- Specified by:
containsVertexin interfaceHypergraph<V,E> - Parameters:
vertex- the vertex whose presence is being queried- Returns:
- true iff this graph contains a vertex
vertex
-
degree
Description copied from interface:HypergraphReturns the number of edges incident tovertex. Special cases of interest:- Incident self-loops are counted once.
- If there is only one edge that connects this vertex to
each of its neighbors (and vice versa), then the value returned
will also be equal to the number of neighbors that this vertex has
(that is, the output of
getNeighborCount). - If the graph is directed, then the value returned will be the sum of this vertex's indegree (the number of edges whose destination is this vertex) and its outdegree (the number of edges whose source is this vertex), minus the number of incident self-loops (to avoid double-counting).
Equivalent to
getIncidentEdges(vertex).size().- Specified by:
degreein interfaceHypergraph<V,E> - Parameters:
vertex- the vertex whose degree is to be returned- Returns:
- the degree of this node
- See Also:
-
findEdge
Description copied from interface:HypergraphReturns an edge that connects this vertex tov. If this edge is not uniquely defined (that is, if the graph contains more than one edge connectingv1tov2), any of these edges may be returned.findEdgeSet(v1, v2)may be used to return all such edges. Returns null if either of the following is true:v2is not connected tov1- either
v1orv2are not present in this graph
Note: for purposes of this method,
v1is only considered to be connected tov2via a given directed edgeeifv1 == e.getSource() && v2 == e.getDest()evaluates totrue. (v1andv2are connected by an undirected edgeuifuis incident to bothv1andv2.)- Specified by:
findEdgein interfaceHypergraph<V,E> - Parameters:
v1- the first endpoint of the returned edgev2- the second endpoint of the returned edge- Returns:
- an edge that connects
v1tov2, ornullif no such edge exists (or either vertex is not present) - See Also:
-
findEdgeSet
Description copied from interface:HypergraphReturns all edges that connects this vertex tov. If this edge is not uniquely defined (that is, if the graph contains more than one edge connectingv1tov2), any of these edges may be returned.findEdgeSet(v1, v2)may be used to return all such edges. Returns null ifv2is not connected tov1.
Returns an empty collection if eitherv1orv2are not present in this graph.Note: for purposes of this method,
v1is only considered to be connected tov2via a given directed edgedifv1 == d.getSource() && v2 == d.getDest()evaluates totrue. (v1andv2are connected by an undirected edgeuifuis incident to bothv1andv2.)- Specified by:
findEdgeSetin interfaceHypergraph<V,E> - Parameters:
v1- the first endpoint of the returned edge setv2- the second endpoint of the returned edge set- Returns:
- a collection containing all edges that connect
v1tov2, ornullif either vertex is not present - See Also:
-
getDefaultEdgeType
Description copied from interface:HypergraphReturns the default edge type for this graph.- Specified by:
getDefaultEdgeTypein interfaceHypergraph<V,E> - Returns:
- the default edge type for this graph
-
getEdgeCount
public int getEdgeCount()Description copied from interface:HypergraphReturns the number of edges in this graph.- Specified by:
getEdgeCountin interfaceHypergraph<V,E> - Returns:
- the number of edges in this graph
-
getEdgeCount
Description copied from interface:HypergraphReturns the number of edges of typeedge_typein this graph.- Specified by:
getEdgeCountin interfaceHypergraph<V,E> - Parameters:
edgeType- the type of edge for which the count is to be returned- Returns:
- the number of edges of type
edge_typein this graph
-
getEdgeType
Description copied from interface:HypergraphReturns the edge type ofedgein this graph.- Specified by:
getEdgeTypein interfaceHypergraph<V,E> - Parameters:
edge- the edge whose type is to be returned- Returns:
- the
EdgeTypeofedge, ornullifedgehas no defined type
-
getEdges
Description copied from interface:HypergraphReturns a view of all edges in this graph. In general, this obeys theCollectioncontract, and therefore makes no guarantees about the ordering of the vertices within the set.- Specified by:
getEdgesin interfaceHypergraph<V,E> - Returns:
- a
Collectionview of all edges in this graph
-
getEdges
Description copied from interface:HypergraphReturns the collection of edges in this graph which are of typeedge_type.- Specified by:
getEdgesin interfaceHypergraph<V,E> - Parameters:
edgeType- the type of edges to be returned- Returns:
- the collection of edges which are of type
edge_type, ornullif the graph does not accept edges of this type - See Also:
-
getIncidentCount
Description copied from interface:HypergraphReturns the number of vertices that are incident toedge. For hyperedges, this can be any nonnegative integer; for edges this must be 2 (or 1 if self-loops are permitted).Equivalent to
getIncidentVertices(edge).size().- Specified by:
getIncidentCountin interfaceHypergraph<V,E> - Parameters:
edge- the edge whose incident vertex count is to be returned- Returns:
- the number of vertices that are incident to
edge.
-
getIncidentEdges
Description copied from interface:HypergraphReturns the collection of edges in this graph which are connected tovertex.- Specified by:
getIncidentEdgesin interfaceHypergraph<V,E> - Parameters:
vertex- the vertex whose incident edges are to be returned- Returns:
- the collection of edges which are connected to
vertex, ornullifvertexis not present
-
getIncidentVertices
Description copied from interface:HypergraphReturns the collection of vertices in this graph which are connected toedge. Note that for some graph types there are guarantees about the size of this collection (i.e., some graphs contain edges that have exactly two endpoints, which may or may not be distinct). Implementations for those graph types may provide alternate methods that provide more convenient access to the vertices.- Specified by:
getIncidentVerticesin interfaceHypergraph<V,E> - Parameters:
edge- the edge whose incident vertices are to be returned- Returns:
- the collection of vertices which are connected to
edge, ornullifedgeis not present
-
getNeighborCount
Description copied from interface:HypergraphReturns the number of vertices that are adjacent tovertex(that is, the number of vertices that are incident to edges invertex's incident edge set).Equivalent to
getNeighbors(vertex).size().- Specified by:
getNeighborCountin interfaceHypergraph<V,E> - Parameters:
vertex- the vertex whose neighbor count is to be returned- Returns:
- the number of neighboring vertices
-
getNeighbors
Description copied from interface:HypergraphReturns the collection of vertices which are connected tovertexvia any edges in this graph. Ifvertexis connected to itself with a self-loop, then it will be included in the collection returned.- Specified by:
getNeighborsin interfaceHypergraph<V,E> - Parameters:
vertex- the vertex whose neighbors are to be returned- Returns:
- the collection of vertices which are connected to
vertex, ornullifvertexis not present
-
getVertexCount
public int getVertexCount()Description copied from interface:HypergraphReturns the number of vertices in this graph.- Specified by:
getVertexCountin interfaceHypergraph<V,E> - Returns:
- the number of vertices in this graph
-
getVertices
Description copied from interface:HypergraphReturns a view of all vertices in this graph. In general, this obeys theCollectioncontract, and therefore makes no guarantees about the ordering of the vertices within the set.- Specified by:
getVerticesin interfaceHypergraph<V,E> - Returns:
- a
Collectionview of all vertices in this graph
-
isIncident
Description copied from interface:HypergraphReturnstrueifvertexandedgeare incident to each other. Equivalent togetIncidentEdges(vertex).contains(edge)and togetIncidentVertices(edge).contains(vertex).- Specified by:
isIncidentin interfaceHypergraph<V,E> - Parameters:
vertex- vertex to testedge- edge to test- Returns:
trueifvertexandedgeare incident to each other
-
isNeighbor
Description copied from interface:HypergraphReturnstrueifv1andv2share an incident edge. Equivalent togetNeighbors(v1).contains(v2).- Specified by:
isNeighborin interfaceHypergraph<V,E> - Parameters:
v1- the first vertex to testv2- the second vertex to test- Returns:
trueifv1andv2share an incident edge
-
removeEdge
Description copied from interface:HypergraphRemovesedgefrom this graph. Fails ifedgeis null, or is otherwise not an element of this graph.- Specified by:
removeEdgein interfaceHypergraph<V,E> - Parameters:
edge- the edge to remove- Returns:
trueif the removal is successful,falseotherwise
-
removeVertex
Description copied from interface:HypergraphRemovesvertexfrom this graph. As a side effect, removes any edgeseincident tovertexif the removal ofvertexwould causeeto be incident to an illegal number of vertices. (Thus, for example, incident hyperedges are not removed, but incident edges--which must be connected to a vertex at both endpoints--are removed.)Fails under the following circumstances:
vertexis not an element of this graphvertexisnull
- Specified by:
removeVertexin interfaceHypergraph<V,E> - Parameters:
vertex- the vertex to remove- Returns:
trueif the removal is successful,falseotherwise
-