---

gnn_random_order.h

Go to the documentation of this file.

/***************************************************************************
 *  @file gnn_random_order.h
 *  @brief Random order for datasets header file.
 *
 *  @date   : 30-05-04 18:14
 *  @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_RANDOM_ORDER_H_
#define _GNN_RANDOM_ORDER_H_



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

#include <gsl/gsl_permutation.h>
#include "gnn_dataset.h"
#include "gnn_input.h"



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

/**
 * @brief The datatype for a random order sampler.
 * @ingroup gnn_random_order_doc
 *
 * This is the datatype for a dataset random order sampler. It extends
 * the basic \ref gnn_dataset structure to include three additional pointers to the input pattern, output
 * pattern and pattern weights samplers.
 */
typedef struct _gnn_random_order gnn_random_order;

struct _gnn_random_order
{
    gnn_dataset      set;  /**< The underlying \ref gnn_dataset structure. */
    gnn_dataset     *data; /**< A pointer to a dataset.                    */
    gsl_permutation *perm; /**< The permutation.                           */
};



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

gnn_dataset *
gnn_random_order_new (gnn_dataset *data);

gnn_dataset *
gnn_random_order_from_inputs_new (gnn_input *inputs,
                                  gnn_input *outputs,
                                  gnn_input *weightsFile);

gnn_dataset *
gnn_random_order_from_file_new (const char *inputsFile,
                                const char *outputsFile,
                                const char *weightsFile);

gnn_dataset *
gnn_random_order_get_dataset (gnn_dataset *set);

#endif /* _GNN_RANDOM_ORDER_H_ */

---