Skip to content

Commit

Permalink
Standardize Comments
Browse files Browse the repository at this point in the history 
use double slashes (//) only for comments.

closes #4820

No functional change.
  • Loading branch information
@FauziAkram @vondele
FauziAkram authored and vondele committed Oct 21, 2023
1 parent fe53a18 commit edb4ab9
Show file tree
Hide file tree
Showing 28 changed files with 491 additions and 493 deletions.
22 changes: 11 additions & 11 deletions src/benchmark.cpp
View file
Expand Up @@ -95,17 +95,17 @@ const std::vector<std::string> Defaults = {

namespace Stockfish {

/// setup_bench() builds a list of UCI commands to be run by bench. There
/// are five parameters: TT size in MB, number of search threads that
/// should be used, the limit value spent for each position, a file name
/// where to look for positions in FEN format, and the type of the limit:
/// depth, perft, nodes and movetime (in milliseconds). Examples:
///
/// bench : search default positions up to depth 13
/// bench 64 1 15 : search default positions up to depth 15 (TT = 64MB)
/// bench 64 1 100000 default nodes : search default positions for 100K nodes each
/// bench 64 4 5000 current movetime : search current position with 4 threads for 5 sec
/// bench 16 1 5 blah perft : run a perft 5 on positions in file "blah"
// setup_bench() builds a list of UCI commands to be run by bench. There
// are five parameters: TT size in MB, number of search threads that
// should be used, the limit value spent for each position, a file name
// where to look for positions in FEN format, and the type of the limit:
// depth, perft, nodes and movetime (in milliseconds). Examples:
//
// bench : search default positions up to depth 13
// bench 64 1 15 : search default positions up to depth 15 (TT = 64MB)
// bench 64 1 100000 default nodes : search default positions for 100K nodes each
// bench 64 4 5000 current movetime : search current position with 4 threads for 5 sec
// bench 16 1 5 blah perft : run a perft 5 on positions in file "blah"

std::vector<std::string> setup_bench(const Position& current, std::istream& is) {

Expand Down
12 changes: 6 additions & 6 deletions src/bitboard.cpp
View file
Expand Up @@ -46,17 +46,17 @@ namespace {

}

/// safe_destination() returns the bitboard of target square for the given step
/// from the given square. If the step is off the board, returns empty bitboard.
// safe_destination() returns the bitboard of target square for the given step
// from the given square. If the step is off the board, returns empty bitboard.

inline Bitboard safe_destination(Square s, int step) {
Square to = Square(s + step);
return is_ok(to) && distance(s, to) <= 2 ? square_bb(to) : Bitboard(0);
}


/// Bitboards::pretty() returns an ASCII representation of a bitboard suitable
/// to be printed to standard output. Useful for debugging.
// Bitboards::pretty() returns an ASCII representation of a bitboard suitable
// to be printed to standard output. Useful for debugging.

std::string Bitboards::pretty(Bitboard b) {

Expand All @@ -75,8 +75,8 @@ std::string Bitboards::pretty(Bitboard b) {
}


/// Bitboards::init() initializes various bitboard tables. It is called at
/// startup and relies on global objects to be already zero-initialized.
// Bitboards::init() initializes various bitboard tables. It is called at
// startup and relies on global objects to be already zero-initialized.

void Bitboards::init() {

Expand Down
66 changes: 33 additions & 33 deletions src/bitboard.h
View file
Expand Up @@ -64,7 +64,7 @@ extern Bitboard PseudoAttacks[PIECE_TYPE_NB][SQUARE_NB];
extern Bitboard PawnAttacks[COLOR_NB][SQUARE_NB];


/// Magic holds all magic bitboards relevant data for a single square
// Magic holds all magic bitboards relevant data for a single square
struct Magic {
Bitboard mask;
Bitboard magic;
Expand Down Expand Up @@ -95,8 +95,8 @@ inline Bitboard square_bb(Square s) {
}


/// Overloads of bitwise operators between a Bitboard and a Square for testing
/// whether a given bit is set in a bitboard, and for setting and clearing bits.
// Overloads of bitwise operators between a Bitboard and a Square for testing
// whether a given bit is set in a bitboard, and for setting and clearing bits.

inline Bitboard operator&( Bitboard b, Square s) { return b & square_bb(s); }
inline Bitboard operator|( Bitboard b, Square s) { return b | square_bb(s); }
Expand All @@ -115,8 +115,8 @@ constexpr bool more_than_one(Bitboard b) {
}


/// rank_bb() and file_bb() return a bitboard representing all the squares on
/// the given file or rank.
// rank_bb() and file_bb() return a bitboard representing all the squares on
// the given file or rank.

constexpr Bitboard rank_bb(Rank r) {
return Rank1BB << (8 * r);
Expand All @@ -135,7 +135,7 @@ constexpr Bitboard file_bb(Square s) {
}


/// shift() moves a bitboard one or two steps as specified by the direction D
// shift() moves a bitboard one or two steps as specified by the direction D

template<Direction D>
constexpr Bitboard shift(Bitboard b) {
Expand All @@ -148,8 +148,8 @@ constexpr Bitboard shift(Bitboard b) {
}


/// pawn_attacks_bb() returns the squares attacked by pawns of the given color
/// from the squares in the given bitboard.
// pawn_attacks_bb() returns the squares attacked by pawns of the given color
// from the squares in the given bitboard.

template<Color C>
constexpr Bitboard pawn_attacks_bb(Bitboard b) {
Expand All @@ -163,10 +163,10 @@ inline Bitboard pawn_attacks_bb(Color c, Square s) {
return PawnAttacks[c][s];
}

/// line_bb() returns a bitboard representing an entire line (from board edge
/// to board edge) that intersects the two given squares. If the given squares
/// are not on a same file/rank/diagonal, the function returns 0. For instance,
/// line_bb(SQ_C4, SQ_F7) will return a bitboard with the A2-G8 diagonal.
// line_bb() returns a bitboard representing an entire line (from board edge
// to board edge) that intersects the two given squares. If the given squares
// are not on a same file/rank/diagonal, the function returns 0. For instance,
// line_bb(SQ_C4, SQ_F7) will return a bitboard with the A2-G8 diagonal.

inline Bitboard line_bb(Square s1, Square s2) {

Expand All @@ -176,13 +176,13 @@ inline Bitboard line_bb(Square s1, Square s2) {
}


/// between_bb(s1, s2) returns a bitboard representing the squares in the semi-open
/// segment between the squares s1 and s2 (excluding s1 but including s2). If the
/// given squares are not on a same file/rank/diagonal, it returns s2. For instance,
/// between_bb(SQ_C4, SQ_F7) will return a bitboard with squares D5, E6 and F7, but
/// between_bb(SQ_E6, SQ_F8) will return a bitboard with the square F8. This trick
/// allows to generate non-king evasion moves faster: the defending piece must either
/// interpose itself to cover the check or capture the checking piece.
// between_bb(s1, s2) returns a bitboard representing the squares in the semi-open
// segment between the squares s1 and s2 (excluding s1 but including s2). If the
// given squares are not on a same file/rank/diagonal, it returns s2. For instance,
// between_bb(SQ_C4, SQ_F7) will return a bitboard with squares D5, E6 and F7, but
// between_bb(SQ_E6, SQ_F8) will return a bitboard with the square F8. This trick
// allows to generate non-king evasion moves faster: the defending piece must either
// interpose itself to cover the check or capture the checking piece.

inline Bitboard between_bb(Square s1, Square s2) {

Expand All @@ -191,16 +191,16 @@ inline Bitboard between_bb(Square s1, Square s2) {
return BetweenBB[s1][s2];
}

/// aligned() returns true if the squares s1, s2 and s3 are aligned either on a
/// straight or on a diagonal line.
// aligned() returns true if the squares s1, s2 and s3 are aligned either on a
// straight or on a diagonal line.

inline bool aligned(Square s1, Square s2, Square s3) {
return line_bb(s1, s2) & s3;
}


/// distance() functions return the distance between x and y, defined as the
/// number of steps for a king in x to reach y.
// distance() functions return the distance between x and y, defined as the
// number of steps for a king in x to reach y.

template<typename T1 = Square> inline int distance(Square x, Square y);
template<> inline int distance<File>(Square x, Square y) { return std::abs(file_of(x) - file_of(y)); }
Expand All @@ -209,8 +209,8 @@ template<> inline int distance<Square>(Square x, Square y) { return SquareDistan

inline int edge_distance(File f) { return std::min(f, File(FILE_H - f)); }

/// attacks_bb(Square) returns the pseudo attacks of the given piece type
/// assuming an empty board.
// attacks_bb(Square) returns the pseudo attacks of the given piece type
// assuming an empty board.

template<PieceType Pt>
inline Bitboard attacks_bb(Square s) {
Expand All @@ -221,9 +221,9 @@ inline Bitboard attacks_bb(Square s) {
}


/// attacks_bb(Square, Bitboard) returns the attacks by the given piece
/// assuming the board is occupied according to the passed Bitboard.
/// Sliding piece attacks do not continue passed an occupied square.
// attacks_bb(Square, Bitboard) returns the attacks by the given piece
// assuming the board is occupied according to the passed Bitboard.
// Sliding piece attacks do not continue passed an occupied square.

template<PieceType Pt>
inline Bitboard attacks_bb(Square s, Bitboard occupied) {
Expand Down Expand Up @@ -253,7 +253,7 @@ inline Bitboard attacks_bb(PieceType pt, Square s, Bitboard occupied) {
}


/// popcount() counts the number of non-zero bits in a bitboard
// popcount() counts the number of non-zero bits in a bitboard

inline int popcount(Bitboard b) {

Expand All @@ -274,7 +274,7 @@ inline int popcount(Bitboard b) {
}


/// lsb() and msb() return the least/most significant bit in a non-zero bitboard
// lsb() and msb() return the least/most significant bit in a non-zero bitboard

#if defined(__GNUC__) // GCC, Clang, ICX

Expand Down Expand Up @@ -342,15 +342,15 @@ inline Square msb(Bitboard b) {

#endif

/// least_significant_square_bb() returns the bitboard of the least significant
/// square of a non-zero bitboard. It is equivalent to square_bb(lsb(bb)).
// least_significant_square_bb() returns the bitboard of the least significant
// square of a non-zero bitboard. It is equivalent to square_bb(lsb(bb)).

inline Bitboard least_significant_square_bb(Bitboard b) {
assert(b);
return b & -b;
}

/// pop_lsb() finds and clears the least significant bit in a non-zero bitboard
// pop_lsb() finds and clears the least significant bit in a non-zero bitboard

inline Square pop_lsb(Bitboard& b) {
assert(b);
Expand Down
34 changes: 17 additions & 17 deletions src/evaluate.cpp
View file
Expand Up @@ -57,13 +57,13 @@ namespace Eval {

std::string currentEvalFileName = "None";

/// NNUE::init() tries to load a NNUE network at startup time, or when the engine
/// receives a UCI command "setoption name EvalFile value nn-[a-z0-9]{12}.nnue"
/// The name of the NNUE network is always retrieved from the EvalFile option.
/// We search the given network in three locations: internally (the default
/// network may be embedded in the binary), in the active working directory and
/// in the engine directory. Distro packagers may define the DEFAULT_NNUE_DIRECTORY
/// variable to have the engine search in a special directory in their distro.
// NNUE::init() tries to load a NNUE network at startup time, or when the engine
// receives a UCI command "setoption name EvalFile value nn-[a-z0-9]{12}.nnue"
// The name of the NNUE network is always retrieved from the EvalFile option.
// We search the given network in three locations: internally (the default
// network may be embedded in the binary), in the active working directory and
// in the engine directory. Distro packagers may define the DEFAULT_NNUE_DIRECTORY
// variable to have the engine search in a special directory in their distro.

void NNUE::init() {

Expand Down Expand Up @@ -105,7 +105,7 @@ namespace Eval {
}
}

/// NNUE::verify() verifies that the last net used was loaded successfully
// NNUE::verify() verifies that the last net used was loaded successfully
void NNUE::verify() {

std::string eval_file = std::string(Options["EvalFile"]);
Expand Down Expand Up @@ -135,18 +135,18 @@ namespace Eval {
}


/// simple_eval() returns a static, purely materialistic evaluation of the position
/// from the point of view of the given color. It can be divided by PawnValue to get
/// an approximation of the material advantage on the board in terms of pawns.
// simple_eval() returns a static, purely materialistic evaluation of the position
// from the point of view of the given color. It can be divided by PawnValue to get
// an approximation of the material advantage on the board in terms of pawns.

Value Eval::simple_eval(const Position& pos, Color c) {
return PawnValue * (pos.count<PAWN>(c) - pos.count<PAWN>(~c))
+ (pos.non_pawn_material(c) - pos.non_pawn_material(~c));
}


/// evaluate() is the evaluator for the outer world. It returns a static evaluation
/// of the position from the point of view of the side to move.
// evaluate() is the evaluator for the outer world. It returns a static evaluation
// of the position from the point of view of the side to move.

Value Eval::evaluate(const Position& pos) {

Expand Down Expand Up @@ -189,10 +189,10 @@ Value Eval::evaluate(const Position& pos) {
return v;
}

/// trace() is like evaluate(), but instead of returning a value, it returns
/// a string (suitable for outputting to stdout) that contains the detailed
/// descriptions and values of each evaluation term. Useful for debugging.
/// Trace scores are from white's point of view
// trace() is like evaluate(), but instead of returning a value, it returns
// a string (suitable for outputting to stdout) that contains the detailed
// descriptions and values of each evaluation term. Useful for debugging.
// Trace scores are from white's point of view

std::string Eval::trace(Position& pos) {

Expand Down

0 comments on commit edb4ab9

Please sign in to comment.