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 #define _GNU_SOURCE
  26
  27 #include <publib.h>
  28
  29 #include <stdio.h>
  30 #include <stdint.h>
  31 #include <stdlib.h>
  32 #include <string.h>
  33 #include <assert.h>
  34 #include <unistd.h>
  35 #include <stdbool.h>
  36 #include <inttypes.h>
  37 #include <sys/types.h>
  38 #include <sys/wait.h>
  39 #include <sys/uio.h>
  40 #include <sys/fcntl.h>
  41
  42 #include <glpk.h>
  43
  44 /*
  45  * Algorithm.
  46  *
  47  * Each input match contributes, or does not contribute, to each
  48  * output match; we do not need to consider multiple fragments
  49  * relating to the same input/output pair this gives an n*m adjacency
  50  * matrix (bitmap).  Given such an adjacency matrix, the problem of
  51  * finding the best sizes for the fragments can be expressed as a
  52  * linear programming problem.
  53  *
  54  * We search all possible adjacency matrices, and for each one we run
  55  * GLPK's simplex solver.  We represent the adjacency matrix as an
  56  * array of bitmaps.
  57  *
  58  * However, there are a couple of wrinkles:
  59  *
  60  * To best represent the problem as a standard LP problem, we separate
  61  * out the size of each fragment into a common minimum size variable,
  62  * plus a fragment-specific extra size variable.  This reduces the LP
  63  * problem size at the cost of making the problem construction, and
  64  * interpretation of the results, a bit fiddly.
  65  *
  66  * Many of the adjacency matrices are equivalent.  In particular,
  67  * permutations of the columns, or of the rows, do not change the
  68  * meaning.  It is only necessasry to consider any one permutation.
  69  * We make use of this by considering only adjacency matrices whose
  70  * bitmap array contains bitmap words whose numerical values are
  71  * nondecreasing in array order.
  72  *
  73  * Once we have a solution, we also avoid considering any candidate
  74  * which involves dividing one of the output sticks into so many
  75  * fragment that the smallest fragment would necessarily be no bigger
  76  * than our best solution.  That is, we reject candidates where any of
  77  * the hamming weights of the adjacency bitmap words are too large.
  78  *
  79  * And, we want to do the search in order of increasing maximum
  80  * hamming weight.  This is because in practice optimal solutions tend
  81  * to have low hamming weight, and having found a reasonable solution
  82  * early allows us to eliminate a lot of candidates without doing the
  83  * full LP.
  84  */
  85
  86 typedef uint32_t AdjWord;
  87 #define PRADJ "08"PRIx32
  88
  89 static int n, m, maxhamweight;
  90 static AdjWord *adjmatrix;
  91 static AdjWord adjall;
  92
  93 static double best;
  94 static glp_prob *best_prob;
  95 static AdjWord *best_adjmatrix;
  96
  97 static unsigned printcounter;
  98
  99 static void iterate(void);
 100 static void iterate_recurse(int i, AdjWord min);
 101 static bool preconsider_ok(int nwords, bool doprint);
 102 static bool maxhamweight_ok(void);
 103 static void optimise(bool doprint);
 104
 105 static void progress_eol(void) {
 106   fprintf(stderr,"        \r");
 107   fflush(stderr);
 108 }
 109
 110 /*----- multicore support -----*/
 111
 112 /*
 113  * Multicore protocol
 114  *
 115  * We fork into:
 116  *   - master (parent)
 117  *   - generator
 118  *   - ncpu workers
 119  *
 120  * ipc facilities:
 121  *   - one pipe ("work") from generator to workers
 122  *   - ever-extending file ("bus") containing new "best" values
 123  *   - one file for each worker giving maxhamweight and adjmatrix for best
 124  *
 125  * generator runs iterate_recurse to a certain depth and writes the
 126  * candidates to a pipe
 127  *
 128  * workers read candidates from the pipe and resume iterate_recurse
 129  * halfway through the recursion
 130  *
 131  * whenever a worker does a doprint, it checks the bus for new best
 132  * value; actual best values are appended
 133  *
 134  * master waits for generator and all workers to finish and then
 135  * runs optimise() for each worker's best, then prints
 136  */
 137
 138 static int ncpus = 0, multicore_iteration_boundary = INT_MAX;
 139
 140 static int mc_bus, mc_work[2];
 141 static off_t mc_bus_read;
 142
 143 typedef struct {
 144   int w;
 145   FILE *results;
 146   pid_t pid;
 147 } Worker;
 148 static Worker *mc_us;
 149
 150 static void multicore_check_for_new_best(void);
 151
 152 #define MAX_NIOVS 3
 153 static AdjWord mc_iter_min;
 154 static int mc_niovs;
 155 static size_t mc_iovlen;
 156 static struct iovec mc_iov[MAX_NIOVS];
 157
 158 #define IOV0 (mc_niovs = mc_iovlen = 0)
 159
 160 #define IOV(obj, count) ({                              \
 161     assert(mc_niovs < MAX_NIOVS);                       \
 162     mc_iov[mc_niovs].iov_base = &(obj);                 \
 163     mc_iov[mc_niovs].iov_len = sizeof(obj) * (count);   \
 164     mc_iovlen += mc_iov[mc_niovs].iov_len;              \
 165     mc_niovs++;                                         \
 166   })
 167
 168 static void mc_rwvsetup_outer(void) {
 169   IOV0;
 170   IOV(maxhamweight, 1);
 171   IOV(mc_iter_min, 1);
 172   IOV(*adjmatrix, multicore_iteration_boundary);
 173 }
 174
 175 static void mc_rwvsetup_full(void) {
 176   IOV0;
 177   IOV(*adjmatrix, n);
 178 }
 179
 180 static void vlprintf(const char *fmt, va_list al) {
 181   vfprintf(stderr,fmt,al);
 182   progress_eol();
 183 }
 184
 185 static void LPRINTF(const char *fmt, ...) {
 186   va_list al;
 187   va_start(al,fmt);
 188   vlprintf(fmt,al);
 189   va_end(al);
 190 }
 191
 192 static void mc_awaitpid(int wnum, pid_t pid) {
 193   LPRINTF("master awaiting %2d [%ld]",wnum,(long)pid);
 194   int status;
 195   pid_t got = waitpid(pid, &status, 0);
 196   assert(got == pid);
 197   if (status) {
 198     fprintf(stderr,"\nFAILED SUBPROC %2d [%ld] %d\n",
 199             wnum, (long)pid, status);
 200     exit(-1);
 201   }
 202 }
 203
 204 static void multicore_outer_iteration(int i, AdjWord min) {
 205   assert(i == multicore_iteration_boundary);
 206   mc_iter_min = min;
 207   mc_rwvsetup_outer();
 208   ssize_t r = writev(mc_work[1], mc_iov, mc_niovs);
 209   assert(r == mc_iovlen);
 210   /* effectively, this writev arranges to transfers control
 211    * to some worker's instance of iterate_recurse via mc_iterate_worker */
 212 }
 213
 214 static void mc_iterate_worker(void) {
 215   for (;;) {
 216     mc_rwvsetup_outer();
 217     ssize_t r = readv(mc_work[0], mc_iov, mc_niovs);
 218     if (r == 0) break;
 219     assert(r == mc_iovlen);
 220
 221     /* stop iterate_recurse from trying to run multicore_outer_iteration */
 222     int mc_org_it_bound = multicore_iteration_boundary;
 223     multicore_iteration_boundary = INT_MAX;
 224     iterate_recurse(mc_org_it_bound, mc_iter_min);
 225     multicore_iteration_boundary = mc_org_it_bound;
 226   }
 227   LPRINTF("worker %2d reporting",mc_us->w);
 228   if (best_adjmatrix) {
 229     adjmatrix = best_adjmatrix;
 230     mc_rwvsetup_full();
 231     ssize_t r = writev(fileno(mc_us->results), mc_iov, mc_niovs);
 232     assert(r == mc_iovlen);
 233   }
 234   LPRINTF("worker %2d ending",mc_us->w);
 235   exit(0);
 236 }
 237
 238 static void multicore(void) {
 239   Worker *mc_workers;
 240   int w;
 241   pid_t genpid;
 242
 243   multicore_iteration_boundary = n / 2;
 244
 245   FILE *busf = tmpfile();  assert(busf);
 246   mc_bus = fileno(busf);
 247   int r = fcntl(mc_bus, F_GETFL);  assert(r >= 0);
 248   r |= O_APPEND;
 249   r = fcntl(mc_bus, F_SETFL, r);  assert(r >= 0);
 250
 251   r = pipe(mc_work);  assert(!r);
 252
 253   mc_workers = xmalloc(sizeof(*mc_workers) * ncpus);
 254   for (w=0; w<ncpus; w++) {
 255     mc_workers[w].w = w;
 256     mc_workers[w].results = tmpfile();  assert(mc_workers[w].results);
 257     mc_workers[w].pid = fork();  assert(mc_workers[w].pid >= 0);
 258     if (!mc_workers[w].pid) {
 259       mc_us = &mc_workers[w];
 260       close(mc_work[1]);
 261       LPRINTF("worker %2d running", w);
 262       mc_iterate_worker();
 263       exit(0);
 264     }
 265   }
 266
 267   close(mc_work[0]);
 268
 269   genpid = fork();  assert(genpid >= 0);
 270   if (!genpid) {
 271     LPRINTF("generator running");
 272     iterate();
 273     exit(0);
 274   }
 275
 276   close(mc_work[1]);
 277   mc_awaitpid(-1, genpid);
 278   for (w=0; w<ncpus; w++)
 279     mc_awaitpid(w, mc_workers[w].pid);
 280
 281   for (w=0; w<ncpus; w++) {
 282     mc_rwvsetup_full();
 283     LPRINTF("reading report from %2d",w);
 284     ssize_t sr = preadv(fileno(mc_workers[w].results), mc_iov, mc_niovs, 0);
 285     if (!sr) continue;
 286     maxhamweight = 0;
 287     optimise(1);
 288   }
 289 }
 290
 291 static void multicore_check_for_new_best(void) {
 292   if (!ncpus) return;
 293
 294   for (;;) {
 295     double msg;
 296     ssize_t got = pread(mc_bus, &msg, sizeof(msg), mc_bus_read);
 297     if (!got) break;
 298     assert(got == sizeof(msg));
 299     if (msg > best)
 300       best = msg;
 301     mc_bus_read += sizeof(msg);
 302   }
 303 }
 304
 305 static void multicore_found_new_best(void) {
 306   if (!ncpus) return;
 307
 308   if (mc_us /* might be master */) fprintf(stderr,"    w%-2d ",mc_us->w);
 309   ssize_t wrote = write(mc_bus, &best, sizeof(best));
 310   assert(wrote == sizeof(best));
 311 }
 312
 313 /*----- end of multicore support -----*/
 314
 315 static AdjWord *xalloc_adjmatrix(void) {
 316   return xmalloc(sizeof(*adjmatrix)*n);
 317 }
 318
 319 static void prep(void) {
 320   adjall = ~((~(AdjWord)0) << m);
 321   adjmatrix = xalloc_adjmatrix();
 322   glp_term_out(GLP_OFF);
 323   setlinebuf(stderr);
 324 }
 325
 326 static AdjWord one_adj_bit(int bitnum) {
 327   return (AdjWord)1 << bitnum;
 328 }
 329
 330 static int count_set_adj_bits(AdjWord w) {
 331   int j, total;
 332   for (j=0, total=0; j<m; j++)
 333     total += !!(w & one_adj_bit(j));
 334   return total;
 335 }
 336
 337 #define PRINTF(...) if (!doprint) ; else fprintf(stderr, __VA_ARGS__)
 338
 339 static int totalfrags;
 340
 341 static bool maxhamweight_ok(void) {
 342   double maxminsize = (double)m / maxhamweight;
 343   return maxminsize > best;
 344 }
 345
 346 static bool preconsider_ok(int nwords, bool doprint) {
 347   int i;
 348
 349   PRINTF("%2d ", maxhamweight);
 350
 351   bool had_max = 0;
 352   for (i=0, totalfrags=0; i<nwords; i++) {
 353     int frags = count_set_adj_bits(adjmatrix[i]);
 354     had_max += (frags >= maxhamweight);
 355     totalfrags += frags;
 356     PRINTF("%"PRADJ" ", adjmatrix[i]);
 357     double maxminsize = (double)m / frags;
 358     if (maxminsize <= best) {
 359       PRINTF(" too fine");
 360       goto out;
 361     }
 362   }
 363   if (!had_max) {
 364     /* Skip this candidate as its max hamming weight is lower than
 365      * we're currently looking for (which means we must have done it
 366      * already).  (The recursive iteration ensures that none of the
 367      * words have more than the max hamming weight.) */
 368     PRINTF(" nomaxham");
 369     goto out;
 370   }
 371   return 1;
 372
 373  out:
 374   return 0;
 375 }
 376
 377 static void optimise(bool doprint) {
 378   /* Consider the best answer (if any) for a given adjacency matrix */
 379   glp_prob *prob = 0;
 380   int i, j;
 381
 382   /*
 383    * Up to a certain point, optimise() can be restarted.  We use this
 384    * to go back and print the debugging output if it turns out that we
 385    * have an interesting case.  The HAVE_PRINTED macro does this: its
 386    * semantics are to go back in time and make sure that we have
 387    * printed the description of the search case.
 388    */
 389 #define HAVE_PRINTED ({                                         \
 390       if (!doprint) { doprint = 1; goto retry_with_print; }     \
 391     })
 392  retry_with_print:
 393   if (prob) {
 394     glp_delete_prob(prob);
 395     prob = 0;
 396   }
 397
 398   bool ok = preconsider_ok(n, doprint);
 399   if (!ok)
 400     goto out;
 401
 402   /*
 403    * We formulate our problem as an LP problem as follows.
 404    * In this file "n" and "m" are the matchstick numbers.
 405    *
 406    * Each set bit in the adjacency matrix corresponds to taking a
 407    * fragment from old match i and making it part of new match j.
 408    *
 409    * The structural variables (columns) are:
 410    *   x_minimum        minimum size of any fragment (bounded below by 0)
 411    *   x_morefrag_i_j   the amount by which the size of the fragment
 412    *                     i,j exceeds the minimum size (bounded below by 0)
 413    *
 414    * The auxiliary variables (rows) are:
 415    *   x_total_i       total length for each input match (fixed variable)
 416    *   x_total_j       total length for each output match (fixed variable)
 417    *
 418    * The objective function is simply
 419    *   maximise x_minimum
 420    *
 421    * We use X_ and Y_ to refer to GLPK's (1-based) column and row indices.
 422    * ME_ refers to entries in the list of constraint matrix elements
 423    * which we build up as we go.
 424    */
 425
 426   prob = glp_create_prob();
 427
 428   int Y_totals_i = glp_add_rows(prob, n);
 429   int Y_totals_j = glp_add_rows(prob, m);
 430   int X_minimum = glp_add_cols(prob, 1);
 431
 432   {
 433   int next_matrix_entry = 1; /* wtf GLPK! */
 434   int matrix_entries_size = next_matrix_entry + n + m + totalfrags*2;
 435   double matrix_entries[matrix_entries_size];
 436   int matrix_entries_XY[2][matrix_entries_size];
 437
 438 #define ADD_MATRIX_ENTRY(Y,X) ({                        \
 439       assert(next_matrix_entry < matrix_entries_size);  \
 440       matrix_entries_XY[0][next_matrix_entry] = (X);    \
 441       matrix_entries_XY[1][next_matrix_entry] = (Y);    \
 442       matrix_entries[next_matrix_entry] = 0;            \
 443       next_matrix_entry++;                              \
 444     })
 445
 446   int ME_totals_i__minimum = next_matrix_entry;
 447   for (i=0; i<n; i++) ADD_MATRIX_ENTRY(Y_totals_i+i, X_minimum);
 448
 449   int ME_totals_j__minimum = next_matrix_entry;
 450   for (j=0; j<m; j++) ADD_MATRIX_ENTRY(Y_totals_j+j, X_minimum);
 451
 452   /* \forall_i x_total_i = m */
 453   /* \forall_i x_total_j = n */
 454   for (i=0; i<n; i++) glp_set_row_bnds(prob, Y_totals_i+i, GLP_FX, m,m);
 455   for (j=0; j<m; j++) glp_set_row_bnds(prob, Y_totals_j+j, GLP_FX, n,n);
 456
 457   /* x_minimum >= 0 */
 458   glp_set_col_bnds(prob, X_minimum, GLP_LO, 0, 0);
 459   glp_set_col_name(prob, X_minimum, "minimum");
 460
 461   /* objective is maximising x_minimum */
 462   glp_set_obj_dir(prob, GLP_MAX);
 463   glp_set_obj_coef(prob, X_minimum, 1);
 464
 465   for (i=0; i<n; i++) {
 466     for (j=0; j<m; j++) {
 467       if (!(adjmatrix[i] & one_adj_bit(j)))
 468         continue;
 469       /* x_total_i += x_minimum */
 470       /* x_total_j += x_minimum */
 471       matrix_entries[ ME_totals_i__minimum + i ] ++;
 472       matrix_entries[ ME_totals_j__minimum + j ] ++;
 473
 474       /* x_morefrag_i_j >= 0 */
 475       int X_morefrag_i_j = glp_add_cols(prob, 1);
 476       glp_set_col_bnds(prob, X_morefrag_i_j, GLP_LO, 0, 0);
 477       if (doprint) {
 478         char buf[255];
 479         snprintf(buf,sizeof(buf),"mf %d,%d",i,j);
 480         glp_set_col_name(prob, X_morefrag_i_j, buf);
 481       }
 482
 483       /* x_total_i += x_morefrag_i_j */
 484       /* x_total_j += x_morefrag_i_j */
 485       int ME_totals_i__mf_i_j = ADD_MATRIX_ENTRY(Y_totals_i+i, X_morefrag_i_j);
 486       int ME_totals_j__mf_i_j = ADD_MATRIX_ENTRY(Y_totals_j+j, X_morefrag_i_j);
 487       matrix_entries[ME_totals_i__mf_i_j] = 1;
 488       matrix_entries[ME_totals_j__mf_i_j] = 1;
 489     }
 490   }
 491
 492   assert(next_matrix_entry == matrix_entries_size);
 493
 494   glp_load_matrix(prob, matrix_entries_size-1,
 495                   matrix_entries_XY[1], matrix_entries_XY[0],
 496                   matrix_entries);
 497
 498   int r = glp_simplex(prob, NULL);
 499   PRINTF(" glp=%d", r);
 500
 501 #define OKERR(e) \
 502   case e: PRINTF(" " #e ); goto out;
 503 #define BADERR(e) \
 504   case e: HAVE_PRINTED; printf(" " #e " CRASHING\n"); exit(-1);
 505 #define DEFAULT \
 506   default: HAVE_PRINTED; printf(" ! CRASHING\n"); exit(-1);
 507
 508   switch (r) {
 509   OKERR(GLP_ESING);
 510   OKERR(GLP_ECOND);
 511   OKERR(GLP_EBOUND);
 512   OKERR(GLP_EFAIL);
 513   OKERR(GLP_ENOPFS);
 514   OKERR(GLP_ENODFS);
 515   BADERR(GLP_EBADB);
 516   BADERR(GLP_EOBJLL);
 517   BADERR(GLP_EOBJUL);
 518   BADERR(GLP_EITLIM);
 519   BADERR(GLP_ETMLIM);
 520   BADERR(GLP_EINSTAB);
 521   BADERR(GLP_ENOCVG);
 522   case 0: break;
 523   DEFAULT;
 524   }
 525
 526   r = glp_get_status(prob);
 527   PRINTF(" status=%d", r);
 528
 529   switch (r) {
 530   OKERR(GLP_NOFEAS);
 531   OKERR(GLP_UNDEF);
 532   BADERR(GLP_FEAS);
 533   BADERR(GLP_INFEAS);
 534   BADERR(GLP_UNBND);
 535   case GLP_OPT: break;
 536   DEFAULT;
 537   }
 538
 539   double got = glp_get_obj_val(prob);
 540   PRINTF("  %g", got);
 541   if (got <= best)
 542     goto out;
 543
 544   HAVE_PRINTED;
 545
 546   best = got;
 547   multicore_found_new_best();
 548
 549   if (best_prob) glp_delete_prob(best_prob);
 550   best_prob = prob;
 551
 552   free(best_adjmatrix);
 553   best_adjmatrix = xalloc_adjmatrix();
 554   memcpy(best_adjmatrix, adjmatrix, sizeof(*adjmatrix)*n);
 555
 556   PRINTF(" BEST        \n");
 557   return;
 558
 559   }
 560  out:
 561   if (prob)
 562     glp_delete_prob(prob);
 563   if (doprint) progress_eol();
 564   if (doprint) multicore_check_for_new_best();
 565 }
 566
 567 static void iterate_recurse(int i, AdjWord min) {
 568   if (i >= n) {
 569     printcounter++;
 570     optimise(!(printcounter & 0xfff));
 571     return;
 572   }
 573   if (i >= multicore_iteration_boundary) {
 574     multicore_outer_iteration(i, min);
 575     return;
 576   }
 577   for (adjmatrix[i] = min;
 578        ;
 579        adjmatrix[i]++) {
 580     if (count_set_adj_bits(adjmatrix[i]) > maxhamweight)
 581       goto again;
 582     if (i == 0 && (adjmatrix[i] & (1+adjmatrix[i])))
 583       goto again;
 584
 585     iterate_recurse(i+1, adjmatrix[i]);
 586
 587   again:
 588     if (adjmatrix[i] == adjall)
 589       return;
 590   }
 591 }
 592
 593 static void iterate(void) {
 594   for (maxhamweight=1; maxhamweight<=m; maxhamweight++) {
 595     if (!maxhamweight_ok())
 596       continue;
 597
 598     iterate_recurse(0, 1);
 599   }
 600 }
 601
 602 static void report(void) {
 603   fprintf(stderr, "\n");
 604   if (best_prob) {
 605     double min = glp_get_obj_val(best_prob);
 606     double a[n][m];
 607     int i, j, cols;
 608     for (i = 0; i < n; i++)
 609       for (j = 0; j < m; j++)
 610         a[i][j] = 0;
 611     cols = glp_get_num_cols(best_prob);
 612     for (i = 1; i <= cols; i++) {
 613       int x, y;
 614       if (2 != sscanf(glp_get_col_name(best_prob, i), "mf %d,%d", &x, &y))
 615         continue;
 616       a[x][y] = min + glp_get_col_prim(best_prob, i);
 617     }
 618     printf("%d into %d: min fragment %g\n", n, m, min);
 619     for (i = 0; i < n; i++) {
 620       for (j = 0; j < m; j++) {
 621         if (a[i][j])
 622           printf(" %9.3f", a[i][j]);
 623         else
 624           printf("          ");
 625       }
 626       printf("\n");
 627     }
 628   }
 629   if (ferror(stdout) || fclose(stdout)) { perror("stdout"); exit(-1); }
 630 }
 631
 632 int main(int argc, char **argv) {
 633   int opt;
 634   while ((opt = getopt(argc,argv,"j:")) >= 0) {
 635     switch (opt) {
 636     case 'j': ncpus = atoi(optarg); break;
 637     case '+': assert(!"bad option");
 638     default: abort();
 639     }
 640   }
 641   argc -= optind-1;
 642   argv += optind-1;
 643   assert(argc==3);
 644   n = atoi(argv[1]);
 645   m = atoi(argv[2]);
 646
 647   prep();
 648
 649   if (ncpus) multicore();
 650   else iterate();
 651
 652   report();
 653   return 0;
 654 }