---

gnn_dataset.h

Go to the documentation of this file.

/***************************************************************************
 *  @file gnn_dataset.h
 *  @brief Data sets Header File.
 *
 *  @date   : 23-08-03 21:12, 22-09-03 02:28
 *  @author : Pedro Ortega C. <peortega@dcc.uchile.cl>
 *  Copyright  2003  Pedro Ortega C.
 ****************************************************************************/
/*
 *  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 Library 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef _GNN_DATASET_H_
#define _GNN_DATASET_H_



/******************************************/
/* Include Files                          */
/******************************************/

#include "gnn_globals.h"
#include "gnn_input.h"



/******************************************/
/* Typedefs                               */
/******************************************/

/**
 * @brief The datatype for dataset reset functions.
 * @ingroup gnn_dataset_doc
 *
 * This is the datatype that contains the basic elements for the implementation
 * of a dataset. Every new type of dataset should extend this structure.
 */
typedef struct _gnn_dataset gnn_dataset;

/**
 * @brief The datatype for dataset reset functions.
 * @ingroup gnn_dataset_doc
 *
 * This function type defines the form of the "reset" functions for datasets.
 * A "reset" function should prepare the internal properties for begin a new
 * sequence of pattern drawings.
 *
 * "reset" is usually called after the end of an epoch has been reached.
 */
typedef int (*gnn_dataset_reset_type) (gnn_dataset *set);

/**
 * @brief The datatype for dataset get functions.
 * @ingroup gnn_dataset_doc
 *
 * This function type defines the form of the "get" functions for datasets.
 * A "get" function should return the k-th pattern full pattern (that is,
 * its input and output vectors, and its weight). The index "k" depends on
 * the specific dataset.
 */
typedef int (*gnn_dataset_get_type) (gnn_dataset *set,
                                     size_t       k,
                                     gsl_vector **x,
                                     gsl_vector **t,
                                     double      *p);

typedef void (*gnn_dataset_destroy_type) (gnn_dataset *set);

struct _gnn_dataset
{
    size_t size;  /**< The number of patterns in the dataset.              */
    size_t n;     /**< The size of the input patterns.                     */
    size_t m;     /**< The size of the output patterns.                    */
    gnn_dataset_reset_type   reset;   /**< The "reset" function pointer.   */
    gnn_dataset_get_type     get;     /**< The "get" function pointer.     */
    gnn_dataset_destroy_type destroy; /**< The "destroy" function pointer. */
};



/******************************************/
/* Public Interface                       */
/******************************************/

int
gnn_dataset_init (gnn_dataset *set,
                  size_t       size,
                  size_t       n,
                  size_t       m,
                  gnn_dataset_reset_type   reset,
                  gnn_dataset_get_type     get,
                  gnn_dataset_destroy_type destroy);

void
gnn_dataset_destroy (gnn_dataset *set);

int
gnn_dataset_reset (gnn_dataset *set);

int
gnn_dataset_get (gnn_dataset *set,
                 size_t       k,
                 gsl_vector **x,
                 gsl_vector **t,
                 double      *p);

size_t
gnn_dataset_get_size (gnn_dataset *set);

size_t
gnn_dataset_input_get_size (gnn_dataset *set);

size_t
gnn_dataset_output_get_size (gnn_dataset *set);



#endif /* _GNN_DATASET_H_ */

---