Improve comments in UCI
authorMarco Costalba <mcostalba@gmail.com>
Sun, 14 Dec 2014 08:31:13 +0000 (09:31 +0100)
committerJoona Kiiski <joona.kiiski@gmail.com>
Sun, 14 Dec 2014 23:50:33 +0000 (23:50 +0000)
And simplify naming while there.

No functional change.

Resolves #159

src/position.cpp
src/search.cpp
src/uci.cpp
src/uci.h

index 5f5bb5a..eed6d88 100644 (file)
@@ -123,7 +123,7 @@ std::ostream& operator<<(std::ostream& os, const Position& pos) {
      << std::setfill('0') << std::setw(16) << pos.st->key << std::dec << "\nCheckers: ";
 
   for (Bitboard b = pos.checkers(); b; )
      << std::setfill('0') << std::setw(16) << pos.st->key << std::dec << "\nCheckers: ";
 
   for (Bitboard b = pos.checkers(); b; )
-      os << UCI::format_square(pop_lsb(&b)) << " ";
+      os << UCI::square(pop_lsb(&b)) << " ";
 
   return os;
 }
 
   return os;
 }
@@ -444,7 +444,7 @@ const string Position::fen() const {
   if (!can_castle(WHITE) && !can_castle(BLACK))
       ss << '-';
 
   if (!can_castle(WHITE) && !can_castle(BLACK))
       ss << '-';
 
-  ss << (ep_square() == SQ_NONE ? " - " : " " + UCI::format_square(ep_square()) + " ")
+  ss << (ep_square() == SQ_NONE ? " - " : " " + UCI::square(ep_square()) + " ")
      << st->rule50 << " " << 1 + (gamePly - (sideToMove == BLACK)) / 2;
 
   return ss.str();
      << st->rule50 << " " << 1 + (gamePly - (sideToMove == BLACK)) / 2;
 
   return ss.str();
index 272634d..d4a7dab 100644 (file)
@@ -179,7 +179,7 @@ uint64_t Search::perft(Position& pos, Depth depth) {
           pos.undo_move(*it);
       }
       if (Root)
           pos.undo_move(*it);
       }
       if (Root)
-          sync_cout << UCI::format_move(*it, pos.is_chess960()) << ": " << cnt << sync_endl;
+          sync_cout << UCI::move(*it, pos.is_chess960()) << ": " << cnt << sync_endl;
   }
   return nodes;
 }
   }
   return nodes;
 }
@@ -216,7 +216,7 @@ void Search::think() {
   {
       RootMoves.push_back(MOVE_NONE);
       sync_cout << "info depth 0 score "
   {
       RootMoves.push_back(MOVE_NONE);
       sync_cout << "info depth 0 score "
-                << UCI::format_value(RootPos.checkers() ? -VALUE_MATE : VALUE_DRAW)
+                << UCI::value(RootPos.checkers() ? -VALUE_MATE : VALUE_DRAW)
                 << sync_endl;
   }
   else
                 << sync_endl;
   }
   else
@@ -274,10 +274,10 @@ void Search::think() {
       RootPos.this_thread()->wait_for(Signals.stop);
   }
 
       RootPos.this_thread()->wait_for(Signals.stop);
   }
 
-  sync_cout << "bestmove " << UCI::format_move(RootMoves[0].pv[0], RootPos.is_chess960());
+  sync_cout << "bestmove " << UCI::move(RootMoves[0].pv[0], RootPos.is_chess960());
 
   if (RootMoves[0].pv.size() > 1)
 
   if (RootMoves[0].pv.size() > 1)
-      std::cout << " ponder " << UCI::format_move(RootMoves[0].pv[1], RootPos.is_chess960());
+      std::cout << " ponder " << UCI::move(RootMoves[0].pv[1], RootPos.is_chess960());
 
   std::cout << sync_endl;
 }
 
   std::cout << sync_endl;
 }
@@ -783,7 +783,7 @@ moves_loop: // When in check and at SpNode search starts from here
 
           if (thisThread == Threads.main() && Time::now() - SearchTime > 3000)
               sync_cout << "info depth " << depth / ONE_PLY
 
           if (thisThread == Threads.main() && Time::now() - SearchTime > 3000)
               sync_cout << "info depth " << depth / ONE_PLY
-                        << " currmove " << UCI::format_move(move, pos.is_chess960())
+                        << " currmove " << UCI::move(move, pos.is_chess960())
                         << " currmovenumber " << moveCount + PVIdx << sync_endl;
       }
 
                         << " currmovenumber " << moveCount + PVIdx << sync_endl;
       }
 
@@ -1446,7 +1446,7 @@ moves_loop: // When in check and at SpNode search starts from here
         ss << "info depth " << d / ONE_PLY
            << " seldepth "  << selDepth
            << " multipv "   << i + 1
         ss << "info depth " << d / ONE_PLY
            << " seldepth "  << selDepth
            << " multipv "   << i + 1
-           << " score "     << ((!tb && i == PVIdx) ? UCI::format_value(v, alpha, beta) : UCI::format_value(v))
+           << " score "     << ((!tb && i == PVIdx) ? UCI::value(v, alpha, beta) : UCI::value(v))
            << " nodes "     << pos.nodes_searched()
            << " nps "       << pos.nodes_searched() * 1000 / elapsed
            << " tbhits "    << TB::Hits
            << " nodes "     << pos.nodes_searched()
            << " nps "       << pos.nodes_searched() * 1000 / elapsed
            << " tbhits "    << TB::Hits
@@ -1454,7 +1454,7 @@ moves_loop: // When in check and at SpNode search starts from here
            << " pv";
 
         for (size_t j = 0; j < RootMoves[i].pv.size(); ++j)
            << " pv";
 
         for (size_t j = 0; j < RootMoves[i].pv.size(); ++j)
-            ss << " " << UCI::format_move(RootMoves[i].pv[j], pos.is_chess960());
+            ss << " " << UCI::move(RootMoves[i].pv[j], pos.is_chess960());
     }
 
     return ss.str();
     }
 
     return ss.str();
index 876bb1d..8178f1c 100644 (file)
@@ -216,14 +216,14 @@ void UCI::loop(int argc, char* argv[]) {
 }
 
 
 }
 
 
-/// format_value() converts a Value to a string suitable for use with the UCI
-/// protocol specifications:
+/// Convert a Value to a string suitable for use with the UCI protocol
+/// specifications:
 ///
 /// cp <x>     The score from the engine's point of view in centipawns.
 /// mate <y>   Mate in y moves, not plies. If the engine is getting mated
 ///            use negative values for y.
 
 ///
 /// cp <x>     The score from the engine's point of view in centipawns.
 /// mate <y>   Mate in y moves, not plies. If the engine is getting mated
 ///            use negative values for y.
 
-string UCI::format_value(Value v, Value alpha, Value beta) {
+string UCI::value(Value v, Value alpha, Value beta) {
 
   stringstream ss;
 
 
   stringstream ss;
 
@@ -238,22 +238,21 @@ string UCI::format_value(Value v, Value alpha, Value beta) {
 }
 
 
 }
 
 
-/// format_square() converts a Square to a string (g1, a7, etc.)
+/// Convert a Square to a string in algebraic notation (g1, a7, etc.)
 
 
-std::string UCI::format_square(Square s) {
+std::string UCI::square(Square s) {
 
 
-  char ch[] = { char('a' + file_of(s)),
-                char('1' + rank_of(s)), 0 }; // Zero-terminating
-  return ch;
+  char sq[] = { char('a' + file_of(s)), char('1' + rank_of(s)), 0 };
+  return sq;
 }
 
 
 }
 
 
-/// format_move() converts a Move to a string in coordinate notation
-/// (g1f3, a7a8q, etc.). The only special case is castling moves, where we print
-/// in the e1g1 notation in normal chess mode, and in e1h1 notation in chess960
-/// mode. Internally castling moves are always encoded as "king captures rook".
+/// Convert a Move to a string in pure coordinate notation (g1f3, a7a8q). The
+/// only special case is castling moves, where we print in the e1g1 notation in
+/// normal chess mode, and in e1h1 notation in chess960 mode. Internally
+/// castling moves are always encoded as "king captures rook".
 
 
-string UCI::format_move(Move m, bool chess960) {
+string UCI::move(Move m, bool chess960) {
 
   Square from = from_sq(m);
   Square to = to_sq(m);
 
   Square from = from_sq(m);
   Square to = to_sq(m);
@@ -267,7 +266,7 @@ string UCI::format_move(Move m, bool chess960) {
   if (type_of(m) == CASTLING && !chess960)
       to = make_square(to > from ? FILE_G : FILE_C, rank_of(from));
 
   if (type_of(m) == CASTLING && !chess960)
       to = make_square(to > from ? FILE_G : FILE_C, rank_of(from));
 
-  string move = format_square(from) + format_square(to);
+  string move = UCI::square(from) + UCI::square(to);
 
   if (type_of(m) == PROMOTION)
       move += " pnbrqk"[promotion_type(m)];
 
   if (type_of(m) == PROMOTION)
       move += " pnbrqk"[promotion_type(m)];
@@ -276,8 +275,8 @@ string UCI::format_move(Move m, bool chess960) {
 }
 
 
 }
 
 
-/// to_move() takes a position and a string representing a move in
-/// simple coordinate notation and returns an equivalent legal Move if any.
+/// Convert a string representing a move in pure coordinate notation to the
+/// corresponding legal Move, if any.
 
 Move UCI::to_move(const Position& pos, string& str) {
 
 
 Move UCI::to_move(const Position& pos, string& str) {
 
@@ -285,7 +284,7 @@ Move UCI::to_move(const Position& pos, string& str) {
       str[4] = char(tolower(str[4]));
 
   for (MoveList<LEGAL> it(pos); *it; ++it)
       str[4] = char(tolower(str[4]));
 
   for (MoveList<LEGAL> it(pos); *it; ++it)
-      if (str == format_move(*it, pos.is_chess960()))
+      if (str == UCI::move(*it, pos.is_chess960()))
           return *it;
 
   return MOVE_NONE;
           return *it;
 
   return MOVE_NONE;
index a39624a..cbf150c 100644 (file)
--- a/src/uci.h
+++ b/src/uci.h
@@ -67,9 +67,9 @@ private:
 void init(OptionsMap&);
 void loop(int argc, char* argv[]);
 
 void init(OptionsMap&);
 void loop(int argc, char* argv[]);
 
-std::string format_value(Value v, Value alpha = -VALUE_INFINITE, Value beta = VALUE_INFINITE);
-std::string format_square(Square s);
-std::string format_move(Move m, bool chess960);
+std::string value(Value v, Value alpha = -VALUE_INFINITE, Value beta = VALUE_INFINITE);
+std::string square(Square s);
+std::string move(Move m, bool chess960);
 Move to_move(const Position& pos, std::string& str);
 
 } // namespace UCI
 Move to_move(const Position& pos, std::string& str);
 
 } // namespace UCI