HamiltonianCycleAlgorithmBase (JGraphT : a free Java graph library)

java.lang.Object
- org.jgrapht.alg.tour.HamiltonianCycleAlgorithmBase<V,E>

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

HamiltonianCycleAlgorithm<V,E>

Direct Known Subclasses:

GreedyHeuristicTSP, NearestInsertionHeuristicTSP, NearestNeighborHeuristicTSP, RandomTourTSP
```
public abstract class HamiltonianCycleAlgorithmBase<V,E>
extends Object
implements HamiltonianCycleAlgorithm<V,E>
```
Base class for TSP solver algorithms.
This class provides implementations of utilities for TSP solver classes.

Author:

Peter Harman

Constructor Summary

Constructors
Constructor Description

HamiltonianCycleAlgorithmBase()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`checkGraph(Graph<V,E> graph)`	Checks that graph is undirected, complete, and non-empty
`protected GraphPath<V,E>`	`edgeSetToTour(Set<E> tour, Graph<V,E> graph)`	Transform from a Set representation to a graph path.
`protected GraphPath<V,E>`	`getSingletonTour(Graph<V,E> graph)`	Creates a tour for a graph with 1 vertex
`protected GraphPath<V,E>`	`vertexListToTour(List<V> tour, Graph<V,E> graph)`	Transform from a List representation to a graph path.

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

Methods inherited from interface org.jgrapht.alg.interfaces.HamiltonianCycleAlgorithm
getTour

- Constructor Detail
  - HamiltonianCycleAlgorithmBase
```
public HamiltonianCycleAlgorithmBase()
```
- Method Detail
  - vertexListToTour
```
protected GraphPath<V,E> vertexListToTour(List<V> tour,
                                                Graph<V,E> graph)
```
    Transform from a List representation to a graph path.
    
    Parameters:
    
    tour - a list containing the vertices of the tour
    
    graph - the graph
    
    Returns:
    
    a graph path
  - edgeSetToTour
```
protected GraphPath<V,E> edgeSetToTour(Set<E> tour,
                                             Graph<V,E> graph)
```
    Transform from a Set representation to a graph path.
    
    Parameters:
    
    tour - a set containing the edges of the tour
    
    graph - the graph
    
    Returns:
    
    a graph path
  - getSingletonTour
```
protected GraphPath<V,E> getSingletonTour(Graph<V,E> graph)
```
    Creates a tour for a graph with 1 vertex
    
    Parameters:
    
    graph - The graph
    
    Returns:
    
    A tour with a single vertex
  - checkGraph
```
protected void checkGraph(Graph<V,E> graph)
```
    Checks that graph is undirected, complete, and non-empty
    
    Parameters:
    
    graph - the graph
    
    Throws:
    
    IllegalArgumentException - if graph is not undirected
    
    IllegalArgumentException - if graph is not complete
    
    IllegalArgumentException - if graph contains no vertices