Rosapolis

Como parte de mi proyecto fin de carrera tengo que escribir un cierto número de algoritmos. Si no se hace del modo adecuado, crear el código LaTeX para mostrar pseudocódigo puede ser una tarea sumamente tediosa y exasperante. Para incluir código fuente, con coloreado de sintaxis y sus tabulaciones y todo, hay herramientas que generan el código necesario a partir de los archivos fuente, como por ejemplo Highlight que es el que yo uso. Sin embargo, el pseudocódigo hay que escribirlo a mano, teniendo en cuenta las tabulaciones, las palabras clave, etc. para que quede bien presentado y ordenado. Es deseable además contar con una numeración de algoritmos a lo largo del documento, tal y como se hace para las tablas o las imágenes, y también con la posibilidad de usar referencias cruzadas mediante \caption, \label y \ref.

Todo esto es muy sencillo de conseguir mediante el paquete algorithms. Hay un par de paquetes más que aportan más flexibilidad o entornos distintos según el lenguaje… pero para lo que yo hago me sobra con el algorithms. La pega que tiene es que el código que genera está en inglés y en el paquete babel no hay traducción, así que para escribir algoritmos en español es necesario redefinir los comandos. Es lo que he hecho en este archivo, spanishAlgorithmic.tex, que se puede bajar y guardar en el directorio donde estén nuestros ficheros .tex. Para poder usar todo basta con incluir en el preámbulo del documento lo siguiente:


\usepackage{algorithm}
\usepackage{algorithmic}
\input{spanishAlgorithmic} % mi archivo de traducción


Y bueno, a continuación unas pequeñas indicaciones de los comandos y opciones que aportan estos dos paquetes.

El entorno algorithmic


\begin{algorithmic}[numeracion_lineas]
…
\end{algorithmic}


Esto sería algo así como el tabular de toda la vida. Es un entorno para describir el algoritmo en sí, mediante comandos muy simples. Podemos activar opcionalmente la numeración de líneas, diciendo cada cuántas líneas queremos un número. Aquí tenéis un pequeño resumen que creo que es suficiente para escribir cualquier algoritmo no demasiado esotérico.

La apariencia del algoritmo que se genera se puede cambiar un poco mediante el comando \algsetup{opciones}, que se pone antes del \begin{algorithmic}. Se puede cambiar la indentación (con indent=length), el tamaño de la numeración de las líneas (con lineosize=font_size) y el delimitador de dichos números de línea (con lineodelimiter=delimiter), que por defecto es ":".

El entorno algorithm


\begin{algorithm}[opciones]
…
\end{algorithm}


Si el anterior era como el entorno tabular, éste sería como el entorno table. Sirve para encapsular un algoritmo como un objeto, para permitir la numeración de éstos, el uso de \caption y la posibilidad de asignarles etiquetas (para posteriores referencias) y para poder hacer índices o listas de algoritmos automáticamente, mediante el comando \listofalgorithms

Hay que tener en cuenta que el objeto algorithm que contiene nuestro algoritmo se comporta como un objeto flotante, al igual que las imágenes o las tablas. Eso significa que no tiene por qué aparecer exactamente donde nosotros lo hemos escrito, en el documento final. Para intentar forzar a LaTeX a que lo coloque donde queremos, podemos usar las opciones h (here),b (bottom),t (top) y H (put this float HERE), después de \begin{algorithm}.

Además de poder usar etiquetas en los algoritmos, es posible usarlas también en las líneas. De este modo, si después del algoritmo incluimos la típica explicación de lo que hace y queremos hacer referencias a líneas concretas no lo tenemos que hacer a lo burro.

Dicen que un trozo de código vale más que mil palabras, así que aquí va un ejemplo de todo.


\begin{algorithm}
\begin{algorithmic}[1]
\REQUIRE Complejo simplicial $K=\{\sigma_1, \dots, \sigma_n \}$ no vacío. \label{lin:lineaRara}
\ENSURE \TRUE si $K$ es contráctil y \FALSE en caso contrario.
\WHILE {$K \neq \{ \langle v \rangle \}$}
\STATE Elegir un símplice $\sigma_i$ de $K$ que sea maximal y que contenga una cara libre $\delta\sigma_i$.
\IF{no hay ningún símplice de esas características}
\RETURN \FALSE
\ELSE
\STATE $K \leftarrow K \setminus \{\sigma_i, \delta\sigma_i\}$
\ENDIF
\ENDWHILE
\RETURN \TRUE
\end{algorithmic}
\caption{Contracción de caras libres maximales}\label{alg:algoritmoRaro}
\end{algorithm}
El algoritmo~\ref{alg:algoritmoRaro} es bastante raro, ¿qué diablos significa la línea~\ref{lin:lineaRara}?


Y el resultado queda así:

Si no nos gusta el diseño con las líneas esas horizontales que pone por defecto, hay otros dos estilos que se pueden fijar cuando se incluye el paquete algorithm. El de las líneas, que se usa por defecto es ruled y los otros dos son plain y boxed. Es cuestión de probarlos.