main.c

   1 /*
   2  * Searches for "good" ways to divide n matchsticks up and reassemble them
   3  * into m matchsticks.  "Good" means the smallest fragment is as big
   4  * as possible.
   5  *
   6  * Invoke as   ./main n m
   7  *
   8  * The algorithm is faster if the arguments are ordered so that n > m.
   9  */
  10
  11 /*
  12  * matchsticks/main.c  Copyright 2014 Ian Jackson
  13  *
  14  * This program is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation, either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  */
  24
  25 #include <stdio.h>
  26 #include <stdint.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29 #include <assert.h>
  30 #include <unistd.h>
  31 #include <stdbool.h>
  32 #include <inttypes.h>
  33
  34 #include <publib.h>
  35 #include <glpk.h>
  36
  37 /*
  38  * Algorithm.
  39  *
  40  * Each input match contributes, or does not contribute, to each
  41  * output match; we do not need to consider multiple fragments
  42  * relating to the same input/output pair this gives an n*m adjacency
  43  * matrix (bitmap).  Given such an adjacency matrix, the problem of
  44  * finding the best sizes for the fragments can be expressed as a
  45  * linear programming problem.
  46  *
  47  * We search all possible adjacency matrices, and for each one we run
  48  * GLPK's simplex solver.  We represent the adjacency matrix as an
  49  * array of bitmaps.
  50  *
  51  * However, there are a couple of wrinkles:
  52  *
  53  * To best represent the problem as a standard LP problem, we separate
  54  * out the size of each fragment into a common minimum size variable,
  55  * plus a fragment-specific extra size variable.  This reduces the LP
  56  * problem size at the cost of making the problem construction, and
  57  * interpretation of the results, a bit fiddly.
  58  *
  59  * Many of the adjacency matrices are equivalent.  In particular,
  60  * permutations of the columns, or of the rows, do not change the
  61  * meaning.  It is only necessasry to consider any one permutation.
  62  * We make use of this by considering only adjacency matrices whose
  63  * bitmap array contains bitmap words whose numerical values are
  64  * nondecreasing in array order.
  65  *
  66  * Once we have a solution, we also avoid considering any candidate
  67  * which involves dividing one of the output sticks into so many
  68  * fragment that the smallest fragment would necessarily be no bigger
  69  * than our best solution.  That is, we reject candidates where any of
  70  * the hamming weights of the adjacency bitmap words are too large.
  71  *
  72  * And, we want to do the search in order of increasing maximum
  73  * hamming weight.  This is because in practice optimal solutions tend
  74  * to have low hamming weight, and having found a reasonable solution
  75  * early allows us to eliminate a lot of candidates without doing the
  76  * full LP.
  77  */
  78
  79 typedef uint32_t AdjWord;
  80 #define PRADJ "08"PRIx32
  81
  82 static int n, m, maxhamweight;
  83 static AdjWord *adjmatrix;
  84 static AdjWord adjall;
  85
  86 static double best;
  87 static glp_prob *best_prob;
  88 static AdjWord *best_adjmatrix;
  89
  90 static unsigned printcounter;
  91
  92 static int ncpus = 1;
  93
  94 static void progress_eol(void) {
  95   fprintf(stderr,"        \r");
  96   fflush(stderr);
  97 }
  98
  99 static AdjWord *xalloc_adjmatrix(void) {
 100   return xmalloc(sizeof(*adjmatrix)*n);
 101 }
 102
 103 static void prep(void) {
 104   adjall = ~((~(AdjWord)0) << m);
 105   adjmatrix = xalloc_adjmatrix();
 106   glp_term_out(GLP_OFF);
 107   setlinebuf(stderr);
 108 }
 109
 110 static AdjWord one_adj_bit(int bitnum) {
 111   return (AdjWord)1 << bitnum;
 112 }
 113
 114 static int count_set_adj_bits(AdjWord w) {
 115   int j, total;
 116   for (j=0, total=0; j<m; j++)
 117     total += !!(w & one_adj_bit(j));
 118   return total;
 119 }
 120
 121 #define PRINTF(...) if (!doprint) ; else fprintf(stderr, __VA_ARGS__)
 122
 123 static int totalfrags;
 124
 125 static bool preconsider_ok(int nwords, bool doprint) {
 126   int i;
 127
 128   PRINTF("%2d ", maxhamweight);
 129
 130   bool had_max = 0;
 131   for (i=0, totalfrags=0; i<nwords; i++) {
 132     int frags = count_set_adj_bits(adjmatrix[i]);
 133     had_max += (frags >= maxhamweight);
 134     totalfrags += frags;
 135     PRINTF("%"PRADJ" ", adjmatrix[i]);
 136     double maxminsize = (double)m / frags;
 137     if (maxminsize <= best) {
 138       PRINTF(" too fine");
 139       goto out;
 140     }
 141   }
 142   if (!had_max) {
 143     /* Skip this candidate as its max hamming weight is lower than
 144      * we're currently looking for (which means we must have done it
 145      * already).  (The recursive iteration ensures that none of the
 146      * words have more than the max hamming weight.) */
 147     PRINTF(" nomaxham");
 148     goto out;
 149   }
 150   return 1;
 151
 152  out:
 153   return 0;
 154 }
 155
 156 static void optimise(bool doprint) {
 157   /* Consider the best answer (if any) for a given adjacency matrix */
 158   glp_prob *prob = 0;
 159   int i, j;
 160
 161   /*
 162    * Up to a certain point, optimise() can be restarted.  We use this
 163    * to go back and print the debugging output if it turns out that we
 164    * have an interesting case.  The HAVE_PRINTED macro does this: its
 165    * semantics are to go back in time and make sure that we have
 166    * printed the description of the search case.
 167    */
 168 #define HAVE_PRINTED ({                                         \
 169       if (!doprint) { doprint = 1; goto retry_with_print; }     \
 170     })
 171  retry_with_print:
 172   if (prob) {
 173     glp_delete_prob(prob);
 174     prob = 0;
 175   }
 176
 177   bool ok = preconsider_ok(n, doprint);
 178   if (!ok)
 179     goto out;
 180
 181   /*
 182    * We formulate our problem as an LP problem as follows.
 183    * In this file "n" and "m" are the matchstick numbers.
 184    *
 185    * Each set bit in the adjacency matrix corresponds to taking a
 186    * fragment from old match i and making it part of new match j.
 187    *
 188    * The structural variables (columns) are:
 189    *   x_minimum        minimum size of any fragment (bounded below by 0)
 190    *   x_morefrag_i_j   the amount by which the size of the fragment
 191    *                     i,j exceeds the minimum size (bounded below by 0)
 192    *
 193    * The auxiliary variables (rows) are:
 194    *   x_total_i       total length for each input match (fixed variable)
 195    *   x_total_j       total length for each output match (fixed variable)
 196    *
 197    * The objective function is simply
 198    *   maximise x_minimum
 199    *
 200    * We use X_ and Y_ to refer to GLPK's (1-based) column and row indices.
 201    * ME_ refers to entries in the list of constraint matrix elements
 202    * which we build up as we go.
 203    */
 204
 205   prob = glp_create_prob();
 206
 207   int Y_totals_i = glp_add_rows(prob, n);
 208   int Y_totals_j = glp_add_rows(prob, m);
 209   int X_minimum = glp_add_cols(prob, 1);
 210
 211   {
 212   int next_matrix_entry = 1; /* wtf GLPK! */
 213   int matrix_entries_size = next_matrix_entry + n + m + totalfrags*2;
 214   double matrix_entries[matrix_entries_size];
 215   int matrix_entries_XY[2][matrix_entries_size];
 216
 217 #define ADD_MATRIX_ENTRY(Y,X) ({                        \
 218       assert(next_matrix_entry < matrix_entries_size);  \
 219       matrix_entries_XY[0][next_matrix_entry] = (X);    \
 220       matrix_entries_XY[1][next_matrix_entry] = (Y);    \
 221       matrix_entries[next_matrix_entry] = 0;            \
 222       next_matrix_entry++;                              \
 223     })
 224
 225   int ME_totals_i__minimum = next_matrix_entry;
 226   for (i=0; i<n; i++) ADD_MATRIX_ENTRY(Y_totals_i+i, X_minimum);
 227
 228   int ME_totals_j__minimum = next_matrix_entry;
 229   for (j=0; j<m; j++) ADD_MATRIX_ENTRY(Y_totals_j+j, X_minimum);
 230
 231   /* \forall_i x_total_i = m */
 232   /* \forall_i x_total_j = n */
 233   for (i=0; i<n; i++) glp_set_row_bnds(prob, Y_totals_i+i, GLP_FX, m,m);
 234   for (j=0; j<m; j++) glp_set_row_bnds(prob, Y_totals_j+j, GLP_FX, n,n);
 235
 236   /* x_minimum >= 0 */
 237   glp_set_col_bnds(prob, X_minimum, GLP_LO, 0, 0);
 238   glp_set_col_name(prob, X_minimum, "minimum");
 239
 240   /* objective is maximising x_minimum */
 241   glp_set_obj_dir(prob, GLP_MAX);
 242   glp_set_obj_coef(prob, X_minimum, 1);
 243
 244   for (i=0; i<n; i++) {
 245     for (j=0; j<m; j++) {
 246       if (!(adjmatrix[i] & one_adj_bit(j)))
 247         continue;
 248       /* x_total_i += x_minimum */
 249       /* x_total_j += x_minimum */
 250       matrix_entries[ ME_totals_i__minimum + i ] ++;
 251       matrix_entries[ ME_totals_j__minimum + j ] ++;
 252
 253       /* x_morefrag_i_j >= 0 */
 254       int X_morefrag_i_j = glp_add_cols(prob, 1);
 255       glp_set_col_bnds(prob, X_morefrag_i_j, GLP_LO, 0, 0);
 256       if (doprint) {
 257         char buf[255];
 258         snprintf(buf,sizeof(buf),"mf %d,%d",i,j);
 259         glp_set_col_name(prob, X_morefrag_i_j, buf);
 260       }
 261
 262       /* x_total_i += x_morefrag_i_j */
 263       /* x_total_j += x_morefrag_i_j */
 264       int ME_totals_i__mf_i_j = ADD_MATRIX_ENTRY(Y_totals_i+i, X_morefrag_i_j);
 265       int ME_totals_j__mf_i_j = ADD_MATRIX_ENTRY(Y_totals_j+j, X_morefrag_i_j);
 266       matrix_entries[ME_totals_i__mf_i_j] = 1;
 267       matrix_entries[ME_totals_j__mf_i_j] = 1;
 268     }
 269   }
 270
 271   assert(next_matrix_entry == matrix_entries_size);
 272
 273   glp_load_matrix(prob, matrix_entries_size-1,
 274                   matrix_entries_XY[1], matrix_entries_XY[0],
 275                   matrix_entries);
 276
 277   int r = glp_simplex(prob, NULL);
 278   PRINTF(" glp=%d", r);
 279
 280 #define OKERR(e) \
 281   case e: PRINTF(" " #e ); goto out;
 282 #define BADERR(e) \
 283   case e: HAVE_PRINTED; printf(" " #e " CRASHING\n"); exit(-1);
 284 #define DEFAULT \
 285   default: HAVE_PRINTED; printf(" ! CRASHING\n"); exit(-1);
 286
 287   switch (r) {
 288   OKERR(GLP_ESING);
 289   OKERR(GLP_ECOND);
 290   OKERR(GLP_EBOUND);
 291   OKERR(GLP_EFAIL);
 292   OKERR(GLP_ENOPFS);
 293   OKERR(GLP_ENODFS);
 294   BADERR(GLP_EBADB);
 295   BADERR(GLP_EOBJLL);
 296   BADERR(GLP_EOBJUL);
 297   BADERR(GLP_EITLIM);
 298   BADERR(GLP_ETMLIM);
 299   BADERR(GLP_EINSTAB);
 300   BADERR(GLP_ENOCVG);
 301   case 0: break;
 302   DEFAULT;
 303   }
 304
 305   r = glp_get_status(prob);
 306   PRINTF(" status=%d", r);
 307
 308   switch (r) {
 309   OKERR(GLP_NOFEAS);
 310   OKERR(GLP_UNDEF);
 311   BADERR(GLP_FEAS);
 312   BADERR(GLP_INFEAS);
 313   BADERR(GLP_UNBND);
 314   case GLP_OPT: break;
 315   DEFAULT;
 316   }
 317
 318   double got = glp_get_obj_val(prob);
 319   PRINTF("  %g", got);
 320   if (got <= best)
 321     goto out;
 322
 323   HAVE_PRINTED;
 324
 325   best = got;
 326
 327   if (best_prob) glp_delete_prob(best_prob);
 328   best_prob = prob;
 329
 330   free(best_adjmatrix);
 331   best_adjmatrix = xalloc_adjmatrix();
 332   memcpy(best_adjmatrix, adjmatrix, sizeof(*adjmatrix)*n);
 333
 334   PRINTF(" BEST        \n");
 335   return;
 336
 337   }
 338  out:
 339   if (prob)
 340     glp_delete_prob(prob);
 341   if (doprint) progress_eol();
 342 }
 343
 344 static void iterate_recurse(int i, AdjWord min) {
 345   if (i >= n) {
 346     printcounter++;
 347     optimise(!(printcounter & 0xfff));
 348     return;
 349   }
 350   for (adjmatrix[i] = min;
 351        ;
 352        adjmatrix[i]++) {
 353     if (count_set_adj_bits(adjmatrix[i]) > maxhamweight)
 354       goto again;
 355     if (i == 0 && (adjmatrix[i] & (1+adjmatrix[i])))
 356       goto again;
 357
 358     iterate_recurse(i+1, adjmatrix[i]);
 359
 360   again:
 361     if (adjmatrix[i] == adjall)
 362       return;
 363   }
 364 }
 365
 366 static void iterate(void) {
 367   for (maxhamweight=1; maxhamweight<=m; maxhamweight++) {
 368     double maxminsize = (double)m / maxhamweight;
 369     if (maxminsize <= best)
 370       continue;
 371
 372     iterate_recurse(0, 1);
 373   }
 374 }
 375
 376 static void report(void) {
 377   fprintf(stderr, "\n");
 378   if (best_prob) {
 379     double min = glp_get_obj_val(best_prob);
 380     double a[n][m];
 381     int i, j, cols;
 382     for (i = 0; i < n; i++)
 383       for (j = 0; j < m; j++)
 384         a[i][j] = 0;
 385     cols = glp_get_num_cols(best_prob);
 386     for (i = 1; i <= cols; i++) {
 387       int x, y;
 388       if (2 != sscanf(glp_get_col_name(best_prob, i), "mf %d,%d", &x, &y))
 389         continue;
 390       a[x][y] = min + glp_get_col_prim(best_prob, i);
 391     }
 392     printf("%d into %d: min fragment %g\n", n, m, min);
 393     for (i = 0; i < n; i++) {
 394       for (j = 0; j < m; j++) {
 395         if (a[i][j])
 396           printf(" %9.3f", a[i][j]);
 397         else
 398           printf("          ");
 399       }
 400       printf("\n");
 401     }
 402   }
 403   if (ferror(stdout) || fclose(stdout)) { perror("stdout"); exit(-1); }
 404 }
 405
 406 int main(int argc, char **argv) {
 407   int opt;
 408   while ((opt = getopt(argc,argv,"j:")) >= 0) {
 409     switch (opt) {
 410     case 'j': ncpus = atoi(optarg); break;
 411     case '+': assert(!"bad option");
 412     default: abort();
 413     }
 414   }
 415   argc -= optind-1;
 416   argv += optind-1;
 417   assert(argc==3);
 418   n = atoi(argv[1]);
 419   m = atoi(argv[2]);
 420
 421   prep();
 422   iterate();
 423   report();
 424   return 0;
 425 }