Skip to content

Commit

Permalink
still more removal of rig from comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Christian-B committed Jul 18, 2019
1 parent 6a89706 commit dc3fc1b
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 22 deletions.
9 changes: 2 additions & 7 deletions pacman/operations/router_algorithms/routing_tree.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,17 +47,12 @@ class RoutingTree(object):
a large memory overhead and in practice the set-like behaviour of
the list of children is not useful.
The route must be either :py:class:`~rig.routing_table.Routes` or
`None`. If :py:class:`~rig.routing_table.Routes` then this indicates
the next step in the route uses a particular route.
The object indicates the intended destination of this step in the
route. It may be one of:
* :py:class:`~.rig.place_and_route.routing_tree.RoutingTree`
* :py:class:`RoutingTree`
representing the continuation of the routing tree after following a
given link. (Only used if the :py:class:`~rig.routing_table.Routes`
object is a link and not a core).
given link.
* A vertex (i.e. some other Python object) when the route terminates at
the supplied vertex. Note that the direction may be None and so
additional logic may be required to determine what core to target to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,18 @@ class RoutingTableEntry(object):
speeds frequent access.
"""

"""
Parameters
----------
route : {:py:class:`~.Routes`, ...}
The set of destinations a packet should be routed to where each element
in the set is a value from the enumeration
:py:class:`~rig.routing_table.Routes`.
key : int
32-bit unsigned integer routing key to match after applying the mask.
mask : int
32-bit unsigned integer mask to apply to keys of packets arriving at
the router.
"""

_slots__ = ["route", "key", "mask", "defaultable"]
_slots__ = [
# int value representing The set of destinations a packet should be
# routed to where each element in the set is a value from the
# enumeration
"route",
# 32-bit unsigned integer routing key to match after applying the mask.
"key",
# 32-bit unsigned integer mask to apply to keys of packets arriving at
# the router.
"mask",
# bool value to say if the route is defaultable
"defaultable"]

def __init__(self, route, key, mask, defaultable):
self.route = route
Expand Down

0 comments on commit dc3fc1b

Please sign in to comment.