---

gnn_output.h

Go to the documentation of this file.

/***************************************************************************
 *  @file gnn_output.h
 *  @brief Output Header File.
 *
 *  @date   : 21-09-03 20:34
 *  @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_OUTPUT_H_
#define _GNN_OUTPUT_H_



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

#include "gnn_globals.h"



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

/**
 * @brief The datatype for outputs.
 * @ingroup gnn_output_doc
 *
 * This is the datatype that contains the basic elements for the implementation
 * of a output vector writer. Every new type of outputs should extend this
 * structure.
 */
typedef struct _gnn_output gnn_output;

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

/**
 * @brief The datatype for \ref gnn_output get functions.
 * @ingroup gnn_output_doc
 *
 * This function type defines the form of the "put" functions for output sets.
 * A "put" function should save/store the k-th output sample and return
 * 0 if suceeded.
 */
typedef int (*gnn_output_put_type) (gnn_output *set,
                                           size_t k, const gsl_vector *v);

/**
 * @brief The datatype for \ref gnn_output destructor functions.
 * @ingroup gnn_output_doc
 *
 * This function type defines the form of the "destroy" functions for output
 * writers. It should deallocate the extension's specific data.
 */
typedef void (*gnn_output_destroy_type) (gnn_output *set);

/**
 * @brief Specifies the output device type.
 * @ingroup gnn_output_doc
 */
typedef enum _gnn_output_type gnn_output_type;

enum _gnn_output_type {gnnOutputStream, gnnOutputRA};

struct _gnn_output
{
    gnn_output_type mode; /**< Can be a stream or random access device.   */
    size_t size;          /**< The number of samples that can be stored.  */
    size_t m;             /**< The size of the output samples.            */
    gnn_output_reset_type   reset;   /**< The "reset" function pointer.   */
    gnn_output_put_type     put;     /**< The "put" function pointer.     */
    gnn_output_destroy_type destroy; /**< The "destroy" function pointer. */
};



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

int
gnn_output_init (gnn_output     *set,
                 gnn_output_type mode,
                 size_t          size,
                 size_t          m,
                 gnn_output_reset_type   reset,
                 gnn_output_put_type     put,
                 gnn_output_destroy_type destroy);

int
gnn_output_stream_init (gnn_output *set,
                        gnn_output_reset_type   reset,
                        gnn_output_put_type     put,
                        gnn_output_destroy_type destroy);

int
gnn_output_random_access_init (gnn_output  *set,
                               size_t       size,
                               size_t       m,
                               gnn_output_reset_type   reset,
                               gnn_output_put_type     put,
                               gnn_output_destroy_type destroy);

void
gnn_output_destroy (gnn_output *set);

int
gnn_output_reset (gnn_output *set);

int
gnn_output_put (gnn_output *set, size_t k, const gsl_vector  *v);

size_t
gnn_output_get_size (gnn_output *set);

size_t
gnn_output_sample_get_size (gnn_output *set);

int
gnn_output_is_stream (gnn_output *set);

int
gnn_output_is_random_access (gnn_output *set);


#endif /* _GNN_OUTPUT_H_ */

---