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
8 * The algorithm is faster if the arguments are ordered so that n > m.
12 * matchsticks/main.c Copyright 2014 Ian Jackson
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.
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.
38 #include <sys/types.h>
41 #include <sys/fcntl.h>
46 #define VERSION "(unknown-version)"
52 * Each input match contributes, or does not contribute, to each
53 * output match; we do not need to consider multiple fragments
54 * relating to the same input/output pair this gives an n*m adjacency
55 * matrix (bitmap). Given such an adjacency matrix, the problem of
56 * finding the best sizes for the fragments can be expressed as a
57 * linear programming problem.
59 * We search all possible adjacency matrices, and for each one we run
60 * GLPK's simplex solver. We represent the adjacency matrix as an
63 * However, there are a couple of wrinkles:
65 * To best represent the problem as a standard LP problem, we separate
66 * out the size of each fragment into a common minimum size variable,
67 * plus a fragment-specific extra size variable. This reduces the LP
68 * problem size at the cost of making the problem construction, and
69 * interpretation of the results, a bit fiddly.
71 * Many of the adjacency matrices are equivalent. In particular,
72 * permutations of the columns, or of the rows, do not change the
73 * meaning. It is only necessasry to consider any one permutation.
74 * We make use of this by considering only adjacency matrices whose
75 * bitmap array contains bitmap words whose numerical values are
76 * nondecreasing in array order.
78 * Once we have a solution, we also avoid considering any candidate
79 * which involves dividing one of the output sticks into so many
80 * fragment that the smallest fragment would necessarily be no bigger
81 * than our best solution. That is, we reject candidates where any of
82 * the hamming weights of the adjacency bitmap words are too large.
84 * And, we want to do the search in order of increasing maximum
85 * hamming weight. This is because in practice optimal solutions tend
86 * to have low hamming weight, and having found a reasonable solution
87 * early allows us to eliminate a lot of candidates without doing the
91 typedef uint32_t AdjWord;
92 #define PRADJ "08"PRIx32
94 #define FOR_BITS(j,m) for (j=0, j##bit=1; j < (m); j++, j##bit<<=1)
96 static int n, m, maxhamweight;
97 static AdjWord *adjmatrix;
98 static AdjWord adjall;
101 static glp_prob *best_prob;
102 static AdjWord *best_adjmatrix;
104 static int n_max_frags, m_max_frags;
107 static unsigned printcounter;
109 static void iterate(void);
110 static void iterate_recurse(int i, AdjWord min);
111 static bool preconsider_ok(int nwords, bool doprint);
112 static bool maxhamweight_ok(void);
113 static void optimise(bool doprint);
115 static void progress_eol(void) {
116 fprintf(stderr," \r");
120 static void set_best(double new_best) {
123 * When computing n_max_frags, we want to set a value that will skip
124 * anything that won't provide strictly better solutions. So we
128 * <=> frags < | n / best |
130 * <=> frags <= | n / best | - 1
132 n_max_frags = ceil(n / best) - 1;
133 m_max_frags = ceil(m / best) - 1;
136 /*----- multicore support -----*/
147 * - one pipe ("work") from generator to workers
148 * - ever-extending file ("bus") containing new "best" values
149 * - one file for each worker giving maxhamweight and adjmatrix for best
151 * generator runs iterate_recurse to a certain depth and writes the
152 * candidates to a pipe
154 * workers read candidates from the pipe and resume iterate_recurse
155 * halfway through the recursion
157 * whenever a worker does a doprint, it checks the bus for new best
158 * value; actual best values are appended
160 * master waits for generator and all workers to finish and then
161 * runs optimise() for each worker's best, then prints
164 static int ncpus = 0, multicore_iteration_boundary = INT_MAX;
166 static int mc_bus, mc_work[2];
167 static off_t mc_bus_read;
174 static Worker *mc_us;
175 static bool mc_am_generator;
177 static void multicore_check_for_new_best(void);
180 static AdjWord mc_iter_min;
182 static size_t mc_iovlen;
183 static struct iovec mc_iov[MAX_NIOVS];
185 #define IOV0 (mc_niovs = mc_iovlen = 0)
187 #define IOV(obj, count) ({ \
188 assert(mc_niovs < MAX_NIOVS); \
189 mc_iov[mc_niovs].iov_base = &(obj); \
190 mc_iov[mc_niovs].iov_len = sizeof(obj) * (count); \
191 mc_iovlen += mc_iov[mc_niovs].iov_len; \
195 static void mc_rwvsetup_outer(void) {
197 IOV(maxhamweight, 1);
199 IOV(*adjmatrix, multicore_iteration_boundary);
203 static void mc_rwvsetup_full(void) {
208 static void vlprintf(const char *fmt, va_list al) {
209 vfprintf(stderr,fmt,al);
213 static void LPRINTF(const char *fmt, ...) {
220 static void mc_awaitpid(int wnum, pid_t pid) {
221 LPRINTF("master awaiting %2d [%ld]",wnum,(long)pid);
223 pid_t got = waitpid(pid, &status, 0);
226 fprintf(stderr,"\nFAILED SUBPROC %2d [%ld] %d\n",
227 wnum, (long)pid, status);
232 static void multicore_outer_iteration(int i, AdjWord min) {
233 static unsigned check_counter;
235 assert(i == multicore_iteration_boundary);
238 ssize_t r = writev(mc_work[1], mc_iov, mc_niovs);
239 assert(r == mc_iovlen);
240 /* effectively, this writev arranges to transfers control
241 * to some worker's instance of iterate_recurse via mc_iterate_worker */
243 if (!(check_counter++ & 0xff))
244 multicore_check_for_new_best();
247 static void mc_iterate_worker(void) {
250 ssize_t r = readv(mc_work[0], mc_iov, mc_niovs);
252 assert(r == mc_iovlen);
254 bool ok = maxhamweight_ok();
257 ok = preconsider_ok(multicore_iteration_boundary, 1);
261 /* stop iterate_recurse from trying to run multicore_outer_iteration */
262 int mc_org_it_bound = multicore_iteration_boundary;
263 multicore_iteration_boundary = INT_MAX;
264 iterate_recurse(mc_org_it_bound, mc_iter_min);
265 multicore_iteration_boundary = mc_org_it_bound;
267 if (best_adjmatrix) {
268 LPRINTF("worker %2d reporting",mc_us->w);
269 adjmatrix = best_adjmatrix;
271 ssize_t r = writev(fileno(mc_us->results), mc_iov, mc_niovs);
272 assert(r == mc_iovlen);
274 LPRINTF("worker %2d ending",mc_us->w);
278 static void multicore(void) {
283 multicore_iteration_boundary = n / 2;
285 FILE *busf = tmpfile(); assert(busf);
286 mc_bus = fileno(busf);
287 int r = fcntl(mc_bus, F_GETFL); assert(r >= 0);
289 r = fcntl(mc_bus, F_SETFL, r); assert(r >= 0);
291 r = pipe(mc_work); assert(!r);
293 mc_workers = xmalloc(sizeof(*mc_workers) * ncpus);
294 for (w=0; w<ncpus; w++) {
296 mc_workers[w].results = tmpfile(); assert(mc_workers[w].results);
297 mc_workers[w].pid = fork(); assert(mc_workers[w].pid >= 0);
298 if (!mc_workers[w].pid) {
299 mc_us = &mc_workers[w];
301 LPRINTF("worker %2d running", w);
309 genpid = fork(); assert(genpid >= 0);
312 LPRINTF("generator running");
318 mc_awaitpid(-1, genpid);
319 for (w=0; w<ncpus; w++)
320 mc_awaitpid(w, mc_workers[w].pid);
322 for (w=0; w<ncpus; w++) {
324 LPRINTF("reading report from %2d",w);
325 ssize_t sr = preadv(fileno(mc_workers[w].results), mc_iov, mc_niovs, 0);
327 LPRINTF("got report from %2d",w);
333 static void multicore_check_for_new_best(void) {
334 if (!(mc_us || mc_am_generator))
339 ssize_t got = pread(mc_bus, &msg, sizeof(msg), mc_bus_read);
341 assert(got == sizeof(msg));
344 mc_bus_read += sizeof(msg);
348 static void multicore_found_new_best(void) {
352 if (mc_us /* might be master */) fprintf(stderr," w%-2d ",mc_us->w);
353 ssize_t wrote = write(mc_bus, &best, sizeof(best));
354 assert(wrote == sizeof(best));
357 /*----- end of multicore support -----*/
359 static AdjWord *xalloc_adjmatrix(void) {
360 return xmalloc(sizeof(*adjmatrix)*n);
363 static void prep(void) {
364 adjall = ~((~(AdjWord)0) << m);
365 adjmatrix = xalloc_adjmatrix();
366 glp_term_out(GLP_OFF);
368 weight = calloc(sizeof(*weight), m); assert(weight);
369 n_max_frags = INT_MAX;
370 m_max_frags = INT_MAX;
374 static AdjWord one_adj_bit(int bitnum) {
375 return (AdjWord)1 << bitnum;
379 static int count_set_adj_bits(AdjWord w) {
383 total += !!(w & jbit);
387 #define PRINTF(...) if (!doprint) ; else fprintf(stderr, __VA_ARGS__)
389 static int totalfrags;
391 static bool maxhamweight_ok(void) {
392 return maxhamweight <= m_max_frags;
395 static bool preconsider_ok(int nwords, bool doprint) {
398 PRINTF("%2d ", maxhamweight);
401 for (i=0, totalfrags=0; i<nwords; i++) {
402 int frags = count_set_adj_bits(adjmatrix[i]);
403 PRINTF("%"PRADJ" ", adjmatrix[i]);
404 if (frags > m_max_frags) {
408 had_max += (frags >= maxhamweight);
412 /* Skip this candidate as its max hamming weight is lower than
413 * we're currently looking for (which means we must have done it
414 * already). (The recursive iteration ensures that none of the
415 * words have more than the max hamming weight.) */
425 static void optimise(bool doprint) {
426 /* Consider the best answer (if any) for a given adjacency matrix */
432 * Up to a certain point, optimise() can be restarted. We use this
433 * to go back and print the debugging output if it turns out that we
434 * have an interesting case. The HAVE_PRINTED macro does this: its
435 * semantics are to go back in time and make sure that we have
436 * printed the description of the search case.
438 #define HAVE_PRINTED ({ \
439 if (!doprint) { doprint = 1; goto retry_with_print; } \
443 glp_delete_prob(prob);
447 bool ok = preconsider_ok(n, doprint);
452 * We formulate our problem as an LP problem as follows.
453 * In this file "n" and "m" are the matchstick numbers.
455 * Each set bit in the adjacency matrix corresponds to taking a
456 * fragment from old match i and making it part of new match j.
458 * The structural variables (columns) are:
459 * x_minimum minimum size of any fragment (bounded below by 0)
460 * x_morefrag_i_j the amount by which the size of the fragment
461 * i,j exceeds the minimum size (bounded below by 0)
463 * The auxiliary variables (rows) are:
464 * x_total_i total length for each input match (fixed variable)
465 * x_total_j total length for each output match (fixed variable)
467 * The objective function is simply
470 * We use X_ and Y_ to refer to GLPK's (1-based) column and row indices.
471 * ME_ refers to entries in the list of constraint matrix elements
472 * which we build up as we go.
475 prob = glp_create_prob();
477 int Y_totals_i = glp_add_rows(prob, n);
478 int Y_totals_j = glp_add_rows(prob, m);
479 int X_minimum = glp_add_cols(prob, 1);
482 int next_matrix_entry = 1; /* wtf GLPK! */
483 int matrix_entries_size = next_matrix_entry + n + m + totalfrags*2;
484 double matrix_entries[matrix_entries_size];
485 int matrix_entries_XY[2][matrix_entries_size];
487 #define ADD_MATRIX_ENTRY(Y,X) ({ \
488 assert(next_matrix_entry < matrix_entries_size); \
489 matrix_entries_XY[0][next_matrix_entry] = (X); \
490 matrix_entries_XY[1][next_matrix_entry] = (Y); \
491 matrix_entries[next_matrix_entry] = 0; \
492 next_matrix_entry++; \
495 int ME_totals_i__minimum = next_matrix_entry;
496 for (i=0; i<n; i++) ADD_MATRIX_ENTRY(Y_totals_i+i, X_minimum);
498 int ME_totals_j__minimum = next_matrix_entry;
499 for (j=0; j<m; j++) ADD_MATRIX_ENTRY(Y_totals_j+j, X_minimum);
501 /* \forall_i x_total_i = m */
502 /* \forall_i x_total_j = n */
503 for (i=0; i<n; i++) glp_set_row_bnds(prob, Y_totals_i+i, GLP_FX, m,m);
504 for (j=0; j<m; j++) glp_set_row_bnds(prob, Y_totals_j+j, GLP_FX, n,n);
507 glp_set_col_bnds(prob, X_minimum, GLP_LO, 0, 0);
508 glp_set_col_name(prob, X_minimum, "minimum");
510 /* objective is maximising x_minimum */
511 glp_set_obj_dir(prob, GLP_MAX);
512 glp_set_obj_coef(prob, X_minimum, 1);
514 for (i=0; i<n; i++) {
516 if (!(adjmatrix[i] & jbit))
518 /* x_total_i += x_minimum */
519 /* x_total_j += x_minimum */
520 matrix_entries[ ME_totals_i__minimum + i ] ++;
521 matrix_entries[ ME_totals_j__minimum + j ] ++;
523 /* x_morefrag_i_j >= 0 */
524 int X_morefrag_i_j = glp_add_cols(prob, 1);
525 glp_set_col_bnds(prob, X_morefrag_i_j, GLP_LO, 0, 0);
528 snprintf(buf,sizeof(buf),"mf %d,%d",i,j);
529 glp_set_col_name(prob, X_morefrag_i_j, buf);
532 /* x_total_i += x_morefrag_i_j */
533 /* x_total_j += x_morefrag_i_j */
534 int ME_totals_i__mf_i_j = ADD_MATRIX_ENTRY(Y_totals_i+i, X_morefrag_i_j);
535 int ME_totals_j__mf_i_j = ADD_MATRIX_ENTRY(Y_totals_j+j, X_morefrag_i_j);
536 matrix_entries[ME_totals_i__mf_i_j] = 1;
537 matrix_entries[ME_totals_j__mf_i_j] = 1;
541 assert(next_matrix_entry == matrix_entries_size);
543 glp_load_matrix(prob, matrix_entries_size-1,
544 matrix_entries_XY[1], matrix_entries_XY[0],
547 int r = glp_simplex(prob, NULL);
548 PRINTF(" glp=%d", r);
551 case e: PRINTF(" " #e ); goto out;
553 case e: HAVE_PRINTED; printf(" " #e " CRASHING\n"); exit(-1);
555 default: HAVE_PRINTED; printf(" ! CRASHING\n"); exit(-1);
575 r = glp_get_status(prob);
576 PRINTF(" status=%d", r);
588 double got = glp_get_obj_val(prob);
596 multicore_found_new_best();
598 if (best_prob) glp_delete_prob(best_prob);
601 free(best_adjmatrix);
602 best_adjmatrix = xalloc_adjmatrix();
603 memcpy(best_adjmatrix, adjmatrix, sizeof(*adjmatrix)*n);
611 glp_delete_prob(prob);
612 if (doprint) progress_eol();
613 if (doprint) multicore_check_for_new_best();
616 static void iterate_recurse(int i, AdjWord min) {
622 optimise(!(printcounter & 0xfff));
625 if (i >= multicore_iteration_boundary) {
626 multicore_outer_iteration(i, min);
629 for (adjmatrix[i] = min;
632 if (count_set_adj_bits(adjmatrix[i]) > maxhamweight)
634 if (i == 0 && (adjmatrix[i] & (1+adjmatrix[i])))
638 if (adjmatrix[i] & jbit)
640 for (int j = 0; j < m; j++)
641 if (weight[j] >= n_max_frags)
644 iterate_recurse(i+1, adjmatrix[i]);
648 if (adjmatrix[i] & jbit)
652 if (adjmatrix[i] == adjall)
657 static void iterate(void) {
658 for (maxhamweight=1; maxhamweight<=m; maxhamweight++) {
659 if (!maxhamweight_ok())
662 iterate_recurse(0, 1);
666 static void report(void) {
667 fprintf(stderr, "\n");
669 double min = glp_get_obj_val(best_prob);
672 for (i = 0; i < n; i++)
673 for (j = 0; j < m; j++)
675 cols = glp_get_num_cols(best_prob);
676 for (i = 1; i <= cols; i++) {
678 if (2 != sscanf(glp_get_col_name(best_prob, i), "mf %d,%d", &x, &y))
680 a[x][y] = min + glp_get_col_prim(best_prob, i);
682 printf("%d into %d: min fragment %g [%s]\n", n, m, min, VERSION);
683 for (i = 0; i < n; i++) {
684 for (j = 0; j < m; j++) {
686 printf(" %9.3f", a[i][j]);
693 if (ferror(stdout) || fclose(stdout)) { perror("stdout"); exit(-1); }
696 int main(int argc, char **argv) {
698 while ((opt = getopt(argc,argv,"j:")) >= 0) {
700 case 'j': ncpus = atoi(optarg); break;
701 case '+': assert(!"bad option");
713 if (ncpus) multicore();