board_group_other_lib(): Introduce nifty helper
[pachi.git] / pattern.c
blobf732ba4105fec87211a641bb3be6ddc27b0ae6c2
1 #define DEBUG
2 #include <assert.h>
3 #include <ctype.h>
4 #include <inttypes.h>
5 #include <stdio.h>
6 #include <stdlib.h>
8 #include "board.h"
9 #include "debug.h"
10 #include "pattern.h"
11 #include "patternsp.h"
12 #include "pattern3.h"
13 #include "tactics.h"
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. */
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,
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,
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,
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 },
82 char *
83 feature2str(char *str, struct feature *f)
85 return str + sprintf(str + strlen(str), "%s:%d", features[f->id].name, f->payload);
88 char *
89 str2feature(char *str, struct feature *f)
91 while (isspace(*str)) str++;
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;
99 fprintf(stderr, "invalid featurespec: %s[%d]\n", str, flen);
100 exit(EXIT_FAILURE);
102 found:
103 str += flen + 1;
104 f->payload = strtoull(str, &str, 10);
105 return str;
108 char *
109 feature_name(enum feature_id f)
111 return features[f].name;
115 feature_payloads(struct pattern_config *pc, enum feature_id f)
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;
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))
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)
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 == trait_at(b, m->coord, m->color).cap) << PF_CAPTURE_1STONE;
155 if (PS_PF(CAPTURE, TRAPPED))
156 f->payload |= (!trait_at(b, m->coord, stone_other(m->color)).safe) << PF_CAPTURE_TRAPPED;
157 (f++, p->n++);
158 return f;
160 /* We need to know details, so we still have to go through
161 * the neighbors. */
162 #endif
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 */
168 /* Whether an escape move would be safe for the opponent. */
169 int captures = 0;
170 bool can_escape = false;
171 bool onestone = false, multistone = false;
173 foreach_neighbor(b, m->coord, {
174 if (board_at(b, c) != stone_other(m->color)) {
175 if (board_at(b, c) == S_NONE)
176 can_escape = true; // free point
177 else if (board_at(b, c) == m->color && board_group_info(b, group_at(b, c)).libs == 1)
178 can_escape = true; // capturable our group
179 continue;
182 group_t g = group_at(b, c); assert(g);
183 if (board_group_info(b, g).libs != 1) {
184 can_escape = true;
185 continue;
188 /* Capture! */
189 captures++;
191 if (PS_PF(CAPTURE, LADDER))
192 f->payload |= is_ladder(b, m->coord, g, true, true) << PF_CAPTURE_LADDER;
193 /* TODO: is_ladder() is too conservative in some
194 * very obvious situations, look at complete.gtp. */
196 /* TODO: PF_CAPTURE_RECAPTURE */
198 if (PS_PF(CAPTURE, ATARIDEF))
199 foreach_in_group(b, g) {
200 foreach_neighbor(b, c, {
201 assert(board_at(b, c) != S_NONE || c == m->coord);
202 if (board_at(b, c) != m->color)
203 continue;
204 group_t g = group_at(b, c);
205 if (!g || board_group_info(b, g).libs != 1)
206 continue;
207 /* A neighboring group of ours is in atari. */
208 f->payload |= 1 << PF_CAPTURE_ATARIDEF;
210 } foreach_in_group_end;
212 if (PS_PF(CAPTURE, KO)
213 && group_is_onestone(b, g)
214 && neighbor_count_at(b, m->coord, stone_other(m->color))
215 + neighbor_count_at(b, m->coord, S_OFFBOARD) == 4)
216 f->payload |= 1 << PF_CAPTURE_KO;
218 if (group_is_onestone(b, g))
219 onestone = true;
220 else
221 multistone = true;
224 if (captures > 0) {
225 if (PS_PF(CAPTURE, 1STONE))
226 f->payload |= (onestone && !multistone) << PF_CAPTURE_1STONE;
227 if (PS_PF(CAPTURE, TRAPPED))
228 f->payload |= (!can_escape) << PF_CAPTURE_TRAPPED;
229 (f++, p->n++);
231 return f;
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)
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 == trait_at(b, m->coord, stone_other(m->color)).cap) << 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;
252 /* We need to know details, so we still have to go through
253 * the neighbors. */
254 #endif
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 bool onestone = false, multistone = false;
262 foreach_neighbor(b, m->coord, {
263 if (board_at(b, c) != m->color) {
264 if (board_at(b, c) == S_NONE)
265 has_extra_lib = true; // free point
266 else if (board_at(b, c) == stone_other(m->color) && board_group_info(b, group_at(b, c)).libs == 1)
267 has_extra_lib = true; // capturable enemy group
268 continue;
270 group_t g = group_at(b, c); assert(g);
271 if (board_group_info(b, g).libs != 1) {
272 has_extra_lib = true;
273 continue;
276 /* In atari! */
277 in_atari = g;
279 if (PS_PF(AESCAPE, LADDER))
280 f->payload |= is_ladder(b, m->coord, g, true, true) << PF_AESCAPE_LADDER;
281 /* TODO: is_ladder() is too conservative in some
282 * very obvious situations, look at complete.gtp. */
284 if (group_is_onestone(b, g))
285 onestone = true;
286 else
287 multistone = true;
290 if (in_atari >= 0) {
291 if (PS_PF(AESCAPE, 1STONE))
292 f->payload |= (onestone && !multistone) << PF_AESCAPE_1STONE;
293 if (PS_PF(AESCAPE, TRAPPED))
294 f->payload |= (!has_extra_lib) << PF_AESCAPE_TRAPPED;
295 (f++, p->n++);
297 return f;
300 static struct feature *
301 pattern_match_atari(struct pattern_config *pc, pattern_spec ps,
302 struct pattern *p, struct feature *f,
303 struct board *b, struct move *m)
305 foreach_neighbor(b, m->coord, {
306 if (board_at(b, c) != stone_other(m->color))
307 continue;
308 group_t g = group_at(b, c);
309 if (!g || board_group_info(b, g).libs != 2)
310 continue;
312 /* Can atari! */
313 f->id = FEAT_ATARI; f->payload = 0;
315 if (PS_PF(ATARI, LADDER)) {
316 /* Opponent will escape by the other lib. */
317 coord_t lib = board_group_other_lib(b, g, m->coord);
318 /* TODO: is_ladder() is too conservative in some
319 * very obvious situations, look at complete.gtp. */
320 f->payload |= is_ladder(b, lib, g, true, true) << PF_ATARI_LADDER;
323 if (PS_PF(ATARI, KO) && !is_pass(b->ko.coord))
324 f->payload |= 1 << PF_ATARI_KO;
326 (f++, p->n++);
328 return f;
331 #ifndef BOARD_SPATHASH
332 #undef BOARD_SPATHASH_MAXD
333 #define BOARD_SPATHASH_MAXD 1
334 #endif
336 /* Match spatial features that are too distant to be pre-matched
337 * incrementally. */
338 struct feature *
339 pattern_match_spatial_outer(struct pattern_config *pc, pattern_spec ps,
340 struct pattern *p, struct feature *f,
341 struct board *b, struct move *m, hash_t h)
343 /* We record all spatial patterns black-to-play; simply
344 * reverse all colors if we are white-to-play. */
345 static enum stone bt_black[4] = { S_NONE, S_BLACK, S_WHITE, S_OFFBOARD };
346 static enum stone bt_white[4] = { S_NONE, S_WHITE, S_BLACK, S_OFFBOARD };
347 enum stone (*bt)[4] = m->color == S_WHITE ? &bt_white : &bt_black;
349 for (int d = BOARD_SPATHASH_MAXD + 1; d <= pc->spat_max; d++) {
350 /* Recompute missing outer circles:
351 * Go through all points in given distance. */
352 for (int j = ptind[d]; j < ptind[d + 1]; j++) {
353 ptcoords_at(x, y, m->coord, b, j);
354 h ^= pthashes[0][j][(*bt)[board_atxy(b, x, y)]];
356 if (d < pc->spat_min)
357 continue;
358 /* Record spatial feature, one per distance. */
359 int sid = spatial_dict_get(pc->spat_dict, d, h & spatial_hash_mask);
360 if (sid > 0) {
361 f->id = FEAT_SPATIAL;
362 f->payload = sid;
363 (f++, p->n++);
364 } /* else not found, ignore */
366 return f;
369 struct feature *
370 pattern_match_spatial(struct pattern_config *pc, pattern_spec ps,
371 struct pattern *p, struct feature *f,
372 struct board *b, struct move *m)
374 /* XXX: This is partially duplicated from spatial_from_board(), but
375 * we build a hash instead of spatial record. */
377 assert(pc->spat_min > 0);
379 hash_t h = pthashes[0][0][S_NONE];
380 #ifdef BOARD_SPATHASH
381 bool w_to_play = m->color == S_WHITE;
382 for (int d = 2; d <= BOARD_SPATHASH_MAXD; d++) {
383 /* Reuse all incrementally matched data. */
384 h ^= b->spathash[m->coord][d - 1][w_to_play];
385 if (d < pc->spat_min)
386 continue;
387 /* Record spatial feature, one per distance. */
388 int sid = spatial_dict_get(pc->spat_dict, d, h & spatial_hash_mask);
389 if (sid > 0) {
390 f->id = FEAT_SPATIAL;
391 f->payload = sid;
392 (f++, p->n++);
393 } /* else not found, ignore */
395 #else
396 assert(BOARD_SPATHASH_MAXD < 2);
397 #endif
398 if (unlikely(pc->spat_max > BOARD_SPATHASH_MAXD))
399 f = pattern_match_spatial_outer(pc, ps, p, f, b, m, h);
400 return f;
404 void
405 pattern_match(struct pattern_config *pc, pattern_spec ps,
406 struct pattern *p, struct board *b, struct move *m)
408 p->n = 0;
409 struct feature *f = &p->f[0];
411 /* TODO: We should match pretty much all of these features
412 * incrementally. */
414 if (is_pass(m->coord)) {
415 if (PS_ANY(PASS)) {
416 f->id = FEAT_PASS; f->payload = 0;
417 if (PS_PF(PASS, LASTPASS))
418 f->payload |= (b->moves > 0 && is_pass(b->last_move.coord))
419 << PF_PASS_LASTPASS;
420 p->n++;
422 return;
425 if (PS_ANY(CAPTURE)) {
426 f = pattern_match_capture(pc, ps, p, f, b, m);
429 if (PS_ANY(AESCAPE)) {
430 f = pattern_match_aescape(pc, ps, p, f, b, m);
433 if (PS_ANY(SELFATARI)) {
434 bool simple = false;
435 if (PS_PF(SELFATARI, STUPID)) {
436 #ifdef BOARD_TRAITS
437 if (!b->precise_selfatari)
438 simple = !trait_at(b, m->coord, m->color).safe;
439 else
440 #endif
441 simple = !board_safe_to_play(b, m->coord, m->color);
443 bool thorough = false;
444 if (PS_PF(SELFATARI, SMART)) {
445 #ifdef BOARD_TRAITS
446 if (b->precise_selfatari)
447 thorough = !trait_at(b, m->coord, m->color).safe;
448 else
449 #endif
450 thorough = is_bad_selfatari(b, m->color, m->coord);
452 if (simple || thorough) {
453 f->id = FEAT_SELFATARI;
454 f->payload = simple << PF_SELFATARI_STUPID;
455 f->payload |= thorough << PF_SELFATARI_SMART;
456 (f++, p->n++);
460 if (PS_ANY(ATARI)) {
461 f = pattern_match_atari(pc, ps, p, f, b, m);
464 if (PS_ANY(BORDER)) {
465 int bdist = coord_edge_distance(m->coord, b);
466 if (bdist <= pc->bdist_max) {
467 f->id = FEAT_BORDER;
468 f->payload = bdist;
469 (f++, p->n++);
473 if (PS_ANY(CONTIGUITY) && !is_pass(b->last_move.coord)
474 && coord_is_8adjecent(m->coord, b->last_move.coord, b)) {
475 f->id = FEAT_CONTIGUITY;
476 f->payload = 1;
477 (f++, p->n++);
480 if (PS_ANY(LDIST) && pc->ldist_max > 0 && !is_pass(b->last_move.coord)) {
481 int ldist = coord_gridcular_distance(m->coord, b->last_move.coord, b);
482 if (pc->ldist_min <= ldist && ldist <= pc->ldist_max) {
483 f->id = FEAT_LDIST;
484 f->payload = ldist;
485 (f++, p->n++);
489 if (PS_ANY(LLDIST) && pc->ldist_max > 0 && !is_pass(b->last_move2.coord)) {
490 int lldist = coord_gridcular_distance(m->coord, b->last_move2.coord, b);
491 if (pc->ldist_min <= lldist && lldist <= pc->ldist_max) {
492 f->id = FEAT_LLDIST;
493 f->payload = lldist;
494 (f++, p->n++);
498 if (PS_ANY(SPATIAL) && pc->spat_max > 0 && pc->spat_dict) {
499 f = pattern_match_spatial(pc, ps, p, f, b, m);
502 if (PS_ANY(PATTERN3) && !is_pass(m->coord)) {
503 #ifdef BOARD_PAT3
504 hash3_t pat = b->pat3[m->coord];
505 #else
506 hash3_t pat = pattern3_hash(b, m->coord);
507 #endif
508 if (m->color == S_WHITE) {
509 /* We work with the pattern3s as black-to-play. */
510 pat = pattern3_reverse(pat);
512 f->id = FEAT_PATTERN3;
513 f->payload = pat;
514 (f++, p->n++);
517 /* FEAT_MCOWNER: TODO */
518 assert(!pc->mcsims);
521 char *
522 pattern2str(char *str, struct pattern *p)
524 str = stpcpy(str, "(");
525 for (int i = 0; i < p->n; i++) {
526 if (i > 0) str = stpcpy(str, " ");
527 str = feature2str(str, &p->f[i]);
529 str = stpcpy(str, ")");
530 return str;
535 /*** Features gamma set */
537 static void
538 features_gamma_load(struct features_gamma *fg, const char *filename)
540 FILE *f = fopen(filename, "r");
541 if (!f) return;
542 char buf[256];
543 while (fgets(buf, 256, f)) {
544 char *bufp = buf;
545 struct feature f;
546 bufp = str2feature(bufp, &f);
547 while (isspace(*bufp)) bufp++;
548 double gamma = strtod(bufp, &bufp);
549 /* Record feature's gamma. */
550 feature_gamma(fg, &f, &gamma);
551 /* In case of 3x3 patterns, record gamma also
552 * for all rotations and transpositions. */
553 if (f.id == FEAT_PATTERN3) {
554 hash3_t transp[8];
555 pattern3_transpose(f.payload, &transp);
556 for (int i = 1; i < 8; i++) {
557 f.payload = transp[i];
558 feature_gamma(fg, &f, &gamma);
560 f.payload = transp[0];
563 fclose(f);
566 const char *features_gamma_filename = "patterns.gamma";
568 struct features_gamma *
569 features_gamma_init(struct pattern_config *pc, const char *file)
571 struct features_gamma *fg = calloc2(1, sizeof(*fg));
572 fg->pc = pc;
573 for (int i = 0; i < FEAT_MAX; i++) {
574 int n = feature_payloads(pc, i);
575 fg->gamma[i] = malloc2(n * sizeof(fg->gamma[0][0]));
576 for (int j = 0; j < n; j++) {
577 fg->gamma[i][j] = 1.0f;
580 features_gamma_load(fg, file ? file : features_gamma_filename);
581 return fg;
584 void
585 features_gamma_done(struct features_gamma *fg)
587 for (int i = 0; i < FEAT_MAX; i++)
588 free(fg->gamma[i]);
589 free(fg);