com.net2plan.libraries

Class GraphUtils.GraphPath<E>

Object

com.net2plan.libraries.GraphUtils.GraphPath<E>

Type Parameters:

E - Edge type

All Implemented Interfaces:

Comparable<GraphUtils.GraphPath>

Enclosing class:

GraphUtils

public static class GraphUtils.GraphPath<E>
extends Object
implements Comparable<GraphUtils.GraphPath>

Class to represent a path in a Graph. Note that a path is defined in terms of edges (rather than vertices) so that multiple edges between the same pair of vertices can be discriminated.

It implements the {@link java.lang.Comparable Comparable} interface to impose order between different paths. First, try to order using the path weight, and if equals, using the number of hops.

Since:

0.2.0

Author:

Pablo Pavon-Marino, Jose-Luis Izquierdo-Zaragoza

Constructor Summary

Constructors

Constructor and Description
GraphUtils.GraphPath(List<E> path, double pathWeight) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(GraphUtils.GraphPath o) Compares this object with the specified object for order.
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
List<E>	getPath() Returns the edges making up the path.
int	getPathLength() Returns the path length measured in number of hops or edges.
double	getPathWeight() Returns the weight assigned to the path.
int	hashCode() Returns a hash code value for the object.

Methods inherited from class Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GraphUtils.GraphPath

public GraphUtils.GraphPath(List<E> path,
                    double pathWeight)

Default constructor.

Parameters:

path - Sequence of links

pathWeight - Path weight

Since:

0.2.0

Method Detail

compareTo

public int compareTo(GraphUtils.GraphPath o)

Compares this object with the specified object for order.

Specified by:

compareTo in interface Comparable<GraphUtils.GraphPath>

Parameters:

o - The object to be compared

Returns:

A negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object

Since:

0.2.0

equals

public boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class Object

Parameters:

o - Reference object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise

Since:

0.2.0

getPath

public List<E> getPath()

Returns the edges making up the path.

Returns:

An unmodifiable list with the sequence of edges followed by the path

Since:

0.2.0

getPathLength

public int getPathLength()

Returns the path length measured in number of hops or edges. It is equivalent to {@link #getPath getPath()}.size().

Returns:

The path length

Since:

0.2.0

getPathWeight

public double getPathWeight()

Returns the weight assigned to the path.

Returns:

The weight assigned to the path

Since:

0.2.0

hashCode

public int hashCode()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

Overrides:

hashCode in class Object

Returns:

Hash code value for this object

Since:

0.2.0