pacman.model.placements package

Module contents

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

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
location

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

Return type:tuple(int,int,int)
p

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

Return type:int
vertex

The vertex that was placed

Return type:MachineVertex
x

The x-coordinate of the chip where the vertex is placed

Return type:int
y

The y-coordinate of the chip where the vertex is placed

Return type:int
class pacman.model.placements.Placements(placements=None)

Bases: object

The placements of vertices on the chips of the machine.

Parameters:

placements (iterable(Placement)) – Any initial placements

Raises:
add_placement(placement)[source]

Add a placement

Parameters:

placement (Placement) – The placement to add

Raises:
add_placements(placements)[source]

Add some placements

Parameters:placements (iterable(Placement)) – The placements to add
get_placed_processors()[source]

Return an iterable of processors with assigned vertices.

Returns:Iterable of (x, y, p) tuples
Return type:iterable(tuple(int, int, int))
get_placement_of_vertex(vertex)[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, y, p)[source]
Return 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

get_vertex_on_processor(x, y, p)[source]
Return the vertex 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 vertex placed on the given processor

Return type:

MachineVertex

Raises:

PacmanProcessorNotOccupiedError – If the processor is not occupied

is_processor_occupied(x, y, p)[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.

n_placements

The number of placements

Return type:int
placements

All of the placements

Returns:iterable of placements
Return type:iterable(Placement)