Interface for matrix generation. More...

#include <common-typedefs.h>

Functions
matrix_generator_t	matrix_generator_init (uint32_t hash, void *region, void synaptic_matrix)
	Initialise a specific matrix generator.

void	matrix_generator_free (matrix_generator_t generator)
	Finish with a matrix generator.

bool	matrix_generator_write_synapse (matrix_generator_t generator, uint32_t pre_index, uint16_t post_index, accum weight, uint16_t delay, unsigned long accum weight_scale)
	Write a synapse with a matrix generator.

Detailed Description

Interface for matrix generation.

Definition in file matrix_generator.h.

Function Documentation

matrix_generator_t matrix_generator_init	(	uint32_t	hash,
		void **	region,
		void *	synaptic_matrix
	)

Initialise a specific matrix generator.

Parameters

[in]	hash	The identifier of the generator to initialise
[in,out]	region	The address to read data from; updated to position after data has been read
[in]	synaptic_matrix	The address of the base of the synaptic matrix

Returns: An initialised matrix generator that can be used with other functions, or NULL if it couldn't be initialised for any reason

Definition at line 92 of file matrix_generator.c.

void matrix_generator_free ( matrix_generator_t generator )

Finish with a matrix generator.

Parameters

[in] generator The generator to free

Definition at line 120 of file matrix_generator.c.

bool matrix_generator_write_synapse	(	matrix_generator_t	generator,
		uint32_t	pre_index,
		uint16_t	post_index,
		accum	weight,
		uint16_t	delay,
		unsigned long accum	weight_scale
	)

Write a synapse with a matrix generator.

Parameters

[in]	generator	The generator to use to generate the matrix
[in]	pre_index	The index of the pre-neuron relative to the start of the matrix
[in]	post_index	The index of the post-neuron on this core
[in]	weight	The weight of the synapse in raw form
[in]	delay	The delay of the synapse in time steps
[in]	weight_scale	The scale to apply to the weight if needed

Definition at line 126 of file matrix_generator.c.