edu.ucla.sspace.graph

Interface EdgeSet<T extends Edge>

Type Parameters:

T - the type of Edge being stored within this set.

All Superinterfaces:

Collection<T>, Iterable<T>, Set<T>

All Known Implementing Classes:

GenericEdgeSet, SparseDirectedEdgeSet, SparseDirectedTypedEdgeSet, SparseTypedEdgeSet, SparseUndirectedEdgeSet, SparseWeightedDirectedEdgeSet, SparseWeightedDirectedTypedEdgeSet, SparseWeightedEdgeSet

public interface EdgeSet<T extends Edge>
extends Set<T>

A subinterface of Set that provides an abstraction over the set of edges that are connected to a single vertex. In addition, the interface provides utility methods for interacting with the Edge objects stored within the set on the basis of their vertex indices.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(T edge) Adds the edge to the set only if the edge is connected to the root vertex.
IntSet	connected() Returns the set of vertices connected to the root edges.
boolean	connects(int vertex) Returns true if the root vertex is connected to the provided vertex.
EdgeSet	copy(IntSet vertices) Copies the edges in this set that are connected to any of the vertices in the provided set.
int	disconnect(int vertex) Removes all edges instances that connect to the specified vertex, returning the number of edges that were removed, if any.
Set<T>	getEdges(int vertex) Returns the set of Edge instances that connect the root vertex with this vertex or an empty set if no such edges exist.
int	getRoot() Returns the vertex to which all edges in this set are connected.

Methods inherited from interface java.util.Set

addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Method Detail

add

boolean add(T edge)

Adds the edge to the set only if the edge is connected to the root vertex.

Specified by:

add in interface Collection<T extends Edge>

Specified by:

add in interface Set<T extends Edge>

Returns:

true if the edge was added, false if the edge was already present, or if it could not be added to this edge set due to the root vertex not being connected to the edge

connected

IntSet connected()

Returns the set of vertices connected to the root edges. Implementations are left free to decide whether modifications to this set are allowed.

connects

boolean connects(int vertex)

Returns true if the root vertex is connected to the provided vertex.

copy

EdgeSet copy(IntSet vertices)

Copies the edges in this set that are connected to any of the vertices in the provided set.

disconnect

int disconnect(int vertex)

Removes all edges instances that connect to the specified vertex, returning the number of edges that were removed, if any.

getEdges

Set<T> getEdges(int vertex)

Returns the set of Edge instances that connect the root vertex with this vertex or an empty set if no such edges exist.

getRoot

int getRoot()

Returns the vertex to which all edges in this set are connected.