tNeuron

Model of a neuron, adapted to act as an oscillator. More...

Enumerations
enum	NeuronMode { NeuronNormal, NeuronTanh, NeuronAaltoShaper }

Functions
void	tNeuron_init (tNeuron *const neuron, LEAF *const leaf)
	Initialize a tNeuron to the default mempool of a LEAF instance. More...
void	tNeuron_initToPool (tNeuron *const neuron, tMempool *const mempool)
	Initialize a tNeuron to a specified mempool. More...
void	tNeuron_free (tNeuron *const neuron)
	Free a tNeuron from its mempool. More...
void	tNeuron_reset (tNeuron *const neuron)
	Reset the neuron model. More...
float	tNeuron_tick (tNeuron *const neuron)
	Tick a tNeuron oscillator. More...
void	tNeuron_setMode (tNeuron *const neuron, NeuronMode mode)
	Set the tNeuron shaping mode. More...
void	tNeuron_setCurrent (tNeuron *const neuron, float current)
	Set the current. More...
void	tNeuron_setK (tNeuron *const neuron, float K)
	Set the potassium value. More...
void	tNeuron_setL (tNeuron *const neuron, float L)
	Set the chloride value. More...
void	tNeuron_setN (tNeuron *const neuron, float N)
	Set the sodium value. More...
void	tNeuron_setC (tNeuron *const neuron, float C)
	Set the calcium value. More...
void	tNeuron_setV1 (tNeuron *const neuron, float V1)
	Set the V1 value. More...
void	tNeuron_setV2 (tNeuron *const neuron, float V2)
	Set the V2 value. More...
void	tNeuron_setV3 (tNeuron *const neuron, float V3)
	Set the V3 value. More...
void	tNeuron_setTimeStep (tNeuron *const neuron, float timestep)
	Set the time step of the model. More...

Detailed Description

Model of a neuron, adapted to act as an oscillator.

Enumeration Type Documentation

NeuronMode

enum NeuronMode

Enumerator
NeuronNormal	Normal operation.
NeuronTanh	Tanh voltage shaping.
NeuronAaltoShaper	Aalto voltage shaping.

Function Documentation

tNeuron_init()

void tNeuron_init	(	tNeuron *const	neuron,
		LEAF *const	leaf
	)

Initialize a tNeuron to the default mempool of a LEAF instance.

Parameters

neuron	A pointer to the tNeuron to initialize.
leaf	A pointer to the leaf instance.

tNeuron_initToPool()

void tNeuron_initToPool	(	tNeuron *const	neuron,
		tMempool *const	mempool
	)

Initialize a tNeuron to a specified mempool.

Parameters

neuron	A pointer to the tNeuron to initialize.
mempool	A pointer to the tMempool to use.

tNeuron_free()

void tNeuron_free

(

tNeuron *const

neuron

)

Free a tNeuron from its mempool.

Parameters

neuron

A pointer to the tNeuron to free.

tNeuron_reset()

void tNeuron_reset

(

tNeuron *const

neuron

)

Reset the neuron model.

Parameters

neuron

A pointer to the relevant tNeuron.

tNeuron_tick()

float tNeuron_tick

(

tNeuron *const

neuron

)

Tick a tNeuron oscillator.

Parameters

neuron

A pointer to the relevant tNeuron.

Returns

The ticked sample as a float from -1 to 1.

tNeuron_setMode()

void tNeuron_setMode	(	tNeuron *const	neuron,
		NeuronMode	mode
	)

Set the tNeuron shaping mode.

Parameters

neuron	A pointer to the relevant tNeuron.
mode	The mode to set the tNeuron to.

tNeuron_setCurrent()

void tNeuron_setCurrent	(	tNeuron *const	neuron,
		float	current
	)

Set the current.

Parameters

neuron	A pointer to the relevant tNeuron.
current	The new current.

tNeuron_setK()

void tNeuron_setK	(	tNeuron *const	neuron,
		float	K
	)

Set the potassium value.

Parameters

neuron	A pointer to the relevant tNeuron.
K	The new potassium.

tNeuron_setL()

void tNeuron_setL	(	tNeuron *const	neuron,
		float	L
	)

Set the chloride value.

Parameters

neuron	A pointer to the relevant tNeuron.
L	The new chloride value.

tNeuron_setN()

void tNeuron_setN	(	tNeuron *const	neuron,
		float	N
	)

Set the sodium value.

Parameters

neuron	A pointer to the relevant tNeuron.
N	The new sodium value.

tNeuron_setC()

void tNeuron_setC	(	tNeuron *const	neuron,
		float	C
	)

Set the calcium value.

Parameters

neuron	A pointer to the relevant tNeuron.
C	The new calcium.

tNeuron_setV1()

void tNeuron_setV1	(	tNeuron *const	neuron,
		float	V1
	)

Set the V1 value.

Parameters

neuron	A pointer to the relevant tNeuron.
V1	The new V1.

tNeuron_setV2()

void tNeuron_setV2	(	tNeuron *const	neuron,
		float	V2
	)

Set the V2 value.

Parameters

neuron	A pointer to the relevant tNeuron.
V2	The new V2.

tNeuron_setV3()

void tNeuron_setV3	(	tNeuron *const	neuron,
		float	V3
	)

Set the V3 value.

Parameters

neuron	A pointer to the relevant tNeuron.
V3	The new V3.

tNeuron_setTimeStep()

void tNeuron_setTimeStep	(	tNeuron *const	neuron,
		float	timestep
	)

Set the time step of the model.

Parameters

neuron	A pointer to the relevant tNeuron.
timestep	The new time step.

Shaping modes for tNeuron output.