Skip to content

Commit 17407f2

Browse files
committed
properly link to router reference page
1 parent 8f13e51 commit 17407f2

2 files changed

Lines changed: 4 additions & 5 deletions

File tree

docs/Guides/Routing/routing_objects.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,11 @@ Ciw has a number of these built in, however their primary use is to be defined b
1414
+ :code:`ciw.routing.TransitionMatrix`, allowing users to define :ref:`transition matrices<transition-matrix>`, that is a matrix of probabilities of being transferred to each node in the network after service at every other node.
1515
+ :code:`ciw.routing.ProcessBased`, allowing pre-defined routes to be given to individuals when they arrive, that is :ref:`process-based routing<process-based>`.
1616

17-
However, the most flexible Network routing object is the generic :code:`ciw.routing.NetworkRouting`. This takes in a list of Node routing objects. Node routing objects are objects that determine routing out of a particular node. The following are built-in to Ciw, but importantly, they can be user defined:
17+
However, the most flexible Network routing object is the generic :code:`ciw.routing.NetworkRouting`. This takes in a list of Node routing objects. Node routing objects are objects that determine routing out of a particular node. A :ref:`full list is given<refs-routing>` in the References section. The following are some of the most basic built-in routers available in Ciw, but importantly, they can also be user defined:
1818

1919
+ :code:`ciw.routing.Direct(to=2)`: Sends the individual directly to another node. For example here, a customer is always send to node 2.
2020
+ :code:`ciw.routing.Leave()`: The individual leaves the system.
2121
+ :code:`ciw.routing.Probabilistic(destinations=[1, 3], probs=[0.1, 0.4])`: Probabilistically sends the individual to either of the destination, according to their corresponding probabilities. In this case, they are send to node 1 with probability 0.1, node 3 with probability 0.4, and leave the system with the rest of the probability, 0.5.
22-
+ :code:`ciw.routing.JoinShortestQueue` and :code:`ciw.routing.LoadBalancing` are forms of sending the individual to the shortest queue. More information on these is given :ref:`here<join-shortest-queue>`.
2322

2423

2524
Example

docs/Reference/routers.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ The general network router allows us to define separate node routing objects for
3434

3535
ciw.routing.NetworkRouting(
3636
routers=[
37-
ciw.routing.NodeRouting(),
38-
ciw.routing.NodeRouting(),
39-
ciw.routing.NodeRouting()
37+
ciw.routing.NodeRouting(), # should be replaced with one of the node routers below
38+
ciw.routing.NodeRouting(), # should be replaced with one of the node routers below
39+
ciw.routing.NodeRouting() # should be replaced with one of the node routers below
4040
]
4141
)
4242

0 commit comments

Comments
 (0)