Operational Research Library  1.0
Public Member Functions | List of all members
operational_research::TravellingSalesmanProblem Class Reference

#include <TravellingSalesmanProblem.h>

Inheritance diagram for operational_research::TravellingSalesmanProblem:
Inheritance graph
Collaboration diagram for operational_research::TravellingSalesmanProblem:
Collaboration graph

Public Member Functions

 TravellingSalesmanProblem (unsigned int cities, const std::vector< CoordinatesHelper > &coordinates)
 Constructor. More...
 
 TravellingSalesmanProblem (unsigned int cities, double minCoordinate, double maxCoordinate, bool integerValues=false)
 Constructor. More...
 
 TravellingSalesmanProblem (const std::string &filename)
 Constructor. More...
 
void setData (unsigned int cities, const std::vector< CoordinatesHelper > &coordinates)
 Setter for travelling salesman problem data. More...
 
void generateData (unsigned int cities, double minCoordinate, double maxCoordinate, bool integerValues=false)
 Generates travelling salesman problem data according to setup. More...
 
void readDataFromFile (const std::string &filename)
 Reads travelling salesman problem data from a file with a filename. More...
 
void writeDataToFile (const std::string &filename)
 Writes travelling salesman problem data to a file with a filename. More...
 
void showData ()
 Shows travelling salesman problem data. More...
 
double evaluateSTSP (const std::vector< unsigned int > &schedule)
 Evaluates symmetric travelling salesman problem. More...
 
double evaluateSTSP (const std::vector< unsigned int > &schedule, const std::string &filename)
 Evaluates symmetric travelling salesman problem to file with a filename. More...
 
unsigned int getCities () const
 Getter for number of cities. More...
 
const std::vector< CoordinatesHelper > & getCoordinates () const
 Getter for coordinates of cities. More...
 
- Public Member Functions inherited from operational_research::IData
virtual ~IData ()
 Virtual destructor. More...
 

Detailed Description

Author
Milan Hlinak
Date
04/14/15

Constructor & Destructor Documentation

operational_research::TravellingSalesmanProblem::TravellingSalesmanProblem ( unsigned int  cities,
const std::vector< CoordinatesHelper > &  coordinates 
)

Constructor.

Parameters
citiesNumber of cities.
coordinatesCoordinates of cities.
Exceptions
std::invalid_argumentexception.
operational_research::TravellingSalesmanProblem::TravellingSalesmanProblem ( unsigned int  cities,
double  minCoordinate,
double  maxCoordinate,
bool  integerValues = false 
)

Constructor.

Parameters
citiesNumber of cities.
minCoordinateMinimal coordinate.
maxCoordinateMaximal coordinate.
integerValuesTrue if generated data is integer values, false if generated data is real values.
Exceptions
std::invalid_argumentexception.
operational_research::TravellingSalesmanProblem::TravellingSalesmanProblem ( const std::string &  filename)

Constructor.

Parameters
filenameFilename.
Exceptions
std::runtime_errorexception.
std::invalid_argumentexception.

Member Function Documentation

double operational_research::TravellingSalesmanProblem::evaluateSTSP ( const std::vector< unsigned int > &  schedule)

Evaluates symmetric travelling salesman problem.

Parameters
scheduleSchedule.
Returns
Cost function value for given schedule.
Exceptions
std::invalid_argumentexception.
double operational_research::TravellingSalesmanProblem::evaluateSTSP ( const std::vector< unsigned int > &  schedule,
const std::string &  filename 
)

Evaluates symmetric travelling salesman problem to file with a filename.

Parameters
scheduleSchedule.
filenameFilename.
Returns
Cost function value for given schedule.
Exceptions
std::invalid_argumentexception.
std::runtime_errorexception.
void operational_research::TravellingSalesmanProblem::generateData ( unsigned int  cities,
double  minCoordinate,
double  maxCoordinate,
bool  integerValues = false 
)

Generates travelling salesman problem data according to setup.

Parameters
citiesNumber of cities.
minCoordinateMinimal coordinate.
maxCoordinateMaximal coordinate.
integerValuesTrue if generated data is integer values, false if generated data is real values.
Exceptions
std::invalid_argumentexception.
unsigned int operational_research::TravellingSalesmanProblem::getCities ( ) const
inline

Getter for number of cities.

Returns
Number of cities.
const std::vector<CoordinatesHelper>& operational_research::TravellingSalesmanProblem::getCoordinates ( ) const
inline

Getter for coordinates of cities.

Returns
Coordinates of cities.
void operational_research::TravellingSalesmanProblem::readDataFromFile ( const std::string &  filename)
virtual

Reads travelling salesman problem data from a file with a filename.

Parameters
filenameFilename.
Exceptions
std::runtime_errorexception.
std::invalid_argumentexception.

Implements operational_research::IData.

void operational_research::TravellingSalesmanProblem::setData ( unsigned int  cities,
const std::vector< CoordinatesHelper > &  coordinates 
)

Setter for travelling salesman problem data.

Parameters
citiesNumber of cities.
coordinatesCoordinates of cities.
Exceptions
std::invalid_argumentexception.
void operational_research::TravellingSalesmanProblem::showData ( )
virtual

Shows travelling salesman problem data.

Implements operational_research::IData.

void operational_research::TravellingSalesmanProblem::writeDataToFile ( const std::string &  filename)
virtual

Writes travelling salesman problem data to a file with a filename.

Parameters
filenameFilename.
Exceptions
std::runtime_errorexception.

Implements operational_research::IData.


The documentation for this class was generated from the following files: