Insertar B+ en teoria fully working con encadenamiento en hojas y toda la mar en...

[z.facultad/75.06/emufs.git] / emufs / indices.h

diff --git a/emufs/indices.h b/emufs/indices.h
index 7e3d70af42581bcc6b4eea3936c07994616b4bcc..2928b141c9b29a96e992d1561f1d37fbb8762f3c 100644 (file)
--- a/emufs/indices.h
+++ b/emufs/indices.h
@@ -5,49 +5,127 @@
 #include <stdlib.h>
 #include <string.h>
 
+#include "common.h"
+
 #define STRUCT_OFFSET(x, y) ((int)(&(x->y))-(int)(x))
 
 typedef struct _emu_fs_t EMUFS;
 
-typedef enum {IND_B, IND_B_ASC} INDICE_TIPO;
+/** Dato guardado junto con la clave */
+typedef struct _reg_def_ {
+       long id;
+       long bloque;
+} INDICE_DATO;
+
+/** Tipos de Indices conocidos */
+typedef enum {
+       IND_B, /**< Utilizacion de Arboles B */
+       IND_B_ASC /**< Utilizacion de Arboles B* */
+} INDICE_TIPO;
 
-typedef enum {IDX_FLOAT, IDX_INT} INDICE_TIPO_DATO;
+typedef enum {
+       IND_PRIMARIO,
+       IND_SELECCION,
+       IND_EXAHUSTIVO
+} INDICE_FUNCION;
 
+/** Tipos de datos soportados para las claves */
+typedef enum {
+       IDX_FLOAT,
+       IDX_INT,
+       IDX_STRING
+} INDICE_TIPO_DATO;
+
+/** Clave de indice 
+ *
+ *  Si el tipo de clave es IDX_STRING se utiliza
+ *  i_clave y representa el ID en un EMUFS Tipo2
+ *  sin indices donde esta el texto de la clave
+ */
 typedef union _data_ {
        float f_clave;
        int i_clave;
 } CLAVE;
 
+/** Manejo de Indices independiente */
 typedef struct _indices_h_ {
-       INDICE_TIPO tipo;
-       INDICE_TIPO_DATO tipo_dato;
-       int offset;
-       unsigned int tam_bloque; /* debe ser multiplo de 512! */
+       INDICE_TIPO tipo;             /**< Tipo de indice */
+       INDICE_TIPO_DATO tipo_dato;   /**< Tipo de dato a manejar */
+       INDICE_FUNCION funcion;       /**< Funcion del indice */
+       int offset;                   /**< Offset desde el inicio del dato hasta el lugar donde esta la clave */
+       unsigned int tam_bloque;      /**< Tamaño del bloque (nodo). Deber set multiplo de 512! */
 
        /** Agrega la clave k de posicion location en el 
         * indice de forma ordenada
         */
-       int (*agregar_entrada)(struct _indices_h_ *idx, CLAVE k, int location);
+       int (*agregar_entrada)(struct _indices_h_ *idx, CLAVE k, INDICE_DATO dato);
        /** Borra del indice la clave k */
        int (*borrar_entrada)(struct _indices_h_ *idx, CLAVE k);
        /** Determina si existe la clave k retornando su posicion o -1
         * en caso fallido
         */
-       int (*existe_entrada)(struct _indices_h_ *idx, CLAVE k);
+       INDICE_DATO (*existe_entrada)(struct _indices_h_ *idx, CLAVE k);
+       
+       INDICE_DATO *(*buscar_entradas)(struct _indices_h_ *idx, CLAVE k, int *cant);
+
+       char *nombre;   /**< Nombre único de busqueda del indice */
+       char *filename; /**< nombre del archivo de indice */
 
-       char *nombre; /* nombre de busqueda */
-       char *filename; /* nombre del archivo indice */
+       EMUFS *emu_string; /**< EMUFS Tipo2 donde se guardan las claves de tipo string */
 
-       struct _indices_h_ *sig;
+       /** EMUFS Donde se guardan INDICE_DATO de multiples claves con repeticion
+        *
+        *  La forma de guardar es la siguiente :
+        *  \code
+        *  +------+---------//---------+
+        *  | CANT |    DATA \\         |
+        *  +------+---------//---------+
+        *  \endcode
+        *
+        *  Donde CANT es un entero (int) y DATA es un array
+        *  de INDICE_DATO que apunta al archivo de datos
+        *  pripiamente dicho
+        */
+       EMUFS *emu_mult;
+       struct _indices_h_ *sig; /**< Siguiente indice */
 } INDICE;
 
-INDICE *emufs_indice_crear(EMUFS *emu, char *nombre, INDICE_TIPO tipo, INDICE_TIPO_DATO tipo_dato, unsigned int offset, unsigned tam_bloque);
+/** Crea un nuevo indice
+ *
+ *  \param emu EMUFS a quien pertenece
+ *  \param nombre Nombre del indice
+ *  \param tipo Tipo de indice
+ *  \param tipo_dato Tipo de dato de la clave
+ *  \param offset Desplazamiento de la clave dentro del dato
+ *  \param tam_bloque Tamaño del bloque (nodo) del arbol
+ */
+INDICE *emufs_indice_crear(EMUFS *emu, char *nombre, INDICE_FUNCION funcion, INDICE_TIPO tipo, INDICE_TIPO_DATO tipo_dato, unsigned int offset, unsigned tam_bloque);
+
+/** Destruye un indice
+ *
+ *  \todo hacer/revisar
+ */
 void emufs_indice_destruir(EMUFS *emu, INDICE *i);
-void emufs_indice_agregar(INDICE *primero, char *data, int ubicacion);
 
-CLAVE emufs_indice_obtenet_clave(INDICE *idx, char *data);
+/** Agrega una clave en los indices
+ * 
+ *  Agrega la clave en todos los indice, dependiendo de su tipo
+ *  de dato, tipo de arboo, offset, etc
+ *
+ *  \param primer Primer indice a agregar
+ *  \param data Array de datos desde donde tomar las claves
+ *  \param ubicacion Dato a guardar asociado a la clave
+ */
+void emufs_indice_agregar(INDICE *primero, char *data, INDICE_DATO dato);
 
+INDICE_DATO emufs_indice_buscar(INDICE *primero, char *data);
+
+CLAVE emufs_indice_generar_clave(INDICE *idx, char *data);
+CLAVE emufs_indice_generar_clave_desde_valor(INDICE *idx, char *data);
+/** Compara 2 claves de la forma c1 < c2 */
 int emufs_indice_es_menor(INDICE *idx, CLAVE c1, CLAVE c2);
+
+/** Compara 2 claves de la forma c1 == c2 */
 int emufs_indice_es_igual(INDICE *idx, CLAVE c1, CLAVE c2);
 #endif