edu.uci.ics.jung.graph.SetHypergraph<V,H>
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
public class SetHypergraph<V,H>
An implementation of Hypergraph that is suitable for sparse graphs and
permits parallel edges.
| Field Summary | |
|---|---|
protected Map<H,Set<V>> |
edges
|
protected Map<V,Set<H>> |
vertices
|
| Constructor Summary | |
|---|---|
SetHypergraph()
Creates a SetHypergraph and initializes the internal data structures. |
|
| Method Summary | ||
|---|---|---|
boolean |
addEdge(H hyperedge,
Collection<? extends V> to_attach)
Adds hyperedge to this graph and connects them to the vertex collection to_attach. |
|
boolean |
addEdge(H hyperedge,
Collection<? extends V> to_attach,
EdgeType edge_type)
Adds edge to this graph with type edge_type. |
|
boolean |
addVertex(V vertex)
Adds vertex to this graph. |
|
boolean |
containsEdge(H edge)
Returns true if this graph's edge collection contains edge. |
|
boolean |
containsVertex(V vertex)
Returns true if this graph's vertex collection contains vertex. |
|
int |
degree(V vertex)
Returns the number of edges incident to vertex. |
|
H |
findEdge(V v1,
V v2)
Returns an edge that connects this vertex to v. |
|
Collection<H> |
findEdgeSet(V v1,
V v2)
Returns all edges that connects this vertex to v. |
|
EdgeType |
getDefaultEdgeType()
Returns the default edge type for this graph. |
|
V |
getDest(H directed_edge)
If directed_edge is a directed edge in this graph, returns the destination;
otherwise returns null. |
|
int |
getEdgeCount()
Returns the number of edges in this graph. |
|
int |
getEdgeCount(EdgeType edge_type)
Returns the number of edges of type edge_type in this graph. |
|
Collection<H> |
getEdges()
Returns a view of all edges in this graph. |
|
Collection<H> |
getEdges(EdgeType edge_type)
Returns the collection of edges in this graph which are of type edge_type. |
|
EdgeType |
getEdgeType(H edge)
Returns the edge type of edge in this graph. |
|
static
|
getFactory()
Returns a Factory which creates instances of this class. |
|
int |
getIncidentCount(H edge)
Returns the number of vertices that are incident to edge. |
|
Collection<H> |
getIncidentEdges(V vertex)
Returns the collection of edges in this graph which are connected to vertex. |
|
Collection<V> |
getIncidentVertices(H edge)
Returns the collection of vertices in this graph which are connected to edge. |
|
Collection<H> |
getInEdges(V vertex)
Returns a Collection view of the incoming edges incident to vertex
in this graph. |
|
int |
getNeighborCount(V vertex)
Returns the number of vertices that are adjacent to vertex
(that is, the number of vertices that are incident to edges in vertex's
incident edge set). |
|
Collection<V> |
getNeighbors(V vertex)
Returns the collection of vertices which are connected to vertex
via any edges in this graph. |
|
Collection<H> |
getOutEdges(V vertex)
Returns a Collection view of the outgoing edges incident to vertex
in this graph. |
|
Collection<V> |
getPredecessors(V vertex)
Returns a Collection view of the predecessors of vertex
in this graph. |
|
V |
getSource(H directed_edge)
If directed_edge is a directed edge in this graph, returns the source;
otherwise returns null. |
|
Collection<V> |
getSuccessors(V vertex)
Returns a Collection view of the successors of vertex
in this graph. |
|
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 |
isIncident(V vertex,
H edge)
Returns true if vertex and edge
are incident to each other. |
|
boolean |
isNeighbor(V v1,
V v2)
Returns true if v1 and v2 share an incident edge. |
|
int |
outDegree(V vertex)
Returns the number of outgoing edges incident to vertex. |
|
boolean |
removeEdge(H hyperedge)
Removes edge from this graph. |
|
boolean |
removeVertex(V vertex)
Removes vertex from this graph. |
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected Map<V,Set<H>> vertices
protected Map<H,Set<V>> edges
| Constructor Detail |
|---|
public SetHypergraph()
SetHypergraph and initializes the internal data structures.
| Method Detail |
|---|
public static <V,H> org.apache.commons.collections15.Factory<Hypergraph<V,H>> getFactory()
Factory which creates instances of this class.
V - vertex type of the hypergraph to be createdH - edge type of the hypergraph to be created
Factory which creates instances of this class
public boolean addEdge(H hyperedge,
Collection<? extends V> to_attach)
hyperedge to this graph and connects them to the vertex collection to_attach.
Any vertices in to_attach that appear more than once will only appear once in the
incident vertex collection for hyperedge, that is, duplicates will be ignored.
addEdge in interface Hypergraph<V,H>true if the add is successful, and false otherwiseHypergraph.addEdge(Object, Collection)
public boolean addEdge(H hyperedge,
Collection<? extends V> to_attach,
EdgeType edge_type)
Hypergraphedge to this graph with type edge_type.
Fails under the following circumstances:
edge is already an element of the graph
either edge or vertices is null
vertices has the wrong number of vertices for the graph type
vertices are already connected by another edge in this graph,
and this graph does not accept parallel edges
edge_type is not legal for this graph
addEdge in interface Hypergraph<V,H>true if the add is successful, and false otherwiseHypergraph.addEdge(Object, Collection, EdgeType)public EdgeType getEdgeType(H edge)
Hypergraphedge in this graph.
getEdgeType in interface Hypergraph<V,H>EdgeType of edge, or null if edge has no defined typeHypergraph.getEdgeType(Object)public boolean containsVertex(V vertex)
Hypergraphvertex.
Equivalent to getVertices().contains(vertex).
containsVertex in interface Hypergraph<V,H>vertex - the vertex whose presence is being queried
vertexpublic boolean containsEdge(H edge)
Hypergraphedge.
Equivalent to getEdges().contains(edge).
containsEdge in interface Hypergraph<V,H>edge - the edge whose presence is being queried
edgepublic Collection<H> getEdges()
HypergraphCollection contract, and therefore makes no guarantees
about the ordering of the vertices within the set.
getEdges in interface Hypergraph<V,H>Collection view of all edges in this graphpublic Collection<V> getVertices()
HypergraphCollection contract, and therefore makes no guarantees
about the ordering of the vertices within the set.
getVertices in interface Hypergraph<V,H>Collection view of all vertices in this graphpublic int getEdgeCount()
Hypergraph
getEdgeCount in interface Hypergraph<V,H>public int getVertexCount()
Hypergraph
getVertexCount in interface Hypergraph<V,H>public Collection<V> getNeighbors(V vertex)
Hypergraphvertex
via any edges in this graph.
If vertex is connected to itself with a self-loop, then
it will be included in the collection returned.
getNeighbors in interface Hypergraph<V,H>vertex - the vertex whose neighbors are to be returned
vertex,
or null if vertex is not presentpublic Collection<H> getIncidentEdges(V vertex)
Hypergraphvertex.
getIncidentEdges in interface Hypergraph<V,H>vertex - the vertex whose incident edges are to be returned
vertex,
or null if vertex is not presentpublic Collection<V> getIncidentVertices(H edge)
Hypergraphedge.
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.
getIncidentVertices in interface Hypergraph<V,H>edge - the edge whose incident vertices are to be returned
edge,
or null if edge is not present
public H findEdge(V v1,
V v2)
Hypergraphv.
If this edge is not uniquely
defined (that is, if the graph contains more than one edge connecting
v1 to v2), 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:
v2 is not connected to v1
either v1 or v2 are not present in this graph
Note: for purposes of this method, v1 is only considered to be connected to
v2 via a given directed edge e if
v1 == e.getSource() && v2 == e.getDest() evaluates to true.
(v1 and v2 are connected by an undirected edge u if
u is incident to both v1 and v2.)
findEdge in interface Hypergraph<V,H>v1 to v2,
or null if no such edge exists (or either vertex is not present)Hypergraph.findEdgeSet(Object, Object)
public Collection<H> findEdgeSet(V v1,
V v2)
Hypergraphv.
If this edge is not uniquely
defined (that is, if the graph contains more than one edge connecting
v1 to v2), any of these edges
may be returned. findEdgeSet(v1, v2) may be
used to return all such edges.
Returns null if v2 is not connected to v1.
v1 or v2 are not present in this graph.
Note: for purposes of this method, v1 is only considered to be connected to
v2 via a given directed edge d if
v1 == d.getSource() && v2 == d.getDest() evaluates to true.
(v1 and v2 are connected by an undirected edge u if
u is incident to both v1 and v2.)
findEdgeSet in interface Hypergraph<V,H>v1 to v2,
or null if either vertex is not presentHypergraph.findEdge(Object, Object)public boolean addVertex(V vertex)
Hypergraphvertex to this graph.
Fails if vertex is null or already in the graph.
addVertex in interface Hypergraph<V,H>vertex - the vertex to add
true if the add is successful, and false otherwisepublic boolean removeVertex(V vertex)
Hypergraphvertex from this graph.
As a side effect, removes any edges e incident to vertex if the
removal of vertex would cause e to 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:
vertex is not an element of this graph
vertex is null
removeVertex in interface Hypergraph<V,H>vertex - the vertex to remove
true if the removal is successful, false otherwisepublic boolean removeEdge(H hyperedge)
Hypergraphedge from this graph.
Fails if edge is null, or is otherwise not an element of this graph.
removeEdge in interface Hypergraph<V,H>hyperedge - the edge to remove
true if the removal is successful, false otherwise
public boolean isNeighbor(V v1,
V v2)
Hypergraphtrue if v1 and v2 share an incident edge.
Equivalent to getNeighbors(v1).contains(v2).
isNeighbor in interface Hypergraph<V,H>v1 - the first vertex to testv2 - the second vertex to test
true if v1 and v2 share an incident edge
public boolean isIncident(V vertex,
H edge)
Hypergraphtrue if vertex and edge
are incident to each other.
Equivalent to getIncidentEdges(vertex).contains(edge) and to
getIncidentVertices(edge).contains(vertex).
isIncident in interface Hypergraph<V,H>true if vertex and edge
are incident to each otherpublic int degree(V vertex)
Hypergraphvertex.
Special cases of interest:
getNeighborCount).
Equivalent to getIncidentEdges(vertex).size().
degree in interface Hypergraph<V,H>vertex - the vertex whose degree is to be returned
Hypergraph.getNeighborCount(Object)public int getNeighborCount(V vertex)
Hypergraphvertex
(that is, the number of vertices that are incident to edges in vertex's
incident edge set).
Equivalent to getNeighbors(vertex).size().
getNeighborCount in interface Hypergraph<V,H>vertex - the vertex whose neighbor count is to be returned
public int getIncidentCount(H edge)
Hypergraphedge.
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().
getIncidentCount in interface Hypergraph<V,H>edge - the edge whose incident vertex count is to be returned
edge.public int getEdgeCount(EdgeType edge_type)
Hypergraphedge_type in this graph.
getEdgeCount in interface Hypergraph<V,H>edge_type - the type of edge for which the count is to be returned
edge_type in this graphpublic Collection<H> getEdges(EdgeType edge_type)
Hypergraphedge_type.
getEdges in interface Hypergraph<V,H>edge_type - the type of edges to be returned
edge_type, or
null if the graph does not accept edges of this typeEdgeTypepublic EdgeType getDefaultEdgeType()
Hypergraph
getDefaultEdgeType in interface Hypergraph<V,H>public Collection<H> getInEdges(V vertex)
HypergraphCollection view of the incoming edges incident to vertex
in this graph.
getInEdges in interface Hypergraph<V,H>vertex - the vertex whose incoming edges are to be returned
Collection view of the incoming edges incident
to vertex in this graphpublic Collection<H> getOutEdges(V vertex)
HypergraphCollection view of the outgoing edges incident to vertex
in this graph.
getOutEdges in interface Hypergraph<V,H>vertex - the vertex whose outgoing edges are to be returned
Collection view of the outgoing edges incident
to vertex in this graphpublic int inDegree(V vertex)
Hypergraphvertex.
Equivalent to getInEdges(vertex).size().
inDegree in interface Hypergraph<V,H>vertex - the vertex whose indegree is to be calculated
vertexpublic int outDegree(V vertex)
Hypergraphvertex.
Equivalent to getOutEdges(vertex).size().
outDegree in interface Hypergraph<V,H>vertex - the vertex whose outdegree is to be calculated
vertexpublic V getDest(H directed_edge)
Hypergraphdirected_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.
getDest in interface Hypergraph<V,H>directed_edge if it is a directed edge in this graph, or null otherwisepublic V getSource(H directed_edge)
Hypergraphdirected_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.
getSource in interface Hypergraph<V,H>directed_edge if it is a directed edge in this graph, or null otherwisepublic Collection<V> getPredecessors(V vertex)
HypergraphCollection 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.
getPredecessors in interface Hypergraph<V,H>vertex - the vertex whose predecessors are to be returned
Collection view of the predecessors of
vertex in this graphpublic Collection<V> getSuccessors(V vertex)
HypergraphCollection 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.
getSuccessors in interface Hypergraph<V,H>vertex - the vertex whose predecessors are to be returned
Collection view of the successors of
vertex in this graph
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||