# Source code for spynnaker.pyNN.models.neuron.synapse_dynamics.abstract_static_synapse_dynamics

# Copyright (c) 2017-2019 The University of Manchester
#
# This program is free software: you can redistribute it and/or modify
# 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 spinn_utilities.abstract_base import AbstractBase, abstractmethod
from .abstract_synapse_dynamics import AbstractSynapseDynamics

[docs]class AbstractStaticSynapseDynamics(
AbstractSynapseDynamics, metaclass=AbstractBase):
""" Dynamics which don't change over time.
"""
# pylint: disable=too-many-arguments

__slots__ = ()

[docs]    @abstractmethod
def get_n_words_for_static_connections(self, n_connections):
""" Get the number of 32-bit words for n_connections in a single row.

:param int n_connections:
:rtype: int
"""

[docs]    @abstractmethod
def get_static_synaptic_data(
self, connections, connection_row_indices, n_rows,
post_vertex_slice, n_synapse_types, max_n_synapses):
""" Get the fixed-fixed data for each row, and lengths for the\
fixed-fixed parts of each row.

Data is returned as an array made up of an array of 32-bit words for\
each row for the fixed-fixed region. The row into which connection\
should go is given by connection_row_indices, and the total number\
of rows is given by n_rows.

Lengths are returned as an array made up of an integer for each row,\
for the fixed-fixed region.

:param ~numpy.ndarray connections: The connections to get data for
:param ~numpy.ndarray connection_row_indices:
The row into which each connection should go
:param int n_rows: The number of rows to write
:param ~pacman.model.graphs.common.Slice post_vertex_slice:
The slice of the post vertex to generate for
:param int n_synapse_types: The number of synapse types
:param int max_n_synapses: The maximum number of synapses to generate
:return: (ff_data, ff_size)
:rtype: tuple(list(~numpy.ndarray), ~numpy.ndarray)
"""

[docs]    @abstractmethod
def get_n_static_words_per_row(self, ff_size):
""" Get the number of bytes to be read per row for the static data\
given the size that was written to each row.

:param ~numpy.ndarray ff_size:
:rtype: ~numpy.ndarray
"""

[docs]    @abstractmethod
def get_n_synapses_in_rows(self, ff_size):
""" Get the number of synapses in the rows with sizes ff_size.

:param ~numpy.ndarray ff_size:
:rtype: ~numpy.ndarray
"""

[docs]    @abstractmethod
""" Read the connections from the words of data in ff_data.