Defines the constants, types and some functions necessary for the transform programs. More...

#include <cmath>
#include <string>
#include <vector>
#include <iomanip>
#include <xercesc/util/PlatformUtils.hpp>

Classes
class	InputFileFormatNotSupported
class	TransformInstance
Functions
void	trimLeft (std::string &s, const std::string &t=" \t\r\n")
void	trimRight (std::string &s, const std::string &t=" \t\r\n")
void	trim (std::string &s, const std::string &t=" \t\r\n")
double	roundToDoublePrecisionAndDoubleFloatField (double d)
TransformInstance *	readInputFileTSPLIB (const std::string &inputFileName)
void	writeOutputFile (const std::string &outputFileName, const TransformInstance *transformInstance)
void	writeOutputFileWithoutUsingAParser (const std::string &outputFileName, const TransformInstance *transformInstance)
Variables
const std::string	INPUT_FILE_FILENAME_EXTENSION_TSP = ".tsp"
const std::string	INPUT_FILE_FILENAME_EXTENSION_ATSP = ".atsp"
const std::string	TAG_NAME = "NAME:"
const std::string	TAG_TYPE = "TYPE:"
const std::string	TAG_COMMENT = "COMMENT:"
const std::string	TAG_DIMENSION = "DIMENSION:"
const std::string	TAG_EDGE_WEIGHT_TYPE = "EDGE_WEIGHT_TYPE:"
const std::string	TAG_EDGE_WEIGHT_FORMAT = "EDGE_WEIGHT_FORMAT:"
const std::string	TAG_DISPLAY_DATA_TYPE = "DISPLAY_DATA_TYPE:"
const std::string	TAG_NODE_COORD_SECTION = "NODE_COORD_SECTION"
const std::string	EDGE_WEIGHT_SECTION = "EDGE_WEIGHT_SECTION"
const std::string	DISPLAY_DATA_SECTION = "DISPLAY_DATA_SECTION"
const std::string	TAG_EOF = "EOF"
const std::string	VALUE_TYPE_TSP = "TSP"
const std::string	VALUE_TYPE_ATSP = "ATSP"
const double	RRR = 6378.388
const std::string	VALUE_EDGE_WEIGHT_TYPE_GEO = "GEO"
const std::string	VALUE_EDGE_WEIGHT_TYPE_EUC_2D = "EUC_2D"
const std::string	VALUE_EDGE_WEIGHT_TYPE_CEIL_2D = "CEIL_2D"
const std::string	VALUE_EDGE_WEIGHT_TYPE_ATT = "ATT"
const std::string	VALUE_EDGE_WEIGHT_TYPE_EXPLICIT = "EXPLICIT"
const std::string	VALUE_EDGE_WEIGHT_FORMAT_FUNCTION = "FUNCTION"
const std::string	VALUE_EDGE_WEIGHT_FORMAT_FULL_MATRIX = "FULL_MATRIX"
const std::string	VALUE_EDGE_WEIGHT_FORMAT_LOWER_DIAG_ROW = "LOWER_DIAG_ROW"
const std::string	VALUE_EDGE_WEIGHT_FORMAT_UPPER_DIAG_ROW = "UPPER_DIAG_ROW"
const std::string	VALUE_EDGE_WEIGHT_FORMAT_UPPER_ROW = "UPPER_ROW"
const std::string	VALUE_DISPLAY_DATA_TYPE_COORD_DISPLAY = "COORD_DISPLAY"
const std::string	VALUE_DISPLAY_DATA_TYPE_TWOD_DISPLAY = "TWOD_DISPLAY"
const std::string	OUTPUT_FILE_FILENAME_EXTENSION = ".xml"
const bool	XML_FORMAT_PRETTY_PRINT = true
const std::string	XML_DOCUMENT_NODE = "travellingSalesmanProblemInstance"
const std::string	XML_NAME = "name"
const std::string	XML_SOURCE = "source"
const std::string	XML_DESCRIPTION = "description"
const std::string	XML_DOUBLE_PRECISION = "doublePrecision"
const std::string	XML_IGNORED_DIGITS = "ignoredDigits"
const std::string	XML_GRAPH = "graph"
const std::string	XML_VERTEX = "vertex"
const std::string	XML_EDGE = "edge"
const std::string	XML_EDGE_ATTRIBUTE_COST = "cost"
const std::string	XML_ENCODING = "UTF-8"
const std::string	XML_VALUE_SOURCE_TSPLIB = "TSPLIB"
const std::ios::fmtflags	DOUBLE_FLOATFIELD = std::ios::scientific
const std::streamsize	TRANSFORM_DOUBLE_PRECISION = std::numeric_limits<double>::digits10
const std::streamsize	TRANSFORM_IGNORED_DIGITS = 5
const double	TRANSFORM_DOUBLE_ZERO

Detailed Description

Defines the constants, types and some functions necessary for the transform programs.

Defines the constants, classes and some functions necessary for the transform programs.

Author:: Ulrich Pferschy and Rostislav Stanek (Institut fuer Statistik und Operations Research, Universitaet Graz)

Definition in file TransformConstantsClassesAndFunctions.hpp.

Function Documentation

TransformInstance* readInputFileTSPLIB ( const std::string & inputFileName )

Reads the input file and creates an instance of the class TransformInstance. The parameters are not checked. Every keyword must be on a new line and is allowed to be used only once. Note that the symbol ":" has to follow the keywords immediately. The order possibilities of the input keywords are: 1) "NAME:", "TYPE:" (= "TSP"), "COMMENT:", "DIMENSION:", "EDGE_WEIGHT_TYPE:" (= "GEO"), ("EDGE_WEIGHT_FORMAT:" (= "FUNCTION"),) DISPLAY_DATA_TYPE:" (= "COORD_DISPLAY"), "NODE_COORD_SECTION", coordinates, "EOF", 2) "NAME:", "TYPE:", "COMMENT:", "DIMENSION:", "EDGE_WEIGHT_TYPE:" (= "EUC_2D" / "CEIL_2D"), "NODE_COORD_SECTION", coordinates, "EOF", 3) "NAME:", "TYPE:", "COMMENT:", "DIMENSION:", "EDGE_WEIGHT_TYPE:" (= "ATT"), "NODE_COORD_SECTION", coordinates, "EOF", 4) "NAME:", "TYPE:" (= "TSP"), "COMMENT:", "DIMENSION:", "EDGE_WEIGHT_TYPE:" (= "EXPLICIT"), "EDGE_WEIGHT_FORMAT:" (= "FULL_MATRIX"), "EDGE_WEIGHT_SECTION", matrix entries, "EOF", 5) "NAME:", "TYPE:" (= "TSP"), "COMMENT:", "DIMENSION:", "EDGE_WEIGHT_TYPE:" (= "EXPLICIT"), "EDGE_WEIGHT_FORMAT:" (= "FULL_MATRIX"), "TAG_DISPLAY_DATA_TYPE" (= "TWOD_DISPLAY"), "EDGE_WEIGHT_SECTION", matrix entries, DISPLAY_DATA_SECTION, coordinates, "EOF", 6) "NAME:", "TYPE:" (= "TSP"), "COMMENT:", "DIMENSION:", "EDGE_WEIGHT_TYPE:" (= "EXPLICIT"), "EDGE_WEIGHT_FORMAT:" (= "LOWER_DIAG_ROW"), "EDGE_WEIGHT_SECTION", matrix entries, "EOF", 7) "NAME:", "TYPE:" (= "TSP"), "COMMENT:", "DIMENSION:", "EDGE_WEIGHT_TYPE:" (= "EXPLICIT"), "EDGE_WEIGHT_FORMAT:" (= "LOWER_DIAG_ROW"), "TAG_DISPLAY_DATA_TYPE" (= "TWOD_DISPLAY"), "EDGE_WEIGHT_SECTION", matrix entries, DISPLAY_DATA_SECTION, coordinates, "EOF", 8) "NAME:", "TYPE:" (= "TSP"), "COMMENT:", "DIMENSION:", "EDGE_WEIGHT_TYPE:" (= "EXPLICIT"), "EDGE_WEIGHT_FORMAT:" (= "UPPER_ROW"), "EDGE_WEIGHT_SECTION", matrix entries, "EOF", 9) "NAME:", "TYPE:" (= "TSP"), "COMMENT:", "DIMENSION:", "EDGE_WEIGHT_TYPE:" (= "EXPLICIT"), "EDGE_WEIGHT_FORMAT:" (= "UPPER_ROW"), "TAG_DISPLAY_DATA_TYPE" (= "TWOD_DISPLAY"), "EDGE_WEIGHT_SECTION", matrix entries, DISPLAY_DATA_SECTION, coordinates, "EOF", 10) "NAME:", "TYPE:" (= "ATSP"), "COMMENT:", "DIMENSION:", "EDGE_WEIGHT_TYPE:" (= "EXPLICIT"), "EDGE_WEIGHT_FORMAT:" (= "FULL_MATRIX"), "NODE_COORD_SECTION", matrix entries, "EOF".

Parameters:

inputFileName Name of the input file.

Returns:: Instance of the class TransformInstance.

double roundToDoublePrecisionAndDoubleFloatField ( double d ) [inline]

Rounds the double to the TRANSFORM_DOUBLE_PRECISION. The floatfield is set to DOUBLE_FLOATFIELD (see IOConstantsBasicFunctionsAndBasicClasses.hpp).

Parameters:

d	Number which should be rounded.

Returns:: Rounded number d.

Definition at line 299 of file TransformConstantsClassesAndFunctions.hpp.

References DOUBLE_FLOATFIELD, and TRANSFORM_DOUBLE_PRECISION.

Referenced by TransformInstance::setAdjacencyMatrixElement().

void trim	(	std::string &	s,
		const std::string &	t = `" \t\r\n"`
	)		`[inline]`

Trims the string from left and from right.

Parameters:

s	The string.
t	The trimmed characters.

Definition at line 288 of file TransformConstantsClassesAndFunctions.hpp.

References trimLeft(), and trimRight().

Referenced by SAX2ContentHandler::characters(), SAX2ContentHandler::endElement(), readInputFileTSPLIB(), and SAX2ContentHandler::startElement().

void trimLeft	(	std::string &	s,
		const std::string &	t = `" \t\r\n"`
	)		`[inline]`

Trims the string from left.

Parameters:

s	The string.
t	The trimmed characters.

Definition at line 264 of file TransformConstantsClassesAndFunctions.hpp.

Referenced by trim().

void trimRight	(	std::string &	s,
		const std::string &	t = `" \t\r\n"`
	)		`[inline]`

Trims the string from right.

Parameters:

s	The string.
t	The trimmed characters.

Definition at line 273 of file TransformConstantsClassesAndFunctions.hpp.

Referenced by trim().

void writeOutputFile	(	const std::string &	outputFileName,
		const TransformInstance *	transformInstance
	)

Writes one instance of the class TransformInstance to an output file. The parameters are not checked.

Parameters:

outputFileName	Name of the output file.
transformInstance	Instance of the class TransformInstance.

void writeOutputFileWithoutUsingAParser	(	const std::string &	outputFileName,
		const TransformInstance *	transformInstance
	)

Writes one instance of the class TransformInstance to an output file without using a parser. This method is quicker than the previous one but it provides no parser guarantee that the output file is a valid xml file. The parameters are not checked.

Parameters:

outputFileName	Name of the output file.
transformInstance	Instance of the class TransformInstance.

Definition at line 1525 of file TransformConstantsClassesAndFunctions.cpp.

References DOUBLE_FLOATFIELD, TransformInstance::getAdjacencyMatrixElement(), TransformInstance::getDescription(), TransformInstance::getN(), TransformInstance::getName(), TransformInstance::getType(), TRANSFORM_DOUBLE_PRECISION, TRANSFORM_IGNORED_DIGITS, and VALUE_TYPE_ATSP.

Referenced by main().

Variable Documentation

const std::string DISPLAY_DATA_SECTION = "DISPLAY_DATA_SECTION"

Tag for the TSPLIB: "DISPLAY_DATA_SECTION".

Definition at line 82 of file TransformConstantsClassesAndFunctions.hpp.

Classes

Functions

Variables

Detailed Description

Function Documentation

Variable Documentation