pacman.utilities package

Subpackages

• pacman.utilities.algorithm_utilities package
  • Submodules
  • pacman.utilities.algorithm_utilities.partition_algorithm_utilities module
    • get_multidimensional_slices()
    • get_single_dimension_slices()
  • pacman.utilities.algorithm_utilities.routes_format module
    • format_route()
  • pacman.utilities.algorithm_utilities.routing_algorithm_utilities module
    • get_app_partitions()
    • longest_dimension_first()
    • vector_to_nodes()
    • vertex_chip()
    • vertex_xy()
    • vertex_xy_and_route()
  • pacman.utilities.algorithm_utilities.routing_tree module
    • RoutingTree
      • RoutingTree.append_child()
      • RoutingTree.children
      • RoutingTree.chip
      • RoutingTree.is_leaf
      • RoutingTree.label
      • RoutingTree.remove_child()
      • RoutingTree.traverse()
  • Module contents
• pacman.utilities.file_format_schemas package
  • Subpackages
    • pacman.utilities.file_format_schemas.unused package
      • Module contents
  • Module contents
    • validate()
• pacman.utilities.utility_objs package
  • Module contents
    • ChipCounter
      • ChipCounter.add_core()
      • ChipCounter.n_chips

Submodules

pacman.utilities.constants module

class pacman.utilities.constants.EDGES(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

The 6 directions links can go.

EAST = 0

NORTH = 2

NORTH_EAST = 1

SOUTH = 5

SOUTH_WEST = 4

WEST = 3

pacman.utilities.constants.SARK_PER_MALLOC_SDRAM_USAGE = 8

The number of bytes used by SARK per memory allocation

pacman.utilities.json_utils module

Miscellaneous minor functions for converting between JSON and Python objects.

pacman.utilities.json_utils.iptag_resource_from_json(json_dict: Dict[str, int | float | str | None | Dict[str, int | float | str | None | JsonObject | List[int | float | str | None | JsonObject | JsonArray]] | List[int | float | str | None | Dict[str, int | float | str | None | JsonObject | JsonArray] | JsonArray]]) → IPtagResource

Creates an iptag from json

Parameters:

json_dict (dict(str, object))

Return type:

IPtagResource

pacman.utilities.json_utils.iptag_resource_to_json(iptag: IPtagResource) → Dict[str, int | float | str | None | Dict[str, int | float | str | None | JsonObject | List[int | float | str | None | JsonObject | JsonArray]] | List[int | float | str | None | Dict[str, int | float | str | None | JsonObject | JsonArray] | JsonArray]]

Converts an iptag to json

Parameters:

iptag (IPtagResource)

Return type:

dict(str, object)

pacman.utilities.json_utils.iptag_resources_from_json(json_list: List[Dict[str, int | float | str | None | Dict[str, int | float | str | None | JsonObject | List[int | float | str | None | JsonObject | JsonArray]] | List[int | float | str | None | Dict[str, int | float | str | None | JsonObject | JsonArray] | JsonArray]]]) → List[IPtagResource]

Creates a list of iptags from json.

Parameters:

json_list (list(dict(str, object)))

Return type:

list(IPtagResource)

pacman.utilities.json_utils.iptag_resources_to_json(iptags: Iterable[IPtagResource]) → List[int | float | str | None | Dict[str, int | float | str | None | JsonObject | List[int | float | str | None | JsonObject | JsonArray]] | List[int | float | str | None | Dict[str, int | float | str | None | JsonObject | JsonArray] | JsonArray]]

Converts a list of iptags to json.

Parameters:

iptags (list(IPtagResource))

Return type:

list

pacman.utilities.json_utils.json_to_object(json_object: str | Dict[str, int | float | str | None | Dict[str, int | float | str | None | JsonObject | List[int | float | str | None | JsonObject | JsonArray]] | List[int | float | str | None | Dict[str, int | float | str | None | JsonObject | JsonArray] | JsonArray]]) → Dict[str, int | float | str | None | Dict[str, int | float | str | None | JsonObject | List[int | float | str | None | JsonObject | JsonArray]] | List[int | float | str | None | Dict[str, int | float | str | None | JsonObject | JsonArray] | JsonArray]]

Makes sure this is a JSON object reading in a file if required

Parameters:

json_object (dict or list or str) – Either a JSON Object or a string pointing to a file

Returns:

a JSON object

Return type:

dict or list

pacman.utilities.json_utils.key_mask_to_json(key_mask: BaseKeyAndMask) → Dict[str, int | float | str | None | Dict[str, int | float | str | None | JsonObject | List[int | float | str | None | JsonObject | JsonArray]] | List[int | float | str | None | Dict[str, int | float | str | None | JsonObject | JsonArray] | JsonArray]]

Converts a BaseKeyAndMask into json

Parameters:

key_mask (BaseKeyAndMask)

Return type:

dict(str, object)

pacman.utilities.json_utils.placement_from_json(json_dict: Dict[str, int | float | str | None | Dict[str, int | float | str | None | JsonObject | List[int | float | str | None | JsonObject | JsonArray]] | List[int | float | str | None | Dict[str, int | float | str | None | JsonObject | JsonArray] | JsonArray]]) → Placement

Gets a Placement based on the json.

Parameters:

json_dict (dict(str, object))

Return type:

Placement

pacman.utilities.json_utils.placement_to_json(placement: Placement) → Dict[str, int | float | str | None | Dict[str, int | float | str | None | JsonObject | List[int | float | str | None | JsonObject | JsonArray]] | List[int | float | str | None | Dict[str, int | float | str | None | JsonObject | JsonArray] | JsonArray]]

Converts a Placement to json

Parameters:

placement (Placement)

Return type:

dict(str, object)

pacman.utilities.json_utils.placements_to_json() → List[int | float | str | None | Dict[str, int | float | str | None | JsonObject | List[int | float | str | None | JsonObject | JsonArray]] | List[int | float | str | None | Dict[str, int | float | str | None | JsonObject | JsonArray] | JsonArray]]

Gets a json description of the placements (held in DataView)

pacman.utilities.json_utils.reverse_iptag_from_json(json_dict: Dict[str, int | float | str | None | Dict[str, int | float | str | None | JsonObject | List[int | float | str | None | JsonObject | JsonArray]] | List[int | float | str | None | Dict[str, int | float | str | None | JsonObject | JsonArray] | JsonArray]]) → ReverseIPtagResource

Creates a ReverseIPtagResource based on json

Parameters:

json_dict (dict(str, object))

Return type:

ReverseIPtagResource

pacman.utilities.json_utils.reverse_iptag_to_json(iptag: ReverseIPtagResource) → Dict[str, int | float | str | None | Dict[str, int | float | str | None | JsonObject | List[int | float | str | None | JsonObject | JsonArray]] | List[int | float | str | None | Dict[str, int | float | str | None | JsonObject | JsonArray] | JsonArray]]

Converts a reverse iptag to json

Parameters:

iptag (ReverseIPtagResource)

Return type:

dict(object)

pacman.utilities.json_utils.reverse_iptags_from_json(json_list: List[Dict[str, int | float | str | None | Dict[str, int | float | str | None | JsonObject | List[int | float | str | None | JsonObject | JsonArray]] | List[int | float | str | None | Dict[str, int | float | str | None | JsonObject | JsonArray] | JsonArray]]]) → List[ReverseIPtagResource]

Creates a list of ReverseIPtagResource from json

Parameters:

json_list (list)

Type:

list(ReverseIPtagResource)

pacman.utilities.json_utils.reverse_iptags_to_json(iptags: Iterable[ReverseIPtagResource]) → List[int | float | str | None | Dict[str, int | float | str | None | JsonObject | List[int | float | str | None | JsonObject | JsonArray]] | List[int | float | str | None | Dict[str, int | float | str | None | JsonObject | JsonArray] | JsonArray]]

Converts a list of reverse iptags to json

Parameters:

iptags (list(ReverseIPtagResource))

Return type:

list

pacman.utilities.utility_calls module

pacman.utilities.utility_calls.allocator_bits_needed(size: int) → int

Get the bits needed for the routing info allocator.

Parameters:

size (int) – The size to calculate the number of bits for

Returns:

the number of bits required for that size

Return type:

int

pacman.utilities.utility_calls.compress_bits_from_bit_array(bit_array: ndarray, bit_positions: ndarray) → int

Compress specific positions from a bit array of 32 uint8 value, where is a 1 or 0, into a 32-bit value.

Parameters:

• bit_array (ndarray(uint8)) – The array to extract the value from

• bit_positions (ndarray(int)) – The positions of the bits to extract, each value being between 0 and 31

Return type:

int

pacman.utilities.utility_calls.compress_from_bit_array(bit_array: ndarray) → int

Compress a bit array of 32 uint8 values, where each is a 1 or 0, into a 32-bit value.

Parameters:

bit_array (ndarray(uint8)) – The array to compress

Return type:

int

pacman.utilities.utility_calls.expand_to_bit_array(value: int) → ndarray

Expand a 32-bit value in to an array of length 32 of uint8 values, each of which is a 1 or 0.

Parameters:

value (int) – The value to expand

Return type:

ndarray(uint8)

pacman.utilities.utility_calls.get_key_ranges(key: int, mask: int) → Iterable[Tuple[int, int]]

Get a generator of base_key, n_keys pairs that represent ranges allowed by the mask.

Parameters:

• key (int) – The base key

• mask (int) – The mask

Return type:

iterable(tuple(int,int))

pacman.utilities.utility_calls.get_keys(base_key: int, vertex_slice: Slice, n_extra_bits: int = 0) → ndarray

Get the keys for a given vertex slice.

Parameters:

• base_key (int) – The base key for the vertex slice

• vertex_slice (Slice) – The slice of the vertex to get keys for

• n_extra_bits (int) – Additional right shift to apply to atoms

Return type:

iterable(int)

pacman.utilities.utility_calls.get_n_bits(n_values: int) → int

Determine how many bits are required for the given number of values.

Parameters:

n_values (int) – the number of values (starting at 0)

Returns:

the number of bits required to express that many values

Return type:

int

pacman.utilities.utility_calls.is_equal_or_none(a: Any, b: Any) → bool

If a and b are both not None, return True if and only if they are equal, otherwise return True.

Return type:

bool

pacman.utilities.utility_calls.is_power_of_2(v: int) → bool

Determine if a value is a power of 2.

Parameters:

v (int) – The value to test

Return type:

bool

pacman.utilities.utility_calls.is_single(iterable: Iterable[Any]) → bool

Test if there is exactly one item in the iterable.

Return type:

bool

pacman.utilities.utility_calls.md5(string: str) → str

Get the MD5 hash of the given string, which is UTF-8 encoded.

Parameters:

string (str)

Return type:

str

Module contents