edu.ucla.sspace.graph

Class SparseDirectedEdgeSet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<DirectedEdge>

edu.ucla.sspace.graph.SparseDirectedEdgeSet

All Implemented Interfaces:

EdgeSet<DirectedEdge>, Serializable, Iterable<DirectedEdge>, Collection<DirectedEdge>, Set<DirectedEdge>

public class SparseDirectedEdgeSet
extends AbstractSet<DirectedEdge>
implements EdgeSet<DirectedEdge>, Serializable

An EdgeSet implementation that stores DirectedEdge instances for a vertex.

Author:

David Jurgens

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SparseDirectedEdgeSet(int rootVertex) Creates a new SparseDirectedEdgeSet for the specfied vertex.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(DirectedEdge e) Adds the edge to this set if one of the vertices is the root vertex and if the non-root vertex has a greater index that this 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.
boolean	contains(Object o)
SparseDirectedEdgeSet	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<DirectedEdge>	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.
Set<DirectedEdge>	inEdges() Returns the set of DirectedEdge instances that point to the root vertex.
boolean	isEmpty()
Iterator<DirectedEdge>	iterator()
Set<DirectedEdge>	outEdges() Returns the set of DirectedEdge instances that originate from the root vertex.
boolean	remove(Object o)
int	size()

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, clear, containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

addAll, clear, containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray

Constructor Detail

SparseDirectedEdgeSet

public SparseDirectedEdgeSet(int rootVertex)

Creates a new SparseDirectedEdgeSet for the specfied vertex.

Method Detail

add

public boolean add(DirectedEdge e)

Adds the edge to this set if one of the vertices is the root vertex and if the non-root vertex has a greater index that this vertex.

Specified by:

add in interface EdgeSet<DirectedEdge>

Specified by:

add in interface Collection<DirectedEdge>

Specified by:

add in interface Set<DirectedEdge>

Overrides:

add in class AbstractCollection<DirectedEdge>

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

public 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. The set of vertices returned by this set is immutable.

Specified by:

connected in interface EdgeSet<DirectedEdge>

connects

public boolean connects(int vertex)

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

Specified by:

connects in interface EdgeSet<DirectedEdge>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<DirectedEdge>

Specified by:

contains in interface Set<DirectedEdge>

Overrides:

contains in class AbstractCollection<DirectedEdge>

copy

public SparseDirectedEdgeSet copy(IntSet vertices)

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

Specified by:

copy in interface EdgeSet<DirectedEdge>

disconnect

public int disconnect(int vertex)

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

Specified by:

disconnect in interface EdgeSet<DirectedEdge>

getEdges

public Set<DirectedEdge> 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.

Specified by:

getEdges in interface EdgeSet<DirectedEdge>

getRoot

public int getRoot()

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

Specified by:

getRoot in interface EdgeSet<DirectedEdge>

inEdges

public Set<DirectedEdge> inEdges()

Returns the set of DirectedEdge instances that point to the root vertex. Changes to this set will be reflected in this EdgeSet and vice versa.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<DirectedEdge>

Specified by:

isEmpty in interface Set<DirectedEdge>

Overrides:

isEmpty in class AbstractCollection<DirectedEdge>

iterator

public Iterator<DirectedEdge> iterator()

Specified by:

iterator in interface Iterable<DirectedEdge>

Specified by:

iterator in interface Collection<DirectedEdge>

Specified by:

iterator in interface Set<DirectedEdge>

Specified by:

iterator in class AbstractCollection<DirectedEdge>

outEdges

public Set<DirectedEdge> outEdges()

Returns the set of DirectedEdge instances that originate from the root vertex. Changes to this set will be reflected in this EdgeSet and vice versa.

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<DirectedEdge>

Specified by:

remove in interface Set<DirectedEdge>

Overrides:

remove in class AbstractCollection<DirectedEdge>

size

public int size()

Specified by:

size in interface Collection<DirectedEdge>

Specified by:

size in interface Set<DirectedEdge>

Specified by:

size in class AbstractCollection<DirectedEdge>