spinn_front_end_common.interface.buffer_management.buffer_models package

Module contents

class spinn_front_end_common.interface.buffer_management.buffer_models.AbstractReceiveBuffersToHost

Bases: object

Indicates that this MachineVertex can receive buffers.

abstractmethod get_recorded_region_ids() → Sequence[int][source]

Get the recording region IDs that have been recorded using buffering.

Returns:

The region numbers that have active recording

abstractmethod get_recording_region_base_address(placement: Placement) → int[source]

Get the recording region base address.

Parameters:

placement – the placement object of the core to find the address of

Returns:

the base address of the recording region

class spinn_front_end_common.interface.buffer_management.buffer_models.AbstractReceiveRegionsToHost

Bases: object

Indicates that this MachineVertex has regions that are to be downloaded to the host.

abstractmethod get_download_regions(placement: Placement) → Sequence[Tuple[int, int, int]][source]

Get the region IDs that are to be downloaded

Returns:

The region number, address and size of the regions to be downloaded

class spinn_front_end_common.interface.buffer_management.buffer_models.AbstractSendsBuffersFromHost

Bases: object

A vertex that sends buffers of keys to be transmitted at given timestamps in the simulation.

abstractmethod buffering_input() → bool[source]
Returns:

True if the input of this vertex is to be buffered.

abstractmethod get_next_key(region: int) → int[source]

Get the next key in the given region.

Parameters:

region – The region to get the next key from

Returns:

The next key, or None if there are no more keys

abstractmethod get_next_timestamp(region: int) → int[source]

Get the next timestamp at which there are still keys to be sent for the given region.

Parameters:

region – The region to get the timestamp for

Returns:

The timestamp of the next available keys

abstractmethod get_region_buffer_size(region: int) → int[source]

Get the size of the buffer to be used in SDRAM on the machine for the region in bytes.

Parameters:

region – The region to get the buffer size of

Returns:

The size of the buffer space in bytes

abstractmethod get_regions() → Iterable[int][source]

Get the set of regions for which there are keys to be sent.

Returns:

Iterable of region IDs

abstractmethod is_empty(region: int) → bool[source]

Return true if there are no spikes to be buffered for the specified region.

Parameters:

region – The region to get the next key from

Returns:

Whether there are no keys to send for the region

abstractmethod is_next_key(region: int, timestamp: int) → bool[source]

Determine if there are still keys to be sent at the given timestamp for the given region.

Parameters:

  • region – The region to determine if there are keys for

  • timestamp – The timestamp to determine if there are more keys for

Returns:

Whether there are more keys to send for the parameters

abstractmethod is_next_timestamp(region: int) → bool[source]

Determine if there is another timestamp with data to be sent.

Parameters:

region – The region to determine if there is more data for

Returns:

Whether there is more data

abstractmethod rewind(region: int) → None[source]

Rewinds the internal buffer in preparation of re-sending the spikes.

Parameters:

region – The region to rewind