Sanmill/include/config.h

/*
  Sanmill, a mill game playing engine derived from NineChess 1.5
  Copyright (C) 2015-2018 liuweilhy (NineChess author)
  Copyright (C) 2019-2020 Calcitem <calcitem@outlook.com>

  Sanmill is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  Sanmill is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef CONFIG_H
#define CONFIG_H

#include "debug.h"

#if _MSC_VER >= 1600
#pragma execution_character_set("utf-8")
#endif

#define QT_UI

//#define MOBILE_APP_UI

//#define TRAINING_MODE

//#define TEST_MODE

//#define UCT_DEMO

//#define PVS_AI
#define MTDF_AI

#ifdef TEST_MODE
#define DONOT_PLAY_SOUND
#endif // TEST_MODE

//#define DEBUG_MODE

#define DEFAULT_RULE_NUMBER 1

#define DEPTH_ADJUST (0)
//#define FIX_DEPTH   (24)

//#define NULL_MOVE

//#define FIRST_MOVE_STAR_PREFERRED

//#define TIME_STAT
//#define CYCLE_STAT

//#define SORT_MOVE_WITHOUT_HUMAN_KNOWLEDGES

#define TRANSPOSITION_TABLE_ENABLE

#ifdef TRANSPOSITION_TABLE_ENABLE
#define CLEAR_TRANSPOSITION_TABLE
#define TRANSPOSITION_TABLE_FAKE_CLEAN
//#define TRANSPOSITION_TABLE_FAKE_CLEAN_NOT_EXACT_ONLY
//#define TRANSPOSITION_TABLE_CUTDOWN
//#define TT_MOVE_ENABLE
//#define TRANSPOSITION_TABLE_DEBUG
#endif

//WIP
//#define HOSTORY_HEURISTIC

#ifdef HOSTORY_HEURISTIC
#define HOSTORY_HEURISTIC_ACTION_MOVE_ONLY
//#define HOSTORY_HEURISTIC_SCORE_HIGH_WHEN_DEEPER
#endif

#ifdef HOSTORY_HEURISTIC
//#define COMPARE_SCORE_ONLY
//#define COMPARE_RATING_PREFERRED
#define COMPARE_SCORE_PREFERRED
#else
//#define COMPARE_RATING_1ST_VALUE_2ND
//#define COMPARE_VALUE_1ST_RATING_2ND
#endif // HOSTORY_HEURISTIC

//#define DISABLE_PREFETCH

// WIP, Debugging only
//#define OPENING_BOOK

//#define ENDGAME_LEARNING
//#define ENDGAME_LEARNING_FORCE
//#define ENDGAME_LEARNING_DEBUG

#define THREEFOLD_REPETITION

//#define MESSAGEBOX_ENABLE

#ifdef DEBUG_MODE
#define DONOT_PLAY_SOUND
#endif

//#define DONOT_PLAY_SOUND

#ifdef DEBUG_MODE
#define PLAYER_DRAW_SEAT_NUMBER
#endif

#ifndef MOBILE_APP_UI
#define SAVE_GAMEBOOK_WHEN_ACTION_NEW_TRIGGERED
#endif

//#define DONOT_PLAY_WIN_SOUND

//#define GAME_PLACING_SHOW_REMOVED_PIECES

//#define SHOW_MAXIMIZED_ON_LOAD

#define DISABLE_HASHBUCKET

#define HASHMAP_NOLOCK

#ifdef WIN32
#define sscanf sscanf_s
#define sprintf sprintf_s
#endif

#ifndef  __GNUC__
#define __builtin_expect(expr, n)    (expr)
#endif

#define likely(expr)    (__builtin_expect(!!(expr), 1))
#define unlikely(expr)  (__builtin_expect(!!(expr), 0))

#endif // CONFIG_H
license: Change Licence to GPL 3.0 由 LGPL 协议切换为 GPL 协议. 2019-11-03 13:00:45 +08:00			`/*`
			`Sanmill, a mill game playing engine derived from NineChess 1.5`
			`Copyright (C) 2015-2018 liuweilhy (NineChess author)`
copyright: 更新版权年份为 2019-2020 2020-01-29 22:22:51 +08:00			`Copyright (C) 2019-2020 Calcitem <calcitem@outlook.com>`
license: Change Licence to GPL 3.0 由 LGPL 协议切换为 GPL 协议. 2019-11-03 13:00:45 +08:00
			`Sanmill is free software: you can redistribute it and/or modify`
			`it under the terms of the GNU General Public License as published by`
			`the Free Software Foundation, either version 3 of the License, or`
			`(at your option) any later version.`

			`Sanmill is distributed in the hope that it will be useful,`
			`but WITHOUT ANY WARRANTY; without even the implied warranty of`
			`MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the`
			`GNU General Public License for more details.`

			`You should have received a copy of the GNU General Public License`
			`along with this program. If not, see <http://www.gnu.org/licenses/>.`
			`*/`
增加版权声明文件头以及 LGPLv3 & GPLv3 协议本文 2019-07-28 02:40:49 +08:00
将 config.h 从 UTF-16 切换为 UTF-8 格式 2019-06-30 07:40:27 +08:00			`#ifndef CONFIG_H`
			`#define CONFIG_H`

将 QDebug 替换为自己定义的 loggerDebug 函数 2019-09-07 19:19:45 +08:00			`#include "debug.h"`

Qt 改为需 C++17 支持并消除部分 clang 警告 2019-08-11 14:26:36 +08:00			`#if _MSC_VER >= 1600`
			`#pragma execution_character_set("utf-8")`
			`#endif`

将原来的 main.c 改名为 qt/winmain.c 并增加新的 main.c 给 UCI 使用 2020-07-11 23:41:59 +08:00			`#define QT_UI`

AppUI: 修改为平面化风格参考: <<漫画设计配色方>> https://wenku.baidu.com/view/b762760fcaaedd3382c4d357.html 选取 "大胆" 的配色。修改使用 MOBILE_APP_UI 宏控制，目前未启用。 2019-08-26 22:33:27 +08:00			`//#define MOBILE_APP_UI`

trainer: 初步实现能走出第1步就停止了 2019-10-26 21:40:26 +08:00			`//#define TRAINING_MODE`

新增 TEST_MODE 宏开启时，启动后进入对引擎对战友好的默认配置 2019-12-13 22:42:07 +08:00			`//#define TEST_MODE`

mcts: 补充 cpp 文件启用 UCT_DEMO 宏时可以运行一个四子棋程序。只是添加四子棋 demo，暂未和原有 AI 结合。 2019-12-15 23:56:56 +08:00			`//#define UCT_DEMO`

pvs: 因单纯开 MTD(f) 略快故关闭 PVS 搜索 depth + 4 自对弈时长统计结果: Alpha-Beta Only: 186.062s PVS (win=1): 144s PVS (win=5): 137s MTDF (win=1): 126s PVS + MTDF (win=5): 95s MTDF (win=5): 93s 最快 2020-05-04 19:24:54 +08:00			`//#define PVS_AI`
mtdf/pvs: 启用MTD(f) 并把 PVS 和 MTD(f) 的窗口由极小窗口1调整为5 即调整为一个棋子的价值。修改后，自对弈棋谱不变，自对弈时长由8s缩短到6s以内。深度+4 测算，耗时缩短到原来的 69%。 2020-05-04 18:57:07 +08:00			`#define MTDF_AI`
mcts: 新增分段线性分布相关代码使用 MCTS_PLD 宏控制，暂不启用。若启用，棋力反而比均匀分布弱。 2020-03-06 00:17:10 +08:00
新增 TEST_MODE 宏开启时，启动后进入对引擎对战友好的默认配置 2019-12-13 22:42:07 +08:00			`#ifdef TEST_MODE`
			`#define DONOT_PLAY_SOUND`
			`#endif // TEST_MODE`

代码清理 2019-07-20 18:30:05 +08:00			`//#define DEBUG_MODE`
新增 RANDOM_MOVE 宏用于随机摆棋 (中圈和外圈等效，和未开启此宏时的细分表现暂时不统一) 程序效率下降 1/3 2019-07-10 01:00:06 +08:00
rule: 新增 DEFAULT_RULE_NUMBER 宏 2019-10-26 19:03:18 +08:00			`#define DEFAULT_RULE_NUMBER 1`

depth: 如果深度小于1则设置为1 为了调试需要, 新增 DEPTH_ADJUST 宏用于深度调整. 2019-11-03 17:43:27 +08:00			`#define DEPTH_ADJUST (0)`
depth: 如果定义了 FIX_DEPTH 宏则深度就定为这个宏的值 2020-03-20 01:10:49 +08:00			`//#define FIX_DEPTH (24)`
depth: 如果深度小于1则设置为1 为了调试需要, 新增 DEPTH_ADJUST 宏用于深度调整. 2019-11-03 17:43:27 +08:00
ai: 增加空着向前裁剪部分代码 (未完成) 宏未开启。 2020-05-01 01:19:04 +08:00			`//#define NULL_MOVE`

如果定义了 FIRST_MOVE_STAR_PREFERRED 则黑方首步强制走星位暂不开启，但是当前星位的 rating 值高所以通常还是走星位。 2020-03-20 22:20:57 +08:00			`//#define FIRST_MOVE_STAR_PREFERRED`

timestat: 增加 TIME_STAT 宏并默认关闭因 now() 函数较耗时. 关闭后自对弈时长恢复到 44-45s 左右. 2019-10-07 16:40:52 +08:00			`//#define TIME_STAT`
timestat: 增加 CYCLE_STAT 宏但仅为示例用故不启用 2019-11-10 12:36:31 +08:00			`//#define CYCLE_STAT`
timestat: 增加 TIME_STAT 宏并默认关闭因 now() 函数较耗时. 关闭后自对弈时长恢复到 44-45s 左右. 2019-10-07 16:40:52 +08:00
删除残留的 ALPHABETA_AI 宏并且把 SORT_MOVE_WITHT_HUMAN_KNOWLEDGES 改名为 SORT_MOVE_WITHOUT_HUMAN_KNOWLEDGES 并反向宏控制。 2020-09-29 18:21:10 +08:00			`//#define SORT_MOVE_WITHOUT_HUMAN_KNOWLEDGES`
摆棋阶段优先成三 (WIP) 2019-08-04 03:17:53 +08:00
refactor: 将部分哈希相关重命名为置换表相关名称 2019-09-09 00:19:02 +08:00			`#define TRANSPOSITION_TABLE_ENABLE`
最优招法随机选最优的两步其中一步 2019-07-04 00:12:05 +08:00
refactor: 将部分哈希相关重命名为置换表相关名称 2019-09-09 00:19:02 +08:00			`#ifdef TRANSPOSITION_TABLE_ENABLE`
			`#define CLEAR_TRANSPOSITION_TABLE`
ai: tt: 使用更新年龄机制来取代每次全部清空置换表 memset 大块内存效率较低, 故在哈希表中增加年龄纪录, 当年龄不一致时即认为哈希表项过时, 就更新它. 如果年龄一致则从中读取数据. 年龄增长到255时才清空一次置换表, 这样自对弈一盘棋只需要清2次. 修改使用 TRANSPOSITION_TABLE_FAKE_CLEAN 宏控制. 代价是会增加哈希表的体积, 空间换时间. 自对弈时长由 63s 缩短到 54s, 提速 15%. 2019-10-02 12:18:31 +08:00			`#define TRANSPOSITION_TABLE_FAKE_CLEAN`
TT: 增加 TRANSPOSITION_TABLE_FAKE_CLEAN_NOT_EXACT_ONLY 宏但不启用开启后，对于确切值的TT值，开始新的搜索前不会清除。 2020-05-13 00:46:36 +08:00			`//#define TRANSPOSITION_TABLE_FAKE_CLEAN_NOT_EXACT_ONLY`
tt: zobrist 值改为 MISC 位放在高8位并将置换表哈希改为64位禁用了 TRANSPOSITION_TABLE_CUTDOWN，内存占用由 272MB 升到 532 MB。在不改为64位 hash 的情况下，会改变自对弈棋谱。自对弈时长由32s缩短到25s。 2020-04-19 10:43:25 +08:00			`//#define TRANSPOSITION_TABLE_CUTDOWN`
BEST_MOVE_ENABLE 改为 TT_MOVE_ENABLE 并完善部分代码 (未完成) 目前在开启后，700盘自对弈显示速度为关闭时的 96.5%, 和关闭时对战600盘，胜率相差 0.8% 左右，可以认为相当。暂未开启此宏。 2020-05-03 13:16:30 +08:00			`//#define TT_MOVE_ENABLE`
refactor: 将部分哈希相关重命名为置换表相关名称 2019-09-09 00:19:02 +08:00			`//#define TRANSPOSITION_TABLE_DEBUG`
hash: 新增 HASH_MAP_DEBUG 宏可在需要时启用此宏相关代码尚未完善。 2019-08-18 12:40:06 +08:00			`#endif`
hash: 缩减哈希key由64位缩减到32位修改不影响自对弈结果。对速度影响基本没有变化。哈希表内存占用由512MB减少到384MB,缩减了128MB。总内存占用由572MB缩减到452MB。修改用 HASH_MAP_CUTDOWN 宏控制。 2019-08-13 23:28:18 +08:00
refactor: 清理代码包括暂时删除 MCTS 大部分代码。后续再加回来。 2020-05-09 00:17:27 +08:00			`//WIP`
hh: 实现历史启发实测效果不明显，暂不启用 2020-05-03 19:59:39 +08:00			`//#define HOSTORY_HEURISTIC`

			`#ifdef HOSTORY_HEURISTIC`
			`#define HOSTORY_HEURISTIC_ACTION_MOVE_ONLY`
			`//#define HOSTORY_HEURISTIC_SCORE_HIGH_WHEN_DEEPER`
			`#endif`

			`#ifdef HOSTORY_HEURISTIC`
			`//#define COMPARE_SCORE_ONLY`
			`//#define COMPARE_RATING_PREFERRED`
			`#define COMPARE_SCORE_PREFERRED`
			`#else`
depth: 白方第4步深度上调到18 顺带将 ai.ttMove 修正为 ai.nextMove() 并且多加了几个 nodeCompare 的策略但未启用。自对弈时长 10s 多。对比2000盘自对弈结果，速度为修改前的90%。自对弈棋谱改变，最后一着为 (2,7)->(2,6) 三次重复局面和棋。 2020-05-04 02:31:28 +08:00			`//#define COMPARE_RATING_1ST_VALUE_2ND`
			`//#define COMPARE_VALUE_1ST_RATING_2ND`
hh: 实现历史启发实测效果不明显，暂不启用 2020-05-03 19:59:39 +08:00			`#endif // HOSTORY_HEURISTIC`

config.h: PREFETCH_SUPPORT 宏改名为 DISABLE_PREFETCH 并反向宏控制。 2020-09-29 18:39:37 +08:00			`//#define DISABLE_PREFETCH`
prefetch: 增加置换表的预读取特性但暂不启用对于自对弈，因为局面模拟走下一步，入栈出栈花了7s时间，而 prefetch 预读置换表，节5s时间，总时间还是增加2s。故暂不启用。 2020-04-19 02:53:04 +08:00
openingbook: 新增开局库部分代码 (未完成) 2020-05-03 23:49:18 +08:00			`// WIP, Debugging only`
			`//#define OPENING_BOOK`

endgame: 关闭 ENDGAME_LEARNING 功能内存占用从 570MB 下降到 433MB. 因为 movingDiffDepthTable 的切换, 自对弈时长由 18s 缩短到 13s. 2019-10-29 00:30:29 +08:00			`//#define ENDGAME_LEARNING`
endgame: 若开启 ENDGAME_LEARNING_FORCE 宏，则不需要勾选菜单，就能生效残局库功能； 2019-12-23 00:26:02 +08:00			`//#define ENDGAME_LEARNING_FORCE`
			`//#define ENDGAME_LEARNING_DEBUG`
最优招法随机选最优的两步其中一步 2019-07-04 00:12:05 +08:00
出现三次重复局面判为和棋并添加和棋盘数显示 2019-07-27 02:44:24 +08:00			`#define THREEFOLD_REPETITION`

新增 MESSAGEBOX_ENABLE 宏用于控制棋局结束是否弹框提示 2019-07-29 22:58:40 +08:00			`//#define MESSAGEBOX_ENABLE`

代码清理 2019-07-20 18:30:05 +08:00			`#ifdef DEBUG_MODE`
Node结构体增加成员表征局面 2019-06-30 11:59:06 +08:00			`#define DONOT_PLAY_SOUND`
将 config.h 从 UTF-16 切换为 UTF-8 格式 2019-06-30 07:40:27 +08:00			`#endif`

最优招法随机选最优的两步其中一步 2019-07-04 00:12:05 +08:00			`//#define DONOT_PLAY_SOUND`
解决随机不生效的问题 2019-07-03 02:01:22 +08:00
代码清理 2019-07-20 18:30:05 +08:00			`#ifdef DEBUG_MODE`
refactor: 创建 board 和 rule 模块 * 将部分逻辑转移到这两个 class; * 创建了 types.h 将部分类型转移到此文件; * 将 millList 由 list 改为 vector, 否则容易出现段错误. 2019-09-08 15:15:21 +08:00			`#define PLAYER_DRAW_SEAT_NUMBER`
将 config.h 从 UTF-16 切换为 UTF-8 格式 2019-06-30 07:40:27 +08:00			`#endif`

AppUI: 重新开局时不保存棋谱文件 2019-08-27 13:52:08 +08:00			`#ifndef MOBILE_APP_UI`
refactor: Rename chess to game 2019-09-08 23:31:38 +08:00			`#define SAVE_GAMEBOOK_WHEN_ACTION_NEW_TRIGGERED`
AppUI: 重新开局时不保存棋谱文件 2019-08-27 13:52:08 +08:00			`#endif`
调整一些宏选项 2019-06-30 09:57:44 +08:00
refactor: 清理代码包括暂时删除 MCTS 大部分代码。后续再加回来。 2020-05-09 00:17:27 +08:00			`//#define DONOT_PLAY_WIN_SOUND`
调整一些宏选项 2019-06-30 09:57:44 +08:00
refactor: 部分变量和类型改名启用 ring_t 和 seat_t capture -> removePiece choose -> selectPiece 2020-05-10 22:58:22 +08:00			`//#define GAME_PLACING_SHOW_REMOVED_PIECES`
将 config.h 从 UTF-16 切换为 UTF-8 格式 2019-06-30 07:40:27 +08:00
			`//#define SHOW_MAXIMIZED_ON_LOAD`

目前HASH棋力弱存在Bug故关闭 2019-07-14 22:35:45 +08:00			`#define DISABLE_HASHBUCKET`
rule: refactor: 修改规则相关变量名提高可读性 2020-06-26 22:16:01 +08:00
perf: 哈希表不加锁去掉线程安全机制自对弈性能测试: 加锁: 2"93 = 213s 不加锁: 2"33 = 153s 提速 28%. 2019-09-14 23:51:41 +08:00			`#define HASHMAP_NOLOCK`
目前HASH棋力弱存在Bug故关闭 2019-07-14 22:35:45 +08:00
win32: 将 sscanf 用 sscanf_s 替代 2019-08-18 12:33:30 +08:00			`#ifdef WIN32`
			`#define sscanf sscanf_s`
Remove warnings (5) 2019-08-25 19:22:53 +08:00			`#define sprintf sprintf_s`
win32: 将 sscanf 用 sscanf_s 替代 2019-08-18 12:33:30 +08:00			`#endif`

[gnuc] A little bit Performance Enhancement 可能对cache命中率稍有提升 (MISS: 0.03%->0.01%) 实测无明显变化. 2019-10-11 02:02:45 +08:00			`#ifndef __GNUC__`
			`#define __builtin_expect(expr, n) (expr)`
			`#endif`

			`#define likely(expr) (__builtin_expect(!!(expr), 1))`
			`#define unlikely(expr) (__builtin_expect(!!(expr), 0))`

replace key_t to hash_t to fix GCC build error 2020-05-16 01:35:36 +08:00			`#endif // CONFIG_H`