reformat reneging destinations similar to rerouting; add jockeying docs

Author: geraintpalmer

ciw/import_params.py

@@ -20,7 +20,6 @@ def create_network(
     ps_thresholds=None,
     server_priority_functions=None,
     reneging_time_distributions=None,
-    reneging_destinations=None,
     service_disciplines=None,
     system_capacity=float('inf')
 ):
@@ -63,8 +62,6 @@ def create_network(
         params["server_priority_functions"] = server_priority_functions
     if reneging_time_distributions is not None:
         params["reneging_time_distributions"] = reneging_time_distributions
-    if reneging_destinations is not None:
-        params["reneging_destinations"] = reneging_destinations
     if service_disciplines is not None:
         params["service_disciplines"] = service_disciplines
 
@@ -123,7 +120,6 @@ def create_network_from_dictionary(params_input):
             params["baulking_functions"][clss_name],
             params["batching_distributions"][clss_name],
             params["reneging_time_distributions"][clss_name],
-            params["reneging_destinations"][clss_name],
             class_change_time_distributions[clss_name],
         )
     n = Network(nodes, classes)
@@ -165,10 +161,6 @@ def fill_out_dictionary(params):
         if isinstance(params["reneging_time_distributions"], list):
             reneging_dists = params["reneging_time_distributions"]
             params["reneging_time_distributions"] = {"Customer": reneging_dists}
-    if "reneging_destinations" in params:
-        if isinstance(params["reneging_destinations"], list):
-            reneging_dests = params["reneging_destinations"]
-            params["reneging_destinations"] = {"Customer": reneging_dests}
 
     class_names = sorted(params["arrival_distributions"].keys())
     params["customer_class_names"] = class_names
@@ -192,10 +184,6 @@ def fill_out_dictionary(params):
             class_name: [None for _ in range(len(params["number_of_servers"]))]
             for class_name in class_names
         },
-        "reneging_destinations": {
-            class_name: [-1 for _ in range(len(params["number_of_servers"]))]
-            for class_name in class_names
-        },
         "service_disciplines": [
             ciw.disciplines.FIFO for _ in range(len(params["number_of_servers"]))
         ],
@@ -219,7 +207,6 @@ def validify_dictionary(params):
         == len(params["routing"])
         == len(params["batching_distributions"])
         == len(params["reneging_time_distributions"])
-        == len(params["reneging_destinations"])
     )
     if not consistant_num_classes:
         raise ValueError("Ensure consistant number of classes is used throughout.")
@@ -229,13 +216,11 @@ def validify_dictionary(params):
         == set(params["routing"])
         == set(params["batching_distributions"])
         == set(params["reneging_time_distributions"])
-        == set(params["reneging_destinations"])
     ) and (
         len(params["arrival_distributions"])
         == len(params["service_distributions"])
         == len(params["batching_distributions"])
         == len(params["reneging_time_distributions"])
-        == len(params["reneging_destinations"])
     )
     if not consistant_class_names:
         raise ValueError("Ensure consistant names for customer classes.")
@@ -245,7 +230,6 @@ def validify_dictionary(params):
         + [len(obs) for obs in params["service_distributions"].values()]
         + [len(obs) for obs in params["batching_distributions"].values()]
         + [len(obs) for obs in params["reneging_time_distributions"].values()]
-        + [len(obs) for obs in params["reneging_destinations"].values()]
         + [len(params["number_of_servers"])]
         + [len(params["server_priority_functions"])]
         + [len(params["queue_capacities"])]
@@ -296,13 +280,6 @@ def validify_dictionary(params):
             raise ValueError(
                 "Ensure consistant customer classes used in class_change_time_distributions."
             )
-    possible_destinations = list(range(1, params["number_of_nodes"] + 1)) + [-1]
-    for dests in params["reneging_destinations"]:
-        correct_destinations = all(
-            d in possible_destinations for d in params["reneging_destinations"][dests]
-        )
-        if not correct_destinations:
-            raise ValueError("Ensure all reneging destinations are possible.")
 
     if not isinstance(params['system_capacity'], int) and params['system_capacity'] != float('inf'):
         raise ValueError("Ensure system capacity is a positive integer.")

ciw/network.py

@@ -52,7 +52,6 @@ def __init__(
         baulking_functions,
         batching_distributions,
         reneging_time_distributions,
-        reneging_destinations,
         class_change_time_distributions,
     ):
         """
@@ -65,7 +64,6 @@ def __init__(
         self.priority_class = priority_class
         self.baulking_functions = baulking_functions
         self.reneging_time_distributions = reneging_time_distributions
-        self.reneging_destinations = reneging_destinations
         self.class_change_time_distributions = class_change_time_distributions
 
 

ciw/node.py

@@ -538,6 +538,12 @@ def next_node_for_rerouting(self, ind):
         """
         return self.simulation.routers[ind.customer_class].next_node_for_rerouting(ind, self.id_number)
 
+    def next_node_for_jockeying(self, ind):
+        """
+        Finds the next node (for jockeing) according the routing method:
+        """
+        return self.simulation.routers[ind.customer_class].next_node_for_jockeying(ind, self.id_number)
+
     def preempt(self, individual_to_preempt, next_individual):
         """
         Removes individual_to_preempt from service and replaces them with next_individual
@@ -640,10 +646,7 @@ def renege(self):
         """
         reneging_individual = self.decide_between_simultaneous_individuals()
         reneging_individual.reneging_date = float("Inf")
-        next_node_number = self.simulation.network.customer_classes[
-            reneging_individual.customer_class
-        ].reneging_destinations[self.id_number - 1]
-        next_node = self.simulation.nodes[next_node_number]
+        next_node = self.next_node_for_jockeying(reneging_individual)
         self.individuals[reneging_individual.prev_priority_class].remove(reneging_individual)
         self.number_of_individuals -= 1
         reneging_individual.queue_size_at_departure = self.number_of_individuals

ciw/routing/routing.py

@@ -37,6 +37,12 @@ def next_node_for_rerouting(self, ind, node_id):
         """
         return self.routers[node_id - 1].next_node_for_rerouting(ind)
 
+    def next_node_for_jockeying(self, ind, node_id):
+        """
+        Chooses the next node when jockeying to another node after reneging.
+        """
+        return self.routers[node_id - 1].next_node_for_jockeying(ind)
+
 
 class TransitionMatrix(NetworkRouting):
     """
@@ -101,6 +107,12 @@ def next_node_for_rerouting(self, ind, node_id):
         """
         return self.next_node(ind, node_id)
 
+    def next_node_for_jockeying(self, ind, node_id):
+        """
+        Chooses the next node when jockeying to another node after reneging.
+        """
+        return self.simulation.nodes[-1]
+
 class FlexibleProcessBased(ProcessBased):
     """
     A class to route an individual based on a pre-defined process.
@@ -184,6 +196,12 @@ def next_node_for_rerouting(self, ind):
         """
         return self.next_node(ind)
 
+    def next_node_for_jockeying(self, ind):
+        """
+        Chooses the next node when jockeying to another node after reneging.
+        """
+        return self.simulation.nodes[-1]
+
 
 class Probabilistic(NodeRouting):
     """

ciw/tests/test_network.py

@@ -74,7 +74,6 @@ def test_init_method(self):
             ciw.dists.Deterministic(1),
         ]
         reneging_time_distributions = [None, None, None]
-        reneging_destinations = [-1, -1, -1]
         class_change_time_distributions = [None]
 
         CC = ciw.CustomerClass(
@@ -85,7 +84,6 @@ def test_init_method(self):
             baulking_functions,
             batching_distributions,
             reneging_time_distributions,
-            reneging_destinations,
             class_change_time_distributions,
         )
         self.assertEqual(CC.arrival_distributions, arrival_distributions)
@@ -94,7 +92,6 @@ def test_init_method(self):
         self.assertEqual(CC.routing, routing)
         self.assertEqual(CC.priority_class, priority_class)
         self.assertEqual(CC.reneging_time_distributions, reneging_time_distributions)
-        self.assertEqual(CC.reneging_destinations, reneging_destinations)
         self.assertEqual(CC.class_change_time_distributions, class_change_time_distributions)
 
         # check baulking function works
@@ -133,7 +130,6 @@ def test_init_method(self):
         ]
         baulking_functions = [None, None, example_baulking_function]
         reneging_time_distributions = [None, None, None]
-        reneging_destinations = [-1, -1, -1]
         class_change_time_distributions = {'Class 0': None, 'Class 1': None}
         service_centres = [
             ciw.ServiceCentre(
@@ -150,7 +146,6 @@ def test_init_method(self):
                 baulking_functions,
                 batching_distributions,
                 reneging_time_distributions,
-                reneging_destinations,
                 class_change_time_distributions,
             ) for i in range(2)
         }
@@ -447,7 +442,7 @@ def test_raising_errors(self):
             "number_of_nodes": 1,
             "queue_capacities": [float("inf")],
         }
-        params_list = [copy.deepcopy(params) for i in range(28)]
+        params_list = [copy.deepcopy(params) for i in range(24)]
 
         params_list[0]["number_of_classes"] = -2
         self.assertRaises(
@@ -601,37 +596,25 @@ def test_raising_errors(self):
             params_list[20]
         )
 
-        params_list[23]["reneging_time_distributions"] = {
+        params_list[21]["reneging_time_distributions"] = {
             "Class 0": [ciw.dists.Exponential(1), ciw.dists.Exponential(1)]
         }
         self.assertRaises(
             ValueError,
             ciw.create_network_from_dictionary,
-            params_list[23]
-        )
-        params_list[24]["reneging_destinations"] = {"Class 0": [-1, -1, -1]}
-        self.assertRaises(
-            ValueError,
-            ciw.create_network_from_dictionary,
-            params_list[24]
+            params_list[21]
         )
-        params_list[25]["reneging_destinations"] = {"Class 0": [7]}
+        params_list[22]["class_change_time_distributions"] = {'Class 0': {'Class 0': None}, 'Class 1': {'Class 0': None, 'Class 1': None}}
         self.assertRaises(
             ValueError,
             ciw.create_network_from_dictionary,
-            params_list[25]
+            params_list[22]
         )
-        params_list[26]["class_change_time_distributions"] = {'Class 0': {'Class 0': None}, 'Class 1': {'Class 0': None, 'Class 1': None}}
+        params_list[23]["routing"]["Class 0"] = [['0.5']]
         self.assertRaises(
             ValueError,
             ciw.create_network_from_dictionary,
-            params_list[26]
-        )
-        params_list[27]["routing"]["Class 0"] = [['0.5']]
-        self.assertRaises(
-            ValueError,
-            ciw.create_network_from_dictionary,
-            params_list[27]
+            params_list[23]
         )
 
     def test_raising_errors_routing(self):
@@ -942,7 +925,6 @@ def test_network_from_kwargs(self):
             number_of_servers=[2, 2],
             routing=[[0.0, 1.0], [0.2, 0.2]],
             reneging_time_distributions=[ciw.dists.Exponential(1), None],
-            reneging_destinations=[2, -1],
         )
         self.assertEqual(N.number_of_nodes, 2)
         self.assertEqual(N.number_of_classes, 1)
@@ -956,8 +938,6 @@ def test_network_from_kwargs(self):
             str(N.customer_classes['Customer'].reneging_time_distributions[0]), "Exponential(rate=1)"
         )
         self.assertEqual(N.customer_classes['Customer'].reneging_time_distributions[1], None)
-        self.assertEqual(N.customer_classes['Customer'].reneging_destinations[0], 2)
-        self.assertEqual(N.customer_classes['Customer'].reneging_destinations[1], -1)
 
         N = ciw.create_network(
             arrival_distributions={

ciw/tests/test_node.py

@@ -1155,13 +1155,25 @@ def test_reneging_records(self):
         self.assertEqual([r.queue_size_at_departure for r in reneging_recs], [1, 1])
 
     def test_reneging_sends_to_destination(self):
+        class Jockey(ciw.routing.NodeRouting):
+            def next_node(self, ind):
+                """
+                Chooses the exit node with probability 1.
+                """
+                return self.simulation.nodes[-1]
+
+            def next_node_for_jockeying(self, ind):
+                """
+                Chooses Node 2
+                """
+                return self.simulation.nodes[2]
+
         N = ciw.create_network(
             arrival_distributions=[ciw.dists.Deterministic(7), None],
             service_distributions=[ciw.dists.Deterministic(11), ciw.dists.Deterministic(2)],
-            routing=[[0.0, 0.0], [0.0, 0.0]],
+            routing=ciw.routing.NetworkRouting(routers=[Jockey(), ciw.routing.Leave()]),
             number_of_servers=[1, 1],
             reneging_time_distributions=[ciw.dists.Deterministic(3), None],
-            reneging_destinations=[2, -1],
         )
         Q = ciw.Simulation(N)
         Q.simulate_until_max_time(20)
@@ -1180,6 +1192,37 @@ def test_reneging_sends_to_destination(self):
         self.assertEqual([r.queue_size_at_arrival for r in recs_ind2], [1, 0])
         self.assertEqual([r.queue_size_at_departure for r in recs_ind2], [1, 0])
 
+    def test_process_based_defaults_jockeyers_to_exit(self):
+        def route(self, ind):
+            """
+            1-2
+            """
+            return [1]
+
+        N = ciw.create_network(
+            arrival_distributions=[ciw.dists.Deterministic(7), None],
+            service_distributions=[ciw.dists.Deterministic(11), ciw.dists.Deterministic(2)],
+            routing=ciw.routing.ProcessBased(route_function=route),
+            number_of_servers=[1, 1],
+            reneging_time_distributions=[ciw.dists.Deterministic(3), None],
+        )
+        Q = ciw.Simulation(N)
+        Q.simulate_until_max_time(20)
+        recs = Q.get_all_records()
+        self.assertEqual([r.id_number for r in recs], [1, 2])
+        self.assertEqual([r.record_type for r in recs], ['service', 'renege'])
+        self.assertEqual([r.arrival_date for r in recs], [7, 14])
+        self.assertEqual([r.exit_date for r in recs], [18, 17])
+        self.assertEqual([r.waiting_time for r in recs], [0, 3])
+        self.assertEqual([r.node for r in recs], [1, 1])
+        self.assertEqual([r.service_time for r in recs], [11, nan])
+        self.assertEqual([r.service_start_date for r in recs], [7, nan])
+        self.assertEqual([r.service_end_date for r in recs], [18, nan])
+        self.assertEqual([r.server_id for r in recs], [1, nan])
+        self.assertEqual([r.customer_class for r in recs], ['Customer', 'Customer'])
+        self.assertEqual([r.queue_size_at_arrival for r in recs], [0, 1])
+        self.assertEqual([r.queue_size_at_departure for r in recs], [0, 1])
+
     def test_reneging_none_dist(self):
         N = ciw.create_network(
             arrival_distributions={
@@ -1195,7 +1238,6 @@ def test_reneging_none_dist(self):
                 "Class 0": [ciw.dists.Deterministic(3)],
                 "Class 1": [None],
             },
-            reneging_destinations={"Class 0": [-1], "Class 1": [-1]},
         )
         Q = ciw.Simulation(N)
         self.assertTrue(Q.nodes[1].reneging)

docs/Guides/CustomerBehaviour/index.rst

@@ -8,3 +8,4 @@ Contents:
 
    baulking.rst
    reneging.rst
+   jockeying.rst