pattern.c

   1 #define DEBUG
   2 #include <assert.h>
   3 #include <ctype.h>
   4 #include <inttypes.h>
   5 #include <stdio.h>
   6 #include <stdlib.h>
   7
   8 #include "board.h"
   9 #include "debug.h"
  10 #include "pattern.h"
  11 #include "patternsp.h"
  12 #include "patternprob.h"
  13 #include "tactics/ladder.h"
  14 #include "tactics/selfatari.h"
  15 #include "tactics/util.h"
  16
  17 #define CAPTURE_COUNTSTONES_MAX ((1 << CAPTURE_COUNTSTONES_PAYLOAD_SIZE) - 1)
  18
  19
  20 struct pattern_config DEFAULT_PATTERN_CONFIG = {
  21         .bdist_max = 4,
  22
  23         .spat_min = 3, .spat_max = MAX_PATTERN_DIST,
  24         .spat_largest = true,
  25 };
  26
  27 #define PF_MATCH 15
  28
  29 pattern_spec PATTERN_SPEC_MATCH_DEFAULT = {
  30         [FEAT_CAPTURE] = ~0,
  31         [FEAT_AESCAPE] = ~0,
  32         [FEAT_SELFATARI] = ~0,
  33         [FEAT_ATARI] = ~0,
  34         [FEAT_BORDER] = ~0,
  35         [FEAT_CONTIGUITY] = 0,
  36         [FEAT_SPATIAL] = ~0,
  37 };
  38
  39 static const struct feature_info {
  40         char *name;
  41         int payloads;
  42 } features[FEAT_MAX] = {
  43         [FEAT_CAPTURE] = { .name = "capture", .payloads = 64 * (CAPTURE_COUNTSTONES_MAX + 1) },
  44         [FEAT_AESCAPE] = { .name = "atariescape", .payloads = 16 },
  45         [FEAT_SELFATARI] = { .name = "selfatari", .payloads = 4 },
  46         [FEAT_ATARI] = { .name = "atari", .payloads = 4 },
  47         [FEAT_BORDER] = { .name = "border", .payloads = -1 },
  48         [FEAT_CONTIGUITY] = { .name = "cont", .payloads = 2 },
  49         [FEAT_SPATIAL] = { .name = "s", .payloads = -1 },
  50 };
  51
  52 char *
  53 feature2str(char *str, struct feature *f)
  54 {
  55         return str + sprintf(str + strlen(str), "%s:%d", features[f->id].name, f->payload);
  56 }
  57
  58 char *
  59 str2feature(char *str, struct feature *f)
  60 {
  61         while (isspace(*str)) str++;
  62
  63         int unsigned flen = strcspn(str, ":");
  64         for (unsigned int i = 0; i < sizeof(features)/sizeof(features[0]); i++)
  65                 if (strlen(features[i].name) == flen && !strncmp(features[i].name, str, flen)) {
  66                         f->id = i;
  67                         goto found;
  68                 }
  69         fprintf(stderr, "invalid featurespec: %s[%d]\n", str, flen);
  70         exit(EXIT_FAILURE);
  71
  72 found:
  73         str += flen + 1;
  74         f->payload = strtoull(str, &str, 10);
  75         return str;
  76 }
  77
  78 char *
  79 feature_name(enum feature_id f)
  80 {
  81         return features[f].name;
  82 }
  83
  84 int
  85 feature_payloads(struct pattern_config *pc, enum feature_id f)
  86 {
  87         switch (f) {
  88                 case FEAT_SPATIAL:
  89                         assert(features[f].payloads < 0);
  90                         return pc->spat_dict->nspatials;
  91                 case FEAT_BORDER:
  92                         assert(features[f].payloads < 0);
  93                         return pc->bdist_max + 1;
  94                 default:
  95                         assert(features[f].payloads > 0);
  96                         return features[f].payloads;
  97         }
  98 }
  99
 100
 101 void
 102 patterns_init(struct pattern_setup *pat, char *arg, bool will_append, bool load_prob)
 103 {
 104         char *pdict_file = NULL;
 105
 106         memset(pat, 0, sizeof(*pat));
 107
 108         pat->pc = DEFAULT_PATTERN_CONFIG;
 109         pat->pc.spat_dict = spatial_dict_init(will_append, !load_prob);
 110
 111         memcpy(&pat->ps, PATTERN_SPEC_MATCH_DEFAULT, sizeof(pattern_spec));
 112
 113         if (arg) {
 114                 char *optspec, *next = arg;
 115                 while (*next) {
 116                         optspec = next;
 117                         next += strcspn(next, ":");
 118                         if (*next) { *next++ = 0; } else { *next = 0; }
 119
 120                         char *optname = optspec;
 121                         char *optval = strchr(optspec, '=');
 122                         if (optval) *optval++ = 0;
 123
 124                         /* See pattern.h:pattern_config for description and
 125                          * pattern.c:DEFAULT_PATTERN_CONFIG for default values
 126                          * of the following options. */
 127                         if (!strcasecmp(optname, "bdist_max") && optval) {
 128                                 pat->pc.bdist_max = atoi(optval);
 129                         } else if (!strcasecmp(optname, "spat_min") && optval) {
 130                                 pat->pc.spat_min = atoi(optval);
 131                         } else if (!strcasecmp(optname, "spat_max") && optval) {
 132                                 pat->pc.spat_max = atoi(optval);
 133                         } else if (!strcasecmp(optname, "spat_largest")) {
 134                                 pat->pc.spat_largest = !optval || atoi(optval);
 135
 136                         } else if (!strcasecmp(optname, "pdict_file") && optval) {
 137                                 pdict_file = optval;
 138
 139                         } else {
 140                                 fprintf(stderr, "patterns: Invalid argument %s or missing value\n", optname);
 141                                 exit(EXIT_FAILURE);
 142                         }
 143                 }
 144         }
 145
 146         if (load_prob && pat->pc.spat_dict) {
 147                 pat->pd = pattern_pdict_init(pdict_file, &pat->pc);
 148         }
 149 }
 150
 151
 152 /* pattern_spec helpers */
 153 #define PS_ANY(F) (ps[FEAT_ ## F] & (1 << PF_MATCH))
 154 #define PS_PF(F, P) (ps[FEAT_ ## F] & (1 << PF_ ## F ## _ ## P))
 155
 156 static struct feature *
 157 pattern_match_capture(struct pattern_config *pc, pattern_spec ps,
 158                       struct pattern *p, struct feature *f,
 159                       struct board *b, struct move *m)
 160 {
 161         f->id = FEAT_CAPTURE; f->payload = 0;
 162 #ifdef BOARD_TRAITS
 163         if (!trait_at(b, m->coord, m->color).cap)
 164                 return f;
 165         /* Capturable! */
 166         if ((ps[FEAT_CAPTURE] & ~(1<<PF_CAPTURE_1STONE | 1<<PF_CAPTURE_TRAPPED | 1<<PF_CAPTURE_CONNECTION)) == 1<<PF_MATCH) {
 167                 if (PS_PF(CAPTURE, 1STONE))
 168                         f->payload |= (trait_at(b, m->coord, m->color).cap1 == trait_at(b, m->coord, m->color).cap) << PF_CAPTURE_1STONE;
 169                 if (PS_PF(CAPTURE, TRAPPED))
 170                         f->payload |= (!trait_at(b, m->coord, stone_other(m->color)).safe) << PF_CAPTURE_TRAPPED;
 171                 if (PS_PF(CAPTURE, CONNECTION))
 172                         f->payload |= (trait_at(b, m->coord, m->color).cap < neighbor_count_at(b, m->coord, stone_other(m->color))) << PF_CAPTURE_CONNECTION;
 173                 (f++, p->n++);
 174                 return f;
 175         }
 176         /* We need to know details, so we still have to go through
 177          * the neighbors. */
 178 #endif
 179
 180         /* We look at neighboring groups we could capture, and also if the
 181          * opponent could save them. */
 182         /* This is very similar in spirit to board_safe_to_play(), and almost
 183          * a color inverse of pattern_match_aescape(). */
 184
 185         /* Whether an escape move would be safe for the opponent. */
 186         int captures = 0;
 187         coord_t onelib = -1;
 188         int extra_libs = 0, connectable_groups = 0;
 189         bool onestone = false, multistone = false;
 190         int captured_stones = 0;
 191
 192         foreach_neighbor(b, m->coord, {
 193                 if (board_at(b, c) != stone_other(m->color)) {
 194                         if (board_at(b, c) == S_NONE)
 195                                 extra_libs++; // free point
 196                         else if (board_at(b, c) == m->color && board_group_info(b, group_at(b, c)).libs == 1)
 197                                 extra_libs += 2; // capturable enemy group
 198                         continue;
 199                 }
 200
 201                 group_t g = group_at(b, c); assert(g);
 202                 if (board_group_info(b, g).libs > 1) {
 203                         connectable_groups++;
 204                         if (board_group_info(b, g).libs > 2) {
 205                                 extra_libs += 2; // connected out
 206                         } else {
 207                                 /* This is a bit tricky; we connect our 2-lib
 208                                  * group to another 2-lib group, which counts
 209                                  * as one liberty, but only if the other lib
 210                                  * is not shared too. */
 211                                 if (onelib == -1) {
 212                                         onelib = board_group_other_lib(b, g, c);
 213                                         extra_libs++;
 214                                 } else {
 215                                         if (c == onelib)
 216                                                 extra_libs--; // take that back
 217                                         else
 218                                                 extra_libs++;
 219                                 }
 220                         }
 221                         continue;
 222                 }
 223
 224                 /* Capture! */
 225                 captures++;
 226
 227                 if (PS_PF(CAPTURE, LADDER))
 228                         f->payload |= is_ladder(b, m->coord, g, true) << PF_CAPTURE_LADDER;
 229                 /* TODO: is_ladder() is too conservative in some
 230                  * very obvious situations, look at complete.gtp. */
 231
 232                 if (PS_PF(CAPTURE, ATARIDEF))
 233                 foreach_in_group(b, g) {
 234                         foreach_neighbor(b, c, {
 235                                 assert(board_at(b, c) != S_NONE || c == m->coord);
 236                                 if (board_at(b, c) != m->color)
 237                                         continue;
 238                                 group_t g = group_at(b, c);
 239                                 if (!g || board_group_info(b, g).libs != 1)
 240                                         continue;
 241                                 /* A neighboring group of ours is in atari. */
 242                                 f->payload |= 1 << PF_CAPTURE_ATARIDEF;
 243                         });
 244                 } foreach_in_group_end;
 245
 246                 if (PS_PF(CAPTURE, KO)
 247                     && group_is_onestone(b, g)
 248                     && neighbor_count_at(b, m->coord, stone_other(m->color))
 249                        + neighbor_count_at(b, m->coord, S_OFFBOARD) == 4)
 250                         f->payload |= 1 << PF_CAPTURE_KO;
 251
 252                 if (PS_PF(CAPTURE, COUNTSTONES)
 253                     && captured_stones < CAPTURE_COUNTSTONES_MAX)
 254                         captured_stones += group_stone_count(b, g, CAPTURE_COUNTSTONES_MAX - captured_stones);
 255
 256                 if (group_is_onestone(b, g))
 257                         onestone = true;
 258                 else
 259                         multistone = true;
 260         });
 261
 262         if (captures > 0) {
 263                 if (PS_PF(CAPTURE, 1STONE))
 264                         f->payload |= (onestone && !multistone) << PF_CAPTURE_1STONE;
 265                 if (PS_PF(CAPTURE, TRAPPED))
 266                         f->payload |= (extra_libs < 2) << PF_CAPTURE_TRAPPED;
 267                 if (PS_PF(CAPTURE, CONNECTION))
 268                         f->payload |= (connectable_groups > 0) << PF_CAPTURE_CONNECTION;
 269                 if (PS_PF(CAPTURE, COUNTSTONES))
 270                         f->payload |= captured_stones << PF_CAPTURE_COUNTSTONES;
 271                 (f++, p->n++);
 272         }
 273         return f;
 274 }
 275
 276 static struct feature *
 277 pattern_match_aescape(struct pattern_config *pc, pattern_spec ps,
 278                       struct pattern *p, struct feature *f,
 279                       struct board *b, struct move *m)
 280 {
 281         f->id = FEAT_AESCAPE; f->payload = 0;
 282 #ifdef BOARD_TRAITS
 283         if (!trait_at(b, m->coord, stone_other(m->color)).cap)
 284                 return f;
 285         /* Opponent can capture something! */
 286         if ((ps[FEAT_AESCAPE] & ~(1<<PF_AESCAPE_1STONE | 1<<PF_AESCAPE_TRAPPED | 1<<PF_AESCAPE_CONNECTION)) == 1<<PF_MATCH) {
 287                 if (PS_PF(AESCAPE, 1STONE))
 288                         f->payload |= (trait_at(b, m->coord, stone_other(m->color)).cap1 == trait_at(b, m->coord, stone_other(m->color)).cap) << PF_AESCAPE_1STONE;
 289                 if (PS_PF(AESCAPE, TRAPPED))
 290                         f->payload |= (!trait_at(b, m->coord, m->color).safe) << PF_AESCAPE_TRAPPED;
 291                 if (PS_PF(AESCAPE, CONNECTION))
 292                         f->payload |= (trait_at(b, m->coord, stone_other(m->color)).cap < neighbor_count_at(b, m->coord, m->color)) << PF_AESCAPE_CONNECTION;
 293                 (f++, p->n++);
 294                 return f;
 295         }
 296         /* We need to know details, so we still have to go through
 297          * the neighbors. */
 298 #endif
 299
 300         /* Find if a neighboring group of ours is in atari, AND that we provide
 301          * a liberty to connect out. XXX: No connect-and-die check. */
 302         /* This is very similar in spirit to board_safe_to_play(). */
 303         group_t in_atari = -1;
 304         coord_t onelib = -1;
 305         int extra_libs = 0, connectable_groups = 0;
 306         bool onestone = false, multistone = false;
 307
 308         foreach_neighbor(b, m->coord, {
 309                 if (board_at(b, c) != m->color) {
 310                         if (board_at(b, c) == S_NONE)
 311                                 extra_libs++; // free point
 312                         else if (board_at(b, c) == stone_other(m->color) && board_group_info(b, group_at(b, c)).libs == 1) {
 313                                 extra_libs += 2; // capturable enemy group
 314                                 /* XXX: We just consider this move safe
 315                                  * unconditionally. */
 316                         }
 317                         continue;
 318                 }
 319                 group_t g = group_at(b, c); assert(g);
 320                 if (board_group_info(b, g).libs > 1) {
 321                         connectable_groups++;
 322                         if (board_group_info(b, g).libs > 2) {
 323                                 extra_libs += 2; // connected out
 324                         } else {
 325                                 /* This is a bit tricky; we connect our 2-lib
 326                                  * group to another 2-lib group, which counts
 327                                  * as one liberty, but only if the other lib
 328                                  * is not shared too. */
 329                                 if (onelib == -1) {
 330                                         onelib = board_group_other_lib(b, g, c);
 331                                         extra_libs++;
 332                                 } else {
 333                                         if (c == onelib)
 334                                                 extra_libs--; // take that back
 335                                         else
 336                                                 extra_libs++;
 337                                 }
 338                         }
 339                         continue;
 340                 }
 341
 342                 /* In atari! */
 343                 in_atari = g;
 344
 345                 if (PS_PF(AESCAPE, LADDER))
 346                         f->payload |= is_ladder(b, m->coord, g, true) << PF_AESCAPE_LADDER;
 347                 /* TODO: is_ladder() is too conservative in some
 348                  * very obvious situations, look at complete.gtp. */
 349
 350                 if (group_is_onestone(b, g))
 351                         onestone = true;
 352                 else
 353                         multistone = true;
 354         });
 355
 356         if (in_atari >= 0) {
 357                 if (PS_PF(AESCAPE, 1STONE))
 358                         f->payload |= (onestone && !multistone) << PF_AESCAPE_1STONE;
 359                 if (PS_PF(AESCAPE, TRAPPED))
 360                         f->payload |= (extra_libs < 2) << PF_AESCAPE_TRAPPED;
 361                 if (PS_PF(AESCAPE, CONNECTION))
 362                         f->payload |= (connectable_groups > 0) << PF_AESCAPE_CONNECTION;
 363                 (f++, p->n++);
 364         }
 365         return f;
 366 }
 367
 368 static struct feature *
 369 pattern_match_atari(struct pattern_config *pc, pattern_spec ps,
 370                     struct pattern *p, struct feature *f,
 371                     struct board *b, struct move *m)
 372 {
 373         foreach_neighbor(b, m->coord, {
 374                 if (board_at(b, c) != stone_other(m->color))
 375                         continue;
 376                 group_t g = group_at(b, c);
 377                 if (!g || board_group_info(b, g).libs != 2)
 378                         continue;
 379
 380                 /* Can atari! */
 381                 f->id = FEAT_ATARI; f->payload = 0;
 382
 383                 if (PS_PF(ATARI, LADDER)) {
 384                         /* Opponent will escape by the other lib. */
 385                         coord_t lib = board_group_other_lib(b, g, m->coord);
 386                         /* TODO: is_ladder() is too conservative in some
 387                          * very obvious situations, look at complete.gtp. */
 388                         f->payload |= wouldbe_ladder(b, g, lib, m->coord, stone_other(m->color)) << PF_ATARI_LADDER;
 389                 }
 390
 391                 if (PS_PF(ATARI, KO) && !is_pass(b->ko.coord))
 392                         f->payload |= 1 << PF_ATARI_KO;
 393
 394                 (f++, p->n++);
 395         });
 396         return f;
 397 }
 398
 399 #ifndef BOARD_SPATHASH
 400 #undef BOARD_SPATHASH_MAXD
 401 #define BOARD_SPATHASH_MAXD 1
 402 #endif
 403
 404 /* Match spatial features that are too distant to be pre-matched
 405  * incrementally. */
 406 struct feature *
 407 pattern_match_spatial_outer(struct pattern_config *pc, pattern_spec ps,
 408                             struct pattern *p, struct feature *f,
 409                             struct board *b, struct move *m, hash_t h)
 410 {
 411         /* We record all spatial patterns black-to-play; simply
 412          * reverse all colors if we are white-to-play. */
 413         static enum stone bt_black[4] = { S_NONE, S_BLACK, S_WHITE, S_OFFBOARD };
 414         static enum stone bt_white[4] = { S_NONE, S_WHITE, S_BLACK, S_OFFBOARD };
 415         enum stone (*bt)[4] = m->color == S_WHITE ? &bt_white : &bt_black;
 416
 417         for (unsigned int d = BOARD_SPATHASH_MAXD + 1; d <= pc->spat_max; d++) {
 418                 /* Recompute missing outer circles:
 419                  * Go through all points in given distance. */
 420                 for (unsigned int j = ptind[d]; j < ptind[d + 1]; j++) {
 421                         ptcoords_at(x, y, m->coord, b, j);
 422                         h ^= pthashes[0][j][(*bt)[board_atxy(b, x, y)]];
 423                 }
 424                 if (d < pc->spat_min)
 425                         continue;
 426                 /* Record spatial feature, one per distance. */
 427                 unsigned int sid = spatial_dict_get(pc->spat_dict, d, h & spatial_hash_mask);
 428                 if (sid > 0) {
 429                         f->id = FEAT_SPATIAL;
 430                         f->payload = sid;
 431                         if (!pc->spat_largest)
 432                                 (f++, p->n++);
 433                 } /* else not found, ignore */
 434         }
 435         return f;
 436 }
 437
 438 struct feature *
 439 pattern_match_spatial(struct pattern_config *pc, pattern_spec ps,
 440                       struct pattern *p, struct feature *f,
 441                       struct board *b, struct move *m)
 442 {
 443         /* XXX: This is partially duplicated from spatial_from_board(), but
 444          * we build a hash instead of spatial record. */
 445
 446         assert(pc->spat_min > 0);
 447         f->id = -1;
 448
 449         hash_t h = pthashes[0][0][S_NONE];
 450 #ifdef BOARD_SPATHASH
 451         bool w_to_play = m->color == S_WHITE;
 452         for (int d = 2; d <= BOARD_SPATHASH_MAXD; d++) {
 453                 /* Reuse all incrementally matched data. */
 454                 h ^= b->spathash[m->coord][d - 1][w_to_play];
 455                 if (d < pc->spat_min)
 456                         continue;
 457                 /* Record spatial feature, one per distance. */
 458                 unsigned int sid = spatial_dict_get(pc->spat_dict, d, h & spatial_hash_mask);
 459                 if (sid > 0) {
 460                         f->id = FEAT_SPATIAL;
 461                         f->payload = sid;
 462                         if (!pc->spat_largest)
 463                                 (f++, p->n++);
 464                 } /* else not found, ignore */
 465         }
 466 #else
 467         assert(BOARD_SPATHASH_MAXD < 2);
 468 #endif
 469         if (unlikely(pc->spat_max > BOARD_SPATHASH_MAXD))
 470                 f = pattern_match_spatial_outer(pc, ps, p, f, b, m, h);
 471         if (pc->spat_largest && f->id == FEAT_SPATIAL)
 472                 (f++, p->n++);
 473         return f;
 474 }
 475
 476
 477 void
 478 pattern_match(struct pattern_config *pc, pattern_spec ps,
 479               struct pattern *p, struct board *b, struct move *m)
 480 {
 481         p->n = 0;
 482         struct feature *f = &p->f[0];
 483
 484         /* TODO: We should match pretty much all of these features
 485          * incrementally. */
 486
 487         if (PS_ANY(CAPTURE)) {
 488                 f = pattern_match_capture(pc, ps, p, f, b, m);
 489         }
 490
 491         if (PS_ANY(AESCAPE)) {
 492                 f = pattern_match_aescape(pc, ps, p, f, b, m);
 493         }
 494
 495         if (PS_ANY(SELFATARI)) {
 496                 bool simple = false;
 497                 if (PS_PF(SELFATARI, STUPID)) {
 498 #ifdef BOARD_TRAITS
 499                         if (!b->precise_selfatari)
 500                                 simple = !trait_at(b, m->coord, m->color).safe;
 501                         else
 502 #endif
 503                         simple = !board_safe_to_play(b, m->coord, m->color);
 504                 }
 505                 bool thorough = false;
 506                 if (PS_PF(SELFATARI, SMART)) {
 507 #ifdef BOARD_TRAITS
 508                         if (b->precise_selfatari)
 509                                 thorough = !trait_at(b, m->coord, m->color).safe;
 510                         else
 511 #endif
 512                         thorough = is_bad_selfatari(b, m->color, m->coord);
 513                 }
 514                 if (simple || thorough) {
 515                         f->id = FEAT_SELFATARI;
 516                         f->payload = simple << PF_SELFATARI_STUPID;
 517                         f->payload |= thorough << PF_SELFATARI_SMART;
 518                         (f++, p->n++);
 519                 }
 520         }
 521
 522         if (PS_ANY(ATARI)) {
 523                 f = pattern_match_atari(pc, ps, p, f, b, m);
 524         }
 525
 526         if (PS_ANY(BORDER)) {
 527                 unsigned int bdist = coord_edge_distance(m->coord, b);
 528                 if (bdist <= pc->bdist_max) {
 529                         f->id = FEAT_BORDER;
 530                         f->payload = bdist;
 531                         (f++, p->n++);
 532                 }
 533         }
 534
 535         if (PS_ANY(CONTIGUITY) && !is_pass(b->last_move.coord)
 536             && coord_is_8adjecent(m->coord, b->last_move.coord, b)) {
 537                 f->id = FEAT_CONTIGUITY;
 538                 f->payload = 1;
 539                 (f++, p->n++);
 540         }
 541
 542         if (PS_ANY(SPATIAL) && pc->spat_max > 0 && pc->spat_dict) {
 543                 f = pattern_match_spatial(pc, ps, p, f, b, m);
 544         }
 545 }
 546
 547 char *
 548 pattern2str(char *str, struct pattern *p)
 549 {
 550         str = stpcpy(str, "(");
 551         for (int i = 0; i < p->n; i++) {
 552                 if (i > 0) str = stpcpy(str, " ");
 553                 str = feature2str(str, &p->f[i]);
 554         }
 555         str = stpcpy(str, ")");
 556         return str;
 557 }
 558
 559 char *
 560 str2pattern(char *str, struct pattern *p)
 561 {
 562         p->n = 0;
 563         while (isspace(*str)) str++;
 564         if (*str++ != '(') {
 565                 fprintf(stderr, "invalid patternspec: %s\n", str);
 566                 exit(EXIT_FAILURE);
 567         }
 568
 569         while (*str != ')') {
 570                 str = str2feature(str, &p->f[p->n++]);
 571         }
 572
 573         str++;
 574         return str;
 575 }