Package org.graph4j.util

Class EdgeSet

java.lang.Object

java.util.AbstractCollection<Edge>

java.util.AbstractSet<Edge>

java.util.HashSet<Edge>

org.graph4j.util.EdgeSet

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Edge>, Collection<Edge>, Set<Edge>

public class EdgeSet
extends HashSet<Edge>

A set of edges in a graph. This is actually an extension of HashSet<Edge>.

Author:

Cristian Frăsinaru

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Graph	graph

Constructor Summary

Constructors

Constructor	Description
EdgeSet(Graph graph)	Constructs a new, empty set of edges.
EdgeSet(Graph graph, int initialCapacity)	Constructs a new, empty set of edges, with a specified initial capacity.
EdgeSet(Graph graph, Collection<Edge> edges)	Constructs a new set containing the elements in the specified collection.
EdgeSet(Graph graph, Edge[] edges)	Constructs a new set containing the elements in the specified array.

Method Summary

Modifier and Type	Method	Description
boolean	add(int v, int u)	Adds the edge (v,u) to this set if it is not already present.
VertexSet	vertexSet()	Returns the vertices representing endpoints of the edges in this collection.
double	weight()	Computes the sum of the weights associated with each edge in the collection.

Methods inherited from class java.util.HashSet

add, clear, clone, contains, isEmpty, iterator, newHashSet, remove, size, spliterator, toArray, toArray

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

addAll, containsAll, equals, hashCode, removeAll, retainAll

Field Details

graph

protected Graph graph

Constructor Details

EdgeSet

public EdgeSet(Graph graph)

Constructs a new, empty set of edges.

Parameters:

graph - the graph the edges belong to.

EdgeSet

public EdgeSet(Graph graph,
 int initialCapacity)

Constructs a new, empty set of edges, with a specified initial capacity.

Parameters:

graph - the graph the edges belong to.

initialCapacity - the initial capacity of this collection.

EdgeSet

public EdgeSet(Graph graph,
 Collection<Edge> edges)

Constructs a new set containing the elements in the specified collection.

Parameters:

graph - the graph the edges belong to.

edges - the collection of edges whose elements are to be placed into this set.

EdgeSet

public EdgeSet(Graph graph,
 Edge[] edges)

Constructs a new set containing the elements in the specified array.

Parameters:

graph - the graph the edges belong to.

edges - the array of edges whose elements are to be placed into this set.

Method Details

vertexSet

public VertexSet vertexSet()

Returns the vertices representing endpoints of the edges in this collection.

Returns:

the vertices representing endpoints of the edges in this collection.

add

public boolean add(int v,
 int u)

Adds the edge (v,u) to this set if it is not already present.

Parameters:

v - the source endpoint of the edge.

u - the target endpoint of the edge.

Returns:

true if the set did not already contain the specified edge, false otherwise.

weight

public double weight()

Computes the sum of the weights associated with each edge in the collection.

Returns:

the sum of all weights of the edges in the collection, including duplicates.