UCT book -> tbook (tree book), added short explanation to HACKING
[pachi/json.git] / uct / internal.h
blob884e81400984c5bb9cda29710b615e0477db2193
1 #ifndef ZZGO_UCT_INTERNAL_H
2 #define ZZGO_UCT_INTERNAL_H
4 /* Internal UCT structures */
6 #include "debug.h"
7 #include "move.h"
8 #include "ownermap.h"
9 #include "playout.h"
10 #include "stats.h"
12 struct tree;
13 struct tree_node;
14 struct uct_policy;
15 struct uct_prior;
16 struct uct_dynkomi;
17 struct uct_pluginset;
18 struct joseki_dict;
20 /* How big proportion of ownermap counts must be of one color to consider
21 * the point sure. */
22 #define GJ_THRES 0.8
23 /* How many games to consider at minimum before judging groups. */
24 #define GJ_MINGAMES 500
26 /* Internal engine state. */
27 struct uct {
28 int debug_level;
29 int games, gamelen;
30 float resign_threshold, sure_win_threshold;
31 double best2_ratio, bestr_ratio;
32 bool pass_all_alive;
33 bool territory_scoring;
34 int expand_p;
35 bool playout_amaf, playout_amaf_nakade;
36 bool amaf_prior;
37 int playout_amaf_cutoff;
38 int dumpthres;
39 int force_seed;
40 bool no_tbook;
41 bool fast_alloc;
42 unsigned long max_tree_size;
43 unsigned long max_pruned_size;
44 unsigned long pruning_threshold;
45 int mercymin;
47 int threads;
48 enum uct_thread_model {
49 TM_TREE, /* Tree parallelization w/o virtual loss. */
50 TM_TREEVL, /* Tree parallelization with virtual loss. */
51 } thread_model;
52 bool virtual_loss;
53 bool pondering_opt; /* User wants pondering */
54 bool pondering; /* Actually pondering now */
55 bool slave; /* Act as slave in distributed engine. */
56 enum stone my_color;
58 int fuseki_end;
59 int yose_start;
61 int dynkomi_mask;
62 int dynkomi_interval;
63 struct uct_dynkomi *dynkomi;
65 float val_scale;
66 int val_points;
67 bool val_extra;
69 int random_policy_chance;
70 int local_tree;
71 int tenuki_d;
72 float local_tree_aging;
73 bool local_tree_allseq;
74 /* Playout-localtree integration. */
75 bool local_tree_playout; // can be true only if ELO playout
76 bool local_tree_pseqroot;
78 char *banner;
80 struct uct_policy *policy;
81 struct uct_policy *random_policy;
82 struct playout_policy *playout;
83 struct uct_prior *prior;
84 struct uct_pluginset *plugins;
85 struct joseki_dict *jdict;
87 /* Used within frame of single genmove. */
88 struct board_ownermap ownermap;
89 /* Used for coordination among slaves of the distributed engine. */
90 int stats_hbits;
91 int shared_nodes;
92 int shared_levels;
93 int played_own;
94 int played_all; /* games played by all slaves */
96 /* Game state - maintained by setup_state(), reset_state(). */
97 struct tree *t;
100 #define UDEBUGL(n) DEBUGL_(u->debug_level, n)
102 bool uct_pass_is_safe(struct uct *u, struct board *b, enum stone color, bool pass_all_alive);
104 void uct_prepare_move(struct uct *u, struct board *b, enum stone color);
105 void uct_genmove_setup(struct uct *u, struct board *b, enum stone color);
106 void uct_pondering_stop(struct uct *u);
109 /* This is the state used for descending the tree; we use this wrapper
110 * structure in order to be able to easily descend in multiple trees
111 * in parallel (e.g. main tree and local tree) or compute cummulative
112 * "path value" throughout the tree descent. */
113 struct uct_descent {
114 /* Active tree nodes: */
115 struct tree_node *node; /* Main tree. */
116 struct tree_node *lnode; /* Local tree. */
117 /* Value of main tree node (with all value factors, but unbiased
118 * - without exploration factor), from black's perspective. */
119 struct move_stats value;
123 typedef struct tree_node *(*uctp_choose)(struct uct_policy *p, struct tree_node *node, struct board *b, enum stone color, coord_t exclude);
124 typedef float (*uctp_evaluate)(struct uct_policy *p, struct tree *tree, struct uct_descent *descent, int parity);
125 typedef void (*uctp_descend)(struct uct_policy *p, struct tree *tree, struct uct_descent *descent, int parity, bool allow_pass);
126 typedef void (*uctp_winner)(struct uct_policy *p, struct tree *tree, struct uct_descent *descent);
127 typedef void (*uctp_prior)(struct uct_policy *p, struct tree *tree, struct tree_node *node, struct board *b, enum stone color, int parity);
128 typedef void (*uctp_update)(struct uct_policy *p, struct tree *tree, struct tree_node *node, enum stone node_color, enum stone player_color, struct playout_amafmap *amaf, float result);
130 struct uct_policy {
131 struct uct *uct;
132 uctp_choose choose;
133 uctp_winner winner;
134 uctp_evaluate evaluate;
135 uctp_descend descend;
136 uctp_update update;
137 uctp_prior prior;
138 bool wants_amaf;
139 void *data;
142 #endif