Add checked BitBoard::to_maybe_square(); document to_square() on empty (#91)#92
Open
Booyaka101 wants to merge 1 commit into
Open
Add checked BitBoard::to_maybe_square(); document to_square() on empty (#91)#92Booyaka101 wants to merge 1 commit into
Booyaka101 wants to merge 1 commit into
Conversation
On current main, BitBoard::new(0).to_square() returns A1, not the invalid "a9" from the report -- Square::new already masks with & 63. What remains is that to_square() silently returns A1 for an empty BitBoard, which is indistinguishable from a BitBoard with only A1 set. Add BitBoard::to_maybe_square() -> Option<Square>, the checked counterpart of to_square() (mirroring the existing from_maybe_square), returning None when empty. to_square()'s documentation now states its non-empty precondition and points to the checked method. Additive and non-breaking. to_maybe_square uses &self to match the existing to_square/to_size convention. Addresses jordanbray#91.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addresses #91.
On current
main,BitBoard::new(0).to_square()returnsA1, not the invalida9from the report —Square::newalready masks with& 63, so the out-of-range square is gone. What remains is thatto_square()silently returnsA1for an emptyBitBoard, which is indistinguishable from aBitBoardwith only A1 set.This adds
BitBoard::to_maybe_square() -> Option<Square>, the checked counterpart ofto_square()(mirroring the existingfrom_maybe_square), returningNonewhen theBitBoardis empty.to_square()'s documentation now states its non-empty precondition and points to the checked method.Additive and non-breaking. Doctests on both methods serve as tests; the full suite (36 unit + 142 doc) passes.
to_maybe_squaretakes&selfto match the existingto_square/to_sizeconvention.