Docs&refactor/clamp refactor - #88
Open
wisegod62 wants to merge 3 commits into
Open
Conversation
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
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.
I made a few messy commits and if this gets merged, I think that it should be squashed as well.
I noticed in SLMath.clamp() the min and max values were interchangeable, so I replaced the if else (which I thought was less readable) with getting doubles lower and upper defined by Math.min and Math.max of the two bounds passed to the function. It then compares lower and upper with {@code x}.
I'm not sure if this will have a performance impact but I suggest this change to make the code more readable.
I also changed the javadoc above the function a little: First of all, I replaced "max to min" to "the range defined by {@code min} and {@code max}". I also noted that the order doesn't matter.
I also reflected this interchangeability in the description for arguments {@code.min} and {@code.max}.