org.optaplanner.examples.tsp.persistence.TspImporter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of optaplanner-examples Show documentation
Show all versions of optaplanner-examples Show documentation
OptaPlanner solves planning problems.
This lightweight, embeddable planning engine implements powerful and scalable algorithms
to optimize business resource scheduling and planning.
This module contains the examples which demonstrate how to use it in a normal Java application.
/*
* Copyright 2011 Red Hat, Inc. and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.optaplanner.examples.tsp.persistence;
import java.io.IOException;
import java.math.BigInteger;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import org.apache.commons.io.FilenameUtils;
import org.optaplanner.examples.common.persistence.AbstractTxtSolutionImporter;
import org.optaplanner.examples.common.persistence.SolutionConverter;
import org.optaplanner.examples.tsp.app.TspApp;
import org.optaplanner.examples.tsp.domain.Domicile;
import org.optaplanner.examples.tsp.domain.Standstill;
import org.optaplanner.examples.tsp.domain.TspSolution;
import org.optaplanner.examples.tsp.domain.Visit;
import org.optaplanner.examples.tsp.domain.location.AirLocation;
import org.optaplanner.examples.tsp.domain.location.DistanceType;
import org.optaplanner.examples.tsp.domain.location.Location;
import org.optaplanner.examples.tsp.domain.location.RoadLocation;
public class TspImporter extends AbstractTxtSolutionImporter {
public static final String INPUT_FILE_SUFFIX = "tsp";
public static void main(String[] args) {
SolutionConverter converter = SolutionConverter.createImportConverter(
TspApp.DATA_DIR_NAME, new TspImporter(), TspSolution.class);
converter.convert("other/air/europe40.tsp", "europe40.xml");
converter.convert("cook/air/dj38.tsp", "dj38.xml");
converter.convert("cook/air/lu980.tsp", "lu980.xml");
}
@Override
public String getInputFileSuffix() {
return INPUT_FILE_SUFFIX;
}
@Override
public TxtInputBuilder createTxtInputBuilder() {
return new TspInputBuilder();
}
public static class TspInputBuilder extends TxtInputBuilder {
private TspSolution tspSolution;
private int locationListSize;
@Override
public TspSolution readSolution() throws IOException {
tspSolution = new TspSolution();
tspSolution.setId(0L);
String firstLine = readStringValue();
if (firstLine.matches("\\s*NAME\\s*:.*")) {
tspSolution.setName(removePrefixSuffixFromLine(firstLine, "\\s*NAME\\s*:", ""));
readTspLibFormat();
} else {
tspSolution.setName(FilenameUtils.getBaseName(inputFile.getName()));
locationListSize = Integer.parseInt(firstLine.trim());
readCourseraFormat();
}
BigInteger possibleSolutionSize = factorial(tspSolution.getLocationList().size() - 1);
logger.info("TspSolution {} has {} locations with a search space of {}.",
getInputId(),
tspSolution.getLocationList().size(),
getFlooredPossibleSolutionSize(possibleSolutionSize));
return tspSolution;
}
// ************************************************************************
// TSP TSPLIB format. See http://www.math.uwaterloo.ca/tsp/
// ************************************************************************
private void readTspLibFormat() throws IOException {
readTspLibHeaders();
readTspLibCityList();
createVisitList();
readTspLibSolution();
readConstantLine("EOF");
}
private void readTspLibHeaders() throws IOException {
readUntilConstantLine("TYPE *: +TSP");
locationListSize = readIntegerValue("DIMENSION *:");
String edgeWeightType = readStringValue("EDGE_WEIGHT_TYPE *:");
if (edgeWeightType.equalsIgnoreCase("EUC_2D")) {
tspSolution.setDistanceType(DistanceType.AIR_DISTANCE);
} else if (edgeWeightType.equalsIgnoreCase("EXPLICIT")) {
tspSolution.setDistanceType(DistanceType.ROAD_DISTANCE);
String edgeWeightFormat = readStringValue("EDGE_WEIGHT_FORMAT *:");
if (!edgeWeightFormat.equalsIgnoreCase("FULL_MATRIX")) {
throw new IllegalArgumentException("The edgeWeightFormat (" + edgeWeightFormat + ") is not supported.");
}
} else {
throw new IllegalArgumentException("The edgeWeightType (" + edgeWeightType + ") is not supported.");
}
tspSolution.setDistanceUnitOfMeasurement(readOptionalStringValue("EDGE_WEIGHT_UNIT_OF_MEASUREMENT *:", "distance"));
}
private void readTspLibCityList() throws IOException {
readConstantLine("NODE_COORD_SECTION");
DistanceType distanceType = tspSolution.getDistanceType();
List locationList = new ArrayList<>(locationListSize);
for (int i = 0; i < locationListSize; i++) {
String line = bufferedReader.readLine();
String[] lineTokens = splitBySpace(line, 3, 4, false, true);
Location location;
switch (distanceType) {
case AIR_DISTANCE:
location = new AirLocation();
break;
case ROAD_DISTANCE:
location = new RoadLocation();
break;
default:
throw new IllegalStateException("The distanceType (" + distanceType
+ ") is not implemented.");
}
location.setId(Long.parseLong(lineTokens[0]));
location.setLatitude(Double.parseDouble(lineTokens[1]));
location.setLongitude(Double.parseDouble(lineTokens[2]));
if (lineTokens.length >= 4) {
location.setName(lineTokens[3]);
}
locationList.add(location);
}
tspSolution.setLocationList(locationList);
if (distanceType == DistanceType.ROAD_DISTANCE) {
readConstantLine("EDGE_WEIGHT_SECTION");
for (int i = 0; i < locationListSize; i++) {
RoadLocation location = (RoadLocation) locationList.get(i);
Map travelDistanceMap = new LinkedHashMap<>(locationListSize);
String line = bufferedReader.readLine();
String[] lineTokens = splitBySpacesOrTabs(line.trim(), locationListSize);
for (int j = 0; j < locationListSize; j++) {
double travelDistance = Double.parseDouble(lineTokens[j]);
if (i == j) {
if (travelDistance != 0.0) {
throw new IllegalStateException("The travelDistance (" + travelDistance
+ ") should be zero.");
}
} else {
RoadLocation otherLocation = (RoadLocation) locationList.get(j);
travelDistanceMap.put(otherLocation, travelDistance);
}
}
location.setTravelDistanceMap(travelDistanceMap);
}
}
}
private void createVisitList() {
List locationList = tspSolution.getLocationList();
List visitList = new ArrayList<>(locationList.size() - 1);
int count = 0;
for (Location location : locationList) {
if (count < 1) {
Domicile domicile = new Domicile();
domicile.setId(location.getId());
domicile.setLocation(location);
tspSolution.setDomicile(domicile);
} else {
Visit visit = new Visit();
visit.setId(location.getId());
visit.setLocation(location);
// Notice that we leave the PlanningVariable properties on null
visitList.add(visit);
}
count++;
}
tspSolution.setVisitList(visitList);
}
private void readTspLibSolution() throws IOException {
boolean enabled = readOptionalConstantLine("TOUR_SECTION");
if (!enabled) {
return;
}
long domicileId = readLongValue();
Domicile domicile = tspSolution.getDomicile();
if (!domicile.getId().equals(domicileId)) {
throw new IllegalStateException("The domicileId (" + domicileId
+ ") is not the domicile's id (" + domicile.getId() + ").");
}
int visitListSize = tspSolution.getVisitList().size();
Map idToVisitMap = new HashMap<>(visitListSize);
for (Visit visit : tspSolution.getVisitList()) {
idToVisitMap.put(visit.getId(), visit);
}
Standstill previousStandstill = domicile;
for (int i = 0; i < visitListSize; i++) {
long visitId = readLongValue();
Visit visit = idToVisitMap.get(visitId);
if (visit == null) {
throw new IllegalStateException("The visitId (" + visitId
+ ") is does not exist.");
}
visit.setPreviousStandstill(previousStandstill);
previousStandstill = visit;
}
}
// ************************************************************************
// TSP coursera format. See https://class.coursera.org/optimization-001/
// ************************************************************************
private void readCourseraFormat() throws IOException {
List locationList = new ArrayList<>(locationListSize);
long id = 0;
for (int i = 0; i < locationListSize; i++) {
String line = bufferedReader.readLine();
String[] lineTokens = splitBySpace(line, 2);
Location location = new AirLocation();
location.setId(id);
id++;
location.setLatitude(Double.parseDouble(lineTokens[0]));
location.setLongitude(Double.parseDouble(lineTokens[1]));
locationList.add(location);
}
tspSolution.setLocationList(locationList);
createVisitList();
}
}
}