emufs/external_sort/mergepool.h

   1 /* vim: set noexpandtab tabstop=4 shiftwidth=4 wrap:
   2  *----------------------------------------------------------------------------
   3  *                                  emufs
   4  *----------------------------------------------------------------------------
   5  * This file is part of emufs.
   6  *
   7  * emufs is free software; you can redistribute it and/or modify it under the
   8  * terms of the GNU General Public License as published by the Free Software
   9  * Foundation; either version 2 of the License, or (at your option) any later
  10  * version.
  11  *
  12  * emufs is distributed in the hope that it will be useful, but WITHOUT ANY
  13  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  15  * details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with emufs; if not, write to the Free Software Foundation, Inc., 59 Temple
  19  * Place, Suite 330, Boston, MA  02111-1307  USA
  20  *----------------------------------------------------------------------------
  21  * Creado:  dom may 30 07:07:53 ART 2004
  22  * Autores: Leandro Lucarella <llucare@fi.uba.ar>
  23  *----------------------------------------------------------------------------
  24  *
  25  * $Id$
  26  *
  27  */
  28
  29 /** \file
  30  *
  31  * Pool de archivos temporales para hacer un ordenamiento externo.
  32  *
  33  * Interfaz de un pool de archivos temporales para hacer un ordenamiento
  34  * externo.
  35  *
  36  */
  37
  38 #ifndef _EXTSORT_MERGEPOOL_H_
  39 #define _EXTSORT_MERGEPOOL_H_
  40
  41 #include "base.h"
  42 #include "mergefile.h"
  43 #include <stdlib.h>
  44
  45 /** <em>Pool</em> de archivos temporales para hacer un ordenamiento externo.
  46  *  La forma de uso general es, de forma similar al MERGEFILE,
  47  *  \ref mergepool_add_file "crear un archivo temporal" ,
  48  *  \ref mergepool_append_data "agregarle datos" (repitiendo el proceso varias
  49  *  veces creando un lote de archivos temporales) y finalmente ir
  50  *  \ref mergepool_pop_min "obteniendo el mínimo valor del lote" hasta que no
  51  *  haya más datos.
  52  *  \warning Una vez obtenido un dato con mergepool_pop_min() no se pueden
  53  *           agregar más archivos temporales ni datos al lote.
  54  */
  55 typedef struct
  56 {
  57         MERGEFILE**            pool; /**< Arreglo de archivos temporales. */
  58         size_t                 size; /**< Cantidad de archivos que tiene el lote. */
  59         size_t                 reg_size; /**< Tamaño del tipo de dato que guarda. */
  60         CMP_FUNC               cmp; /**< Función de comparación. */
  61         enum { INPUT, OUTPUT } mode; /**< Modo. */
  62 }
  63 MERGEPOOL;
  64
  65 /** Crea un nuevo lote de archivos temporales para ordenamiento externo. */
  66 MERGEPOOL* mergepool_new(size_t reg_size, CMP_FUNC cmp);
  67
  68 /** Libera un lote de archivos temporales para ordenamiento externo. */
  69 void mergepool_delete(MERGEPOOL* mp);
  70
  71 /** Agrega un nuevo archivo temporal al lote.
  72  *  \return puntero al nuevo archivo temporal o 0 si hubo error.
  73  */
  74 MERGEFILE* mergepool_add_file(MERGEPOOL* mp);
  75
  76 /** Agrega un nuevo dato al lote que se almacena en el último archivo creado.
  77  *  \pre mergepool_add_file() fue ejecutada (es decir, hay al menos un archivo
  78  *       temporal en el lote.
  79  *  \return 0 si hubo error.
  80  */
  81 int mergepool_append_data(MERGEPOOL* mp, void* data);
  82
  83 /** Obtiene el mínimo dato en el lote, sácandolo de éste.
  84  *  \post No se pueden ingresar más archivos o datos al lote.
  85  *  \return 0 si hubo error, si no, un puntero al mínimo dato del lote que debe
  86  *          ser liberado después de usado.
  87  */
  88 void* mergepool_pop_min(MERGEPOOL* mp);
  89
  90 #endif /* _EXTSORT_MERGEPOOL_H_ */
  91