add "mod" function to FlxMath #3341
Open
Conversation
This file contains 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
Geokureli
requested changes
Jan 23, 2025
flixel/math/FlxMath.hx
Outdated
| @@ -573,4 +573,13 @@ class FlxMath | |||
| { | |||
| return (n > 0) ? n : -n; | |||
| } | |||
|
|
|||
| /** | |||
| * Returns `a mod b`. | |||
There was a problem hiding this comment.
The doc should explain what "mod" is, the difference between this and haxe's % operator and give at least one key example of that difference
There was a problem hiding this comment.
also we should add that example and others to the unit test
Geokureli
reviewed
Jan 23, 2025
| @@ -575,7 +575,15 @@ class FlxMath | |||
| } | |||
|
|
|||
| /** | |||
| * Returns `a mod b`. | |||
| * Performs a modulo operation on two numbers. | |||
There was a problem hiding this comment.
What about?
Suggested change
| * Performs a modulo operation on two numbers. | |
| * Performs a modulo operation to calculate the remainder of `a` divided by `b` |
I want it to actually say what modulo/mod is
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.
this pr adds a more "mathematically accurate" alternative to the built-in modulo operator to
FlxMathas a helper functionhaxe
a % bbehavior (truncated division):By Mathnerd314159 - Own work based on: Divmod.svg by Salix alba, CC BY-SA 3.0, Link
a mod bbehavior (euclidean division):By Mathnerd314159 - Own work based on: Divmod.svg by Salix alba, CC BY-SA 3.0, Link