---

gnn_input.h

Go to the documentation of this file.

/***************************************************************************
 *  @file gnn_input.h
 *  @brief Input Header File.
 *
 *  @date   : 21-09-03 19:47
 *  @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_INPUT_H_
#define _GNN_INPUT_H_



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

#include "gnn_globals.h"



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

/**
 * @brief The datatype for inputs.
 * @ingroup gnn_input_doc
 *
 * This is the datatype that contains the basic elements for the implementation
 * of a inputvector reader. Every new type of inputs should extend this
 * structure.
 */
typedef struct _gnn_input gnn_input;

/**
 * @brief The datatype for \ref gnn_input reset functions.
 * @ingroup gnn_input_doc
 *
 * This function type defines the form of the "reset" functions for input
 * sets. A "reset" function should prepare the internal properties for
 * beginning a new sequence of input pattern drawings.
 *
 * "reset" is usually called after the end of an epoch has been reached.
 */
typedef int (*gnn_input_reset_type) (gnn_input *set);

/**
 * @brief The datatype for \ref gnn_input get functions.
 * @ingroup gnn_input_doc
 *
 * This function type defines the form of the "get" functions for input sets.
 * A "get" function should return the k-th pattern. The returned vector is
 * not intended to be modified. The pointed vector should persist until
 * a call on "reset", "get" or "destroy".
 */
typedef const gsl_vector * (*gnn_input_get_type) (gnn_input *set, size_t k);

/**
 * @brief The datatype for \ref gnn_input destructor functions.
 * @ingroup gnn_input_doc
 *
 * This function type defines the form of the "destroy" functions for input
 * sets. It should deallocate the extension's specific data.
 */
typedef void (*gnn_input_destroy_type) (gnn_input *set);

struct _gnn_input
{
    size_t size;  /**< The number of patterns in the dataset.            */
    size_t n;     /**< The size of the input patterns.                   */
    gnn_input_reset_type   reset;   /**< The "reset" function pointer.   */
    gnn_input_get_type     get;     /**< The "get" function pointer.     */
    gnn_input_destroy_type destroy; /**< The "destroy" function pointer. */
};



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

int
gnn_input_init (gnn_input *set,
                size_t       size,
                size_t       n,
                gnn_input_reset_type   reset,
                gnn_input_get_type     get,
                gnn_input_destroy_type destroy);

void
gnn_input_destroy (gnn_input *set);

int
gnn_input_reset (gnn_input *set);

const gsl_vector *
gnn_input_get (gnn_input *set,
               size_t       k);

size_t
gnn_input_get_size (gnn_input *set);

size_t
gnn_input_sample_get_size (gnn_input *set);



#endif /* _GNN_INPUT_H_ */

---