---

gnn_null_output.c

Go to the documentation of this file.

/***************************************************************************
 *  @file gnn_null_output.c
 *  @brief Null Output Set Implementation.
 *
 *  @date   : 22-09-03 22:00
 *  @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.
 */



/**
 * @defgroup gnn_null_output_doc gnn_null_output : Null Output Device.
 * @ingroup gnn_output_doc
 * @brief Null output device.
 *
 * The \ref gnn_null_output datatype is a special device. The output samples
 * written to the \ref gnn_null_output stream are automatically deleted.
 */



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

#include "gnn_utilities.h"
#include "gnn_null_output.h"



/******************************************/
/* Static Declaration                     */
/******************************************/

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



/******************************************/
/* Static Implementation                  */
/******************************************/

/**
 * @brief The "put" function for a null output set.
 * @ingroup gnn_null_output_doc
 *
 * This function does nothing.
 *
 * @param  set A pointer to a \ref gnn_null_output.
 * @param  k   The index of the pattern to be stored.
 * @param  v   A pointer to the output vector to be stored.
 * @return Returns 0 if suceeded.
 */
static int
gnn_null_output_put (gnn_output *set, size_t k, const gsl_vector *v)
{
    return 0;
}




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

/**
 * @brief Builds a new null output device.
 * @ingroup gnn_null_output_doc
 *
 * This function creates a new \ref gnn_null_output device.
 *
 * @return Returns a pointer to a new \ref gnn_null_output set.
 */
gnn_output *
gnn_null_output_new ()
{
    int status;
    gnn_output *set;

    /* allocate */
    set = (gnn_output *) malloc (sizeof (*set));
    if (set == NULL)
    {
        GSL_ERROR_VAL ("could not allocate memory for gnn_null_output",
                       GSL_ENOMEM, NULL);
    }

    /* initialize */
    status = gnn_output_stream_init (set, NULL, gnn_null_output_put, NULL);
    if (status)
    {
        gnn_output_destroy (set);
        GSL_ERROR_VAL ("could not initialize gnn_memory_output",
                       GSL_EFAILED, NULL);
    }
    return ;
}

---