Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages  

gnn_simple_set.h

Go to the documentation of this file.
00001 /***************************************************************************
00002  *  @file gnn_simple_set.h
00003  *  @brief Simple data set header file.
00004  *
00005  *  @date   : 22/09/03 12:48
00006  *  @author : Pedro Ortega C. <peortega@dcc.uchile.cl>
00007  *  Copyright  2003  Pedro Ortega C.
00008  ****************************************************************************/
00009 /*
00010  *  This program is free software; you can redistribute it and/or modify
00011  *  it under the terms of the GNU General Public License as published by
00012  *  the Free Software Foundation; either version 2 of the License, or
00013  *  (at your option) any later version.
00014  *
00015  *  This program is distributed in the hope that it will be useful,
00016  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00017  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00018  *  GNU Library General Public License for more details.
00019  *
00020  *  You should have received a copy of the GNU General Public License
00021  *  along with this program; if not, write to the Free Software
00022  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
00023  */
00024 
00025 #ifndef _GNN_SIMPLE_SET_H_
00026 #define _GNN_SIMPLE_SET_H_
00027 
00028 
00029 
00030 /******************************************/
00031 /* Include Files                          */
00032 /******************************************/
00033 
00034 #include "gnn_dataset.h"
00035 #include "gnn_input.h"
00036 
00037 
00038 /******************************************/
00039 /* Typedefs                               */
00040 /******************************************/
00041 
00042 /**
00043  * @brief The datatype for simple sets.
00044  * @ingroup gnn_simple_set_doc
00045  *
00046  * This is the datatype for simple sets. It extends the basic \ref gnn_dataset
00047  * structure to include three additional pointers to the input pattern, output
00048  * pattern and pattern weights samplers.
00049  */
00050 typedef struct _gnn_simple_set gnn_simple_set;
00051 
00052 struct _gnn_simple_set
00053 {
00054     gnn_dataset set;     /**< The underlying \ref gnn_dataset structure.      */
00055     gnn_input *inputs;   /**< A pointer to the input pattern sampler.         */
00056     gnn_input *outputs;  /**< A pointer to the output pattern sampler.        */
00057     gnn_input *weights;  /**< A pointer to the pattern weight sampler.        */
00058 };
00059 
00060 
00061 
00062 /******************************************/
00063 /* Public Interface                       */
00064 /******************************************/
00065 
00066 gnn_dataset *
00067 gnn_simple_set_new (gnn_input *inputs, gnn_input *outputs, gnn_input *weights);
00068 
00069 gnn_dataset *
00070 gnn_simple_set_from_files_new (const char *inputsFile,
00071                                const char *outputsFile,
00072                                const char *weightsFile);
00073 
00074 gnn_input *
00075 gnn_simple_set_get_inputs (gnn_dataset *set);
00076 
00077 gnn_input *
00078 gnn_simple_set_get_outputs (gnn_dataset *set);
00079 
00080 gnn_input *
00081 gnn_simple_set_get_weights (gnn_dataset *set);
00082 
00083 
00084 
00085 #endif /* _GNN_SIMPLE_SET_H_ */
00086 
00087 
00088 

Generated on Sun Jun 13 20:50:12 2004 for libgnn Gradient Retropropagation Machine Library by doxygen1.2.18