edu.ucla.sspace.graph

Class SparseWeightedEdgeSet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<WeightedEdge>

edu.ucla.sspace.graph.SparseWeightedEdgeSet

All Implemented Interfaces:

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

public class SparseWeightedEdgeSet
extends AbstractSet<WeightedEdge>
implements EdgeSet<WeightedEdge>, Serializable

A set for containing WeightedEdge instances. Note that the equality condition for WeightedEdge is treated specially in this set such that two vertices will only have at most one edge between them. If an edge exists for vertices i and j with weight w₁, then adding a new edge to the same vertices with weight w₂ will not add a parallel edge and increase the size of this set, even though the edges are not equal. Rather, the weight on the edge between the two vertices is changed to w₂. Similarly, any contains or removal operation will return its value based on the WeightedEdge's vertices but not on the weight of the edge itself.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SparseWeightedEdgeSet(int rootVertex) Creates a new SparseWeightedEdgeSet where all edges in this set must connect to rootVertex.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(WeightedEdge e) Adds the edge to this set if one of the vertices is 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.
boolean	contains(Object o)
SparseWeightedEdgeSet	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<WeightedEdge>	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.
Iterator<WeightedEdge>	iterator()
boolean	remove(Object o)
int	size()
double	sum() Returns the sum of the weights of the edges contained in this set.

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, clear, containsAll, isEmpty, 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, isEmpty, removeAll, retainAll, toArray, toArray

Constructor Detail

SparseWeightedEdgeSet

public SparseWeightedEdgeSet(int rootVertex)

Creates a new SparseWeightedEdgeSet where all edges in this set must connect to rootVertex.

Method Detail

add

public boolean add(WeightedEdge e)

Adds the edge to this set if one of the vertices is the root vertex.

Specified by:

add in interface EdgeSet<WeightedEdge>

Specified by:

add in interface Collection<WeightedEdge>

Specified by:

add in interface Set<WeightedEdge>

Overrides:

add in class AbstractCollection<WeightedEdge>

Returns:

true if e was added or if the weight was changed for the conenction between an existing edge that matched

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.

Specified by:

connected in interface EdgeSet<WeightedEdge>

connects

public boolean connects(int vertex)

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

Specified by:

connects in interface EdgeSet<WeightedEdge>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<WeightedEdge>

Specified by:

contains in interface Set<WeightedEdge>

Overrides:

contains in class AbstractCollection<WeightedEdge>

copy

public SparseWeightedEdgeSet 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<WeightedEdge>

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<WeightedEdge>

getEdges

public Set<WeightedEdge> 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<WeightedEdge>

getRoot

public int getRoot()

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

Specified by:

getRoot in interface EdgeSet<WeightedEdge>

iterator

public Iterator<WeightedEdge> iterator()

Specified by:

iterator in interface Iterable<WeightedEdge>

Specified by:

iterator in interface Collection<WeightedEdge>

Specified by:

iterator in interface Set<WeightedEdge>

Specified by:

iterator in class AbstractCollection<WeightedEdge>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<WeightedEdge>

Specified by:

remove in interface Set<WeightedEdge>

Overrides:

remove in class AbstractCollection<WeightedEdge>

size

public int size()

Specified by:

size in interface Collection<WeightedEdge>

Specified by:

size in interface Set<WeightedEdge>

Specified by:

size in class AbstractCollection<WeightedEdge>

sum

public double sum()

Returns the sum of the weights of the edges contained in this set.