graphhopper-jsprit/jsprit-instances/src/main/java/jsprit/instance/reader/VrphGoldenReader.java

/*******************************************************************************
 * Copyright (C) 2014  Stefan Schroeder
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3.0 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/

package jsprit.instance.reader;

import jsprit.core.problem.Location;
import jsprit.core.problem.VehicleRoutingProblem;
import jsprit.core.problem.VehicleRoutingProblem.Builder;
import jsprit.core.problem.VehicleRoutingProblem.FleetSize;
import jsprit.core.problem.io.VrpXMLWriter;
import jsprit.core.problem.job.Service;
import jsprit.core.problem.vehicle.VehicleImpl;
import jsprit.core.problem.vehicle.VehicleTypeImpl;
import jsprit.core.util.Coordinate;

import java.io.*;

/**
 * Reads modified files from Taillard's website
 * http://mistic.heig-vd.ch/taillard/problemes.dir/vrp.dir/vrp.html. You can find the modified version here:
 * jsprit-instances/instances/vrph.
 * <p/>
 * <p>See {@link VrphType} what kind of problems can be generated
 *
 * @author schroeder
 */
public class VrphGoldenReader {

    /**
     * <b>FSMD</b> - Fleet Size and Mix with Dependent costs
     * <p><b>FSMF</b> - Fleet Size and Mix with Fixed costs
     * <p><b>FSMFD</b> - Fleet Size and Mix with Fixed and Dependent costs
     * <p><b>HVRPD</b> - Heterogeneous Vehicle Routing Problem with Dependent costs and finite (limited) fleet
     * <p><b>HVRPFD</b> - Heterogeneous Vehicle Routing Problem with Fixed and Dependent costs and finite (limited) fleet
     *
     * @author schroeder
     */
    public enum VrphType {
        FSMD,
        HVRPD,
        FSMF,
        FSMFD,
        HVRPFD
    }

    private final VehicleRoutingProblem.Builder vrpBuilder;

    private final VrphType vrphType;

    public VrphGoldenReader(Builder vrpBuilder, VrphType vrphType) {
        super();
        this.vrpBuilder = vrpBuilder;
        this.vrphType = vrphType;
    }

    public void read(String filename) {
        BufferedReader reader = getReader(filename);
        String line;
        boolean firstline = true;
        Coordinate depotCoord = null;
        int customerCount = 0;
        Integer nuOfCustomer = 0;
        while ((line = readLine(reader)) != null) {
            String trimedLine = line.trim();
            if (trimedLine.startsWith("//")) continue;
            String[] tokens = trimedLine.split("\\s+");
            if (firstline) {
                nuOfCustomer = Integer.parseInt(tokens[0]);
                customerCount = 0;
                firstline = false;
            } else if (customerCount <= nuOfCustomer) {
                if (customerCount == 0) {
                    depotCoord = Coordinate.newInstance(Double.parseDouble(tokens[1]), Double.parseDouble(tokens[2]));
                } else {
                    Service.Builder serviceBuilder = Service.Builder.newInstance(tokens[0]).addSizeDimension(0, Integer.parseInt(tokens[3]));
                    serviceBuilder.setLocation(Location.newInstance(Double.parseDouble(tokens[1]), Double.parseDouble(tokens[2])));
                    vrpBuilder.addJob(serviceBuilder.build());
                }
                customerCount++;
            } else if (trimedLine.startsWith("v")) {
                VehicleTypeImpl.Builder typeBuilder = VehicleTypeImpl.Builder.newInstance("type_" + tokens[1]).addCapacityDimension(0, Integer.parseInt(tokens[2]));
                int nuOfVehicles = 1;
                if (vrphType.equals(VrphType.FSMF)) {
                    typeBuilder.setFixedCost(Double.parseDouble(tokens[3]));
                } else if (vrphType.equals(VrphType.FSMFD)) {
                    typeBuilder.setFixedCost(Double.parseDouble(tokens[3]));
                    if (tokens.length > 4) {
                        typeBuilder.setCostPerDistance(Double.parseDouble(tokens[4]));
                    } else
                        throw new IllegalStateException("option " + vrphType + " cannot be applied with this instance");
                } else if (vrphType.equals(VrphType.FSMD)) {
                    if (tokens.length > 4) {
                        typeBuilder.setCostPerDistance(Double.parseDouble(tokens[4]));
                    } else
                        throw new IllegalStateException("option " + vrphType + " cannot be applied with this instance");
                } else if (vrphType.equals(VrphType.HVRPD)) {
                    if (tokens.length > 4) {
                        typeBuilder.setCostPerDistance(Double.parseDouble(tokens[4]));
                        nuOfVehicles = Integer.parseInt(tokens[5]);
                        vrpBuilder.setFleetSize(FleetSize.FINITE);
                    } else
                        throw new IllegalStateException("option " + vrphType + " cannot be applied with this instance");
                } else if (vrphType.equals(VrphType.HVRPFD)) {
                    if (tokens.length > 4) {
                        typeBuilder.setFixedCost(Double.parseDouble(tokens[3]));
                        typeBuilder.setCostPerDistance(Double.parseDouble(tokens[4]));
                        nuOfVehicles = Integer.parseInt(tokens[5]);
                        vrpBuilder.setFleetSize(FleetSize.FINITE);
                    } else
                        throw new IllegalStateException("option " + vrphType + " cannot be applied with this instance");
                }
                for (int i = 0; i < nuOfVehicles; i++) {
                    VehicleTypeImpl type = typeBuilder.build();
                    VehicleImpl vehicle = VehicleImpl.Builder.newInstance("vehicle_" + tokens[1] + "_" + i)
                        .setStartLocation(Location.newInstance(depotCoord.getX(), depotCoord.getY())).setType(type).build();
                    vrpBuilder.addVehicle(vehicle);
                }
            }
        }
        closeReader(reader);
    }

    private void closeReader(BufferedReader reader) {
        try {
            reader.close();
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

    private String readLine(BufferedReader reader) {
        String readLine = null;
        try {
            readLine = reader.readLine();
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
        return readLine;
    }

    private BufferedReader getReader(String filename) {
        BufferedReader bufferedReader = null;
        try {
            bufferedReader = new BufferedReader(new FileReader(new File(filename)));
            return bufferedReader;
        } catch (FileNotFoundException e) {
            throw new RuntimeException(e);
        }
    }

    public static void main(String[] args) {
        VehicleRoutingProblem.Builder vrpBuilder = VehicleRoutingProblem.Builder.newInstance();
        VrphGoldenReader goldenReader = new VrphGoldenReader(vrpBuilder, VrphType.FSMD);
        goldenReader.read("instances/vrph/orig/cn_13mix.txt");
        VehicleRoutingProblem vrp = vrpBuilder.build();
        new VrpXMLWriter(vrp).write("instances/vrph/cn_13mix_VRPH_INFINITE.xml");
    }

}