Skip to content

Commit

Permalink
Improve comments in UCI
Browse files Browse the repository at this point in the history 
And simplify naming while there.

No functional change.

Resolves official-stockfish#159
  • Loading branch information
@mcostalba @zamar
mcostalba authored and zamar committed Dec 14, 2014
1 parent 413b243 commit b8fd1a7
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 29 deletions.
4 changes: 2 additions & 2 deletions src/position.cpp
View file
Expand Up @@ -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; )
os << UCI::format_square(pop_lsb(&b)) << " ";
os << UCI::square(pop_lsb(&b)) << " ";

return os;
}
Expand Down Expand Up @@ -444,7 +444,7 @@ const string Position::fen() const {
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();
Expand Down
14 changes: 7 additions & 7 deletions src/search.cpp
View file
Expand Up @@ -179,7 +179,7 @@ uint64_t Search::perft(Position& pos, Depth depth) {
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;
}
Expand Down Expand Up @@ -216,7 +216,7 @@ void Search::think() {
{
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
Expand Down Expand Up @@ -274,10 +274,10 @@ void Search::think() {
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)
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;
}
Expand Down Expand Up @@ -783,7 +783,7 @@ namespace {

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;
}

Expand Down Expand Up @@ -1446,15 +1446,15 @@ namespace {
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
<< " time " << elapsed
<< " 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();
Expand Down
33 changes: 16 additions & 17 deletions src/uci.cpp
View file
Expand Up @@ -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.

string UCI::format_value(Value v, Value alpha, Value beta) {
string UCI::value(Value v, Value alpha, Value beta) {

stringstream ss;

Expand All @@ -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);
Expand All @@ -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));

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)];
Expand All @@ -276,16 +275,16 @@ 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) {

if (str.length() == 5) // Junior could send promotion piece in uppercase
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;
Expand Down
6 changes: 3 additions & 3 deletions src/uci.h
View file
Expand Up @@ -67,9 +67,9 @@ class Option {
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
Expand Down

0 comments on commit b8fd1a7

Please sign in to comment.