refine ServiceDeliveriesFirst constraint and add examples

jsprit-core/src/main/java/algorithms/BestInsertionBuilder.java

@@ -107,5 +107,7 @@ public class BestInsertionBuilder {
 		return bestInsertion;
 	}
 
+	
+
 
 }

jsprit-core/src/main/java/algorithms/CalculatorBuilder.java

@@ -20,6 +20,7 @@ import java.util.ArrayList;
 import java.util.List;
 
 import basics.Delivery;
+import basics.Job;
 import basics.Pickup;
 import basics.Service;
 import basics.Shipment;
@@ -193,6 +194,7 @@ class CalculatorBuilder {
 			standardLocal = createStandardLocal(vrp, states);
 		}
 		else{
+			checkServicesOnly();
 			standardLocal = createStandardRoute(vrp, states,forwardLooking,memory);
 		}
 		baseCalculator = standardLocal.getCalculator();
@@ -210,6 +212,17 @@ class CalculatorBuilder {
 		return createFinalInsertion(fleetManager, baseCalculator, states);
 	}
 
+	private void checkServicesOnly() {
+		for(Job j : vrp.getJobs().values()){
+			if(j instanceof Shipment){
+				throw new UnsupportedOperationException("currently the 'insert-on-route-level' option is only available for services (i.e. service, pickup, delivery), \n" +
+						"if you want to deal with shipments switch to option 'local-level' by either setting bestInsertionBuilder.setLocalLevel() or \n"
+						+ "by omitting the xml-tag '<level forwardLooking=2 memory=1>route</level>' when defining your insertionStrategy in algo-config.xml file");
+			}
+		}
+		
+	}
+
 	private void addInsertionListeners(List<InsertionListener> list) {
 		for(InsertionListener iL : list){
 			insertionListeners.add(iL);

jsprit-core/src/main/java/algorithms/ServiceBackhaulConstraint.java

@@ -1,7 +1,9 @@
 package algorithms;
 
 import basics.route.DeliverService;
+import basics.route.DeliverShipment;
 import basics.route.PickupService;
+import basics.route.PickupShipment;
 import basics.route.ServiceActivity;
 import basics.route.TourActivity;
 
@@ -13,6 +15,12 @@ public class ServiceBackhaulConstraint implements HardActivityStateLevelConstrai
 		if(newAct instanceof ServiceActivity && nextAct instanceof DeliverService){ return ConstraintsStatus.NOT_FULFILLED; }
 		if(newAct instanceof DeliverService && prevAct instanceof PickupService){ return ConstraintsStatus.NOT_FULFILLED_BREAK; }
 		if(newAct instanceof DeliverService && prevAct instanceof ServiceActivity){ return ConstraintsStatus.NOT_FULFILLED_BREAK; }
+		
+		if(newAct instanceof DeliverService && prevAct instanceof PickupShipment){ return ConstraintsStatus.NOT_FULFILLED_BREAK; }
+		if(newAct instanceof DeliverService && prevAct instanceof DeliverShipment){ return ConstraintsStatus.NOT_FULFILLED_BREAK; }
+		if(newAct instanceof PickupShipment && nextAct instanceof DeliverService){ return ConstraintsStatus.NOT_FULFILLED;}
+		if(newAct instanceof DeliverShipment && nextAct instanceof DeliverService){ return ConstraintsStatus.NOT_FULFILLED;}
+	
 		return ConstraintsStatus.FULFILLED;
 	}
 		

jsprit-core/src/main/java/basics/VehicleRoutingProblem.java

@@ -55,7 +55,7 @@ public class VehicleRoutingProblem {
 	/**
 	 * Overall problem constraints.
 	 * 
-	 * <p>DELIIVERIES_FIRST corresponds to the vehicle routing problem with back hauls, i.e. before a vehicle is not entirely unloaded, no pickup can be made. 
+	 * <p>DELIVERIES_FIRST corresponds to the vehicle routing problem with back hauls, i.e. before a vehicle is not entirely unloaded, no pickup can be made. 
 	 * 
 	 * @author stefan
 	 *

jsprit-core/src/test/java/algorithms/TestMixedServiceAndShipmentsProblemOnRouteLevel.java

@@ -0,0 +1,160 @@
+package algorithms;
+
+import static org.junit.Assert.*;
+
+import org.junit.Before;
+import org.junit.Test;
+
+import util.Coordinate;
+import basics.Delivery;
+import basics.Shipment;
+import basics.VehicleRoutingAlgorithm;
+import basics.VehicleRoutingProblem;
+import basics.route.InfiniteFleetManagerFactory;
+import basics.route.Vehicle;
+import basics.route.VehicleFleetManager;
+import basics.route.VehicleImpl;
+import basics.route.VehicleImpl.Builder;
+import basics.route.VehicleType;
+import basics.route.VehicleTypeImpl;
+
+public class TestMixedServiceAndShipmentsProblemOnRouteLevel {
+	
+	
+	
+	
+
+	
+	@Test(expected=UnsupportedOperationException.class)
+	public void whenHavingShipmentsAndServicesInOneProblem_andInsertionShouldBeMadeOnRouteLevel_throwException(){
+		/* get a vehicle type-builder and build a type with the typeId "vehicleType" and a capacity of 2
+		 */
+		VehicleTypeImpl.Builder vehicleTypeBuilder = VehicleTypeImpl.Builder.newInstance("vehicleType", 2);
+		VehicleType vehicleType = vehicleTypeBuilder.build();
+		
+		/*
+		 * get a vehicle-builder and build a vehicle located at (10,10) with type "vehicleType"
+		 */
+		Builder vehicleBuilder = VehicleImpl.Builder.newInstance("vehicle");
+		vehicleBuilder.setLocationCoord(Coordinate.newInstance(10, 10));
+		vehicleBuilder.setType(vehicleType);
+		Vehicle vehicle = vehicleBuilder.build();
+		
+		/*
+		 * build shipments at the required locations, each with a capacity-demand of 1.
+		 * 4 shipments
+		 * 1: (5,7)->(6,9)
+		 * 2: (5,13)->(6,11)
+		 * 3: (15,7)->(14,9)
+		 * 4: (15,13)->(14,11)
+		 */
+		
+		Shipment shipment1 = Shipment.Builder.newInstance("1", 1).setPickupCoord(Coordinate.newInstance(5, 7)).setDeliveryCoord(Coordinate.newInstance(6, 9)).build();
+		Shipment shipment2 = Shipment.Builder.newInstance("2", 1).setPickupCoord(Coordinate.newInstance(5, 13)).setDeliveryCoord(Coordinate.newInstance(6, 11)).build();
+		
+		Shipment shipment3 = Shipment.Builder.newInstance("3", 1).setPickupCoord(Coordinate.newInstance(15, 7)).setDeliveryCoord(Coordinate.newInstance(14, 9)).build();
+		Shipment shipment4 = Shipment.Builder.newInstance("4", 1).setPickupCoord(Coordinate.newInstance(15, 13)).setDeliveryCoord(Coordinate.newInstance(14, 11)).build();
+		
+		/*
+		 * build deliveries, (implicitly picked up in the depot)
+		 * 1: (4,8)
+		 * 2: (4,12)
+		 * 3: (16,8)
+		 * 4: (16,12)
+		 */
+		Delivery delivery1 = (Delivery) Delivery.Builder.newInstance("5", 1).setCoord(Coordinate.newInstance(4, 8)).build();
+		Delivery delivery2 = (Delivery) Delivery.Builder.newInstance("6", 1).setCoord(Coordinate.newInstance(4, 12)).build();
+		Delivery delivery3 = (Delivery) Delivery.Builder.newInstance("7", 1).setCoord(Coordinate.newInstance(16, 8)).build();
+		Delivery delivery4 = (Delivery) Delivery.Builder.newInstance("8", 1).setCoord(Coordinate.newInstance(16, 12)).build();
+		
+		VehicleRoutingProblem.Builder vrpBuilder = VehicleRoutingProblem.Builder.newInstance();
+		vrpBuilder.addVehicle(vehicle);
+		vrpBuilder.addJob(shipment1).addJob(shipment2).addJob(shipment3).addJob(shipment4)
+			.addJob(delivery1).addJob(delivery2).addJob(delivery3).addJob(delivery4).build();
+		
+		VehicleRoutingProblem vrp = vrpBuilder.build();
+		
+		VehicleRoutingAlgorithm vra;
+		
+		final StateManager stateManager = new StateManager();
+
+		ConstraintManager constraintManager = new ConstraintManager(vrp,stateManager);
+		constraintManager.addLoadConstraint();
+		constraintManager.addTimeWindowConstraint();
+		
+		VehicleFleetManager fleetManager = new InfiniteFleetManagerFactory(vrp.getVehicles()).createFleetManager();
+
+		BestInsertionBuilder bestIBuilder = new BestInsertionBuilder(vrp, fleetManager, stateManager,constraintManager);
+		bestIBuilder.setRouteLevel(2, 2);
+		InsertionStrategy bestInsertion = bestIBuilder.build();
+		
+	}
+	
+	@Test
+	public void whenHavingOnlyServicesInOneProblem_andInsertionShouldBeMadeOnRouteLevel_itShouldAssertTrue(){
+		/* get a vehicle type-builder and build a type with the typeId "vehicleType" and a capacity of 2
+		 */
+		VehicleTypeImpl.Builder vehicleTypeBuilder = VehicleTypeImpl.Builder.newInstance("vehicleType", 2);
+		VehicleType vehicleType = vehicleTypeBuilder.build();
+		
+		/*
+		 * get a vehicle-builder and build a vehicle located at (10,10) with type "vehicleType"
+		 */
+		Builder vehicleBuilder = VehicleImpl.Builder.newInstance("vehicle");
+		vehicleBuilder.setLocationCoord(Coordinate.newInstance(10, 10));
+		vehicleBuilder.setType(vehicleType);
+		Vehicle vehicle = vehicleBuilder.build();
+		
+		/*
+		 * build shipments at the required locations, each with a capacity-demand of 1.
+		 * 4 shipments
+		 * 1: (5,7)->(6,9)
+		 * 2: (5,13)->(6,11)
+		 * 3: (15,7)->(14,9)
+		 * 4: (15,13)->(14,11)
+		 */
+//		
+//		Shipment shipment1 = Shipment.Builder.newInstance("1", 1).setPickupCoord(Coordinate.newInstance(5, 7)).setDeliveryCoord(Coordinate.newInstance(6, 9)).build();
+//		Shipment shipment2 = Shipment.Builder.newInstance("2", 1).setPickupCoord(Coordinate.newInstance(5, 13)).setDeliveryCoord(Coordinate.newInstance(6, 11)).build();
+//		
+//		Shipment shipment3 = Shipment.Builder.newInstance("3", 1).setPickupCoord(Coordinate.newInstance(15, 7)).setDeliveryCoord(Coordinate.newInstance(14, 9)).build();
+//		Shipment shipment4 = Shipment.Builder.newInstance("4", 1).setPickupCoord(Coordinate.newInstance(15, 13)).setDeliveryCoord(Coordinate.newInstance(14, 11)).build();
+//		
+		/*
+		 * build deliveries, (implicitly picked up in the depot)
+		 * 1: (4,8)
+		 * 2: (4,12)
+		 * 3: (16,8)
+		 * 4: (16,12)
+		 */
+		Delivery delivery1 = (Delivery) Delivery.Builder.newInstance("5", 1).setCoord(Coordinate.newInstance(4, 8)).build();
+		Delivery delivery2 = (Delivery) Delivery.Builder.newInstance("6", 1).setCoord(Coordinate.newInstance(4, 12)).build();
+		Delivery delivery3 = (Delivery) Delivery.Builder.newInstance("7", 1).setCoord(Coordinate.newInstance(16, 8)).build();
+		Delivery delivery4 = (Delivery) Delivery.Builder.newInstance("8", 1).setCoord(Coordinate.newInstance(16, 12)).build();
+		
+		VehicleRoutingProblem.Builder vrpBuilder = VehicleRoutingProblem.Builder.newInstance();
+		vrpBuilder.addVehicle(vehicle)
+//		vrpBuilder.addJob(shipment1).addJob(shipment2).addJob(shipment3).addJob(shipment4)
+			.addJob(delivery1).addJob(delivery2).addJob(delivery3).addJob(delivery4).build();
+		
+		VehicleRoutingProblem vrp = vrpBuilder.build();
+		
+		VehicleRoutingAlgorithm vra;
+		
+		final StateManager stateManager = new StateManager();
+
+		ConstraintManager constraintManager = new ConstraintManager(vrp,stateManager);
+		constraintManager.addLoadConstraint();
+		constraintManager.addTimeWindowConstraint();
+		
+		VehicleFleetManager fleetManager = new InfiniteFleetManagerFactory(vrp.getVehicles()).createFleetManager();
+
+		BestInsertionBuilder bestIBuilder = new BestInsertionBuilder(vrp, fleetManager, stateManager,constraintManager);
+		bestIBuilder.setRouteLevel(2, 2);
+		InsertionStrategy bestInsertion = bestIBuilder.build();
+		
+		assertTrue(true);
+		
+	}
+
+}