From: Ricardo Markiewicz Date: Tue, 1 Nov 2005 16:36:59 +0000 (+0000) Subject: Paso el README e INSTALL a Doxygen. X-Git-Tag: 1_0~19 X-Git-Url: https://git.llucax.com/z.facultad/75.52/treemulator.git/commitdiff_plain/450420209e44a1789a31a2c41ad9a8e470f63703 Paso el README e INSTALL a Doxygen. --- diff --git a/src/doc.h b/src/doc.h new file mode 100644 index 0000000..0fad4e0 --- /dev/null +++ b/src/doc.h @@ -0,0 +1,115 @@ +/** + +\page page_tree TreeMulator + +Esta es una aplicación creada con fines didácticos cuyo principal motivo es +mostrar el funcionamiento del árbol B de 4 formas diferentes: + + +Para una mas fácil comprobación y ejecución de la aplicación, se han +desarrollado programas de prueba (ver INSTALL) que permiten realizar altas y +bajas a "pedido" o aleatorias. +Para claves fijas se utiliza 'btree': +
+./btree   
+        El tamaño de bloque usado es 512*2^.
+
+ +donde el tamaño del bloque, la cantidad de altas y la cantidad de bajas están +parametrizados. + +Lo mismo sucede para las claves de longitud variable, pero esta vez utilizando +'btree_var': +
+./btree_var   
+        El tamaño de bloque usado es 512*2^.
+
+ +al igual que el anterior, podemos definir cuantas altas y bajas deseamos +realizar y cual será el tamaño del bloque. + +Las claves de longitud fija se generan pseudo-aleatoriamente utilizando funciones +provistas por el lenguaje y las claves de longitud variable se generan +combinando palabras de dos archivos que contienen grandes listas de productos y +marcas en este caso. + +\section page_tree_viewer Visualizador + +Para poder inspeccionar todavia mejor el árbol, hemos desarrollado un inspector +visual basado en ventanas, con el cual se puede ir viendo el contenido de un +nodo haciendo click sobre el mismo. +Podremos encontrar esta aplicación dentro del directorio viewer/ y ejecutando +
+./viewer
+
+ +\image html viewer_01.png +\image latex viewer_01.eps "Pantalla Principal" width=10cm + +Luego en el menú 'archivo' tendremos la posibilidad de crear un nuevo árbol +indicando los parámetros vistos anteriormente. +También se pueden agregar claves desde el menú 'Clave' donde se desplegará una +ventana que pedirá el ingreso de una clave y un valor asociado a ella para +insertar en el árbol. De la misma manera podrán eliminarse valores siempre y +cuando estos existan en el árbol. +Un último menú permite realizar zoom para acercar y alejar la vista del árbol al +inspeccionarlo. + +Esta aplicación será mejorada en la próxima versión de TreeMulator. + +\section page_tree_instalar Instalar + +\subsection page_instalar_req Requerimientos + +TreeMulator ha sido implementado en lenguaje C++, por lo tanto es necesario un +compilador complatible. +Para las pruebas preliminares se utilizó el compilador gcc en su versión 4.0.x, +y la herramienta make para facilitar la construcción de la aplicación. +Todas las pruebas se realizaron sobre plataforma GNU/Linux Debian. +La interfaz gráfica utiliza las bibliotecas para implementación de ventanas GTK + + +\subsection page_instalar_ins Instalación + +Descomprimir el paquete treemulator.tar.gz en el directorio deseado +
+	~# cd dir_deseado
+	~# tar -xvzf treemulator.tar.gz
+
+ +Este paso tendrá como consecuencia directa la creación de la estructura de +directorios y todos los archivos fuentes y de documentación de la aplicación. + +Una vez dentro del directorio raíz de TreeMulator + +
+	~# cd treemulator/
+
+ +con la ayuda del Makefile se podrá compilar la aplicación. +Solo basta con invocar al comando 'make'. El éxito de este último paso +dependerá de que todos los requerimientos mencioandos esten cumplidos. + +Al finalizar, se puede observar dentro del directorio src/ que han aparecido los +ejecutables llamados 'btree' y 'btree_var', los cuales son programas de prueba +(ver README). +También se creará en el directorio viewer/ un ejecutable 'viewer' el cual es una +interfaz gráfica que permite inspeccionar el árbol. + +\section page_tree_autores Autores + + +*/ +