org.jorlib.io.tspLibReader.graph

Class NodeCoordinates

java.lang.Object

org.jorlib.io.tspLibReader.graph.DistanceTable

org.jorlib.io.tspLibReader.graph.NodeCoordinates

public class NodeCoordinates
extends DistanceTable

Stores the nodes in a TSPLIB problem instance and provides methods for calculating the distances between nodes.

Author:

David Hadka

Constructor Summary

Constructors

Constructor and Description
NodeCoordinates(int size, EdgeWeightType edgeWeightType) Constructs a new, empty node coordinates instance.
NodeCoordinates(int size, NodeCoordType type, DistanceFunction distanceFunction) Constructs a new, empty node coordinates instance.

Method Summary

Modifier and Type	Method and Description
protected void	add(Node node) Adds the specified node to this problem instance.
protected void	clear() Removes all nodes from this problem instance.
Node	get(int id) Returns the node with the specified identifier.
double	getDistanceBetween(int id1, int id2) Returns the distance between the two specified nodes.
int[]	getNeighborsOf(int id) Returns the identifiers of all neighbors of the specified node.
int[]	listNodes() Returns the identifiers of all nodes in this distance table.
void	load(BufferedReader reader) Loads the distance table from the specified reader.
protected void	remove(int id) Removes the node with the specified identifier from this problem instance.
int	size() Returns the number of nodes that this instance contains.
String	toString()

Methods inherited from class org.jorlib.io.tspLibReader.graph.DistanceTable

isNeighbor

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeCoordinates

public NodeCoordinates(int size,
                       EdgeWeightType edgeWeightType)

Constructs a new, empty node coordinates instance.

Parameters:

size - the number of nodes to load into this problem instance

edgeWeightType - the edge weight type

NodeCoordinates

public NodeCoordinates(int size,
                       NodeCoordType type,
                       DistanceFunction distanceFunction)

Constructs a new, empty node coordinates instance.

Parameters:

size - the number of nodes to load into this problem instance

type - the type of coordinates (i.e., 2D or 3D)

distanceFunction - the distance function

Method Detail

load

public void load(BufferedReader reader)
          throws IOException

Description copied from class: DistanceTable

Loads the distance table from the specified reader.

Specified by:

load in class DistanceTable

Parameters:

reader - the reader containing the distance table

Throws:

IOException - if an I/O error occurred while reading the distance table

add

protected void add(Node node)

Adds the specified node to this problem instance. If a node with the same identifier already exists, the previous node will be replaced.

Parameters:

node - the node to add

get

public Node get(int id)

Returns the node with the specified identifier.

Parameters:

id - the identifier of the node to return

Returns:

the node with the specified identifier

remove

protected void remove(int id)

Removes the node with the specified identifier from this problem instance.

Parameters:

id - the identifier of the node to remove

clear

protected void clear()

Removes all nodes from this problem instance.

size

public int size()

Returns the number of nodes that this instance contains.

Returns:

the number of nodes that this instance contains

listNodes

public int[] listNodes()

Description copied from class: DistanceTable

Returns the identifiers of all nodes in this distance table.

Specified by:

listNodes in class DistanceTable

Returns:

the identifiers of all nodes in this distance table

getNeighborsOf

public int[] getNeighborsOf(int id)

Description copied from class: DistanceTable

Returns the identifiers of all neighbors of the specified node. A neighbor must have a direct edge between itself and the specified node.

Specified by:

getNeighborsOf in class DistanceTable

Parameters:

id - the identifier of the node whose neighbors are enumerated

Returns:

the identifiers of all neighbors of the specified node

getDistanceBetween

public double getDistanceBetween(int id1,
                                 int id2)

Description copied from class: DistanceTable

Returns the distance between the two specified nodes.

Specified by:

getDistanceBetween in class DistanceTable

Parameters:

id1 - the identifier of the first node

id2 - the identifier of the second node

Returns:

the distance between the two specified nodes

toString

public String toString()

Overrides:

toString in class Object