src/zerogrouping/zerogrouping.h

   1 /* vim: set noexpandtab tabstop=4 shiftwidth=4 wrap:
   2  *----------------------------------------------------------------------------
   3  *                                  jacu
   4  *----------------------------------------------------------------------------
   5  * This file is part of jacu.
   6  *
   7  * jacu 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  * jacu 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 jacu; if not, write to the Free Software Foundation, Inc., 59 Temple
  19  * Place, Suite 330, Boston, MA  02111-1307  USA
  20  *----------------------------------------------------------------------------
  21  * Creado:  lun jun 21 05:35:10 ART 2004
  22  * Autores: Leandro Lucarella <llucare@fi.uba.ar>
  23  *----------------------------------------------------------------------------
  24  *
  25  * $Id$
  26  *
  27  */
  28
  29 #ifndef _JACU_ZG_H_
  30 #define _JACU_ZG_H_
  31
  32 #include <stdlib.h>
  33
  34 /** \file
  35  *
  36  * Agrupador de ceros.
  37  *
  38  * Interfaz del agrupador de ceros. TODO completar doc.
  39  *
  40  */
  41
  42 /** Estado del agrupador de ceros. */
  43 typedef struct
  44 {
  45         unsigned char count; /**< Cantidad de ceros acumulados. */
  46         int  in_zero;        /**< Indica si está en una serie de ceros. */
  47 }
  48 ZG;
  49
  50 /** Inicializa un agrupador de ceros. */
  51 void zg_init(ZG* zg);
  52
  53 /** Agrupa varios ceros seguis en 2 bytes, el primero es cero y el segundo la
  54  * cantidad. FIXME */
  55 size_t zg_group(ZG* zg, unsigned char *dst, unsigned char src);
  56
  57 /** Termina de obtener ceros agrupados por zg_group(), si los hubiera.
  58  * FIXME */
  59 size_t zg_group_finish(ZG* zg, unsigned char *dst);
  60
  61 /** Vuelve al original. FIXME */
  62 size_t zg_ungroup(ZG* zg, unsigned char *dst, unsigned char src);
  63
  64 #endif /* _JACU_ZG_H_ */
  65