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

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

All Implemented Interfaces:

ArchetypeEdge, Element, Hyperedge, UserDataContainer, Cloneable

Deprecated. As of version 1.7, replaced by native implementations of Hyperedge.

public class HyperedgeBPG
extends AbstractHyperUnitBPG
implements Hyperedge

A HyperEdge has zero or more HyperVertices attached to it; this implements that as part of an underlying HyperGraph.

Author:

danyelf

See Also:

SetHyperedge, ListHyperedge

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

HyperedgeBPG()
Deprecated.

Method Summary

boolean	connectVertex(Hypervertex hv3_x) Deprecated. Registers an additional vertex hv3_x onto this Edge.
ArchetypeEdge	copy(ArchetypeGraph g) Deprecated. Creates a copy of this edge in graph g.
boolean	disconnectVertex(Hypervertex v) Deprecated. Disconnects hv1 from this hyperedge and vice versa.
ArchetypeEdge	getEqualEdge(ArchetypeGraph g) Deprecated. Returns the edge in graph g, if any, that is equivalent to this edge.
ArchetypeEdge	getEquivalentEdge(ArchetypeGraph g) Deprecated. As of version 1.4, renamed to getEqualEdge(g).
Set	getIncidentElements() Deprecated. Returns the set of elements that are incident to this element.
Set	getIncidentVertices() Deprecated. Returns the set of vertices which are incident to this edge.
boolean	isIncident(ArchetypeVertex v) Deprecated. Returns true if the specified vertex v is incident to this edge, and false otherwise.
int	numVertices() Deprecated. Returns the number of vertices which are incident to this edge.

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

HyperedgeBPG

public HyperedgeBPG()

Deprecated.

Method Detail

getIncidentElements

public Set getIncidentElements()

Deprecated.

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

getIncidentVertices

public Set getIncidentVertices()

Deprecated.

Description copied from interface: ArchetypeEdge

Returns the set of vertices which are incident to this edge. Each of the vertices returned should implement ArchetypeVertex. For example, returns the source and destination vertices of a directed edge.

Specified by:

getIncidentVertices in interface ArchetypeEdge

Returns:

the vertices incident to this edge

See Also:

ArchetypeEdge.getIncidentVertices()

getEqualEdge

public ArchetypeEdge getEqualEdge(ArchetypeGraph g)

Deprecated.

Description copied from interface: ArchetypeEdge

Returns the edge in graph g, if any, that is equivalent to this edge. Two edges are equivalent if one of them is an ancestor (via copy()) of the other.

Specified by:

getEqualEdge in interface ArchetypeEdge

See Also:

ArchetypeEdge.getEqualEdge(edu.uci.ics.jung.graph.ArchetypeGraph)

getEquivalentEdge

public ArchetypeEdge getEquivalentEdge(ArchetypeGraph g)

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

Specified by:

getEquivalentEdge in interface ArchetypeEdge

numVertices

public int numVertices()

Deprecated.

Description copied from interface: ArchetypeEdge

Returns the number of vertices which are incident to this edge.

Specified by:

numVertices in interface ArchetypeEdge

See Also:

ArchetypeEdge.numVertices()

isIncident

public boolean isIncident(ArchetypeVertex v)

Deprecated.

Description copied from interface: ArchetypeEdge

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

Specified by:

isIncident in interface ArchetypeEdge

See Also:

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

copy

public ArchetypeEdge copy(ArchetypeGraph g)

Deprecated.

Description copied from interface: ArchetypeEdge

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

Given the set of vertices S that are incident to this edge, the copied edge will be made incident to the set of vertices S' in g that are equivalent to S. S must be copied into g before this edge can be copied into g. If there is no such set of vertices in g, this method throws IllegalArgumentException.

Thus, for example, given the following code:

      Graph g1 = new Graph();
      Vertex v1 = g1.addVertex(new DirectedSparseVertex());
      Vertex v2 = g1.addVertex(new DirectedSparseVertex());
      ... 
      Edge e = g1.addEdge(new DirectedSparseEdge(v1, v2));
      Vertex v3 = v1.getEquivalentVertex(g2);
      Vertex v4 = v2.getEquivalentVertex(g2);
 

then e.copy(g2) will create a directed edge connecting v3 to v4 in g2.

Specified by:

copy in interface ArchetypeEdge

Parameters:

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

Returns:

the edge created

See Also:

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

connectVertex

public boolean connectVertex(Hypervertex hv3_x)

Deprecated.

Registers an additional vertex hv3_x onto this Edge.

Specified by:

connectVertex in interface Hyperedge

disconnectVertex

public boolean disconnectVertex(Hypervertex v)

Deprecated.

Description copied from interface: Hyperedge

Disconnects hv1 from this hyperedge and vice versa. Does not affect hv1's membership in the graph. Equivalent to calling hv1.disconnectEdge(this).

Specified by:

disconnectVertex in interface Hyperedge