connection_generator.c File Reference

The implementation of the functions in connection_generator.h. More...

#include "connection_generator.h"
#include <spin1_api.h>
#include <debug.h>
#include "generator_types.h"
#include "connection_generators/connection_generator_one_to_one.h"
#include "connection_generators/connection_generator_all_to_all.h"
#include "connection_generators/connection_generator_fixed_prob.h"
#include "connection_generators/connection_generator_fixed_total.h"
#include "connection_generators/connection_generator_fixed_pre.h"
#include "connection_generators/connection_generator_fixed_post.h"
#include "connection_generators/connection_generator_kernel.h"

Go to the source code of this file.

Data Structures
struct	connection_generator_info
	A "class" for connection generators. More...
struct	connection_generator_t
	The data for a connection generator. More...

Enumerations
enum	{   ONE_TO_ONE , ALL_TO_ALL , FIXED_PROBABILITY , FIXED_TOTAL ,   FIXED_PRE , FIXED_POST , KERNEL , N_CONNECTION_GENERATORS }
	Known "hashes" of connection generators. More...

Functions
connection_generator_t	connection_generator_init (uint32_t hash, void **in_region)
	Initialise a specific connection generator.
bool	connection_generator_generate (connection_generator_t generator, uint32_t pre_lo, uint32_t pre_hi, uint32_t post_lo, uint32_t post_hi, uint32_t post_index, uint32_t post_slice_start, uint32_t post_slice_count, unsigned long accum weight_scale, accum timestep_per_delay, param_generator_t weight_generator, param_generator_t delay_generator, matrix_generator_t matrix_generator)
	Generate connections with a connection generator.
void	connection_generator_free (connection_generator_t generator)
	Finish with a connection generator.

Variables
static const connection_generator_info	connection_generators []
	An Array of known generators.

Detailed Description

The implementation of the functions in connection_generator.h.

Definition in file connection_generator.c.

---

Data Structure Documentation

connection_generator_info

struct connection_generator_info

A "class" for connection generators.

Definition at line 50 of file connection_generator.c.

Data Fields
generator_hash_t	hash	The hash of the generator.
initialize_connector_func *	initialize	Initialises the generator.
generate_connection_func *	generate	Generate connections.
free_func *	free	Frees any data for the generator.

connection_generator

struct connection_generator

The data for a connection generator.

Connection generator "object".

Definition at line 65 of file connection_generator.c.

Data Fields
const connection_generator_info *	type
void *	data

Enumeration Type Documentation

anonymous enum

anonymous enum

Known "hashes" of connection generators.

For now, hash is just an index agreed between Python and here

Enumerator
ONE_TO_ONE	One-to-one connection generator.
ALL_TO_ALL	All-to-all connection generator.
FIXED_PROBABILITY	Fixed probability connection generator.
FIXED_TOTAL	Fixed total connections connection generator.
FIXED_PRE	Fixed pre-size connection generator.
FIXED_POST	Fixed post-size connection generator.
KERNEL	Convolution kernel connection generator.
N_CONNECTION_GENERATORS	The number of known generators.

Definition at line 38 of file connection_generator.c.

Function Documentation

connection_generator_init()

connection_generator_t connection_generator_init	(	uint32_t	hash,
		void **	region
	)

Initialise a specific connection 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

Returns

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

Definition at line 102 of file connection_generator.c.

connection_generator_generate()

bool connection_generator_generate	(	connection_generator_t	generator,
		uint32_t	pre_lo,
		uint32_t	pre_hi,
		uint32_t	post_lo,
		uint32_t	post_hi,
		uint32_t	post_index,
		uint32_t	post_slice_start,
		uint32_t	post_slice_count,
		unsigned long accum	weight_scale,
		accum	timestep_per_delay,
		param_generator_t	weight_generator,
		param_generator_t	delay_generator,
		matrix_generator_t	matrix_generator
	)

Generate connections with a connection generator.

Parameters

[in]	generator	The generator to use to generate connections
[in]	pre_slice_start	The start of the slice of the pre-population being generated
[in]	pre_slice_count	The number of neurons in the slice of the pre-population being generated
[in]	pre_neuron_index	The index of the neuron in the pre-population being generated
[in]	post_slice_start	The start of the slice of the post-population being generated
[in]	post_slice_count	The number of neurons in the slice of the post-population being generated
[in]	max_row_length	The maximum number of connections to generate
[in,out]	indices	An array into which the core-relative post-indices should be placed. This will be initialised to be max_row_length in size

Returns

The number of connections generated

Definition at line 130 of file connection_generator.c.

connection_generator_free()

void connection_generator_free

(

connection_generator_t

generator

)

Finish with a connection generator.

Parameters

[in]

generator

The generator to free

Definition at line 143 of file connection_generator.c.

Variable Documentation

connection_generators

const connection_generator_info connection_generators[]

static

Initial value:

= {
    {ONE_TO_ONE,
            connection_generator_one_to_one_initialise,
            connection_generator_one_to_one_generate,
            connection_generator_one_to_one_free},
    {ALL_TO_ALL,
            connection_generator_all_to_all_initialise,
            connection_generator_all_to_all_generate,
            connection_generator_all_to_all_free},
    {FIXED_PROBABILITY,
            connection_generator_fixed_prob_initialise,
            connection_generator_fixed_prob_generate,
            connection_generator_fixed_prob_free},
    {FIXED_TOTAL,
            connection_generator_fixed_total_initialise,
            connection_generator_fixed_total_generate,
            connection_generator_fixed_total_free},
    {FIXED_PRE,
            connection_generator_fixed_pre_initialise,
            connection_generator_fixed_pre_generate,
            connection_generator_fixed_pre_free},
    {FIXED_POST,
            connection_generator_fixed_post_initialise,
            connection_generator_fixed_post_generate,
            connection_generator_fixed_post_free},
    {KERNEL,
            connection_generator_kernel_initialise,
            connection_generator_kernel_generate,
            connection_generator_kernel_free}
}

An Array of known generators.

Definition at line 71 of file connection_generator.c.