Source code for pacman.model.resources.abstract_sdram
# Copyright (c) 2017-2019 The University of Manchester
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
from six import add_metaclass
from spinn_utilities.abstract_base import (
AbstractBase, abstractmethod, abstractproperty)
[docs]@add_metaclass(AbstractBase)
class AbstractSDRAM(object):
""" Represents an amount of SDRAM used on a chip in the machine.
"""
[docs] @abstractmethod
def get_total_sdram(self, n_timesteps):
"""
The total SDRAM.
:param n_timesteps: number of timesteps to cost for
:type n_timesteps: int
:return:
"""
@abstractmethod
def __add__(self, other):
"""
Combines this SDRAM resource with the other one and creates a new one
:param other: another SDRAM resource
:type other: ~.AbstractSDRAM
:return: a New AbstractSDRAM
:rtype: ~.AbstractSDRAM
"""
@abstractmethod
def __sub__(self, other):
""" Creates a new SDRAM which is this one less the other
:param other: another SDRAM resource
:type other: ~.AbstractSDRAM
:return: a New AbstractSDRAM
:rtype: ~.AbstractSDRAM
"""
[docs] @abstractmethod
def sub_from(self, other):
""" Creates a new SDRAM which is the other less this one
:param other: another SDRAM resource
:type other: ~.AbstractSDRAM
:return: a New AbstractSDRAM
:rtype: ~.AbstractSDRAM
"""
@abstractproperty
def fixed(self):
""" Returns the fixed SDRAM cost
"""
@abstractproperty
def per_timestep(self):
""" Returns extra SDRAM cost for each additional timestep
Warning may well be zero
"""