ruby-fann 0.7.10 → 1.0.0

data/ext/ruby_fann/fann_error.c

@@ -0,0 +1,204 @@
+/*
+  Fast Artificial Neural Network Library (fann)
+  Copyright (C) 2003 Steffen Nissen (lukesky@diku.dk)
+  
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+  
+  This library 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
+  Lesser General Public License for more details.
+  
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+*/
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <stdarg.h>
+#include <string.h>
+
+#include "config.h"
+#include "fann.h"
+
+#ifdef _MSC_VER
+#define vsnprintf _vsnprintf
+#define snprintf _snprintf
+#endif
+
+FILE * fann_default_error_log = (FILE *)-1;
+
+/* resets the last error number
+ */
+FANN_EXTERNAL void FANN_API fann_reset_errno(struct fann_error *errdat)
+{
+	errdat->errno_f = FANN_E_NO_ERROR;
+}
+
+/* resets the last errstr
+ */
+FANN_EXTERNAL void FANN_API fann_reset_errstr(struct fann_error *errdat)
+{
+	if(errdat->errstr != NULL)
+		free(errdat->errstr);
+	errdat->errstr = NULL;
+}
+
+/* returns the last error number
+ */
+FANN_EXTERNAL enum fann_errno_enum FANN_API fann_get_errno(struct fann_error *errdat)
+{
+	return errdat->errno_f;
+}
+
+/* returns the last errstr
+ */
+FANN_EXTERNAL char *FANN_API fann_get_errstr(struct fann_error *errdat)
+{
+	char *errstr = errdat->errstr;
+
+	fann_reset_errno(errdat);
+	fann_reset_errstr(errdat);
+
+	return errstr;
+}
+
+/* change where errors are logged to
+ */
+FANN_EXTERNAL void FANN_API fann_set_error_log(struct fann_error *errdat, FILE * log_file)
+{
+	if(errdat == NULL)
+		fann_default_error_log = log_file;
+	else
+		errdat->error_log = log_file;
+}
+
+/* prints the last error to stderr
+ */
+FANN_EXTERNAL void FANN_API fann_print_error(struct fann_error *errdat)
+{
+	if(errdat->errno_f != FANN_E_NO_ERROR && errdat->errstr != NULL)
+	{
+		fprintf(stderr, "FANN Error %d: %s", errdat->errno_f, errdat->errstr);
+	}
+}
+
+/* INTERNAL FUNCTION
+   Populate the error information
+ */
+void fann_error(struct fann_error *errdat, const enum fann_errno_enum errno_f, ...)
+{
+	va_list ap;
+	char *errstr;
+	FILE * error_log = fann_default_error_log;
+
+	if(errdat != NULL)
+		errdat->errno_f = errno_f;
+
+	if(errdat != NULL && errdat->errstr != NULL)
+	{
+		errstr = errdat->errstr;
+	}
+	else
+	{
+		errstr = (char *) malloc(FANN_ERRSTR_MAX);
+		if(errstr == NULL)
+		{
+			fprintf(stderr, "Unable to allocate memory.\n");
+			return;
+		}
+	}
+
+	va_start(ap, errno_f);
+	switch (errno_f)
+	{
+	case FANN_E_NO_ERROR:
+		break;
+	case FANN_E_CANT_OPEN_CONFIG_R:
+		vsprintf(errstr, "Unable to open configuration file \"%s\" for reading.\n", ap);
+		break;
+	case FANN_E_CANT_OPEN_CONFIG_W:
+		vsprintf(errstr, "Unable to open configuration file \"%s\" for writing.\n", ap);
+		break;
+	case FANN_E_WRONG_CONFIG_VERSION:
+		vsprintf(errstr,
+				 "Wrong version of configuration file, aborting read of configuration file \"%s\".\n",
+				 ap);
+		break;
+	case FANN_E_CANT_READ_CONFIG:
+		vsprintf(errstr, "Error reading \"%s\" from configuration file \"%s\".\n", ap);
+		break;
+	case FANN_E_CANT_READ_NEURON:
+		vsprintf(errstr, "Error reading neuron info from configuration file \"%s\".\n", ap);
+		break;
+	case FANN_E_CANT_READ_CONNECTIONS:
+		vsprintf(errstr, "Error reading connections from configuration file \"%s\".\n", ap);
+		break;
+	case FANN_E_WRONG_NUM_CONNECTIONS:
+		vsprintf(errstr, "ERROR connections_so_far=%d, total_connections=%d\n", ap);
+		break;
+	case FANN_E_CANT_OPEN_TD_W:
+		vsprintf(errstr, "Unable to open train data file \"%s\" for writing.\n", ap);
+		break;
+	case FANN_E_CANT_OPEN_TD_R:
+		vsprintf(errstr, "Unable to open train data file \"%s\" for writing.\n", ap);
+		break;
+	case FANN_E_CANT_READ_TD:
+		vsprintf(errstr, "Error reading info from train data file \"%s\", line: %d.\n", ap);
+		break;
+	case FANN_E_CANT_ALLOCATE_MEM:
+		sprintf(errstr, "Unable to allocate memory.\n");
+		break;
+	case FANN_E_CANT_TRAIN_ACTIVATION:
+		sprintf(errstr, "Unable to train with the selected activation function.\n");
+		break;
+	case FANN_E_CANT_USE_ACTIVATION:
+		sprintf(errstr, "Unable to use the selected activation function.\n");
+		break;
+	case FANN_E_TRAIN_DATA_MISMATCH:
+		sprintf(errstr, "Training data must be of equivalent structure.\n");
+		break;
+	case FANN_E_CANT_USE_TRAIN_ALG:
+		sprintf(errstr, "Unable to use the selected training algorithm.\n");
+		break;
+	case FANN_E_TRAIN_DATA_SUBSET:
+		vsprintf(errstr, "Subset from %d of length %d not valid in training set of length %d.\n", ap);
+		break;
+	case FANN_E_INDEX_OUT_OF_BOUND:
+		vsprintf(errstr, "Index %d is out of bound.\n", ap);
+		break;
+	case FANN_E_SCALE_NOT_PRESENT: 
+		sprintf(errstr, "Scaling parameters not present.\n");
+		break;
+	}
+	va_end(ap);
+
+	if(errdat != NULL)
+	{
+		errdat->errstr = errstr;
+		error_log = errdat->error_log;
+	}
+
+	if(error_log == (FILE *)-1) /* This is the default behavior and will give stderr */
+	{
+		fprintf(stderr, "FANN Error %d: %s", errno_f, errstr);
+	}
+	else if(error_log != NULL)
+	{
+		fprintf(error_log, "FANN Error %d: %s", errno_f, errstr);
+	}
+}
+
+/* INTERNAL FUNCTION
+   Initialize an error data strcuture
+ */
+void fann_init_error_data(struct fann_error *errdat)
+{
+	errdat->errstr = NULL;
+	errdat->errno_f = FANN_E_NO_ERROR;
+	errdat->error_log = fann_default_error_log;
+}

data/ext/ruby_fann/fann_error.h

@@ -0,0 +1,161 @@
+/*
+Fast Artificial Neural Network Library (fann)
+Copyright (C) 2003 Steffen Nissen (lukesky@diku.dk)
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library 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
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+*/
+
+#ifndef __fann_error_h__
+#define __fann_error_h__
+
+#include <stdio.h>
+
+#define FANN_ERRSTR_MAX 128
+struct fann_error;
+
+/* Section: FANN Error Handling
+
+   Errors from the fann library are usually reported on stderr. 
+   It is however possible to redirect these error messages to a file, 
+   or completely ignore them by the <fann_set_error_log> function.
+   
+   It is also possible to inspect the last error message by using the
+   <fann_get_errno> and <fann_get_errstr> functions.
+ */
+
+/* Enum: fann_errno_enum
+	Used to define error events on <struct fann> and <struct fann_train_data>. 
+
+	See also:
+		<fann_get_errno>, <fann_reset_errno>, <fann_get_errstr>
+
+	FANN_E_NO_ERROR - No error 
+	FANN_E_CANT_OPEN_CONFIG_R - Unable to open configuration file for reading 
+	FANN_E_CANT_OPEN_CONFIG_W - Unable to open configuration file for writing
+	FANN_E_WRONG_CONFIG_VERSION - Wrong version of configuration file 
+	FANN_E_CANT_READ_CONFIG - Error reading info from configuration file
+	FANN_E_CANT_READ_NEURON - Error reading neuron info from configuration file
+	FANN_E_CANT_READ_CONNECTIONS - Error reading connections from configuration file
+	FANN_E_WRONG_NUM_CONNECTIONS - Number of connections not equal to the number expected
+	FANN_E_CANT_OPEN_TD_W - Unable to open train data file for writing
+	FANN_E_CANT_OPEN_TD_R - Unable to open train data file for reading
+	FANN_E_CANT_READ_TD - Error reading training data from file
+	FANN_E_CANT_ALLOCATE_MEM - Unable to allocate memory
+	FANN_E_CANT_TRAIN_ACTIVATION - Unable to train with the selected activation function
+	FANN_E_CANT_USE_ACTIVATION - Unable to use the selected activation function
+	FANN_E_TRAIN_DATA_MISMATCH - Irreconcilable differences between two <struct fann_train_data> structures
+	FANN_E_CANT_USE_TRAIN_ALG - Unable to use the selected training algorithm
+	FANN_E_TRAIN_DATA_SUBSET - Trying to take subset which is not within the training set
+	FANN_E_INDEX_OUT_OF_BOUND - Index is out of bound
+	FANN_E_SCALE_NOT_PRESENT - Scaling parameters not present
+*/
+enum fann_errno_enum
+{
+	FANN_E_NO_ERROR = 0,
+	FANN_E_CANT_OPEN_CONFIG_R,
+	FANN_E_CANT_OPEN_CONFIG_W,
+	FANN_E_WRONG_CONFIG_VERSION,
+	FANN_E_CANT_READ_CONFIG,
+	FANN_E_CANT_READ_NEURON,
+	FANN_E_CANT_READ_CONNECTIONS,
+	FANN_E_WRONG_NUM_CONNECTIONS,
+	FANN_E_CANT_OPEN_TD_W,
+	FANN_E_CANT_OPEN_TD_R,
+	FANN_E_CANT_READ_TD,
+	FANN_E_CANT_ALLOCATE_MEM,
+	FANN_E_CANT_TRAIN_ACTIVATION,
+	FANN_E_CANT_USE_ACTIVATION,
+	FANN_E_TRAIN_DATA_MISMATCH,
+	FANN_E_CANT_USE_TRAIN_ALG,
+	FANN_E_TRAIN_DATA_SUBSET,
+	FANN_E_INDEX_OUT_OF_BOUND,
+	FANN_E_SCALE_NOT_PRESENT
+};
+
+/* Group: Error Handling */
+	
+/* Function: fann_set_error_log
+
+   Change where errors are logged to. Both <struct fann> and <struct fann_data> can be 
+   casted to <struct fann_error>, so this function can be used to set either of these.
+   
+   If log_file is NULL, no errors will be printed.
+   
+   If errdata is NULL, the default log will be set. The default log is the log used when creating 
+   <struct fann> and <struct fann_data>. This default log will also be the default for all new structs
+   that are created.
+   
+   The default behavior is to log them to stderr.
+   
+   See also:
+    <struct fann_error>
+   
+   This function appears in FANN >= 1.1.0.   
+ */ 
+FANN_EXTERNAL void FANN_API fann_set_error_log(struct fann_error *errdat, FILE * log_file);
+
+
+/* Function: fann_get_errno
+
+   Returns the last error number.
+   
+   See also:
+    <fann_errno_enum>, <fann_reset_errno>
+    
+   This function appears in FANN >= 1.1.0.   
+ */ 
+FANN_EXTERNAL enum fann_errno_enum FANN_API fann_get_errno(struct fann_error *errdat);
+
+
+/* Function: fann_reset_errno
+
+   Resets the last error number.
+   
+   This function appears in FANN >= 1.1.0.   
+ */ 
+FANN_EXTERNAL void FANN_API fann_reset_errno(struct fann_error *errdat);
+
+
+/* Function: fann_reset_errstr
+
+   Resets the last error string.
+
+   This function appears in FANN >= 1.1.0.   
+ */ 
+FANN_EXTERNAL void FANN_API fann_reset_errstr(struct fann_error *errdat);
+
+
+/* Function: fann_get_errstr
+
+   Returns the last errstr.
+  
+   This function calls <fann_reset_errno> and <fann_reset_errstr>
+
+   This function appears in FANN >= 1.1.0.   
+ */ 
+FANN_EXTERNAL char *FANN_API fann_get_errstr(struct fann_error *errdat);
+
+
+/* Function: fann_print_error
+
+   Prints the last error to stderr.
+
+   This function appears in FANN >= 1.1.0.   
+ */ 
+FANN_EXTERNAL void FANN_API fann_print_error(struct fann_error *errdat);
+
+extern FILE * fann_default_error_log;
+
+#endif

data/ext/ruby_fann/fann_internal.h

@@ -0,0 +1,148 @@
+/*
+Fast Artificial Neural Network Library (fann)
+Copyright (C) 2003 Steffen Nissen (lukesky@diku.dk)
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library 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
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+*/
+
+#ifndef __fann_internal_h__
+#define __fann_internal_h__
+/* internal include file, not to be included directly
+ */
+
+#include <math.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include "fann_data.h"
+
+#define FANN_FIX_VERSION "FANN_FIX_2.0"
+#define FANN_FLO_VERSION "FANN_FLO_2.1"
+
+#ifdef FIXEDFANN
+#define FANN_CONF_VERSION FANN_FIX_VERSION
+#else
+#define FANN_CONF_VERSION FANN_FLO_VERSION
+#endif
+
+#define FANN_GET(type, name) \
+FANN_EXTERNAL type FANN_API fann_get_ ## name(struct fann *ann) \
+{ \
+	return ann->name; \
+}
+
+#define FANN_SET(type, name) \
+FANN_EXTERNAL void FANN_API fann_set_ ## name(struct fann *ann, type value) \
+{ \
+	ann->name = value; \
+}
+
+#define FANN_GET_SET(type, name) \
+FANN_GET(type, name) \
+FANN_SET(type, name)
+
+
+struct fann_train_data;
+
+struct fann *fann_allocate_structure(unsigned int num_layers);
+void fann_allocate_neurons(struct fann *ann);
+
+void fann_allocate_connections(struct fann *ann);
+
+int fann_save_internal(struct fann *ann, const char *configuration_file,
+					   unsigned int save_as_fixed);
+int fann_save_internal_fd(struct fann *ann, FILE * conf, const char *configuration_file,
+						  unsigned int save_as_fixed);
+int fann_save_train_internal(struct fann_train_data *data, const char *filename,
+							  unsigned int save_as_fixed, unsigned int decimal_point);
+int fann_save_train_internal_fd(struct fann_train_data *data, FILE * file, const char *filename,
+								 unsigned int save_as_fixed, unsigned int decimal_point);
+
+void fann_update_stepwise(struct fann *ann);
+void fann_seed_rand();
+
+void fann_error(struct fann_error *errdat, const enum fann_errno_enum errno_f, ...);
+void fann_init_error_data(struct fann_error *errdat);
+
+struct fann *fann_create_from_fd(FILE * conf, const char *configuration_file);
+struct fann_train_data *fann_read_train_from_fd(FILE * file, const char *filename);
+
+void fann_compute_MSE(struct fann *ann, fann_type * desired_output);
+void fann_update_output_weights(struct fann *ann);
+void fann_backpropagate_MSE(struct fann *ann);
+void fann_update_weights(struct fann *ann);
+void fann_update_slopes_batch(struct fann *ann, struct fann_layer *layer_begin,
+							  struct fann_layer *layer_end);
+void fann_update_weights_quickprop(struct fann *ann, unsigned int num_data,
+								   unsigned int first_weight, unsigned int past_end);
+void fann_update_weights_batch(struct fann *ann, unsigned int num_data, unsigned int first_weight,
+							   unsigned int past_end);
+void fann_update_weights_irpropm(struct fann *ann, unsigned int first_weight,
+								 unsigned int past_end);
+
+void fann_clear_train_arrays(struct fann *ann);
+
+fann_type fann_activation(struct fann * ann, unsigned int activation_function, fann_type steepness,
+						  fann_type value);
+
+fann_type fann_activation_derived(unsigned int activation_function,
+								  fann_type steepness, fann_type value, fann_type sum);
+
+int fann_desired_error_reached(struct fann *ann, float desired_error);
+
+/* Some functions for cascade */
+int fann_train_outputs(struct fann *ann, struct fann_train_data *data, float desired_error);
+
+float fann_train_outputs_epoch(struct fann *ann, struct fann_train_data *data);
+
+int fann_train_candidates(struct fann *ann, struct fann_train_data *data);
+
+fann_type fann_train_candidates_epoch(struct fann *ann, struct fann_train_data *data);
+
+void fann_install_candidate(struct fann *ann);
+
+int fann_initialize_candidates(struct fann *ann);
+
+void fann_set_shortcut_connections(struct fann *ann);
+
+int fann_allocate_scale(struct fann *ann);
+
+/* called fann_max, in order to not interferre with predefined versions of max */
+#define fann_max(x, y) (((x) > (y)) ? (x) : (y))
+#define fann_min(x, y) (((x) < (y)) ? (x) : (y))
+#define fann_safe_free(x) {if(x) { free(x); x = NULL; }}
+#define fann_clip(x, lo, hi) (((x) < (lo)) ? (lo) : (((x) > (hi)) ? (hi) : (x)))
+/*#define fann_clip(x, lo, hi) (x)*/
+
+#define fann_rand(min_value, max_value) (((float)(min_value))+(((float)(max_value)-((float)(min_value)))*rand()/(RAND_MAX+1.0f)))
+
+#define fann_abs(value) (((value) > 0) ? (value) : -(value))
+
+#ifdef FIXEDFANN
+
+#define fann_mult(x,y) ((x*y) >> decimal_point)
+#define fann_div(x,y) (((x) << decimal_point)/y)
+#define fann_random_weight() (fann_type)(fann_rand(0,multiplier/10))
+#define fann_random_bias_weight() (fann_type)(fann_rand((0-multiplier)/10,multiplier/10))
+
+#else
+
+#define fann_mult(x,y) (x*y)
+#define fann_div(x,y) (x/y)
+#define fann_random_weight() (fann_rand(-0.1f,0.1f))
+#define fann_random_bias_weight() (fann_rand(-0.1f,0.1f))
+
+#endif
+
+#endif