Use a looser tolerance on pitch for HexGrid roughly equal check #2058
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.
What is the change?
Use
math.isclose
to compare pitches of two hex grids rather than strict equality.Why is the change being made?
We don't need a super strict check to make sure the grids are roughly equal. The ideal of the method is to check that one index location in one grid would be in approximately the same spatial location in the other grid. Otherwise we can't accurately rotate the position within the grid.
This problem came up in some shuffling work where two assemblies had ever so slightly different pitches, on the order of hundreths of a percent. The strict
other.pitch == self.pitch
failed even though, for the purposes of this method, the two grids are "roughly equal"Checklist
doc
folder.pyproject.toml
.