]> git.llucax.com Git - z.facultad/75.52/treemulator.git/blobdiff - src/btree.h
Hago que el header ocupe todo el primer bloque.
[z.facultad/75.52/treemulator.git] / src / btree.h
index f68bc32a33405ec01a1e9d115a03c609bf331b6d..e67c7cf537fd99a4782415d11695557ab988e7db 100644 (file)
 
 /* alias para codear menos :) */
 
 
 /* alias para codear menos :) */
 
-/** Encabezado del archivo BTree */
+/** Encabezado del archivo BTree 
+ *
+ *  Esta estructura es para comodidad de manejo, aunque en disco
+ *  ocupe block_size de tamaño.
+ */
 struct BTreeFileHeader {
        uint block_size;
 };
 struct BTreeFileHeader {
        uint block_size;
 };
@@ -79,10 +83,11 @@ struct BTreeNodeHeader {
        unsigned int item_count;
 };
 
        unsigned int item_count;
 };
 
-/** Crea un nuevo arbol B
+/** Modelo del árbol B
  *
  *  \param filename Nombre del archivo a crear
  *  \param block_size Tamaño de bloque a utilizar
  *
  *  \param filename Nombre del archivo a crear
  *  \param block_size Tamaño de bloque a utilizar
+ *  \param k_t Tipo de clave a utilizar
  *  \return Un nuevo arbol B creado o NULL en caso de error
  */
 class BTree {
  *  \return Un nuevo arbol B creado o NULL en caso de error
  */
 class BTree {
@@ -96,9 +101,14 @@ class BTree {
                        KEY_VARIABLE
                };
 
                        KEY_VARIABLE
                };
 
+               /** Agrega una nueva clave al árbol. */
                void AddKey (const Clave &k);
                void AddKey (const Clave &k);
+               /** Elimina una clave del árbol. */
                void DelKey (const Clave &k);
                void DelKey (const Clave &k);
-               /* TODO : Deberia retornar algun tipo de dato */
+               /** Busca si existe una clave en el árbol
+                *
+                * \TODO : Deberia retornar algun tipo de dato
+                */
                bool FindKey (const Clave &k);
 
        protected:
                bool FindKey (const Clave &k);
 
        protected: