Ticket #145: board.texi.patch

gnugo/doc/board.texi

@@ -71 +71 @@
 @group
 
 int           board_size;
-Intersection  board[MAXSIZE];
+Intersection  board[BOARDSIZE];
 int           board_ko_pos;
 
 float         komi;
 int           white_captured;
 int           black_captured;
 
-Hash_data     hashdata;
+Hash_data     board_hash;
 @end group
 @end example
 
-The description of the @code{Position} struct is applicable to these
+The description of the @code{board_state} struct is applicable to these
 variables also, so we won't duplicate it here.  All these variables are
 globals for performance reasons.  Behind these variables, there are a
 number of other private data structures.  These implement incremental
 handling of strings, liberties and other properties 
-(@pxref{Incremental Board}). The variable @code{hashdata} contains information
+(@pxref{Incremental Board}). The variable @code{board_hash} contains information
 about the hash value for the current position (@pxref{Hashing}).
 
 These variables should never be manipulated directly, since they are
@@ -181 +181 @@
 #define NS           (MAX_BOARD + 1)
 #define WE           1
 #define SOUTH(pos)   ((pos) + NS)
-#define WEST(pos)    ((pos) - 1)
+#define WEST(pos)    ((pos) - WE)
 #define NORTH(pos)   ((pos) - NS)
-#define EAST(pos)    ((pos) + 1)
+#define EAST(pos)    ((pos) + WE)
 @end example
 
 There are also shorthand macros @code{SW}, @code{NW}, @code{NE},
@@ -209 +209 @@
 often one computation is sufficient for 1D-coordinate where we would need
 two with two 2D-coordinates: If we, for example, want to have the
 coordinate of the upper right of @code{pos}, we can do this with
-@code{NORTH(EAST(pos))} instead of @code{(i+1, j-1)}.
+@code{NE(pos)} instead of @code{(i+1, j-1)}.
 
 @strong{Important}: The 2D coordinate @code{(-1,-1)}, which is used for
 pass and sometimes to indicate no point, maps to the 1D coordinate
@@ -219 +219 @@
 A loop over multiple directions is straightforwardly written:
 
 @example
-  for (k = 0; k < 4; k++) @{
+  for (k = 0; k < 4; ++k) @{
     int d = delta[k];
     do_something(pos + d);
   @}
@@ -240 +240 @@
 a point on the board. 
 
 Often one wants to traverse the board, carrying out some function
-at every vertex. Here are two possible ways of doing this:
+at every vertex. There is a macro for doing this:
 
 @example
-  int m, n;
-  for (m = 0; m < board_size; m++)
-    for (n = 0; n < board_size; n++) @{
-      do_something(POS(m, n));
-    @}
+#define scan_board(_pos_var, _code)
 @end example
 
-Or:
+The @code{_code} parameter is code to be run for each vertex and
+@code{_pos_var} is name of the variable, which will hold the 1D position
+on the board, to be used inside @code{_code}. @code{break} and
+@code{continue} can be used inside @code{_code} like inside @code{for}
+loop. @strong{Warning:} every variable
+declared inside @code{_code} must be declared separately or there will be
+compilation errors (eg. @code{int x; int y;} instead of @code{int x, y;}).
+Example:
 
 @example
-  int pos;
-  for (pos = BOARDMIN; pos < BOARDMAX; pos++) @{
-    if (ON_BOARD(pos))
-      do_something(pos);
-  @}
+
+int pos;
+
+scan_board(pos,
+  int x;
+  int y;
+  x = do_something_with(pos);
+  y = do_something_else_with(pos);
+)
+
 @end example