pacman.model.placements package

Module contents

class pacman.model.placements.Placement(vertex: MachineVertex, x: int, y: int, p: int)

Bases: object

The placement of a vertex on to a machine chip and core.

Parameters:

  • vertex (MachineVertex) – The vertex that has been placed

  • x (int) – the x-coordinate of the chip on which the vertex is placed

  • y (int) – the y-coordinate of the chip on which the vertex is placed

  • p (int) – the ID of the processor on which the vertex is placed

property chip: Chip

The chip of this placement.

Return type:

Chip

property location: Tuple[int, int, int]

The (x,y,p) tuple that represents the location of this placement.

Return type:

tuple(int,int,int)

property p: int

The ID of the processor of the chip where the vertex is placed.

Return type:

int

property vertex: MachineVertex

The vertex that was placed.

Return type:

MachineVertex

property x: int

The X-coordinate of the chip where the vertex is placed.

Return type:

int

property xy: Tuple[int, int]

The (x,y) tuple that represents the chip of this placement.

Return type:

tuple(int,int)

property y: int

The Y-coordinate of the chip where the vertex is placed.

Return type:

int

class pacman.model.placements.Placements(placements: Iterable[Placement] = ())

Bases: object

The placements of vertices on the chips of the machine.

Parameters:

placements (iterable(Placement)) – Any initial placements

Raises:
add_placement(placement: Placement)[source]

Add a placement.

Parameters:

placement (Placement) – The placement to add

Raises:
add_placements(placements: Iterable[Placement])[source]

Add some placements.

Parameters:

placements (iterable(Placement)) – The placements to add

property chips_with_placements: Iterable[Tuple[int, int]]

The chips with placements on them.

Return type:

iterable(tuple(int,int))

get_placement_of_vertex(vertex: MachineVertex) → Placement[source]

Return the placement information for a vertex.

Parameters:

vertex (MachineVertex) – The vertex to find the placement of

Returns:

The placement

Return type:

Placement

Raises:

PacmanNotPlacedError – If the vertex has not been placed.

get_placement_on_processor(x: int, y: int, p: int) → Placement[source]

Get the placement on a specific processor, or raises an exception if the processor has not been allocated.

Parameters:

  • x (int) – the x coordinate of the chip

  • y (int) – the y coordinate of the chip

  • p (int) – the processor on the chip

Returns:

the placement on the given processor

Return type:

Placement

Raises:

PacmanProcessorNotOccupiedError – If the processor is not occupied

is_processor_occupied(x: int, y: int, p: int) → bool[source]

Determine if a processor has a vertex on it.

Parameters:

  • x (int) – x coordinate of processor.

  • y (int) – y coordinate of processor.

  • p (int) – Index of processor.

Return bool:

Whether the processor has an assigned vertex.

is_vertex_placed(vertex: MachineVertex) → bool[source]

Determine if a vertex has been placed.

Parameters:

vertex (MachineVertex) – The vertex to determine the status of

Return type:

bool

iterate_placements_by_vertex_type(vertex_type: type | Tuple[type, ...]) → Iterable[Placement][source]

Iterate over placements on any chip with this vertex_type.

Parameters:

vertex_type (type or tuple(type)) – Class of vertex to find

Return type:

iterable(Placement)

iterate_placements_by_xy_and_type(xy: Tuple[int, int], vertex_type: type | Tuple[type, ...]) → Iterable[Placement][source]

Iterate over placements with this x, y and this vertex_type.

Parameters:

  • xy (tuple(int, int)) – x and y coordinate to find placements for.

  • vertex_type (class or tuple(class)) – Class of vertex to find

Return type:

iterable(Placement)

iterate_placements_on_core(xy: Tuple[int, int]) → Iterable[Placement][source]

Iterate over placements with this x and y.

Parameters:

xy (tuple(int, int)) – x and y coordinates to find placements for.

Return type:

iterable(Placement)

property n_placements: int

The number of placements.

Return type:

int

n_placements_on_chip(xy: Tuple[int, int]) → int[source]

The number of placements on the given chip.

Parameters:

xy (tuple(int, int)) – x and y coordinate of chip.

Return type:

int

property placements: Iterable[Placement]

All of the placements.

Returns:

iterable of placements

Return type:

iterable(Placement)

placements_on_chip(xy: Tuple[int, int]) → Collection[Placement][source]

Get the placements on a specific chip.

Parameters:

xy (tuple(int , int)) – The x and y coordinates of the chip

Return type:

iterable(Placement)