Source code for pacman.model.routing_info.vertex_routing_info

# Copyright (c) 2021 The University of Manchester
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from typing import Optional, Union
import numpy

from spinn_utilities.abstract_base import abstractmethod, AbstractBase

from pacman.exceptions import PacmanConfigurationException
from pacman.model.graphs.application import ApplicationVertex
from pacman.model.graphs.machine import MachineVertex

from .base_key_and_mask import BaseKeyAndMask


class VertexRoutingInfo(object, metaclass=AbstractBase):
    """
    Associates a partition identifier to its routing information
    (keys and masks).
    """

    __slots__ = (
        # The keys allocated to the machine partition
        "__key_and_mask",
        # The partition identifier of the allocation
        "__partition_id")

    def __init__(self, key_and_mask: BaseKeyAndMask, partition_id: str):
        """
        :param BaseKeyAndMask key_and_mask:
            The keys allocated to the machine partition
        :param str partition_id: The partition to set the keys for
        """
        assert isinstance(key_and_mask, BaseKeyAndMask)
        self.__key_and_mask = key_and_mask
        self.__partition_id = partition_id



    def get_keys(self, n_keys: Optional[int] = None) -> numpy.ndarray:
        """
        Get the ordered list of individual keys allocated to the edge.

        :param int n_keys: Optional limit on the number of keys to return
        :return: An array of keys
        :rtype: ~numpy.ndarray
        """
        max_n_keys = self.__key_and_mask.n_keys

        if n_keys is None:
            n_keys = max_n_keys
        elif max_n_keys < n_keys:
            raise PacmanConfigurationException(
                f"You asked for {n_keys} keys, but the routing info can only "
                f"provide {max_n_keys} keys.")

        key_array = numpy.zeros(n_keys, dtype=">u4")
        offset = 0
        _, offset = self.__key_and_mask.get_keys(
            key_array=key_array, offset=offset, n_keys=(n_keys - offset))
        return key_array


    @property
    def key_and_mask(self):
        """
        The only key and mask.

        :rtype: BaseKeyAndMask
        """
        return self.__key_and_mask

    @property
    def key(self) -> int:
        """
        The first key (or only one if there is only one).

        :rtype: int
        """
        return self.__key_and_mask.key

    @property
    def mask(self) -> int:
        """
        The first mask (or only one if there is only one).

        :rtype: int
        """
        return self.__key_and_mask.mask

    @property
    def partition_id(self) -> str:
        """
        The identifier of the partition.

        :rtype: str
        """
        return self.__partition_id

    @property
    @abstractmethod
    def vertex(self) -> Union[ApplicationVertex, MachineVertex]:
        """
        The vertex of the information.

        :rtype: ApplicationVertex or MachineVertex
        """
        raise NotImplementedError