network.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 _NETWORK_H_
#define _NETWORK_H_

#include "neuron.h"
#include "learning.h"

typedef struct {
  aspi_object_t parent;
  /* Number of neurons */
  int number_neurons;
  /* Current step */
  int time;
  
  /* Neurons */
  aspi_object_t ** neurons;
  aspi_class_t * model;
  
  /* Synapses matrix */
  aspi_object_t * synapses;


  /* Learning method */
  aspi_learning_rule_t learn_func;
} aspi_network_t;


typedef struct {
  aspi_class_t parent;
} aspi_network_class_t;

aspi_class_t * aspi_network (void);
aspi_object_t * aspi_network_init (aspi_object_t * self, aspi_class_t * neuron_model, int neurons);
aspi_object_t * aspi_network_init_full (aspi_object_t * self, aspi_class_t * neuron_model, aspi_class_t * synapse_model, int neurons);
void aspi_network_dtor (aspi_object_t * self);


/* Get the number of neurons */
int aspi_network_get_size (aspi_object_t * self);

/* Get the current time */
int aspi_network_get_time (aspi_object_t * self);

void aspi_network_set_weight (aspi_object_t * self, int pre, int post, double weight);
double aspi_network_get_weight (aspi_object_t * self, int pre, int post);

unsigned int aspi_network_get_delay (aspi_object_t * self, int pre, int post);


/* Set a synapse's delay */
void aspi_network_set_delay (aspi_object_t * self, int pre, int post, unsigned int delay);

/* Alloc delays memorys */
void aspi_network_calc_max_delays (aspi_object_t * self);

/* Act method */
void aspi_network_act (aspi_object_t * self);

/* Get the neuron number n */
aspi_object_t * aspi_network_get_neuron (aspi_object_t * self, unsigned int n);
/* Get the index of a neuron */
int aspi_network_get_neuron_index (aspi_object_t * self, aspi_object_t * neuron);
/* Get all neurons in the range */
aspi_object_t ** aspi_network_get_neurons (aspi_object_t * self);

/* Change the network's learning rule */
void aspi_network_set_rule (aspi_object_t * self, aspi_learning_rule_t learn_func);
//void aspi_network_set_rule (aspi_object_t * self, void * learn_func);

/* Get mean voltage */
double aspi_network_get_avg_v (aspi_object_t * self);

/* Run the learning function */
void aspi_network_learn_ranged (aspi_object_t * self, double alpha_plus, double alpha_neg, int from_begin, int from_end, int to_begin, int to_end);
void aspi_network_learn (aspi_object_t * self, double alpha_plus, double alpha_neg);

/* Clone the network */
aspi_object_t * aspi_network_dup (aspi_object_t * self);

struct aspi_efficiency {
  double eglob;
  double eloc;
};
struct aspi_efficiency aspi_network_get_efficiency (aspi_object_t * self);

double * aspi_network_get_node_strengths (aspi_object_t * self);
int * aspi_network_get_node_degrees (aspi_object_t * self);
double aspi_network_get_cluster (aspi_object_t * self);

double aspi_network_get_freq_skewness (aspi_object_t * self);
double aspi_network_get_freq_kurtosis (aspi_object_t * self);

/* Cast an object to aspi_network_t */
#define ASPI_NETWORK(x) (aspi_object_check (x, aspi_network ()), ((aspi_network_t *) x))
#define ASPI_NETWORK_CLASS(x) (aspi_class_check (x, aspi_network ()), ((aspi_network_class_t * ) x))
  
#endif /* _NETWORK_H_ */

---