TSPLibInstance (Java Operations Research Library)

java.lang.Object
- org.jorlib.io.tspLibReader.TSPLibInstance

public class TSPLibInstance
extends Object

A TSPLIB problem instance.

Author:: David Hadka

Constructor Summary

Constructors
Constructor and Description
`TSPLibInstance()` Constructs a new, empty TSPLIB problem instance.
`TSPLibInstance(File file)` Constructs a TSPLIB problem instance from the specified TSPLIB file.
`TSPLibInstance(InputStream inputStream)` Constructs a TSPLIB problem instance from the specified TSPLIB file.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTour(File file)` Adds a solution to this TSPLIB problem instance that is defined in a separate file.
`void`	`addTour(InputStream inputStream)` Adds a solution to this TSPLIB problem instance that is defined in a separate file.
`void`	`addTour(TSPLibTour tour)` Adds a solution to this TSPLIB problem instance.
`int`	`getCapacity()` Returns the truck capacity in CVRP problem instances.
`String`	`getComment()` Returns any comments about this problem instance.
`DataType`	`getDataType()` Returns the type of this problem instance.
`int`	`getDimension()` Returns the number of nodes defined by this problem instance.
`NodeCoordinates`	`getDisplayData()` Returns the data used to graphically display the nodes; or `null` if the display data is not explicitly defined.
`DisplayDataType`	`getDisplayDataType()` Returns the way graphical displays of the data should be generated.
`DistanceTable`	`getDistanceTable()` Returns the distance table that defines the nodes, edges, and weights for this problem instance.
`EdgeDataFormat`	`getEdgeDataFormat()` Returns the format of edge data; or `null` if edge data is not explicitly defined.
`EdgeWeightFormat`	`getEdgeWeightFormat()` Returns the format of the edge weight matrix when explicit weights are used; or `null` if edge weights are not explicit.
`EdgeWeightType`	`getEdgeWeightType()` Returns the way edge weights are specified.
`EdgeData`	`getFixedEdges()` Returns the edges that are required in each solution to this problem instance.
`String`	`getName()` Returns the name of this problem instance.
`NodeCoordType`	`getNodeCoordinateType()` Returns the format of node coordinate data.
`List<TSPLibTour>`	`getTours()` Returns the solutions to this problem instance.
`VehicleRoutingTable`	`getVehicleRoutingTable()` Returns the demands and depot nodes for vehicle routing problems; or `null` if this is not a vehicle routing problem instance.
`void`	`load(BufferedReader reader)` Loads a problem instance from the specified TSPLIB file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TSPLibInstance
```
public TSPLibInstance()
```
    Constructs a new, empty TSPLIB problem instance.
  - TSPLibInstance
```
public TSPLibInstance(File file)
               throws IOException
```
    Constructs a TSPLIB problem instance from the specified TSPLIB file.
    
    Parameters:
    
    file - the TSPLIB file defining the problem
    
    Throws:
    
    IOException - if an I/O error occurred while loading the TSPLIB file
  - TSPLibInstance
```
public TSPLibInstance(InputStream inputStream)
               throws IOException
```
    Constructs a TSPLIB problem instance from the specified TSPLIB file.
    
    Parameters:
    
    inputStream - inputStream to the TSPLIB file defining the problem
    
    Throws:
    
    IOException - if an I/O error occurred while loading the TSPLIB file
- Method Detail
  - load
```
public void load(BufferedReader reader)
          throws IOException
```
    Loads a problem instance from the specified TSPLIB file.
    
    Parameters:
    
    reader - input stream to a TSPLIB file defining the problem
    
    Throws:
    
    IOException - if an I/O error occurred while loading the TSPLIB file
  - addTour
```
public void addTour(TSPLibTour tour)
```
    Adds a solution to this TSPLIB problem instance. This method does not verify that the solution has all required edges; the caller must ensure this condition holds.
    
    Parameters:
    
    tour - the solution to add
  - addTour
```
public void addTour(File file)
             throws IOException
```
    Adds a solution to this TSPLIB problem instance that is defined in a separate file. This method does not verify that the solution is a valid tour for this problem instance; the caller must ensure this condition holds.
    
    Parameters:
    
    file - the file containing a solution to this TSPLIB problem instance
    
    Throws:
    
    IOException - if an I/O error occurred while loading the tour
  - addTour
```
public void addTour(InputStream inputStream)
             throws IOException
```
    Adds a solution to this TSPLIB problem instance that is defined in a separate file. This method does not verify that the solution is a valid tour for this problem instance; the caller must ensure this condition holds.
    
    Parameters:
    
    inputStream - inputStream to the file containing a solution to this TSPLIB problem instance
    
    Throws:
    
    IOException - if an I/O error occurred while loading the tour
  - getName
```
public String getName()
```
    Returns the name of this problem instance.
    
    Returns:
    
    the name of this problem instance
  - getDataType
```
public DataType getDataType()
```
    Returns the type of this problem instance.
    
    Returns:
    
    the type of this problem instance
  - getComment
```
public String getComment()
```
    Returns any comments about this problem instance.
    
    Returns:
    
    any comments about this problem instance
  - getDimension
```
public int getDimension()
```
    Returns the number of nodes defined by this problem instance.
    
    Returns:
    
    the number of nodes defined by this problem instance
  - getCapacity
```
public int getCapacity()
```
    Returns the truck capacity in CVRP problem instances. The return value is undefined if the data type is not CVRP.
    
    Returns:
    
    the truck capacity in CVRP problem instances
  - getEdgeWeightType
```
public EdgeWeightType getEdgeWeightType()
```
    Returns the way edge weights are specified.
    
    Returns:
    
    the way edge weights are specified
  - getEdgeWeightFormat
```
public EdgeWeightFormat getEdgeWeightFormat()
```
    Returns the format of the edge weight matrix when explicit weights are used; or null if edge weights are not explicit.
    
    Returns:
    
    the format of the edge weight matrix when explicit weights are used; or null if edge weights are not explicit
  - getEdgeDataFormat
```
public EdgeDataFormat getEdgeDataFormat()
```
    Returns the format of edge data; or null if edge data is not explicitly defined.
    
    Returns:
    
    the format of edge data; or null if edge data is not explicitly defined
  - getNodeCoordinateType
```
public NodeCoordType getNodeCoordinateType()
```
    Returns the format of node coordinate data.
    
    Returns:
    
    the format of node coordinate data
  - getDisplayDataType
```
public DisplayDataType getDisplayDataType()
```
    Returns the way graphical displays of the data should be generated.
    
    Returns:
    
    the way graphical displays of the data should be generated
  - getDistanceTable
```
public DistanceTable getDistanceTable()
```
    Returns the distance table that defines the nodes, edges, and weights for this problem instance.
    
    Returns:
    
    the distance table that defines the nodes, edges, and weights for this problem instance
  - getDisplayData
```
public NodeCoordinates getDisplayData()
```
    Returns the data used to graphically display the nodes; or null if the display data is not explicitly defined.
    
    Returns:
    
    the data used to graphically display the nodes; or null if the display data is not explicitly defined
  - getFixedEdges
```
public EdgeData getFixedEdges()
```
    Returns the edges that are required in each solution to this problem instance.
    
    Returns:
    
    the edges that are required in each solution to this problem instance
  - getTours
```
public List<TSPLibTour> getTours()
```
    Returns the solutions to this problem instance.
    
    Returns:
    
    the solutions to this problem instance
  - getVehicleRoutingTable
```
public VehicleRoutingTable getVehicleRoutingTable()
```
    Returns the demands and depot nodes for vehicle routing problems; or null if this is not a vehicle routing problem instance.
    
    Returns:
    
    the demands and depot nodes for vehicle routing problems; or null if this is not a vehicle routing problem instance

Class TSPLibInstance

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TSPLibInstance

TSPLibInstance

TSPLibInstance

Method Detail

load

addTour

addTour

addTour

getName

getDataType

getComment

getDimension

getCapacity

getEdgeWeightType

getEdgeWeightFormat

getEdgeDataFormat

getNodeCoordinateType

getDisplayDataType

getDistanceTable

getDisplayData

getFixedEdges

getTours

getVehicleRoutingTable