pdsneuronml.h

/*
 * pdsneuronml.h
 * 
 * Copyright 2011 Fernando Pujaico Rivera <fernando.pujaico.rivera@gmail.com>
 * 
 * This program 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.
 * 
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301, USA.
 * 
 */

#ifndef __PDSNEURONML_H__
#define __PDSNEURONML_H__

#ifdef __cplusplus
extern "C" {
#endif 

#include <stdio.h>
#include <stdlib.h>
#include <pds/pdsnnglobal.h>
#include <pds/pdssn.h>
#include <pds/pdsnivector.h>
#include <pds/pdsnvector.h>


#ifndef TRUE
        #define TRUE 1
#endif

#ifndef FALSE
        #define FALSE 0
#endif


typedef struct 
{
        PdsNnNatural *L;
        PdsNnNatural N;

        PdsNIVector *LayerInput;
        PdsNVector **Layer;

        PdsNnReal MaxError;
        PdsNnReal Alpha;
        PdsNnNatural MaxIter;
        PdsNnNatural Iter;
        PdsNnBool ShowPrintf;

}PdsNeuronML;

PdsNeuronML *pds_neuronml_new(const PdsVector *L);

PdsNeuronML *pds_neuronml_new_from_array(const PdsNnNatural *L,PdsNnNatural Nel);

PdsNeuronML *pds_neuronml_new_load_data(const char *mlayer_filename);


int pds_neuronml_save_data(const PdsNeuronML *NeuronML, const char *mlayer_filename);



int pds_neuronml_set_max_error(PdsNeuronML *NeuronML,PdsNnReal MaxError);


int pds_neuronml_set_max_iterations(PdsNeuronML *NeuronML,PdsNnNatural MaxIter);


int pds_neuronml_enable_printf(PdsNeuronML *NeuronML);

int pds_neuronml_get_number_of_input_neurons(PdsNeuronML *NeuronML,PdsNnNatural *Number);

int pds_neuronml_get_number_of_output_neurons(PdsNeuronML *NeuronML,PdsNnNatural *Number);

int pds_neuronml_get_maximum_output(PdsNeuronML *NeuronML,PdsNnReal *Max);

int pds_neuronml_get_minimum_output(PdsNeuronML *NeuronML,PdsNnReal *Min);


int pds_neuronml_init_weight_uniform(PdsNeuronML *NeuronML,PdsUniform *RV);

int pds_neuronml_init_weight_rand(PdsNeuronML *NeuronML,PdsSnReal min, PdsSnReal max);


int pds_neuronml_init_u_uniform(PdsNeuronML *NeuronML,PdsUniform *RV);


int pds_neuronml_init_u_rand(PdsNeuronML *NeuronML,PdsSnReal min, PdsSnReal max);


int pds_neuronml_iterate(PdsNeuronML *NeuronML,const PdsVector *Input,PdsVector *Output);

int pds_neuronml_get_number_iterations(const PdsNeuronML *NeuronML,PdsNnNatural *Iter);


PdsNnBool pds_neuronml_iterate_results_printf(const PdsNeuronML *MLayer,const char* Type);

int pds_neuronml_get_output(const PdsNeuronML *NeuronML,PdsVector *Y);


int pds_neuronml_get_output_soft_vote(const PdsNeuronML *NeuronML,PdsNnReal *Vote);



int pds_neuronml_get_output_rms_error(const PdsNeuronML *NeuronML,PdsNnReal *RmsError);


int pds_neuronml_training(PdsNeuronML *NeuronML,const PdsVector *Input,PdsVector *Output);

PdsNnNatural pds_neuronml_training_results_printf(PdsNeuronML *MLayer,const char* Type);

int pds_neuronml_set_alpha(PdsNeuronML *NeuronML,PdsNnReal Alpha);




int pds_neuronml_head_printf(const PdsNeuronML *NeuronML);


int pds_neuronml_head_fprintf(const PdsNeuronML *NeuronML, FILE *fd);

PdsNeuronML *pds_neuronml_new_head_fscanf(FILE *fd);

int pds_neuronml_body_fprintf(const PdsNeuronML *NeuronML, FILE *fd);


int pds_neuronml_body_fscanf(PdsNeuronML *NeuronML, FILE *fd);


int pds_neuronml_body_fwrite(const PdsNeuronML *NeuronML, FILE *fd);


int pds_neuronml_body_fread(PdsNeuronML *NeuronML, FILE *fd);


void pds_neuronml_free(PdsNeuronML *NeuronML);


void pds_neuronml_destroy(PdsNeuronML **NeuronML);


#ifdef __cplusplus
}
#endif 

#endif