sn-evolution: Implemented the use of `getopt'.
[sort-networks.git] / src / sn-evolution.c
index 4638b37..4b2ce72 100644 (file)
@@ -1,15 +1,25 @@
+#define _ISOC99_SOURCE
+#define _POSIX_C_SOURCE 200112L
+
 #include <stdlib.h>
 #include <stdio.h>
+#include <stdint.h>
 #include <string.h>
 
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <fcntl.h>
 #include <unistd.h>
+#include <signal.h>
 #include <assert.h>
+#include <limits.h>
 
 #include "sn_network.h"
 
+/* Yes, this is ugly, but the GNU libc doesn't export it with the above flags.
+ * */
+char *strdup (const char *s);
+
 struct population_entry_s
 {
   sn_network_t *network;
@@ -17,12 +27,25 @@ struct population_entry_s
 };
 typedef struct population_entry_s population_entry_t;
 
-static int iterations_num  = 10000;
-static int max_population_size = 64;
+static uint64_t iteration_counter = 0;
+static int max_population_size = 128;
+static int olymp_size = 96;
 static int inputs_num      = 16;
 
+static char *initial_input_file = NULL;
+static char *best_output_file = NULL;
+
+static int stats_interval = 0;
+
 static population_entry_t *population = NULL;
-int population_size = 0;
+static int population_size = 0;
+
+static int do_loop = 0;
+
+static void sigint_handler (int signal)
+{
+  do_loop++;
+} /* void sigint_handler */
 
 static int init_random (void)
 {
@@ -52,10 +75,75 @@ static int bounded_random (int upper_bound)
 
 static void exit_usage (const char *name)
 {
-  printf ("%s <file0>\n", name);
+  printf ("Usage: %s [options]\n"
+      "\n"
+      "Valid options are:\n"
+      "  -i <file>     Initial input file (REQUIRED)\n"
+      "  -o <file>     Write the current best solution to <file>\n"
+      "  -p <num>      Size of the population (default: 128)\n"
+      "  -P <num>      Size of the \"olymp\" (default: 96)\n"
+      "\n",
+      name);
   exit (1);
 } /* void exit_usage */
 
+int read_options (int argc, char **argv)
+{
+  int option;
+
+  while ((option = getopt (argc, argv, "i:o:p:P:s:h")) != -1)
+  {
+    switch (option)
+    {
+      case 'i':
+      {
+       if (initial_input_file != NULL)
+         free (initial_input_file);
+       initial_input_file = strdup (optarg);
+       break;
+      }
+
+      case 'o':
+      {
+       if (best_output_file != NULL)
+         free (best_output_file);
+       best_output_file = strdup (optarg);
+       break;
+      }
+
+      case 'p':
+      {
+       int tmp = atoi (optarg);
+       if (tmp > 0)
+         max_population_size = tmp;
+       break;
+      }
+
+      case 'P':
+      {
+       int tmp = atoi (optarg);
+       if (tmp > 0)
+         olymp_size = tmp;
+       break;
+      }
+
+      case 's':
+      {
+       int tmp = atoi (optarg);
+       if (tmp > 0)
+         stats_interval = tmp;
+       break;
+      }
+
+      case 'h':
+      default:
+       exit_usage (argv[0]);
+    }
+  }
+
+  return (0);
+} /* int read_options */
+
 static int rate_network (const sn_network_t *n)
 {
   int rate;
@@ -93,6 +181,10 @@ static int population_print_stats (int iterations)
 static int insert_into_population (sn_network_t *n)
 {
   int rating;
+  int worst_rating;
+  int worst_index;
+  int best_rating;
+  int nmemb;
   int i;
 
   rating = rate_network (n);
@@ -105,21 +197,48 @@ static int insert_into_population (sn_network_t *n)
     return (0);
   }
 
-  for (i = 0; i < population_size; i++)
-    if (population[i].rating > rating)
-      break;
-
-  if (i < population_size)
+  worst_rating = -1;
+  worst_index  = -1;
+  best_rating  = -1;
+  for (i = 0; i < olymp_size; i++)
   {
-    sn_network_destroy (population[i].network);
-    population[i].network = n;
-    population[i].rating  = rating;
+    if (population[i].rating > worst_rating)
+    {
+      worst_rating = population[i].rating;
+      worst_index  = i;
+    }
+    if ((population[i].rating < best_rating)
+       || (best_rating == -1))
+      best_rating = population[i].rating;
   }
-  else
+
+  if (rating < best_rating)
   {
-    sn_network_destroy (n);
+    if (best_output_file != NULL)
+    {
+      printf ("Writing network with rating %i to %s\n",
+         rating, best_output_file);
+      sn_network_write_file (n, best_output_file);
+    }
+    else
+    {
+      printf ("New best solution has rating %i\n",
+         rating);
+    }
   }
 
+  nmemb = max_population_size - (worst_index + 1);
+
+  sn_network_destroy (population[worst_index].network);
+  population[worst_index].network = NULL;
+
+  memmove (population + worst_index,
+      population + (worst_index + 1),
+      nmemb * sizeof (population_entry_t));
+
+  population[max_population_size - 1].network = n;
+  population[max_population_size - 1].rating  = rating;
+
   return (0);
 } /* int insert_into_population */
 
@@ -147,6 +266,10 @@ static int create_offspring (void)
     sn_network_cut_at (n, pos, dir);
   }
 
+  sn_network_compress (n);
+
+  assert (SN_NETWORK_INPUT_NUM (n) == inputs_num);
+
   insert_into_population (n);
 
   return (0);
@@ -154,14 +277,17 @@ static int create_offspring (void)
 
 static int start_evolution (void)
 {
-  int i;
+  uint64_t i;
 
-  for (i = 0; i < iterations_num; i++)
+  while (do_loop == 0)
   {
-    if ((i % 100) == 0)
-      population_print_stats (i);
-
     create_offspring ();
+
+    iteration_counter++;
+    i = iteration_counter;
+
+    if ((stats_interval > 0) && ((i % stats_interval) == 0))
+      population_print_stats (i);
   }
 
   return (0);
@@ -169,11 +295,18 @@ static int start_evolution (void)
 
 int main (int argc, char **argv)
 {
-  if (argc != 2)
+  struct sigaction sigint_action;
+
+  read_options (argc, argv);
+  if (initial_input_file == NULL)
     exit_usage (argv[0]);
 
   init_random ();
 
+  memset (&sigint_action, '\0', sizeof (sigint_action));
+  sigint_action.sa_handler = sigint_handler;
+  sigaction (SIGINT, &sigint_action, NULL);
+
   population = (population_entry_t *) malloc (max_population_size
       * sizeof (population_entry_t));
   if (population == NULL)
@@ -185,7 +318,7 @@ int main (int argc, char **argv)
       * sizeof (population_entry_t));
 
   {
-    sn_network_t *n = sn_network_read_file (argv[1]);
+    sn_network_t *n = sn_network_read_file (initial_input_file);
     if (n == NULL)
     {
       printf ("n == NULL\n");
@@ -194,17 +327,51 @@ int main (int argc, char **argv)
     population[0].network = n;
     population[0].rating  = rate_network (n);
     population_size++;
+
+    inputs_num = SN_NETWORK_INPUT_NUM(n);
   }
 
+  printf ("Current configuration:\n"
+      "  Initial network:  %s\n"
+      "  Number of inputs: %3i\n"
+      "  Population size:  %3i\n"
+      "  Olymp size:       %3i\n"
+      "=======================\n",
+      initial_input_file, inputs_num, max_population_size, olymp_size);
+
   start_evolution ();
 
-  if (0) {
+  printf ("Exiting after %llu iterations.\n", iteration_counter);
+
+  if (best_output_file == NULL)
+  {
     int i;
+    int best_rate = -1;
+    int best_index = -1;
+
     for (i = 0; i < population_size; i++)
     {
-      sn_network_show (population[i].network);
-      printf ("=============\n");
+      if ((best_rate == -1) || (best_rate > population[i].rating))
+      {
+       best_rate = population[i].rating;
+       best_index = i;
+      }
     }
+
+    sn_network_show (population[best_index].network);
+  }
+
+  {
+    int i;
+
+    for (i = 0; i < population_size; i++)
+    {
+      sn_network_destroy (population[i].network);
+      population[i].network = NULL;
+    }
+
+    free (population);
+    population = 0;
   }
 
   return (0);