com.codemelon.graph.graph

Class UndirectedWeightedEdgeGraph<E extends EdgeWeightData,V extends UndirectedEdgeDataVertex<E> & EdgeWeightVertex<E>>

java.lang.Object

com.codemelon.graph.graph.AbstractGraph<V>

com.codemelon.graph.graph.UndirectedEdgeDataGraph<E,V>

com.codemelon.graph.graph.UndirectedWeightedEdgeGraph<E,V>

All Implemented Interfaces:

WeightedEdgeGraph

Direct Known Subclasses:

KruskalGraph

public class UndirectedWeightedEdgeGraph<E extends EdgeWeightData,V extends UndirectedEdgeDataVertex<E> & EdgeWeightVertex<E>>
extends UndirectedEdgeDataGraph<E,V>
implements WeightedEdgeGraph

Undirected graph supporting floating point edge weight. This graph also has a method for determining floating point equality between weights by determining whether or not the difference lies below a certain epsilon value defined for the graph at the time of its creation.

Field Summary

Fields inherited from interface com.codemelon.graph.graph.WeightedEdgeGraph

DEFAULT_WEIGHT_EPSILON

Constructor Summary

Constructors

Constructor and Description
UndirectedWeightedEdgeGraph() Initialize an empty graph using the default values for weightEpsilon and initial capacity.
UndirectedWeightedEdgeGraph(java.util.Collection<V> vertices) Use the vertices in a collection as the initial vertices in the graph and set weight epsilon to the default value.
UndirectedWeightedEdgeGraph(java.util.Collection<V> vertices, double weightEpsilon) Use the vertices in a collection as the initial vertices in the graph and set weight epsilon to the specified value.
UndirectedWeightedEdgeGraph(double weightEpsilon) Initialize an empty graph using the given value for weightEpsilon and default initial capacity.
UndirectedWeightedEdgeGraph(int initialCapacity) Initialize an empty graph to have capacity for the given number of vertices and the default weight epsilon.
UndirectedWeightedEdgeGraph(int initialCapacity, double weightEpsilon) Initialize an empty graph to have capacity for the given number of vertices and the specified weight epsilon.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	areEqualWeights(double w1, double w2) Determine if 2 floating point weights are to be considered equal in the given graph.
java.util.Set<UndirectedWeightedEdge<E,V>>	getWeightedEdges() Return a set containing all weighted edges in the graph.
double	getWeightEpsilon() Retrieve the epsilon used to determine weight equality in the given graph.

Methods inherited from class com.codemelon.graph.graph.UndirectedEdgeDataGraph

edgeCount

Methods inherited from class com.codemelon.graph.graph.AbstractGraph

addVertex, containsEdge, containsVertex, getVertices, removeVertex, vertexCount, vertexIterator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UndirectedWeightedEdgeGraph

public UndirectedWeightedEdgeGraph()

Initialize an empty graph using the default values for weightEpsilon and initial capacity.

UndirectedWeightedEdgeGraph

public UndirectedWeightedEdgeGraph(double weightEpsilon)

Initialize an empty graph using the given value for weightEpsilon and default initial capacity. The input value must be greater than 0.

Parameters:

weightEpsilon - weight epsilon to be used to determine weight equality in this graph

UndirectedWeightedEdgeGraph

public UndirectedWeightedEdgeGraph(java.util.Collection<V> vertices)

Use the vertices in a collection as the initial vertices in the graph and set weight epsilon to the default value.

Parameters:

vertices - collection of vertices that will make up the initial vertices of the graph

UndirectedWeightedEdgeGraph

public UndirectedWeightedEdgeGraph(java.util.Collection<V> vertices,
                           double weightEpsilon)

Use the vertices in a collection as the initial vertices in the graph and set weight epsilon to the specified value.

Parameters:

vertices - collection of vertices that will make up the initial vertices of the graph

weightEpsilon - weight epsilon to be used to determine weight equality in this graph

UndirectedWeightedEdgeGraph

public UndirectedWeightedEdgeGraph(int initialCapacity)

Initialize an empty graph to have capacity for the given number of vertices and the default weight epsilon.

Parameters:

initialCapacity - expected number of vertices in the graph

UndirectedWeightedEdgeGraph

public UndirectedWeightedEdgeGraph(int initialCapacity,
                           double weightEpsilon)

Initialize an empty graph to have capacity for the given number of vertices and the specified weight epsilon.

Parameters:

initialCapacity - expected number of vertices in the graph

weightEpsilon - weight epsilon to be used to determine weight equality in this graph

Method Detail

areEqualWeights

public boolean areEqualWeights(double w1,
                      double w2)

Description copied from interface: WeightedEdgeGraph

Determine if 2 floating point weights are to be considered equal in the given graph.

Specified by:

areEqualWeights in interface WeightedEdgeGraph

Parameters:

w1 - one of the weights to be tested for equality

w2 - the other weight to be tested for equality

Returns:

true if the absolute value of the difference between the 2 weights is below the a threshold

getWeightEpsilon

public double getWeightEpsilon()

Description copied from interface: WeightedEdgeGraph

Retrieve the epsilon used to determine weight equality in the given graph.

Specified by:

getWeightEpsilon in interface WeightedEdgeGraph

Returns:

the epsilon used to determine weight equality in the given graph

getWeightedEdges

public java.util.Set<UndirectedWeightedEdge<E,V>> getWeightedEdges()

Return a set containing all weighted edges in the graph.

Returns:

a set containing all weighted edges in the graph