From 03cbbcae78e4ef7adc9509b766bef7c3cb9fcf63 Mon Sep 17 00:00:00 2001 From: Stefan Schroeder <4sschroeder@gmail.com> Date: Thu, 23 Jan 2014 14:32:08 +0100 Subject: [PATCH 01/22] add javadoc --- .../problem/solution/route/VehicleRoute.java | 142 +++++++++++++++++- 1 file changed, 139 insertions(+), 3 deletions(-) diff --git a/jsprit-core/src/main/java/jsprit/core/problem/solution/route/VehicleRoute.java b/jsprit-core/src/main/java/jsprit/core/problem/solution/route/VehicleRoute.java index 08b17991..e1c3083f 100644 --- a/jsprit-core/src/main/java/jsprit/core/problem/solution/route/VehicleRoute.java +++ b/jsprit-core/src/main/java/jsprit/core/problem/solution/route/VehicleRoute.java @@ -37,22 +37,65 @@ import jsprit.core.problem.vehicle.Vehicle; import jsprit.core.problem.vehicle.VehicleImpl; import jsprit.core.problem.vehicle.VehicleImpl.NoVehicle; +/** + * Contains the tour, i.e. a number of activities, a vehicle servicing the tour and a driver. + * + * + * @author stefan + * + */ public class VehicleRoute { - + + /** + * Returns a deep copy of this vehicleRoute. + * + * @param route + * @return copied route + * @throws IllegalArgumentException if route is null + */ public static VehicleRoute copyOf(VehicleRoute route) { + if(route == null) throw new IllegalArgumentException("route must not be null"); return new VehicleRoute(route); } + /** + * Returns a newInstance of {@link VehicleRoute}. + * + * @param tour + * @param driver + * @param vehicle + * @return + */ public static VehicleRoute newInstance(TourActivities tour, Driver driver, Vehicle vehicle) { return new VehicleRoute(tour,driver,vehicle); } + /** + * Returns an empty route. + * + *

An empty route has an empty list of tour-activities, no driver (DriverImpl.noDriver()) and no vehicle (VehicleImpl.createNoVehicle()). + * + * @return + */ public static VehicleRoute emptyRoute() { return new VehicleRoute(TourActivities.emptyTour(), DriverImpl.noDriver(), VehicleImpl.createNoVehicle()); } + /** + * Builder that builds the vehicle route. + * + * @author stefan + * + */ public static class Builder { + /** + * Returns new instance of this builder. + * + * @param vehicle + * @param driver + * @return this builder + */ public static Builder newInstance(Vehicle vehicle, Driver driver){ return new Builder(vehicle,driver); } @@ -73,10 +116,24 @@ public class VehicleRoute { private Set openShipments = new HashSet(); + /** + * Sets the serviceActivityFactory to create serviceActivities. + * + *

By default {@link DefaultTourActivityFactory} is used. + * + * @param serviceActivityFactory + */ public void setServiceActivityFactory(TourActivityFactory serviceActivityFactory) { this.serviceActivityFactory = serviceActivityFactory; } + /** + * Sets the shipmentActivityFactory to create shipmentActivities. + * + *

By default {@link DefaultShipmentActivityFactory} is used. + * + * @param shipmentActivityFactory + */ public void setShipmentActivityFactory(TourShipmentActivityFactory shipmentActivityFactory) { this.shipmentActivityFactory = shipmentActivityFactory; } @@ -100,7 +157,7 @@ public class VehicleRoute { } /** - * Sets the departure-time of the route. + * Sets the departure-time of the route, i.e. which is the time the vehicle departs from start-location. * * @param departureTime * @return @@ -110,16 +167,46 @@ public class VehicleRoute { return this; } + /** + * Sets the end-time of the route, i.e. which is the time the vehicle has to be at its end-location at latest. + * + * @param endTime + * @return this builder + */ public Builder setRouteEndArrivalTime(double endTime){ end.setArrTime(endTime); return this; } + /** + * Adds a service to this route. + * + *

This implies that for this service a serviceActivity is created with {@link TourActivityFactory} and added to the sequence of tourActivities. + * + *

The resulting activity occurs in the activity-sequence in the order adding/inserting. + * + * @param service + * @return this builder + * @throws IllegalArgumentException if service is null + */ public Builder addService(Service service){ + if(service == null) throw new IllegalArgumentException("service must not be null"); addService(service,0.0,0.0); return this; } + /** + * Adds a service with specified activity arrival- and endTime. + * + *

This implies that for this service a serviceActivity is created with {@link TourActivityFactory} and added to the sequence of tourActivities. + * + *

Basically this activity is then scheduled with an activity arrival and activity endTime. + * + * @param service + * @param arrTime + * @param endTime + * @return builder + */ public Builder addService(Service service, double arrTime, double endTime){ TourActivity act = serviceActivityFactory.createActivity(service); act.setArrTime(arrTime); @@ -266,15 +353,38 @@ public class VehicleRoute { return tourActivities; } - + /** + * Returns the vehicle operating this route. + * + * @return Vehicle + */ public Vehicle getVehicle() { return vehicle; } + /** + * Returns the driver operating this route. + * + * @return Driver + */ public Driver getDriver() { return driver; } + /** + * Sets the vehicle and its departureTime. + * + *

This implies the following:
+ * if start and end are null, new start and end activities are created.
+ *

startActivity is initialized with the location of the specified vehicle. the time-window of this activity is initialized + * as follows: [time-window.start = vehicle.getEarliestDeparture()][time-window.end = vehicle.getLatestArrival()] + *

endActivity is initialized with the location of the specified vehicle as well. time-window of this activity:[time-window.start = vehicle.getEarliestDeparture()][time-window.end = vehicle.getLatestArrival()] + *

start.endTime is set to the specified departureTime + *

Note that start end end-locations are always initialized with the location of the specified vehicle. (this will change soon, then there will be start and end location of vehicle which can be different, 23.01.14) + * + * @param vehicle + * @param vehicleDepTime + */ public void setVehicle(Vehicle vehicle, double vehicleDepTime){ this.vehicle = vehicle; setStartAndEnd(vehicle, vehicleDepTime); @@ -297,24 +407,50 @@ public class VehicleRoute { } + /** + * Sets departureTime of this route, i.e. the time the vehicle departs from its start-location. + * + * @param vehicleDepTime + */ public void setDepartureTime(double vehicleDepTime){ if(start == null) throw new IllegalStateException("cannot set departureTime without having a vehicle on this route. use setVehicle(vehicle,departureTime) instead."); start.setEndTime(vehicleDepTime); } + /** + * Returns the departureTime of this vehicle. + * + * @return departureTime + * @throws IllegalStateException if start is null + */ public double getDepartureTime(){ if(start == null) throw new IllegalStateException("cannot get departureTime without having a vehicle on this route. use setVehicle(vehicle,departureTime) instead."); return start.getEndTime(); } + /** + * Returns tour if tour-activity-sequence is empty, i.e. to activity on the tour yet. + * + * @return + */ public boolean isEmpty() { return tourActivities.isEmpty(); } + /** + * Returns start-activity of this route. + * + * @return start + */ public Start getStart() { return start; } + /** + * Returns end-activity of this route. + * + * @return end + */ public End getEnd() { return end; } From a05a342a67a95741464b6f4dda1235ef57da68ad Mon Sep 17 00:00:00 2001 From: jsprit Date: Fri, 24 Jan 2014 15:25:11 +0100 Subject: [PATCH 02/22] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d8c24e67..e3a3cbc5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ jsprit ====== jsprit is a java based, open source toolkit for solving rich traveling salesman (TSP) and vehicle routing problems (VRP). -It is lightweight, flexible and easy-to-use, and based on a single all-purpose meta-heuristic currently solving +It is lightweight, flexible and easy-to-use, and based on a single all-purpose meta-heuristic currently solving - Capacitated VRP - Multiple Depot VRP - VRP with Time Windows From 2a2c52bfce7103062d4cae3f11ba63b4235e7fe0 Mon Sep 17 00:00:00 2001 From: jsprit Date: Mon, 27 Jan 2014 11:18:14 +0100 Subject: [PATCH 03/22] Update README.md --- README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/README.md b/README.md index e3a3cbc5..22d84746 100644 --- a/README.md +++ b/README.md @@ -16,10 +16,6 @@ It is lightweight, flexible and easy-to-use, and based on a single all-purpose < Setting up the problem, defining additional constraints, modifying the algorithms and visualising the discovered solutions is as easy and handy as reading classical VRP instances to benchmark your algorithm. It is fit for change and extension due to a modular design and a comprehensive set of unit and integration-tests. -Additionally, jsprit can be used along with MATSim -to solve the above problem-types in real networks (i.e. without preprocessing transport times and costs). A variety of least cost path algorithms such as Dijkstra and A* -can be used, and a dynamic and interactive visualiser greatly enhances the analysis. - ##In Development - continues improvement of code, handling and performance - soft constraints From 7d931152f2d43f38009bbd869608d3a2970e7946 Mon Sep 17 00:00:00 2001 From: jsprit Date: Mon, 27 Jan 2014 11:51:15 +0100 Subject: [PATCH 04/22] update according to v1.1.0 --- CHANGELOG.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 28122e2a..2034b24f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,30 @@ Change-log ========== +**v1.1.0** @ 2014-01-27 +jsprit-core: +- added javadocs (VehicleRoutingProblem and classes in package vehicle. and job.) +- added unit-tests (for classes in package vehicle. and job.) +- deprecated methods in VehicleRoutingProblem, VehicleTypeImpl, VehicleImpl +- added func in VehicleRoutingProblem.Builder (.addPenaltyVehicle(...) methods) +- added feature: open-routes (#54) +- added func in VehicleImpl and VehicleImpl.Builder (.setReturnToDepot(...), isReturnToDepot()) +- added feature: prohibit vehicles to take over entire route (#70) +- fixed bug: #58,#76-#79 +- inspected and removed all warnings + +jsprit-analysis: +- added GraphStreamViewer +- inspected and removed all warnings + +jsprit-example: +- added BicycleMessenger +- enriched examples with GraphStreamViewer +- inspected and removed all warnings + +jsprit-instance: +- added VrphGoldenReader (plus instances to bechmark VRPH) +- inspected and removed all warnings + **v1.0.0** @ 2013-11-26 (break change) - re-organized API From a055516042588439f9d2ca3d858eec164d144848 Mon Sep 17 00:00:00 2001 From: jsprit Date: Mon, 27 Jan 2014 11:51:46 +0100 Subject: [PATCH 05/22] Update CHANGELOG.md --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2034b24f..33dbf670 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,8 @@ Change-log ========== **v1.1.0** @ 2014-01-27 -jsprit-core: + +jsprit-core: - added javadocs (VehicleRoutingProblem and classes in package vehicle. and job.) - added unit-tests (for classes in package vehicle. and job.) - deprecated methods in VehicleRoutingProblem, VehicleTypeImpl, VehicleImpl From 3b310b1116c3b93d953201abf0046fbdcb25f1ec Mon Sep 17 00:00:00 2001 From: jsprit Date: Mon, 27 Jan 2014 11:52:16 +0100 Subject: [PATCH 06/22] Update CHANGELOG.md --- CHANGELOG.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 33dbf670..f8bd9fab 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ Change-log ========== **v1.1.0** @ 2014-01-27 -jsprit-core: +jsprit-core: - added javadocs (VehicleRoutingProblem and classes in package vehicle. and job.) - added unit-tests (for classes in package vehicle. and job.) - deprecated methods in VehicleRoutingProblem, VehicleTypeImpl, VehicleImpl @@ -13,16 +13,16 @@ Change-log - fixed bug: #58,#76-#79 - inspected and removed all warnings -jsprit-analysis: +jsprit-analysis: - added GraphStreamViewer - inspected and removed all warnings -jsprit-example: +jsprit-example: - added BicycleMessenger - enriched examples with GraphStreamViewer - inspected and removed all warnings -jsprit-instance: +jsprit-instance: - added VrphGoldenReader (plus instances to bechmark VRPH) - inspected and removed all warnings From 119484170496f376066139b809cda9684cebd565 Mon Sep 17 00:00:00 2001 From: jsprit Date: Mon, 27 Jan 2014 11:52:56 +0100 Subject: [PATCH 07/22] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f8bd9fab..15c98f0f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@ Change-log jsprit-core: - added javadocs (VehicleRoutingProblem and classes in package vehicle. and job.) -- added unit-tests (for classes in package vehicle. and job.) +- added unit-tests (for classes in package vehicle., job. and io.) - deprecated methods in VehicleRoutingProblem, VehicleTypeImpl, VehicleImpl - added func in VehicleRoutingProblem.Builder (.addPenaltyVehicle(...) methods) - added feature: open-routes (#54) From a47acc63fb0993a4f30d62bac562384e7fccea76 Mon Sep 17 00:00:00 2001 From: jsprit Date: Mon, 27 Jan 2014 11:53:25 +0100 Subject: [PATCH 08/22] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 15c98f0f..6f7870bd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,7 @@ Change-log - added unit-tests (for classes in package vehicle., job. and io.) - deprecated methods in VehicleRoutingProblem, VehicleTypeImpl, VehicleImpl - added func in VehicleRoutingProblem.Builder (.addPenaltyVehicle(...) methods) -- added feature: open-routes (#54) +- added feature: open-routes (issue #54) - added func in VehicleImpl and VehicleImpl.Builder (.setReturnToDepot(...), isReturnToDepot()) - added feature: prohibit vehicles to take over entire route (#70) - fixed bug: #58,#76-#79 From 80317b2fb710c13aeb918386b9aacd748259afdf Mon Sep 17 00:00:00 2001 From: jsprit Date: Mon, 27 Jan 2014 11:53:40 +0100 Subject: [PATCH 09/22] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6f7870bd..15c98f0f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,7 @@ Change-log - added unit-tests (for classes in package vehicle., job. and io.) - deprecated methods in VehicleRoutingProblem, VehicleTypeImpl, VehicleImpl - added func in VehicleRoutingProblem.Builder (.addPenaltyVehicle(...) methods) -- added feature: open-routes (issue #54) +- added feature: open-routes (#54) - added func in VehicleImpl and VehicleImpl.Builder (.setReturnToDepot(...), isReturnToDepot()) - added feature: prohibit vehicles to take over entire route (#70) - fixed bug: #58,#76-#79 From 2861652bf27b7a67fb55791d94674b344a31fff2 Mon Sep 17 00:00:00 2001 From: jsprit Date: Mon, 27 Jan 2014 11:54:23 +0100 Subject: [PATCH 10/22] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 15c98f0f..50eafb67 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,7 @@ Change-log - added unit-tests (for classes in package vehicle., job. and io.) - deprecated methods in VehicleRoutingProblem, VehicleTypeImpl, VehicleImpl - added func in VehicleRoutingProblem.Builder (.addPenaltyVehicle(...) methods) -- added feature: open-routes (#54) +- added feature: open-routes ([#54](https://github.com/jsprit/jsprit/issues/54)) - added func in VehicleImpl and VehicleImpl.Builder (.setReturnToDepot(...), isReturnToDepot()) - added feature: prohibit vehicles to take over entire route (#70) - fixed bug: #58,#76-#79 From b0d02874d29dc4735d330f9f11045e12c8fd07f6 Mon Sep 17 00:00:00 2001 From: jsprit Date: Mon, 27 Jan 2014 11:55:20 +0100 Subject: [PATCH 11/22] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 50eafb67..8abe59f8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,7 +10,7 @@ Change-log - added feature: open-routes ([#54](https://github.com/jsprit/jsprit/issues/54)) - added func in VehicleImpl and VehicleImpl.Builder (.setReturnToDepot(...), isReturnToDepot()) - added feature: prohibit vehicles to take over entire route (#70) -- fixed bug: #58,#76-#79 +- fixed bug: [#58](https://github.com/jsprit/jsprit/issues/58),[#76](https://github.com/jsprit/jsprit/issues/76),-[#79](https://github.com/jsprit/jsprit/issues/79) - inspected and removed all warnings jsprit-analysis: From ab88c1bca2edfadb7b0617d731e73e93b32281c2 Mon Sep 17 00:00:00 2001 From: jsprit Date: Mon, 27 Jan 2014 11:55:59 +0100 Subject: [PATCH 12/22] Update CHANGELOG.md --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8abe59f8..11b8a3fd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,8 +9,8 @@ Change-log - added func in VehicleRoutingProblem.Builder (.addPenaltyVehicle(...) methods) - added feature: open-routes ([#54](https://github.com/jsprit/jsprit/issues/54)) - added func in VehicleImpl and VehicleImpl.Builder (.setReturnToDepot(...), isReturnToDepot()) -- added feature: prohibit vehicles to take over entire route (#70) -- fixed bug: [#58](https://github.com/jsprit/jsprit/issues/58),[#76](https://github.com/jsprit/jsprit/issues/76),-[#79](https://github.com/jsprit/jsprit/issues/79) +- added feature: prohibit vehicles to take over entire route ([#70](https://github.com/jsprit/jsprit/issues/70)) +- fixed bug: [#58](https://github.com/jsprit/jsprit/issues/58),[#76](https://github.com/jsprit/jsprit/issues/76)-[#79](https://github.com/jsprit/jsprit/issues/79) - inspected and removed all warnings jsprit-analysis: From fd907b05cb10ef0cc6dab37178c353e5c77a568b Mon Sep 17 00:00:00 2001 From: Stefan Schroeder <4sschroeder@gmail.com> Date: Mon, 27 Jan 2014 13:08:15 +0100 Subject: [PATCH 13/22] [maven-release-plugin] prepare release v1.1.0 --- jsprit-analysis/pom.xml | 2 +- jsprit-core/pom.xml | 2 +- jsprit-examples/pom.xml | 2 +- jsprit-instances/pom.xml | 2 +- pom.xml | 4 ++-- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/jsprit-analysis/pom.xml b/jsprit-analysis/pom.xml index 9beae624..0bd19e28 100644 --- a/jsprit-analysis/pom.xml +++ b/jsprit-analysis/pom.xml @@ -22,7 +22,7 @@ jsprit jsprit - 1.0.1-SNAPSHOT + v1.1.0 4.0.0 jsprit-analysis diff --git a/jsprit-core/pom.xml b/jsprit-core/pom.xml index f205a492..6abb5bf1 100644 --- a/jsprit-core/pom.xml +++ b/jsprit-core/pom.xml @@ -3,7 +3,7 @@ jsprit jsprit - 1.0.1-SNAPSHOT + v1.1.0 4.0.0 jsprit-core diff --git a/jsprit-examples/pom.xml b/jsprit-examples/pom.xml index 64c563d3..b3be2d7b 100644 --- a/jsprit-examples/pom.xml +++ b/jsprit-examples/pom.xml @@ -3,7 +3,7 @@ jsprit jsprit - 1.0.1-SNAPSHOT + v1.1.0 4.0.0 diff --git a/jsprit-instances/pom.xml b/jsprit-instances/pom.xml index 5a46de9d..6b490aac 100644 --- a/jsprit-instances/pom.xml +++ b/jsprit-instances/pom.xml @@ -3,7 +3,7 @@ jsprit jsprit - 1.0.1-SNAPSHOT + v1.1.0 4.0.0 diff --git a/pom.xml b/pom.xml index b7bf6563..cca90a40 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,7 @@ jsprit jsprit - 1.0.1-SNAPSHOT + v1.1.0 pom @@ -35,7 +35,7 @@ scm:git:git@github.com:jsprit/jsprit.git scm:git:https://github.com/jsprit/jsprit.git http://github.com/jsprit/jsprit/tree/master - HEAD + v1.1.0 From 8c8d798cc1fce9da6717f339dea4a5937ccf0016 Mon Sep 17 00:00:00 2001 From: Stefan Schroeder <4sschroeder@gmail.com> Date: Mon, 27 Jan 2014 13:13:23 +0100 Subject: [PATCH 14/22] [maven-release-plugin] rollback the release of v1.1.0 --- jsprit-analysis/pom.xml | 2 +- jsprit-core/pom.xml | 2 +- jsprit-examples/pom.xml | 2 +- jsprit-instances/pom.xml | 2 +- pom.xml | 4 ++-- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/jsprit-analysis/pom.xml b/jsprit-analysis/pom.xml index 0bd19e28..9beae624 100644 --- a/jsprit-analysis/pom.xml +++ b/jsprit-analysis/pom.xml @@ -22,7 +22,7 @@ jsprit jsprit - v1.1.0 + 1.0.1-SNAPSHOT 4.0.0 jsprit-analysis diff --git a/jsprit-core/pom.xml b/jsprit-core/pom.xml index 6abb5bf1..f205a492 100644 --- a/jsprit-core/pom.xml +++ b/jsprit-core/pom.xml @@ -3,7 +3,7 @@ jsprit jsprit - v1.1.0 + 1.0.1-SNAPSHOT 4.0.0 jsprit-core diff --git a/jsprit-examples/pom.xml b/jsprit-examples/pom.xml index b3be2d7b..64c563d3 100644 --- a/jsprit-examples/pom.xml +++ b/jsprit-examples/pom.xml @@ -3,7 +3,7 @@ jsprit jsprit - v1.1.0 + 1.0.1-SNAPSHOT 4.0.0 diff --git a/jsprit-instances/pom.xml b/jsprit-instances/pom.xml index 6b490aac..5a46de9d 100644 --- a/jsprit-instances/pom.xml +++ b/jsprit-instances/pom.xml @@ -3,7 +3,7 @@ jsprit jsprit - v1.1.0 + 1.0.1-SNAPSHOT 4.0.0 diff --git a/pom.xml b/pom.xml index cca90a40..b7bf6563 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,7 @@ jsprit jsprit - v1.1.0 + 1.0.1-SNAPSHOT pom @@ -35,7 +35,7 @@ scm:git:git@github.com:jsprit/jsprit.git scm:git:https://github.com/jsprit/jsprit.git http://github.com/jsprit/jsprit/tree/master - v1.1.0 + HEAD From 16171c01548606b9b4128c19ec083255bc6f1d54 Mon Sep 17 00:00:00 2001 From: Stefan Schroeder <4sschroeder@gmail.com> Date: Mon, 27 Jan 2014 13:20:52 +0100 Subject: [PATCH 15/22] mod readme and changelog --- CHANGELOG.md | 26 ++++++++++++++++++++++++++ README.md | 6 +----- 2 files changed, 27 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 28122e2a..11b8a3fd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,31 @@ Change-log ========== +**v1.1.0** @ 2014-01-27 + +jsprit-core: +- added javadocs (VehicleRoutingProblem and classes in package vehicle. and job.) +- added unit-tests (for classes in package vehicle., job. and io.) +- deprecated methods in VehicleRoutingProblem, VehicleTypeImpl, VehicleImpl +- added func in VehicleRoutingProblem.Builder (.addPenaltyVehicle(...) methods) +- added feature: open-routes ([#54](https://github.com/jsprit/jsprit/issues/54)) +- added func in VehicleImpl and VehicleImpl.Builder (.setReturnToDepot(...), isReturnToDepot()) +- added feature: prohibit vehicles to take over entire route ([#70](https://github.com/jsprit/jsprit/issues/70)) +- fixed bug: [#58](https://github.com/jsprit/jsprit/issues/58),[#76](https://github.com/jsprit/jsprit/issues/76)-[#79](https://github.com/jsprit/jsprit/issues/79) +- inspected and removed all warnings + +jsprit-analysis: +- added GraphStreamViewer +- inspected and removed all warnings + +jsprit-example: +- added BicycleMessenger +- enriched examples with GraphStreamViewer +- inspected and removed all warnings + +jsprit-instance: +- added VrphGoldenReader (plus instances to bechmark VRPH) +- inspected and removed all warnings + **v1.0.0** @ 2013-11-26 (break change) - re-organized API diff --git a/README.md b/README.md index d8c24e67..22d84746 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ jsprit ====== jsprit is a java based, open source toolkit for solving rich traveling salesman (TSP) and vehicle routing problems (VRP). -It is lightweight, flexible and easy-to-use, and based on a single all-purpose meta-heuristic currently solving +It is lightweight, flexible and easy-to-use, and based on a single all-purpose meta-heuristic currently solving - Capacitated VRP - Multiple Depot VRP - VRP with Time Windows @@ -16,10 +16,6 @@ It is lightweight, flexible and easy-to-use, and based on a single all-purpose < Setting up the problem, defining additional constraints, modifying the algorithms and visualising the discovered solutions is as easy and handy as reading classical VRP instances to benchmark your algorithm. It is fit for change and extension due to a modular design and a comprehensive set of unit and integration-tests. -Additionally, jsprit can be used along with MATSim -to solve the above problem-types in real networks (i.e. without preprocessing transport times and costs). A variety of least cost path algorithms such as Dijkstra and A* -can be used, and a dynamic and interactive visualiser greatly enhances the analysis. - ##In Development - continues improvement of code, handling and performance - soft constraints From c13a5a9c1a762c061f18e6976aca47c955a17f76 Mon Sep 17 00:00:00 2001 From: Stefan Schroeder <4sschroeder@gmail.com> Date: Mon, 27 Jan 2014 14:55:28 +0100 Subject: [PATCH 16/22] [maven-release-plugin] prepare release v1.1.0 --- jsprit-analysis/pom.xml | 2 +- jsprit-core/pom.xml | 2 +- jsprit-examples/pom.xml | 2 +- jsprit-instances/pom.xml | 2 +- pom.xml | 4 ++-- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/jsprit-analysis/pom.xml b/jsprit-analysis/pom.xml index 9beae624..b6083fb7 100644 --- a/jsprit-analysis/pom.xml +++ b/jsprit-analysis/pom.xml @@ -22,7 +22,7 @@ jsprit jsprit - 1.0.1-SNAPSHOT + 1.1.0 4.0.0 jsprit-analysis diff --git a/jsprit-core/pom.xml b/jsprit-core/pom.xml index f205a492..ab796b24 100644 --- a/jsprit-core/pom.xml +++ b/jsprit-core/pom.xml @@ -3,7 +3,7 @@ jsprit jsprit - 1.0.1-SNAPSHOT + 1.1.0 4.0.0 jsprit-core diff --git a/jsprit-examples/pom.xml b/jsprit-examples/pom.xml index 64c563d3..306be735 100644 --- a/jsprit-examples/pom.xml +++ b/jsprit-examples/pom.xml @@ -3,7 +3,7 @@ jsprit jsprit - 1.0.1-SNAPSHOT + 1.1.0 4.0.0 diff --git a/jsprit-instances/pom.xml b/jsprit-instances/pom.xml index 5a46de9d..00946480 100644 --- a/jsprit-instances/pom.xml +++ b/jsprit-instances/pom.xml @@ -3,7 +3,7 @@ jsprit jsprit - 1.0.1-SNAPSHOT + 1.1.0 4.0.0 diff --git a/pom.xml b/pom.xml index b7bf6563..8c2c3872 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,7 @@ jsprit jsprit - 1.0.1-SNAPSHOT + 1.1.0 pom @@ -35,7 +35,7 @@ scm:git:git@github.com:jsprit/jsprit.git scm:git:https://github.com/jsprit/jsprit.git http://github.com/jsprit/jsprit/tree/master - HEAD + v1.1.0 From 57dc8b5220ec7a2cc7508ee7fb71715812cb54d6 Mon Sep 17 00:00:00 2001 From: Stefan Schroeder <4sschroeder@gmail.com> Date: Mon, 27 Jan 2014 14:56:39 +0100 Subject: [PATCH 17/22] [maven-release-plugin] prepare for next development iteration --- jsprit-analysis/pom.xml | 2 +- jsprit-core/pom.xml | 2 +- jsprit-examples/pom.xml | 2 +- jsprit-instances/pom.xml | 2 +- pom.xml | 4 ++-- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/jsprit-analysis/pom.xml b/jsprit-analysis/pom.xml index b6083fb7..b6d53099 100644 --- a/jsprit-analysis/pom.xml +++ b/jsprit-analysis/pom.xml @@ -22,7 +22,7 @@ jsprit jsprit - 1.1.0 + 1.1.1-SNAPSHOT 4.0.0 jsprit-analysis diff --git a/jsprit-core/pom.xml b/jsprit-core/pom.xml index ab796b24..697384b1 100644 --- a/jsprit-core/pom.xml +++ b/jsprit-core/pom.xml @@ -3,7 +3,7 @@ jsprit jsprit - 1.1.0 + 1.1.1-SNAPSHOT 4.0.0 jsprit-core diff --git a/jsprit-examples/pom.xml b/jsprit-examples/pom.xml index 306be735..08628a52 100644 --- a/jsprit-examples/pom.xml +++ b/jsprit-examples/pom.xml @@ -3,7 +3,7 @@ jsprit jsprit - 1.1.0 + 1.1.1-SNAPSHOT 4.0.0 diff --git a/jsprit-instances/pom.xml b/jsprit-instances/pom.xml index 00946480..dbf3d269 100644 --- a/jsprit-instances/pom.xml +++ b/jsprit-instances/pom.xml @@ -3,7 +3,7 @@ jsprit jsprit - 1.1.0 + 1.1.1-SNAPSHOT 4.0.0 diff --git a/pom.xml b/pom.xml index 8c2c3872..60c5923d 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,7 @@ jsprit jsprit - 1.1.0 + 1.1.1-SNAPSHOT pom @@ -35,7 +35,7 @@ scm:git:git@github.com:jsprit/jsprit.git scm:git:https://github.com/jsprit/jsprit.git http://github.com/jsprit/jsprit/tree/master - v1.1.0 + HEAD From 93ae652e6c4c408b396ccea1303117894ad6f385 Mon Sep 17 00:00:00 2001 From: jsprit Date: Mon, 27 Jan 2014 15:54:07 +0100 Subject: [PATCH 18/22] Update CHANGELOG.md --- CHANGELOG.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 11b8a3fd..df92af17 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,10 @@ Change-log - added feature: prohibit vehicles to take over entire route ([#70](https://github.com/jsprit/jsprit/issues/70)) - fixed bug: [#58](https://github.com/jsprit/jsprit/issues/58),[#76](https://github.com/jsprit/jsprit/issues/76)-[#79](https://github.com/jsprit/jsprit/issues/79) - inspected and removed all warnings +- visibility of methods activity.Start.get/setCoordinate(...) decreased from public to private [potential Break Change] +- visibility of methods activity.End.get/setCoordinate(...) decreased from public to private [potential Break Change] +- method isReturnToDepot() has added to interface Vehicle [potential Break Change] +- visibility of constructor VehicleImpl.Builder decreased from public to private [potential Break Change] jsprit-analysis: - added GraphStreamViewer @@ -26,6 +30,8 @@ Change-log - added VrphGoldenReader (plus instances to bechmark VRPH) - inspected and removed all warnings + + **v1.0.0** @ 2013-11-26 (break change) - re-organized API From 4d845a841766e3dc3637a36d06b4a28d12ca4bf2 Mon Sep 17 00:00:00 2001 From: jsprit Date: Mon, 27 Jan 2014 15:54:57 +0100 Subject: [PATCH 19/22] Update CHANGELOG.md --- CHANGELOG.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index df92af17..39736ad4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,10 +12,10 @@ Change-log - added feature: prohibit vehicles to take over entire route ([#70](https://github.com/jsprit/jsprit/issues/70)) - fixed bug: [#58](https://github.com/jsprit/jsprit/issues/58),[#76](https://github.com/jsprit/jsprit/issues/76)-[#79](https://github.com/jsprit/jsprit/issues/79) - inspected and removed all warnings -- visibility of methods activity.Start.get/setCoordinate(...) decreased from public to private [potential Break Change] -- visibility of methods activity.End.get/setCoordinate(...) decreased from public to private [potential Break Change] -- method isReturnToDepot() has added to interface Vehicle [potential Break Change] -- visibility of constructor VehicleImpl.Builder decreased from public to private [potential Break Change] +- visibility of methods activity.Start.get/setCoordinate(...) decreased from public to private [potential Break Change] +- visibility of methods activity.End.get/setCoordinate(...) decreased from public to private [potential Break Change] +- method isReturnToDepot() has added to interface Vehicle [potential Break Change] +- visibility of constructor VehicleImpl.Builder decreased from public to private [potential Break Change] jsprit-analysis: - added GraphStreamViewer From abfc1880db765207ad20d0665dcff0de2d091363 Mon Sep 17 00:00:00 2001 From: jsprit Date: Mon, 27 Jan 2014 15:55:20 +0100 Subject: [PATCH 20/22] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 39736ad4..7364a693 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,7 +14,7 @@ Change-log - inspected and removed all warnings - visibility of methods activity.Start.get/setCoordinate(...) decreased from public to private [potential Break Change] - visibility of methods activity.End.get/setCoordinate(...) decreased from public to private [potential Break Change] -- method isReturnToDepot() has added to interface Vehicle [potential Break Change] +- method isReturnToDepot() has been added to interface Vehicle [potential Break Change] - visibility of constructor VehicleImpl.Builder decreased from public to private [potential Break Change] jsprit-analysis: From 22c8b00e2f2c3dc16b21b63d31859ef7e3ffde49 Mon Sep 17 00:00:00 2001 From: jsprit Date: Mon, 27 Jan 2014 15:56:29 +0100 Subject: [PATCH 21/22] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7364a693..17423d79 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ Change-log - added func in VehicleImpl and VehicleImpl.Builder (.setReturnToDepot(...), isReturnToDepot()) - added feature: prohibit vehicles to take over entire route ([#70](https://github.com/jsprit/jsprit/issues/70)) - fixed bug: [#58](https://github.com/jsprit/jsprit/issues/58),[#76](https://github.com/jsprit/jsprit/issues/76)-[#79](https://github.com/jsprit/jsprit/issues/79) +- added abstract class AbstractForwardVehicleRoutingCosts - inspected and removed all warnings - visibility of methods activity.Start.get/setCoordinate(...) decreased from public to private [potential Break Change] - visibility of methods activity.End.get/setCoordinate(...) decreased from public to private [potential Break Change] From 28063feee40747d38aaedb4397263236a550fd74 Mon Sep 17 00:00:00 2001 From: jsprit Date: Mon, 27 Jan 2014 16:10:02 +0100 Subject: [PATCH 22/22] Update CHANGELOG.md --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 17423d79..a2da8ade 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,8 @@ Change-log ========== **v1.1.0** @ 2014-01-27 +- [detailed changelog](https://github.com/jsprit/misc-rep/raw/master/changelog_1.1.0_to_1.1.0.txt) + jsprit-core: - added javadocs (VehicleRoutingProblem and classes in package vehicle. and job.) - added unit-tests (for classes in package vehicle., job. and io.)