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