edu.uci.ics.jung.graph.impl
Class HypervertexBPG

java.lang.Object
  edu.uci.ics.jung.graph.impl.AbstractHyperUnitBPG
      edu.uci.ics.jung.graph.impl.HypervertexBPG

All Implemented Interfaces:

ArchetypeVertex, Element, Hypervertex, UserDataContainer, Cloneable

public class HypervertexBPG
extends AbstractHyperUnitBPG
implements Hypervertex

A Hypervertex has zero or more hyperEdges attached to it, and is a member of a Hypergraph.

Author:

danyelf

Nested Class Summary

Nested classes/interfaces inherited from interface edu.uci.ics.jung.utils.UserDataContainer

UserDataContainer.CopyAction

Field Summary

Fields inherited from class edu.uci.ics.jung.graph.impl.AbstractHyperUnitBPG

graph, vertex

Constructor Summary

HypervertexBPG()

Method Summary

boolean	connectEdge(Hyperedge e) Connects he to this hypervertex and vice versa.
ArchetypeVertex	copy(ArchetypeGraph g) Creates a copy of this vertex in graph g.
int	degree() Returns the number of edges adjacent to this vertex
boolean	disconnectEdge(Hyperedge e) Disconnects he from this hypervertex and vice versa.
ArchetypeEdge	findEdge(ArchetypeVertex v) Returns an edge that connects this vertex to v.
Set	findEdgeSet(ArchetypeVertex v) Returns the set of all edges that connect this vertex with the specified vertex v.
ArchetypeVertex	getEqualVertex(ArchetypeGraph g) Returns the vertex in graph g, if any, that is equal to this vertex.
ArchetypeVertex	getEquivalentVertex(ArchetypeGraph g) Deprecated. As of version 1.4, renamed to getEqualVertex(g).
Set	getIncidentEdges() Returns the set of edges which are incident to this vertex.
Set	getIncidentElements() Returns the set of elements that are incident to this element.
Set	getNeighbors() Returns the set of vertices which are connected to this vertex via edges; each of these vertices should implement ArchetypeVertex.
boolean	isIncident(ArchetypeEdge e) Returns true if the specified edge e is incident to this vertex, and false otherwise.
boolean	isNeighborOf(ArchetypeVertex v) Not a very efficient implementation
int	numNeighbors() Not a very efficient implemenation: for each edge, counts the neighbors.

Methods inherited from class edu.uci.ics.jung.graph.impl.AbstractHyperUnitBPG

addUserDatum, clone, containsUserDatumKey, equals, getGraph, getUserDatum, getUserDatumCopyAction, getUserDatumKeyIterator, importUserData, removeUserDatum, removeVertex, setGraph, setUserDatum, underlying_vertex

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.uci.ics.jung.graph.Element

getGraph

Methods inherited from interface edu.uci.ics.jung.utils.UserDataContainer

addUserDatum, clone, containsUserDatumKey, getUserDatum, getUserDatumCopyAction, getUserDatumKeyIterator, importUserData, removeUserDatum, setUserDatum

Constructor Detail

HypervertexBPG

public HypervertexBPG()

Method Detail

getIncidentElements

public Set getIncidentElements()

Description copied from interface: Element

Returns the set of elements that are incident to this element. For a vertex this corresponds to returning the vertex's incident edges; for an edge this corresponds to returning the edge's incident vertices.

Specified by:

getIncidentElements in interface Element

getNeighbors

public Set getNeighbors()

Description copied from interface: ArchetypeVertex

Returns the set of vertices which are connected to this vertex via edges; each of these vertices should implement ArchetypeVertex. If this vertex is connected to itself with a self-loop, then this vertex will be included in its own neighbor set.

Specified by:

getNeighbors in interface ArchetypeVertex

See Also:

ArchetypeVertex.getNeighbors()

getIncidentEdges

public Set getIncidentEdges()

Description copied from interface: ArchetypeVertex

Returns the set of edges which are incident to this vertex. Each of these edges should implement ArchetypeEdge.

Specified by:

getIncidentEdges in interface ArchetypeVertex

See Also:

ArchetypeVertex.getIncidentEdges()

degree

public int degree()

Returns the number of edges adjacent to this vertex

Specified by:

degree in interface ArchetypeVertex

Returns:

int the degree of this node

See Also:

ArchetypeVertex.degree()

getEqualVertex

public ArchetypeVertex getEqualVertex(ArchetypeGraph g)

Description copied from interface: ArchetypeVertex

Returns the vertex in graph g, if any, that is equal to this vertex. Otherwise, returns null. Two vertices are equal if one of them is an ancestor (via copy()) of the other.

Specified by:

getEqualVertex in interface ArchetypeVertex

See Also:

ArchetypeVertex.getEqualVertex(edu.uci.ics.jung.graph.ArchetypeGraph)

getEquivalentVertex

public ArchetypeVertex getEquivalentVertex(ArchetypeGraph g)

Deprecated. As of version 1.4, renamed to getEqualVertex(g).

Specified by:

getEquivalentVertex in interface ArchetypeVertex

isNeighborOf

public boolean isNeighborOf(ArchetypeVertex v)

Not a very efficient implementation

Specified by:

isNeighborOf in interface ArchetypeVertex

See Also:

ArchetypeVertex.isNeighborOf(edu.uci.ics.jung.graph.ArchetypeVertex)

isIncident

public boolean isIncident(ArchetypeEdge e)

Description copied from interface: ArchetypeVertex

Returns true if the specified edge e is incident to this vertex, and false otherwise. The behavior of this method is undefined if e is not an element of this vertex's graph.

Specified by:

isIncident in interface ArchetypeVertex

See Also:

ArchetypeVertex.isIncident(edu.uci.ics.jung.graph.ArchetypeEdge)

findEdge

public ArchetypeEdge findEdge(ArchetypeVertex v)

Description copied from interface: ArchetypeVertex

Returns an edge that connects this vertex to v. If this edge is not uniquely defined (that is, if the graph contains more than one edge connecting this vertex to v), any of these edges v may be returned. findEdgeSet(v) may be used to return all such edges. If v is not connected to this vertex, returns null.

Specified by:

findEdge in interface ArchetypeVertex

See Also:

ArchetypeVertex.findEdge(ArchetypeVertex)

findEdgeSet

public Set findEdgeSet(ArchetypeVertex v)

Description copied from interface: ArchetypeVertex

Returns the set of all edges that connect this vertex with the specified vertex 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.

Specified by:

findEdgeSet in interface ArchetypeVertex

See Also:

ArchetypeVertex.findEdgeSet(ArchetypeVertex)

numNeighbors

public int numNeighbors()

Not a very efficient implemenation: for each edge, counts the neighbors.

Specified by:

numNeighbors in interface ArchetypeVertex

See Also:

ArchetypeVertex.numNeighbors()

copy

public ArchetypeVertex copy(ArchetypeGraph g)

Description copied from interface: ArchetypeVertex

Creates a copy of this vertex in graph g. The vertex created will be equivalent to this vertex: given v = this.copy(g), then this.getEquivalentVertex(g) == v, and this.equals(v) == true.

Specified by:

copy in interface ArchetypeVertex

Parameters:

g - the graph in which the copied vertex will be placed

Returns:

the vertex created

See Also:

ArchetypeVertex.copy(edu.uci.ics.jung.graph.ArchetypeGraph)

connectEdge

public boolean connectEdge(Hyperedge e)

Description copied from interface: Hypervertex

Connects he to this hypervertex and vice versa. Does not affect he's membership in the graph. Equivalent to calling he.connectVertex(this).

Specified by:

connectEdge in interface Hypervertex

disconnectEdge

public boolean disconnectEdge(Hyperedge e)

Description copied from interface: Hypervertex

Disconnects he from this hypervertex and vice versa. Does not affect he's membership in the graph. Equivalent to calling he.disconnectVertex(this).

Specified by:

disconnectEdge in interface Hypervertex