tp1.h

   1 /* vim: set et ts=4 sw=4 fdm=indent fdl=1 fdn=1 fo+=t:
   2  *
   3  * Taller de Programación (75.42).
   4  *
   5  * Ejercicio Número 1:
   6  * Graficador de la solución de una ecuación diferencial por el método
   7  * de Euler (explícito).
   8  *
   9  * Copyleft 2003 - Leandro Lucarella <llucare@fi.uba.ar>
  10  * Puede copiar, modificar y distribuir este programa bajo los términos de
  11  * la licencia GPL (http://www.gnu.org/).
  12  *
  13  * Creado: sáb ago 23 16:59:01 ART 2003
  14  *
  15  * $Id$
  16  */
  17
  18 /************************ BIBLIOTECAS USADAS *******************************/
  19
  20 /* Para utilizar printf(), fprintf() y stderr */
  21 #include <stdio.h>
  22 /* Para utilizar strtod(), EXIT_SUCCES y EXIT_FAILURE */
  23 #include <stdlib.h>
  24
  25
  26
  27 /***************************** CONSTANTES **********************************/
  28
  29 /** Indica un valor verdadero */
  30 #define TRUE 1
  31
  32 /** Indica un valor falso */
  33 #define FALSE 0
  34
  35 /** Máxima cantidad de pasos a calcular. */
  36 #define MAX_PASOS 70
  37
  38 /** Altura (en líneas) utilizadas para dibujar el gráfico. */
  39 #define ALTO 20
  40
  41 /** Tiempo inicial. */
  42 #define T0 0.0
  43
  44 /** Tiempo final por omisión. */
  45 #define DEFAULT_TF 70.0
  46
  47 /** Valor inicial de la función por omisión. */
  48 #define DEFAULT_F0 0.0
  49
  50 /** Valor del pas de iteración por omisión. */
  51 #define DEFAULT_PASO 1.0
  52
  53
  54
  55 /******************************* MACROS ************************************/
  56
  57 /**
  58  * \ref integracion "Calcula" el siguiente paso de la función numérica.
  59  * Obtiene el siguiente valor de \f$ f \f$, integrando numéricamente la \ref
  60  * funcion "ecuación diferencial" por el \ref metodo "método de euler".
  61  * \f[
  62  *     f_{t + step} = f_{(step, f_t)} = f_t + \frac{500 - f_t}{30} \cdot step
  63  * \f]
  64  *
  65  * \note Se pone en un macro para poder reemplazar fácilmente la función sin la
  66  *       pérdida de velocidad que agrega la indirección de un llamado a una
  67  *       función.
  68  */
  69 #define FUNCION(paso, ft) ((ft) + (500.0 - (ft)) / 30.0 * paso)
  70
  71
  72
  73 /************************ TIPOS DE DATOS UTILIZADOS ************************/
  74
  75 /**
  76  * Tipo de dato utilizado para medir el tiempo y el valor de la función.
  77  * Se define como un tipo de dato propio para cambiar fácilmente la precisión.
  78  */
  79 typedef float Real;
  80
  81 /**
  82  * Vector que representa los resultados.
  83  * El índice del vector representa el número de iteración (que multiplicado por
  84  * el paso da el tiempo, o eje X). El contenido es el valor de la
  85  * \ref funcion "función" en ese instante.
  86  */
  87 typedef Real Resultados[MAX_PASOS];
  88
  89
  90
  91 /********************************* FUNCIONES *******************************/
  92
  93 /**
  94  * Imprime una explicación de como usar el programa.
  95  *
  96  * \param fh Archivo en donde imprimir el mensaje (ej: stdout o stderr).
  97  */
  98 void imprimir_uso(FILE* fh);
  99
 100 /**
 101  * Carga (validando) un dato real en una variable.
 102  * Si al validar hay algún error, muestra un mensaje por la salida de error y
 103  * devuelve false.
 104  *
 105  * \param arg Argumento a cargar (y validar).
 106  * \param var Variable en donde cargar el real.
 107  * \param nom Nombre de la variable que se quiere cargar (para el mensaje de
 108  *            error, en caso de haberlo).
 109  *
 110  * \return TRUE si se cargó bien, FALSE si no.
 111  */
 112 int argtod(const char* arg, Real* var, const char* nom);
 113
 114 /**
 115  * Carga los datos necesarios por el programai.
 116  * Obtiene los datos desde los parámetros de la línea de comandos, validándolos
 117  * y mostrando un mensaje de error en caso de haberlo.
 118  *
 119  * \param argc Cantidad de parámetros de línea de comandos ingresados.
 120  * \param argv Parámetros de línea de comandos.
 121  * \param paso Paso utilizado para las iteraciones.
 122  * \param tf   Tiempo final.
 123  * \param f0   Valor inicial de la función.
 124  *
 125  * \return TRUE si se cargaron bien, FALSE si no.
 126  * \todo Verificar que el paso no sea cero y que tf > ti.
 127  */
 128 int cargar_datos(int argc, const char** argv, Real* paso, Real* tf, Real* f0);
 129
 130 /**
 131  * \ref integracion "Calcula" todos los valores de la función.
 132  *
 133  * \param res  Vector donde se guardan los resultados.
 134  * \param paso Paso de iteración.
 135  * \param ti   Tiempo de inicio de la iteración.
 136  * \param tf   Tiempo final de la iteración.
 137  * \param f0   Valor inicial de la función.
 138  *
 139  * \return Cantidad de pasos realizados.
 140  */
 141 size_t calcular(Resultados* res, Real paso, Real ti, Real tf, Real f0);
 142
 143 /**
 144  * Devuelve el valor máximo de los resultados.
 145  *
 146  * \param res   Vector de resultados.
 147  * \param pasos Cantidad de pasos a iterar.
 148  *
 149  * \return Máximo resultado.
 150  */
 151 Real max(const Resultados* res, size_t pasos);
 152
 153 /**
 154  * Devuelve el valor mínimo de los resultados.
 155  *
 156  * \param res   Vector de resultados.
 157  * \param pasos Cantidad de pasos a iterar.
 158  *
 159  * \return Mínimo resultado.
 160  */
 161 Real min(const Resultados* res, size_t pasos);
 162
 163 /**
 164  * Programa principal.
 165  * Este es el programa que se encarga de resolver el trabajo práctico.
 166  *
 167  * \param argc Cantidad de parámetros de línea de comandos ingresados.
 168  * \param argv Parámetros de línea de comandos.
 169  *
 170  * \return EXIT_FAILURE si hubo un error, si no EXIT_SUCCESS.
 171  */
 172 int main(int argc, const char** argv);
 173