synapses.h

Go to the documentation of this file.

/***********************************************************************
    Copyright (C) 2005,2006 Frédéric HENRY <neryel@reveries.info>

    This file is part of ASpiReNN.

    ASpiReNN is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published 
    by the Free Software Foundation; either version 2 of the License,
    or (at your option) any later version.

    ASpiReNN 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 ASpiReNN; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
    02111-1307  USA.

***********************************************************************/

#ifndef _SYNAPSES_
#define _SYNAPSES_

#include "object.h"
#include "misc.h"
typedef struct {
  double value;
  int last_update;
} aspi_trace_t;


typedef struct {
  double * weight;
  int  * delay;
  aspi_trace_t * trace;
  aspi_object_t * pre;
  aspi_object_t * post;
} aspi_synapse_t;


typedef void (* aspi_callback_t) (void * data, aspi_synapse_t * syn);

typedef struct {
  aspi_object_t parent;

  /* Number of neurons. */
  int number_neurons;
  /* Leak used to compute the synaptic traces */
  double leak;
} aspi_synapses_t;

typedef struct {
  aspi_class_t parent;
  aspi_object_t * (* init) (aspi_object_t * self, int n_neurons, double trace_leak);
  double (* get_weight) (aspi_object_t * self, int pre, int post);
  void (* set_weight) (aspi_object_t * self, int pre, int post, double weight);
  int (* get_delay) (aspi_object_t * self, int pre, int post);
  void (* set_delay) (aspi_object_t * self, int pre, int post, int delay);
  double (* get_trace) (aspi_object_t * self, int pre, int post, int time);
  void (* add_to_trace) (aspi_object_t * self, int pre, int post, double value, int time);
  void (* apply_callback) (aspi_object_t * self, aspi_object_t * network, aspi_callback_t callback, void * data);
  void (* apply_callback_post) (aspi_object_t * self, aspi_object_t * network, int neuron, aspi_callback_t callback, void * data);
  void (* apply_callback_pre) (aspi_object_t * self, aspi_object_t * network, int neuron, aspi_callback_t callback, void * data);
} aspi_synapses_class_t;


aspi_class_t * aspi_synapses (void);
aspi_object_t * aspi_synapses_init (aspi_object_t * self, int n_neurons, double trace_leak);
void aspi_synapses_dtor (aspi_object_t * self); 
aspi_object_t * aspi_synapses_init_generic (aspi_class_t * klass, aspi_object_t * self, int n_neurons, double trace_leak);

int aspi_synapses_get_size (aspi_object_t * self);
double aspi_synapses_get_trace_leak (aspi_object_t * self);

double aspi_synapses_get_weight (aspi_object_t * self, int pre, int post);
void aspi_synapses_set_weight (aspi_object_t * self, int pre, int post, double value);

int aspi_synapses_get_delay (aspi_object_t * self, int pre, int post);
void aspi_synapses_set_delay (aspi_object_t * self, int pre, int post, int value);

double aspi_synapses_get_trace (aspi_object_t * self, int pre, int post, int time);
void aspi_synapses_add_to_trace (aspi_object_t * self, int pre, int post, double value, int time);

void aspi_synapses_apply_callback_pre (aspi_object_t * self, aspi_object_t * net, int neuron, aspi_callback_t callback, void * data);
void aspi_synapses_apply_callback_post (aspi_object_t * self, aspi_object_t * net, int neuron, aspi_callback_t callback, void * data);
void aspi_synapses_apply_callback (aspi_object_t * self, aspi_object_t * net, aspi_callback_t callback, void * data);


/* Cast an object to aspi_synapses_t */
#define ASPI_SYNAPSES(x) (aspi_object_check (x, aspi_synapses ()), ((aspi_synapses_t *) x))
#define ASPI_SYNAPSES_CLASS(x) (aspi_class_check (x, aspi_synapses ()), ((aspi_synapses_class_t *) x))


#endif /* _SYNAPSES_ */

---