edu.uci.ics.jung.graph

Class SetHypergraph<V,H>

java.lang.Object

edu.uci.ics.jung.graph.SetHypergraph<V,H>

All Implemented Interfaces:

Hypergraph<V,H>, MultiGraph<V,H>, Serializable

public class SetHypergraph<V,H>
extends Object
implements Hypergraph<V,H>, MultiGraph<V,H>, Serializable

An implementation of Hypergraph that is suitable for sparse graphs and permits parallel edges.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<H,Set<V>>	edges
protected Map<V,Set<H>>	vertices

Constructor Summary

Constructors

Constructor and Description
SetHypergraph() Creates a SetHypergraph and initializes the internal data structures.

Method Summary

Modifier and Type	Method and Description
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)
boolean	addVertex(V vertex)
boolean	containsEdge(H edge)
boolean	containsVertex(V vertex)
int	degree(V vertex)
H	findEdge(V v1, V v2)
Collection<H>	findEdgeSet(V v1, V v2)
EdgeType	getDefaultEdgeType()
V	getDest(H directed_edge)
int	getEdgeCount()
int	getEdgeCount(EdgeType edge_type)
Collection<H>	getEdges()
Collection<H>	getEdges(EdgeType edge_type)
EdgeType	getEdgeType(H edge)
static <V,H> com.google.common.base.Supplier<Hypergraph<V,H>>	getFactory() Returns a Factory which creates instances of this class.
int	getIncidentCount(H edge)
Collection<H>	getIncidentEdges(V vertex)
Collection<V>	getIncidentVertices(H edge)
Collection<H>	getInEdges(V vertex)
int	getNeighborCount(V vertex)
Collection<V>	getNeighbors(V vertex)
Collection<H>	getOutEdges(V vertex)
Collection<V>	getPredecessors(V vertex)
V	getSource(H directed_edge)
Collection<V>	getSuccessors(V vertex)
int	getVertexCount()
Collection<V>	getVertices()
int	inDegree(V vertex)
boolean	isIncident(V vertex, H edge)
boolean	isNeighbor(V v1, V v2)
int	outDegree(V vertex)
boolean	removeEdge(H hyperedge)
boolean	removeVertex(V vertex)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

vertices

protected Map<V,Set<H>> vertices

edges

protected Map<H,Set<V>> edges

Constructor Detail

SetHypergraph

public SetHypergraph()

Creates a SetHypergraph and initializes the internal data structures.

Method Detail

getFactory

public static <V,H> com.google.common.base.Supplier<Hypergraph<V,H>> getFactory()

Returns a Factory which creates instances of this class.

Type Parameters:

V - vertex type of the hypergraph to be created

H - edge type of the hypergraph to be created

Returns:

a Factory which creates instances of this class

addEdge

public boolean addEdge(H hyperedge,
                       Collection<? extends V> to_attach)

Adds 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.

Specified by:

addEdge in interface Hypergraph<V,H>

See Also:

Hypergraph.addEdge(Object, Collection)

addEdge

public boolean addEdge(H hyperedge,
                       Collection<? extends V> to_attach,
                       EdgeType edge_type)

Specified by:

addEdge in interface Hypergraph<V,H>

See Also:

Hypergraph.addEdge(Object, Collection, EdgeType)

getEdgeType

public EdgeType getEdgeType(H edge)

Specified by:

getEdgeType in interface Hypergraph<V,H>

See Also:

Hypergraph.getEdgeType(Object)

containsVertex

public boolean containsVertex(V vertex)

Specified by:

containsVertex in interface Hypergraph<V,H>

containsEdge

public boolean containsEdge(H edge)

Specified by:

containsEdge in interface Hypergraph<V,H>

getEdges

public Collection<H> getEdges()

Specified by:

getEdges in interface Hypergraph<V,H>

getVertices

public Collection<V> getVertices()

Specified by:

getVertices in interface Hypergraph<V,H>

getEdgeCount

public int getEdgeCount()

Specified by:

getEdgeCount in interface Hypergraph<V,H>

getVertexCount

public int getVertexCount()

Specified by:

getVertexCount in interface Hypergraph<V,H>

getNeighbors

public Collection<V> getNeighbors(V vertex)

Specified by:

getNeighbors in interface Hypergraph<V,H>

getIncidentEdges

public Collection<H> getIncidentEdges(V vertex)

Specified by:

getIncidentEdges in interface Hypergraph<V,H>

getIncidentVertices

public Collection<V> getIncidentVertices(H edge)

Specified by:

getIncidentVertices in interface Hypergraph<V,H>

findEdge

public H findEdge(V v1,
                  V v2)

Specified by:

findEdge in interface Hypergraph<V,H>

findEdgeSet

public Collection<H> findEdgeSet(V v1,
                                 V v2)

Specified by:

findEdgeSet in interface Hypergraph<V,H>

addVertex

public boolean addVertex(V vertex)

Specified by:

addVertex in interface Hypergraph<V,H>

removeVertex

public boolean removeVertex(V vertex)

Specified by:

removeVertex in interface Hypergraph<V,H>

removeEdge

public boolean removeEdge(H hyperedge)

Specified by:

removeEdge in interface Hypergraph<V,H>

isNeighbor

public boolean isNeighbor(V v1,
                          V v2)

Specified by:

isNeighbor in interface Hypergraph<V,H>

isIncident

public boolean isIncident(V vertex,
                          H edge)

Specified by:

isIncident in interface Hypergraph<V,H>

degree

public int degree(V vertex)

Specified by:

degree in interface Hypergraph<V,H>

getNeighborCount

public int getNeighborCount(V vertex)

Specified by:

getNeighborCount in interface Hypergraph<V,H>

getIncidentCount

public int getIncidentCount(H edge)

Specified by:

getIncidentCount in interface Hypergraph<V,H>

getEdgeCount

public int getEdgeCount(EdgeType edge_type)

Specified by:

getEdgeCount in interface Hypergraph<V,H>

getEdges

public Collection<H> getEdges(EdgeType edge_type)

Specified by:

getEdges in interface Hypergraph<V,H>

getDefaultEdgeType

public EdgeType getDefaultEdgeType()

Specified by:

getDefaultEdgeType in interface Hypergraph<V,H>

getInEdges

public Collection<H> getInEdges(V vertex)

Specified by:

getInEdges in interface Hypergraph<V,H>

getOutEdges

public Collection<H> getOutEdges(V vertex)

Specified by:

getOutEdges in interface Hypergraph<V,H>

inDegree

public int inDegree(V vertex)

Specified by:

inDegree in interface Hypergraph<V,H>

outDegree

public int outDegree(V vertex)

Specified by:

outDegree in interface Hypergraph<V,H>

getDest

public V getDest(H directed_edge)

Specified by:

getDest in interface Hypergraph<V,H>

getSource

public V getSource(H directed_edge)

Specified by:

getSource in interface Hypergraph<V,H>

getPredecessors

public Collection<V> getPredecessors(V vertex)

Specified by:

getPredecessors in interface Hypergraph<V,H>

getSuccessors

public Collection<V> getSuccessors(V vertex)

Specified by:

getSuccessors in interface Hypergraph<V,H>