com.codemelon.graph.edge

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

java.lang.Object

com.codemelon.graph.edge.UndirectedWeightedEdge<E,V>

public class UndirectedWeightedEdge<E extends EdgeWeightData,V extends UndirectedEdgeDataVertex<E> & EdgeWeightVertex<E>>
extends java.lang.Object

Immutable, undirected edges that maintain a floating point weight. Since the edge is undirected, the distinction between head and tail or from and to is arbitrary. Once the edge has been initialized, it will alway show the same from() and to() vertices, but it is equivalent to an edge object having opposite from() and to() vertices.

Constructor Summary

Constructors

Constructor and Description
UndirectedWeightedEdge(V from, V to)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Since weighted edges are undirected, they are equal not only if they have the same tail and head but also if they have opposite tails and heads.
V	from() Returns one end of the given edge.
AbstractGraph<? extends Vertex>	getGraph() Get the graph to which the edge belongs
int	hashCode() Overridden so that adding weighted edges to a HashSet will automatically eliminate duplicates.
V	to() Returns one end of the given edge.
double	weight() Returns the edge's weight.

Methods inherited from class java.lang.Object

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

Constructor Detail

UndirectedWeightedEdge

public UndirectedWeightedEdge(V from,
                      V to)

Parameters:

from -

to -

Method Detail

from

public final V from()

Returns one end of the given edge. Note that the edge is undirected, so the distinction between head and tail or from and to is arbitrary. Once the edge has been initialized, it will always show the same from() and to() vertices, but it is equivalent to an edge object having opposite from() and to() vertices.

Returns:

the "from" vertex specified in the constructor

to

public final V to()

Returns one end of the given edge. Note that the edge is undirected, so the distinction between head and tail or from and to is arbitrary. Once the edge has been initialized, it will alway show the same from() and to() vertices, but it is equivalent to an edge object having opposite from() and to() vertices.

Returns:

the "from" vertex specified in the constructor

weight

public final double weight()

Returns the edge's weight.

Returns:

the edge's weight

getGraph

public final AbstractGraph<? extends Vertex> getGraph()

Get the graph to which the edge belongs

Returns:

the graph to which the edge belongs

equals

public final boolean equals(java.lang.Object o)

Since weighted edges are undirected, they are equal not only if they have the same tail and head but also if they have opposite tails and heads. That is, 2 edges e1 and e2 are equal if either of the following conditions holds:

1. e1.from() == e2.from() && e1.to() == e2.to(), or
2. e1.from() == e2.to() && e1.to() == e2.from()

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overridden so that adding weighted edges to a HashSet will automatically eliminate duplicates. We want edges that are equal (according to the equals() method) to have the same hash code.

Overrides:

hashCode in class java.lang.Object