Source code for pacman.model.routing_info.abstract_machine_partition_n_keys_map

from six import add_metaclass

from spinn_utilities.abstract_base import AbstractBase, abstractmethod


@add_metaclass(AbstractBase)
class AbstractMachinePartitionNKeysMap(object):
    """ A map that provides the number of keys required by each partition
    """

    __slots__ = []

    @abstractmethod
    def n_keys_for_partition(self, partition):
        """ The number of keys required by the given partition

        :param partition: The partition to set the number of keys for
        :type partition:\
                    :py:class:`pacman.model.graph.simple_outgoing_edge_partition.OutgoingEdgePartition`
        :return: The number of keys required by the partition
        :rtype: int
        """
        pass